Kanbus

Docs

Documentation

Start with the guide for the way you plan to run Kanbus, then keep the command overview close by. The full reference lives with the code.

Everything on these pages describes Kanbus as it ships today. When a page and the reference in the repository disagree, the repository wins, because it is tested with the code.

Guides on this site

Getting started

Install Kanbus, put a board in a repository and hand it to your agents. Then pick how far to take it.

Everyday commands

The commands that cover most days, from creating an issue to committing the board.

Reference in the repository

These guides live next to the code on GitHub and change in the same pull requests as the behavior they describe.

Getting started

Install the CLI and follow the step-by-step guide for local files, files in the cloud, or S3 and DynamoDB.

CLI reference

Every command and flag, including agent metadata, dependencies, the wiki and realtime tools.

Configuration

The .kanbus.yml schema: project key, issue types, workflows, priorities, realtime and coordination.

Realtime collaboration

How change notifications and the overlay cache keep boards live while your files stay the source of truth.

Lifecycle hooks

Run your own commands before and after Kanbus events, and block a change when a check fails.