AgentKit
ReferenceCLI commands

CLI commands

ak projects

Manage the global AK project registry

ak projects

Manage the global AK project registry

Synopsis

What it does: 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.

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 project

What changes on disk: Reads and writes ~/.agentkit/projects.json. Writes are atomic (temp-file + rename) under an advisory lock.

Output modes: pretty default on TTY (colors, ASCII markers) plain auto when stdout piped or --no-interactive json --json (single-object envelope, NDJSON-safe)

Exit codes: 0 success 1 runtime error 2 invalid flags 3 user-cancel (SIGINT, prompt-cancel)

Options

  -h, --help   help for projects

SEE ALSO

On this page