# yakanban

> Let your AI agents work the board your team already uses. No migration, no second UI, nothing for your product owner to learn.

Commands are driven from a terminal by developers and AI agents; the tracker
keeps its own web UI for everybody else. The backend is the source of truth,
so every write goes straight to it and reads are cached for one minute. Claims
are soft, expiring locks that keep two agents off the same ticket.

Authentication is delegated: yakanban stores no credentials and falls back to
`gh auth token`, so a run without a token environment variable and without the
GitHub CLI on PATH exits 4.

This file is generated from the repository's own sources at build time. It
describes yakanban v1.0.1-4-gc6829e5.

## Start here

- [Install and quick start](https://github.com/aramponi/yakanban/blob/main/README.md#install): the install commands and the first five commands to run
- [Authentication](https://github.com/aramponi/yakanban/blob/main/README.md#authentication): no credentials are stored; a token comes from `$YAKANBAN_GITHUB_TOKEN`, `$GH_TOKEN` or `$GITHUB_TOKEN`, and otherwise from `gh auth token`, so the GitHub CLI is a prerequisite unless one of those is set. Projects v2 needs its own scope: `gh auth refresh -s project`
- [Command reference](https://github.com/aramponi/yakanban/blob/main/README.md#commands): every command, and the global flags (`--json`, `--compact`, `--table`, `--no-color`, `--refresh`, `--no-cache`) that all of them accept
- [Exit codes](https://github.com/aramponi/yakanban/blob/main/README.md#exit-codes): the programmatic contract — 0 success, 1 unexpected error, 2 bad input or missing configuration, 3 task not found, 4 authentication or scope problem, 5 the task is claimed by another agent, 6 the provider cannot express what you asked for

## Agent instructions

- [yakanban skill](https://github.com/aramponi/yakanban/blob/main/skills/yakanban/SKILL.md): the decision tree, the claim protocol and the exit codes, for any task or board work
- [yakanban-based-development skill](https://github.com/aramponi/yakanban/blob/main/skills/yakanban-based-development/SKILL.md): the autonomous, parallel-safe loop — pick, branch, implement, merge, done — with the handoff protocol for anything needing a human
- [Working with agents](https://github.com/aramponi/yakanban/blob/main/docs/agents.md): claims, expiry, and what makes several agents on one board safe

## Reference

- [GitHub mapping](https://github.com/aramponi/yakanban/blob/main/docs/github-mapping.md): which yakanban field lives in which issue or project field
- [Architecture](https://github.com/aramponi/yakanban/blob/main/docs/architecture.md): the packages, and what adding a provider involves
- [Configuration](https://github.com/aramponi/yakanban/blob/main/docs/configuration.md): `.yakanban.yml`, the columns and what they mean, WIP limits and claim rules
- [Branching](https://github.com/aramponi/yakanban/blob/main/docs/branching.md): the presets, the name templates, and what is deliberately left to you
- [Adopting an existing board](https://github.com/aramponi/yakanban/blob/main/docs/adopting-a-board.md): what `init` does and does not touch on a project the team already uses

## Optional

- [What we didn't build](https://aramponi.github.io/yakanban#what-we-didnt-build): the deliberate omissions and the reason for each; useful for judging fit, not for driving the tool
- [Why yakanban exists](https://github.com/aramponi/yakanban/blob/main/README.md#why): background on the model it borrows and the storage it does not
- [Releases](https://github.com/aramponi/yakanban/releases): binaries for macOS, Linux and Windows