AgentKit
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 show

Show details for a registered project

Display full detail for one project registered in ~/.agentkit/projects.json. Lookup is first by exact directory path, then by name.

Who it's for: Both: power devs (--json) and non-technical users.

When to use it: Inspecting registration metadata for a specific project.

What changes on disk: Read-only: ~/.agentkit/projects.json.

Usage

ak projects show <name|path> [flags]

Examples

ak projects show myproj              # lookup by name
ak projects show $HOME/projects/myproj    # lookup by path
ak projects show myproj --json       # machine-readable output

Flags

FlagDescription
-h, --helphelp for show
--jsonEmit machine-readable JSON (implies --no-interactive)
--no-interactiveDisable interactive prompts (CI-safe)
-q, --quietSuppress non-error output on stderr
-V, --verboseExtra diagnostic output on stderr (loses to --quiet)
-y, --yesAssume yes for all prompts

Output modes

ModeBehavior
prettydefault on TTY (colors, ASCII markers)
plainauto when stdout piped or --no-interactive
json--json (single-object envelope, NDJSON-safe)

Exit codes

CodeMeaning
0success
1runtime error
2invalid flags
3user-cancel (SIGINT, prompt-cancel)
0project found
5project not found in registry
2invalid arguments
  • ak projects — Manage the global AK project registry

On this page