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 projects
Manage the global AK project registry
The project registry (~/.agentkit/projects.json) tracks every directory that ak new or ak init has bootstrapped. Use these subcommands to inspect and maintain the registry.
Who it's for: Both: power devs (--json) and non-technical users (TUI table).
When to use it: Listing, adding, removing, or inspecting registered AK projects.
What changes on disk: Reads and writes ~/.agentkit/projects.json. Writes are atomic (temp-file + rename) under an advisory lock.
Examples
ak projects list # show all registered projects
ak projects list --json # machine-readable output
ak projects add ./myproj # manually register a directory
ak projects remove myproj # deregister by name or path
ak projects show myproj # show details for one projectFlags
| Flag | Description |
|---|---|
-h, --help | help for projects |
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) |
Related commands
ak— AgentKit CLIak projects add— Register a project directory in the global registryak projects list— List all registered AK projectsak projects prune— Remove stale project registry entriesak projects remove— Deregister a project from the global registryak projects show— Show details for a registered project