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 gui
Launch the AgentKit desktop GUI
Open the AgentKit desktop UI in a native window backed by the same binary as the CLI.
Who it's for: Non-technical users and power devs who prefer a graphical surface for kit + agent ops.
When to use it: When you want point-and-click access to kit browsing, agent runs, and dashboards. The CLI exposes the same operations for scripting.
What changes on disk: Read-only (UI launch). Underlying agent runs may write per-agent caches.
Usage
ak gui [flags]Examples
ak gui # launch on macOS/Linux/Windows
ak gui --no-interactive # fail fast in CI rather than block on a windowFlags
| Flag | Description |
|---|---|
-h, --help | help for gui |
--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) |
0 | GUI not packaged for this platform (linux/arm64, windows/arm64) — CLI works normally |
4 | GUI not linked (this binary built without -tags wails); see https://github.com/bestagentkits/agentkit-support/releases |
Related commands
ak— AgentKit CLI