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 check
Mark all checkboxes in a phase file as done
Toggle every '- [ ]' checkbox in the named phase-NN-*.md file to '- [x]'. Already-checked boxes are left unchanged (idempotent).
Who it's for: Both: interactive workflow and CI automation.
When to use it: (unspecified)
What changes on disk: Mutates the phase file in-place (atomic write).
Usage
ak plan check <phase-file> [flags]Examples
ak plan check ./plans/my-plan/phase-01-setup.md
ak plan check ./plans/my-plan/phase-01-setup.md --jsonFlags
| Flag | Description |
|---|---|
-h, --help | help for check |
--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 | phase file not found or I/O error |
Related commands
ak plan— Manage AgentKit plan directories