Getting Started

A jupyter lab extension is provided to help you get started with Waldiez. You can generate, convert and run Waldiez flows. Alternatively, you can use the Visual Studio Code extension: Waldiez for Visual Studio Code.

Note

Requirements:

Python >= 3.10, < 3.13

For the Jupyter lab extension:

jupyterlab>=4.0.0,<5

Manually¶

If not already, install jupyter:

pip install jupyter

Install the waldiez extension:

pip install waldiez-jupyter

Start jupyter lab:

jupyter lab

Using Docker or Podman¶

Don't want to install anything? A docker image is also available, with jupyter and the waldiez extension pre-installed.

Pull the image:

docker pull waldiez/jupyter

Run the container:

# To share files with the container, 
# mount (for example) the `notebooks` directory:  
docker run -it -p 8888:8888 -v ${PWD}/notebooks:/home/user/notebooks waldiez/jupyter

Modify if needed, for example to use a different port:

docker run -p 10000:8888 -v ${PWD}/notebooks:/home/user/notebooks waldiez/jupyter

Note

With podman and/or selinux, you might get permission errors, so you can try:

podman run \
    --rm \
    -it \
    -p 10000:8888 \
    -v ${PWD}/notebooks:/home/user/notebooks \
    --userns=keep-id \
    --security-opt label=disable \
    waldiez/jupyter

You can now open your browser at http://localhost:8888 (or the port you chose) and start using Waldiez.

Preview Dark Preview