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 config status
Show the running state of the dashboard server
Read the dashboard server state file and report whether the server is running. Shows PID, bind address, URL, and uptime when running. Exits 0 whether or not the server is running - use the running field in --json output to branch.
Who it's for: Both: power devs checking server health in scripts (--json) and non-technical users.
When to use it: Checking whether ak config start has been run, or verifying the dashboard is still up. Safe to call repeatedly - read-only.
What changes on disk: Read-only: ~/.agentkit/dashboard-state.json.
Usage
ak config status [flags]Examples
ak config status # human-readable one-liner
ak config status --json # JSON envelope with schema_version, running, url, pidFlags
| Flag | Description |
|---|---|
-h, --help | help for status |
--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) |
Related commands
ak config— Open the local AgentKit dashboard