AgentKit
ReferenceCLI commands

CLI commands

ak config

Open the local AgentKit dashboard

ak config

Open the local AgentKit dashboard

Synopsis

What it does: Open the AgentKit dashboard. On Wails-enabled builds this opens a native desktop window backed by the same binary (no HTTP server). On headless builds, or when --no-window / --port / --no-interactive is set, it starts the HTTP dashboard server instead and opens your browser. Non-loopback HTTP binds require --auth-token.

Who it's for: Users who want a visual overview of their AgentKit projects and config.

When to use it: Use ak config for the default dashboard flow. Use subcommands for lifecycle control.

Examples: ak config # native window (wails build) or browser (fallback) ak config --no-window # force HTTP dashboard + browser even on wails build ak config start # start HTTP dashboard daemon (all builds) ak config --port 9000 # force HTTP path, custom port ak config start --port 9000 # custom port ak config start --no-open # skip browser auto-open ak config start --json # emit startup JSON for CI ak config start --bind 0.0.0.0 --auth-token=tok # non-loopback with auth ak config stop # stop the running daemon ak config status # show PID, port, uptime

What changes on disk: Reads ~/.agentkit/config.yaml for settings. In HTTP mode: writes ~/.agentkit/dashboard/state.json on start; removes it on stop.

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) 1 runtime error (config I/O, listen failure, window init failure) 2 invalid flags or arguments 7 security violation: non-loopback bind without auth token

ak config [flags]

Options

      --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 config
      --json                Emit machine-readable JSON (implies --no-interactive)
      --no-interactive      Disable interactive prompts (CI-safe)
      --no-open             Skip browser auto-open on startup
      --no-window           Skip native window and use the HTTP dashboard + browser instead (wails builds only)
      --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

SEE ALSO

On this page