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 projects remove

Deregister a project from the global registry

Remove a project entry from ~/.agentkit/projects.json by name or absolute path. The project directory and its files are NOT touched; only the registry entry is deleted. This command is called automatically by ak uninstall unless --keep-registry is passed.

Who it's for: Both: power devs (--json) and non-technical users.

When to use it: Cleaning up stale registry entries for moved or deleted projects.

What changes on disk: Writes ~/.agentkit/projects.json atomically (removes one entry).

Usage

ak projects remove <name|path> [flags]

Examples

ak projects remove myproj              # remove by name
ak projects remove $HOME/projects/myproj    # remove by absolute path
ak projects remove ./myproj --json     # machine-readable output

Flags

FlagDescription
-h, --helphelp for remove
--jsonEmit machine-readable JSON (implies --no-interactive)
--no-interactiveDisable interactive prompts (CI-safe)
-q, --quietSuppress non-error output on stderr
-V, --verboseExtra diagnostic output on stderr (loses to --quiet)
-y, --yesAssume yes for all prompts

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)
0success, or entry was already absent (idempotent)
2invalid arguments
1registry read/write error
  • ak projects — Manage the global AK project registry

On this page