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 validate
Check plan directory format; exits 0 (valid) or 3 (invalid)
Validate that a plan directory follows the CK convention: plan.md with front-matter title, and at least one phase-NN-*.md file.
Who it's for: Power devs (CI/CD gates, scripting).
When to use it: (unspecified)
What changes on disk: Read-only.
Usage
ak plan validate <path> [flags]Examples
ak plan validate ./plans/my-plan
ak plan validate ./plans/my-plan --jsonFlags
| Flag | Description |
|---|---|
-h, --help | help for validate |
--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) |
0 | plan is valid |
3 | plan failed validation |
Related commands
ak plan— Manage AgentKit plan directories