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 parse
Parse and display a structured plan view
Parse a plan directory and print a structured summary of all phases, task counts, and progress. Use --json for machine-readable output.
Who it's for: Both: power devs (--json) and non-tech users (plain view).
When to use it: Inspecting plan structure, dumping a parsed view for tooling, or feeding into a script via --json.
What changes on disk: Read-only.
Usage
ak plan parse <path> [flags]Examples
ak plan parse ./plans/my-plan
ak plan parse ./plans/my-plan --jsonFlags
| Flag | Description |
|---|---|
-h, --help | help for parse |
--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 not found or invalid format |
Related commands
ak plan— Manage AgentKit plan directories