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 create
Bootstrap a new plan directory from template
Scaffold a new AgentKit plan directory under --basedir (default: ./plans/). Creates plan.md with YAML front matter and a starter phase-01-start.md.
Who it's for: Both: interactive planning and CI automation.
When to use it: (unspecified)
What changes on disk: Creates <basedir>/<timestamp>-<slug>/ with plan.md and phase-01-start.md.
Usage
ak plan create <name> [flags]Examples
ak plan create "My Feature"
ak plan create "Deploy Pipeline" --basedir ./work
ak plan create "Auth" --jsonFlags
| Flag | Description |
|---|---|
--basedir string | Parent directory for the new plan (default: ./plans/) |
-h, --help | help for create |
--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 | I/O error or invalid name |
Related commands
ak plan— Manage AgentKit plan directories