Reference
Reference
CLI conventions
Global flags, output modes, and standard exit codes shared by every ak command.
Every ak command follows the same conventions for flags, output, and exit
codes. Command pages in the CLI reference list only what is specific
to that command; everything on this page applies everywhere.
Global flags
| Flag | Description |
|---|---|
--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 |
-h, --help | Print help for the command |
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) |
A command page's Exit codes section lists only codes (or meanings) that extend this standard set.