Installation¶

Prerequisites¶

bubblewrap¶

# Debian/Ubuntu
sudo apt install bubblewrap

# Fedora
sudo dnf install bubblewrap

# Arch Linux
sudo pacman -S bubblewrap

# Alpine
sudo apk add bubblewrap

# openSUSE
sudo zypper install bubblewrap

Python¶

Python >= 3.11 is required. uv is recommended for installation.

Make sure ~/.local/bin is in your PATH.

Install bubble-agent¶

From PyPI¶

uv tool install bubble-agent

From Test PyPI¶

uv tool install --index-url https://test.pypi.org/simple/ bubble-agent

From GitHub¶

Install directly from the repository:

# Latest master branch
uv tool install git+https://github.com/ak1ra-lab/bubble-agent.git

# Specific branch (e.g. dev)
uv tool install git+https://github.com/ak1ra-lab/bubble-agent.git@dev

# Specific tag (e.g. v0.1.0)
uv tool install git+https://github.com/ak1ra-lab/bubble-agent.git@v0.1.0

From local clone¶

git clone https://github.com/ak1ra-lab/bubble-agent.git
cd bubble-agent
uv tool install .

For development convenience, the repo includes a justfile:

just install    # uv tool install . + copy example config as reference
just uninstall  # uv tool uninstall bubble-agent

Configuration¶

Create your config file from the example:

mkdir -p ~/.config/bubble-agent
curl -o ~/.config/bubble-agent/bubble-agent.conf \
  https://raw.githubusercontent.com/ak1ra-lab/bubble-agent/master/bubble-agent.example.conf
# edit ~/.config/bubble-agent/bubble-agent.conf

See Configuration for details.

Uninstall¶

uv tool uninstall bubble-agent

Optionally remove the config directory:

rm -rf ~/.config/bubble-agent