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

AgentKit CLI

ak is the AgentKit command-line interface — a multi-agent toolkit for both power developers who script against the CLI and non-technical users working through the TUI or desktop GUI. It covers the full project lifecycle, with expert kit and skill commands available when you need finer control.

When to use it: Reach for ak as your daily driver for AgentKit work — onboarding a project with ak init, previewing refreshes with ak update, checking your setup with ak doctor, and running agent operations. Start with the top-level lifecycle commands and drop into the ak kit and ak skill families when a task needs more precise control.

The root command is read-only; each subcommand documents its own disk effects. Scripted --json output is wrapped in a versioned success envelope (schema_version, kind, data).

Examples

ak init                                      # onboard the current project
ak update                                    # preview project refreshes; add --yes to apply
ak doctor                                    # check setup and get the next command
ak uninstall                                 # preview removal of AK-owned project files
ak gui                                       # open the desktop UI
ak kit list-kits                             # advanced: inspect available kits

Flags

FlagDescription
-h, --helphelp for ak

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)
  • ak activity — Inspect the local AgentKit activity feed
  • ak agents — Per-agent management commands
  • ak api — Run a local API + proxy server for AgentKit
  • ak audit — Check installed kits for drift
  • ak backups — Manage rollback snapshots
  • ak changelog — Show verified CLI, app, and kit release changelogs
  • ak codex-agent-runtime — Codex agent MCP dispatch runtime.
  • ak commands — Per-slash-command management commands
  • ak config — Open the local AgentKit dashboard
  • ak content — Publish content to channels
  • ak diagnostics — Export redacted support diagnostics
  • ak doctor — Run health checks on the AgentKit installation
  • ak feedback — Send or export product feedback
  • ak gui — Launch the AgentKit desktop GUI
  • ak init — Initialize an AgentKit project
  • ak kit — Kit management commands
  • ak licenses — Show licensed AgentKit kits
  • ak login — Log in to AgentKit
  • ak logout — Clear local AgentKit credentials
  • ak mcp — Inspect local MCP server configuration
  • ak migrate — Migrate an existing ClaudeKit install to AgentKit
  • ak new — Bootstrap a new AgentKit project
  • ak plan — Manage AgentKit plan directories
  • ak projects — Manage the global AK project registry
  • ak recover — Recover AgentKit state from a snapshot
  • ak run — Run a skill via the configured agent adapter
  • ak self-update — Check or apply signed AgentKit binary updates
  • ak sessions — Inspect and maintain local coding-agent sessions
  • ak setup — Guided first-run configuration wizard for AgentKit
  • ak skill — Manage per-skill runtime envs
  • ak skills — Browse and install kit skills
  • ak uninstall — Remove an AK-managed project
  • ak update — Preview or apply AgentKit-owned project refreshes
  • ak versions — List local versions for ak, kits, and skills
  • ak watch — Watch a GitHub repository and auto-respond to issues
  • ak whoami — Show current AgentKit login and licensed kits

Docs / feedback: https://github.com/bestagentkits/agentkit-support

On this page