Install Bub

Install the CLI app

macOS / Linux

curl -fsSL https://bub.build/install.sh | bash

Windows

powershell -ExecutionPolicy ByPass -c "irm https://bub.build/install.ps1 | iex"

uv

uv tool install "bub[app]"
uv tool update-shell

The install script installs uv and Python 3.12, and puts bub[app] into your current environment. app is an optional dependency group that bundles the application-layer capabilities such as the CLI, channels, and plugins; you do not need it if you only use the SDK.

When it finishes, run bub --help, then run bub onboard to start configuring.

Tip

If the command is not found, check whether the environment variables include the directory that holds the executable, or add ~/.local/bin to PATH yourself.

Install the SDK

From 0.6.0 on, Bub ships the core only. Use your package manager to add Bub to your project as a dependency. Here is uv:

uv add bub
uv run python -c "from bub.core import Agent; print(Agent.__name__)"

Run from source

Clone the repository and sync its dependencies:

git clone https://github.com/bubbuild/bub.git
cd bub
uv sync

Then run it with uv run bub.

---

With the installation done, continue to Quick start.