# Kan

> A file-based kanban board CLI tool. All data lives as plain files - no database, no server. Works with any VCS.

Kan manages kanban boards using plain files in a `.kan/` directory. It includes both a CLI and a web UI (served via `kan serve`). Boards, columns, and cards are stored as TOML and JSON files, making them easy to version control and merge.

## Docs

- [Kan Documentation](https://amterp.dev/kan/docs/index.md): Who is Kan for?, Quick Start, Topics, Roadmap
- [AI Agents](https://amterp.dev/kan/docs/ai-agents.md): Why It Works, The Kan Skill, Tips for AI-Friendly Boards
- [CLI Reference](https://amterp.dev/kan/docs/cli.md): Getting Started, Git Worktree Support, Commands, Global Flags, JSON Output
- [Configuration](https://amterp.dev/kan/docs/configuration.md): File Locations, Board Configuration, Fields Reference, Global User Configuration, Managing Columns via CLI
- [Custom Fields](https://amterp.dev/kan/docs/custom-fields.md): Field Types, Defining Fields, Card Display, Setting Fields via CLI, Default Configuration, Reserved Names
- [Editing Cards](https://amterp.dev/kan/docs/editing.md): Keyboard Shortcuts, Supported Markdown, My Card
- [Link Rules](https://amterp.dev/kan/docs/link-rules.md): Configuration, Pattern Syntax, URL Template Placeholders, How Matches Work, Troubleshooting
- [Keyboard Shortcuts](https://amterp.dev/kan/docs/shortcuts.md): Quick Search (Omnibar), View Modes, Board, Card Creation, Undo, Card Editor