ReferenceCLI commands
BetaYou are reading docs for the beta channel (
2.4.1-beta.1) — updated automatically on every beta release.Switch to stable →CLI commands
ak plan
Manage AgentKit plan directories
Parse, validate, inspect, and mutate AgentKit plan directories (plan.md + phase-NN-*.md files). Supports both interactive TUI and scripted --json output modes.
Who it's for: Both: power devs (--json --no-interactive) and non-tech users (defaults).
When to use it: Planning, tracking progress, or automating plan operations in CI.
What changes on disk: create, check, uncheck, add-phase write to plan files. parse, validate, status, kanban are read-only.
Examples
ak plan parse ./plans/my-plan # display structured plan view
ak plan validate ./plans/my-plan # check format; exit 0 or 1
ak plan status ./plans/my-plan # progress summary
ak plan kanban ./plans/my-plan # TUI kanban board
ak plan create "My Feature" # scaffold new plan
ak plan check ./plans/my-plan/phase-01-setup.md # mark phase done
ak plan uncheck ./plans/my-plan/phase-01.md # mark phase todo
ak plan add-phase ./plans/my-plan "Deploy" # append new phaseFlags
| Flag | Description |
|---|---|
-h, --help | help for plan |
--json | Emit machine-readable JSON (implies --no-interactive) |
--no-interactive | Disable interactive prompts (CI-safe) |
-q, --quiet | Suppress non-error output on stderr |
-V, --verbose | Extra diagnostic output on stderr (loses to --quiet) |
-y, --yes | Assume yes for all prompts |
Output modes
| Mode | Behavior |
|---|---|
pretty | default on TTY (colors, ASCII markers) |
plain | auto when stdout piped or --no-interactive |
json | --json (single-object envelope, NDJSON-safe) |
Exit codes
| Code | Meaning |
|---|---|
0 | success |
1 | runtime error |
2 | invalid flags |
3 | user-cancel (SIGINT, prompt-cancel) |
1 | plan directory or phase file not found / I/O error |
2 | invalid flags or arguments |
3 | plan validation failed (validate subcommand) |
Related commands
ak— AgentKit CLIak plan add-phase— Append a new phase-NN-<slug>.md to an existing planak plan check— Mark all checkboxes in a phase file as doneak plan create— Bootstrap a new plan directory from templateak plan kanban— Display a kanban board of plan phasesak plan parse— Parse and display a structured plan viewak plan status— Print plan progress summaryak plan uncheck— Mark all checkboxes in a phase file as todoak plan validate— Check plan directory format; exits 0 (valid) or 3 (invalid)