Skip to main content

KanbAI

KanbAI

PyPI version Python versions CI License

A file-based Kanban board that lives in your repo, built for Claude Code and other AI coding harnesses (and humans too). The board is plain Markdown files under .kanbai/, driven by a simple kanbai CLI and a local web UI. Installed and invoked as kanbai.

KanbAI web UI

Why

  • The board lives in your repo. One Markdown card per task, one folder per column — git-friendly, diffable, no external service, no database.
  • Claude drives it. kanbai init installs a rule + skills so Claude picks the next task, implements it, and moves it across the board while you review.
  • You stay in control. Finished work waits in review for your approval, and a friendly local web UI lets you watch and manage everything live.

How it works

kanbai init creates a .kanbai/ folder — one directory per column, one Markdown card per task:

.kanbai/
├── config.toml
├── backlog/
│   └── 004-add-oauth-login.md
├── todo/
├── doing/
├── review/
├── done/
└── archive/

Each card is Markdown with YAML frontmatter (managed by the CLI — don't edit by hand):

---
id: "004"
title: Add OAuth login
status: backlog
priority: high
order: 1
labels: [auth, backend]
deps: []
---

## Description
Support "Sign in with Google".

## Acceptance criteria
- [ ] OAuth flow works end to end

The sprint workflow

Cards flow through five columns:

Column Meaning
backlog Everything to do eventually. New cards land here.
todo The current sprint — what's planned for now.
doing In progress.
review Finished, awaiting your approval.
done Approved and complete.

kanbai next only reads the sprint (todo), respecting card order and blocking dependencies — so the backlog stays out of the way until you plan work into the sprint. When work is finished it goes to review; you approve it into done.

Install

uv add --dev kanbai          # add to your project as a dev dependency
# or
pip install kanbai

# for the web UI, install the extra:
uv add --dev 'kanbai[ui]'    # or: pip install 'kanbai[ui]'

Quick start

kanbai init                              # scaffold .kanbai/ + Claude integration
kanbai add "Build the login screen" -p high   # lands in the backlog
kanbai move 001 todo                     # plan it into the sprint
kanbai list                              # show the board

Then open a Claude Code session and ask it to "work through the KanbAI board".

Working with Claude Code

kanbai init installs the integration into .claude/:

  • .claude/rules/kanbai.md — teaches Claude the board convention, loaded every session.
  • Skills — kanbai-next (work one card and stop), kanbai-sprint (work the whole sprint), and kanbai-status (summarize the board).

Claude then works one card at a time:

  1. kanbai next --json — pick the next actionable sprint task.
  2. kanbai start <id> — move it to doing.
  3. Implement it (reading kanbai show <id> --json for the details).
  4. kanbai review <id> — send it to review and stop.
  5. You review the work and approve it with kanbai done <id>.

Allow the CLI without prompts by adding Bash(kanbai *) to your .claude/settings.json.

Using another assistant (Cursor, Windsurf, Aider, Copilot, …)? The board is harness-agnostic — see docs/other-harnesses.md.

Web UI

kanbai ui                    # serves the board and opens your browser
kanbai ui --reload           # auto-restart on code changes (development)
kanbai ui --poll             # for sandboxes/containers without OS file events

The UI (FastAPI + HTMX, assets vendored so it works offline) lets you:

  • View the board and create, edit, move, archive, or delete cards.
  • Drag-and-drop between columns (with persisted reordering) or move from a card's modal.
  • Plan a sprint (move several backlog cards to todo at once) and start a new sprint (archive done cards, optionally reset the active columns).
  • Search cards and filter by label.
  • Browse and restore archived cards.
  • See WIP-limit and blocked-by-dependency indicators, and live updates as Claude moves cards from the CLI (via Server-Sent Events).

Configuration

.kanbai/config.toml is created by init and can be edited:

[board]
name = "my-project"
columns = ["backlog", "todo", "doing", "review", "done"]

[defaults]
priority = "medium"

# Optional work-in-progress limits per column (the CLI and UI warn when exceeded).
[wip]
doing = 3

Commands

Command Description
kanbai init Scaffold .kanbai/ and install the Claude Code integration.
kanbai add "title" Create a card in backlog (use -c todo for the sprint).
kanbai list [column] Show the board, a single column, or the archive.
kanbai next Print the next actionable card in the sprint (todo).
kanbai show <id> Show full details of a card.
kanbai move <id> <column> Move a card to a column.
kanbai start <id> Move a card to doing.
kanbai review <id> / kanbai done <id> Send a card to review / approve it to done.
kanbai edit <id> Update fields of a card.
kanbai archive <id> / kanbai restore <id> Archive a card / restore it from the archive.
kanbai rm <id> Delete a card permanently.
kanbai new-sprint Archive done cards (optionally reset active columns to the backlog).
kanbai ui Serve the board in a local web UI (needs the ui extra).

Add --json to read-only commands for machine-readable output.

Changelog

See CHANGELOG.md.

License

MIT

Release files for kanbai 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kanbai 0.1.1
File Size Uploaded
kanbai-0.1.1.tar.gz 746.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kanbai 0.1.1
File Interpreter ABI Platform
kanbai-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 861.1 kB

Release files / kanbai-0.1.1.tar.gz

Download URL kanbai-0.1.1.tar.gz
Size 746.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ccffe20b602c0203db61131f0234defd123913dd737f3b770b8b1f880d930a5c
BLAKE2b-256 checksum
How to use checksums
14e5160d9f237bd5ddd8225919d1b56721911e79456c79907837acb8e50565eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

Release files / kanbai-0.1.1-py3-none-any.whl

Download URL kanbai-0.1.1-py3-none-any.whl
Size 115.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
32b75cb7f5affc348ffda054cebf4015fb117b409e7d3678d2cf45ed5f7a8392
BLAKE2b-256 checksum
How to use checksums
47bae10646afc832c6bfc5d3c01f877c3ddf4b0a0afe305fdef7c0b0d1039f15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

Release history Release notifications | RSS feed

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page