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 start
Start the local dashboard server
Start the AgentKit local dashboard server. The server hosts the configuration UI at http://127.0.0.1:<port>/ and opens it in your default browser automatically (unless --no-open is set). Non-loopback binds require --auth-token.
Who it's for: Non-technical users who prefer the web UI for configuration; power devs running the dashboard in CI or headless environments (--no-open --json).
When to use it: When you want to use the AgentKit web UI to configure API keys, manage kits, or inspect project state. Stop with ak config stop when done.
What changes on disk: Writes ~/.agentkit/dashboard-state.json with PID, bind address, and start time. File is removed by ak config stop.
Usage
ak config start [flags]Examples
ak config start # start on default port, open browser
ak config start --port 8080 # custom port
ak config start --no-open # suppress browser auto-open
ak config start --bind 0.0.0.0 --auth-token secret # non-loopback (auth required)
ak config start --json # emit startup envelope as JSONFlags
| Flag | Description |
|---|---|
--auth-token string | Bearer token for request auth (required when --bind is non-loopback; env: AK_DASHBOARD_TOKEN) |
--bind string | Bind address (default 127.0.0.1; non-loopback requires --auth-token) (default "127.0.0.1") |
-h, --help | help for start |
--json | Emit machine-readable JSON (implies --no-interactive) |
--no-interactive | Disable interactive prompts (CI-safe) |
--no-open | Skip browser auto-open on startup |
--port int | Port to listen on (0 = OS-assigned) (default 8766) |
-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) |
7 | non-loopback bind attempted without --auth-token (security violation) |
Related commands
ak config— Open the local AgentKit dashboard