Skip to content

Installation

KanbAI is a Python package (Python 3.10+). Install it as a dev dependency of the project whose board you want to manage.

Add it to a project

uv add --dev kanbai

pip install kanbai

poetry add --group dev kanbai

This gives you the kanbai command.

The web UI extra

The web UI and multi-board hub need a few extra packages (FastAPI, Uvicorn, …). Install the ui extra to enable them:

uv add --dev 'kanbai[ui]'

pip install 'kanbai[ui]'

Without the extra, the CLI works fully; only kanbai ui / kanbai hub are unavailable.

Installing globally (for the hub)

The hub serves the boards of several projects at once, so it makes sense to install KanbAI globally rather than per-project:

pipx install 'kanbai[ui]'
# or run it without installing anything:
uvx --from 'kanbai[ui]' kanbai hub

Verify

kanbai --help          # list all commands
kanbai --version       # print the installed version

Next: scaffold a board with kanbai init and read about the concepts.