Skip to content

CLI Cheatsheet

A dense reference of every apx command. One line per command, organized to match apx --help. For deep dives, follow the links at the bottom.

apx
$ apx --help
  apx  Agent Project Context  v1.82.0
Docs: https://agentprojectcontext.com

Usage:  apx <command> [subcommand] [args] [--flags]


Bootstrap

apx init [path]                       --name "<name>"  initialize a new APC project
apx setup                             interactive wizard: provider → model → channels → daemon  (alias: install)
apx status                            full system status: daemon, super-agent, engines, telegram, projects
apx update                            check for updates and upgrade  (alias: upgrade)

# … 22 more groups, from Projects to Pair …

Flags

  --project <name|id|path>              pin commands to a specific project
  --help                                show this help
  --version                             print version
apx --help — trimmed to the first and last of its 24 sections; the real output lists every command in full

CommandWhat it does
apx init [path]Initialize a new APC project (creates AGENTS.md + .apc/)
apx setupInteractive wizard: provider → model → channels → daemon (alias: install)
apx statusFull system status: daemon, super-agent, engines, Telegram, projects
apx updateCheck for updates and upgrade (alias: upgrade)

CommandWhat it does
apx project add [path]Register a project with the daemon
apx project listList registered projects
apx project remove <id>Unregister a project
apx project rebuild [id]Rebuild the project index from the filesystem

CommandWhat it does
apx agent add <slug>Create a project-local agent (--role R --model M --skills a,b --language L --description D)
apx agent set <slug>Edit the system prompt (--prompt -) or any other field
apx agent listList project agents
apx agent get <slug>Print one agent definition
apx agent remove <slug>Delete a project agent (file + runtime memory)
apx agent importImport an agent template from ~/.apx/agents/
apx agent vault listList vault templates (bundled defaults + your overrides)
apx agent vault addCreate a new vault template

CommandWhat it does
apx identity showPrint current APX identity (name, owner, personality)
apx identity set <k> <v>Set an identity field
apx identity wizardInteractive identity setup

CommandWhat it does
apx config showPrint project config (--effective for merged view, --only-overrides for deltas)
apx config show --globalPrint ~/.apx/config.json, secrets redacted
apx config set <key.path> <value>Set a JSON-aware value in the project’s config
apx config set --global <key.path> <value>Set a value in ~/.apx/config.json — credentials, voice, daemon
apx config unset [--global] <key.path>Remove a key from the project or global config
apx model statusProvider health + active model (fallback router)
apx model order <p1> <p2> …Set fallback order — e.g. ollama openrouter groq
apx model key <provider> <api-key>Save an API key to ~/.apx/config.json
apx model set <provider> <model-id>Pin a specific model id for one provider
apx model testResolve which model the router picks right now
apx model enableEnable the fallback router
apx model disableDisable the fallback router (primary only)
apx permission showShow the APX tool permission mode
apx permission set <mode>Set mode: total | automatico | permiso

CommandWhat it does
apx memory <slug>Print an agent’s memory.md
apx memory <slug> --append "<note>"Append a note under ## Recent context
apx memory <slug> --replaceReplace memory from stdin
apx memory notebookShow the super-agent’s own notebook (~/.apx/memory.md) and its size
apx memory consolidate [--apply]Propose durable facts from stdin candidates (writes only with --apply)
apx memory prune [--apply]Collapse replicated notebook entries, keeping the newest (dry-run by default)
apx memory revert [--since D]Remove entries written by consolidation

CommandWhat it does
apx session new <slug>Create a session file (--title T --task-ref REF --body -|"text")
apx session list [slug]List sessions (--last N)
apx session get <id>Print session metadata or body (--body)
apx session update <id>Update session frontmatter (--status S --result R --title T)
apx session close <id>Mark a session complete (--result "text")
apx session checkExit non-zero if an active session already exists
apx session close-staleAuto-close sessions older than 1 h
apx session resume <id>Show APC session + optional transcript (--summary --full)
apx session compact <slug>Collapse conversation history into a summary
apx session find <text>Find sessions by title cross-engine (--deep --engine X)
apx session summary <id>LLM summary of any session by id
apx session ask <id> "<q>"Ask a question about a session (--max-chunks N)
apx sessions listList AI engine sessions (--engine claude|codex|apx --project P)

CommandWhat it does
apx mcp listList MCP servers for the project
apx mcp add <name>Add a project-owned MCP server (--command <cmd> --env KEY=VAL)
apx mcp remove <name>Remove a project-owned MCP server
apx mcp enable <name>Enable a project-owned MCP server
apx mcp disable <name>Disable a project-owned MCP server
apx mcp run <name> <tool>Call one MCP tool ([<json-args>])
apx mcp tools <name> [<tool>]List a server’s tools; with <tool>, show schema + run example (--json for raw schemas)
apx mcp logs <name>Spawn/init event log + stderr tail
apx mcp checkAudit multi-source merge and conflicts

CommandWhat it does
apx obsidian set <vault-path>Connect a vault, validating the path (--global --mcp --memory)
apx obsidian statusShow the configured vault, note count and toggles for the scope
apx obsidian syncMirror APX memory into the vault, without duplicates
apx obsidian removeDisconnect the vault (and any auto-registered MCP)

Scope works like the rest of APX: the command targets the current project unless --global (or --scope global) puts the vault in the space every project shares. --mcp registers an obsidian MCP server pointing at it; --memory turns on memory sync, which then runs on apx obsidian sync.


CommandWhat it does
apx daemon startStart the daemon
apx daemon stopStop the daemon
apx daemon restartStop then start — picks up code, prompt, and tool changes
apx daemon reloadRe-read ~/.apx/config.json only (no restart, no code reload)
apx daemon statusShow daemon health
apx daemon logsPrint daemon log tail (--tail N)
apx logUnified log for all modules (-f follow, --tail N, --errors only)
apx usageModel calls for a UTC day by model, channel and agent (--date, --since H, --json)
apx usage breaker / resumeThe spend breaker’s last hour and pause; lift a pause now

CommandWhat it does
apx telegram send "text"Send a message (--chat <id>)
apx telegram statusShow Telegram plugin status
apx telegram startStart polling on every configured channel
apx telegram stopStop polling (config stays intact)
apx telegram setupPrint setup guidance
apx telegram channel <sub>Manage channels: add | list | show | set | unset | remove
apx telegram contactsList the known-people roster
apx telegram role <user_id> <role>Assign a role to a contact
apx telegram roles <sub>Define role→tools: list | set <name> --tools a,b | rm <name>
apx telegram owner <channel> <user_id>Set who owns a channel

CommandWhat it does
apx messages tailPrint recent messages (--agent <slug> --channel <ch> -n 50 --global)
apx messages chatChat transcript with actor types (--channel telegram -n 50)
apx messages search "q"Search message logs

CommandWhat it does
apx codeAPX terminal coding assistant (TUI)
apx exec "prompt"One-shot LLM call to the super-agent (--model <id> -a <agent>)
apx chat <agent>Interactive agent REPL (--conversation <id>)
apx search "query"Web search via DDG / Brave / browser (--mode <m> -n N)
apx conversations listList stored exec/chat conversations
apx conversations get <agent> <id>Print a stored conversation
apx acpServe the super-agent over the Agent Client Protocol (stdio, for IDEs)

CommandWhat it does
apx run <agent>Launch a full external runtime session (--runtime <id> "prompt" --timeout <s>)
apx env detectShow which runtime CLIs are installed

Available runtimes: claude-code · codex · opencode · aider · cursor-agent · gemini-cli · qwen-code


CommandWhat it does
apx send <from> <to> "msg"Log an A2A message (--deliver runs a project agent, runtime, or the configured super-agent identity)
apx connections <agent>Mental map: who, how, and when this agent communicated

CommandWhat it does
apx routine listList routines with next and last run
apx routine add <name>Create a routine
apx routine get <name>Print routine definition
apx routine history <name>Show execution history
apx routine run <name>Trigger manually (ignores schedule)
apx routine enable <name>Enable a routine
apx routine disable <name>Disable a routine
apx routine remove <name>Remove a routine

CommandWhat it does
apx task add "<title>"Create a task (--tag t --due 2026-06-01 --agent A --body "...")
apx task listList tasks (--state open|done|dropped|all --tag X --agent Y --limit N)
apx task show <id>Print one task as JSON
apx task done <id>Mark task done (--by <name>)
apx task drop <id>Drop / archive a task
apx task reopen <id>Reopen a done or dropped task
apx task patch <id>Edit fields (--title T --body B --due D --agent A --tag t)

What you promised a named person, by when. Separate from tasks: a task is work, a commitment is someone waiting.

CommandWhat it does
apx commitment add "<what>" --to "<person>"Record a promise (--due ISO --project X --channel C)
apx commitment listList promises (--all --to X --state open|kept|missed|dropped|all --overdue)
apx commitment show <id>Print one promise, with every date it has had
apx commitment kept <id>Delivered (--note "...")
apx commitment missed <id>The date passed and it did not happen (--note "...")
apx commitment renegotiate <id> --due <ISO>A new date, agreed with them — reopens it and keeps the old date
apx commitment drop <id>Filed by mistake — off the lists, and NOT counted as broken

CommandWhat it does
apx artifact create <name>Create a managed file in project storage (--content '...' --project 0)
apx artifact listList artifacts
apx artifact show <name>Print artifact content
apx artifact preview <name>Serve HTML/React on a local URL with live reload (--open --share)
apx artifact share <name>Preview plus a public tunnel URL
apx artifact previewsList running previews (stop one with apx artifact stop <id>)
apx artifact remove <name>Delete an artifact

CommandWhat it does
apx command listList workflow commands in .apc/commands/
apx command show <name>Print command content
apx skills add [targets]Install skills into IDE rule files (claude-code cursor windsurf copilot trae)
apx skills add --globalInstall to ~/.claude/skills/ etc.
apx skills listList skills in this project’s .apc/skills/
apx skills statusShow which IDE targets have bundled skills installed
apx skills syncForce-refresh all bundled skills to every global skill dir

CommandWhat it does
apx plugins listShow loaded plugins and their status
apx plugins status <id>Detailed status of one plugin (e.g. telegram)

CommandWhat it does
apx image "<prompt>"Generate an image (--out <file> --size 768x512 --steps N --cfg N --seed N)
apx image "<prompt>" --provider <id>Force an engine: a1111 | sdcpp | openai | mock | custom:<slug>
apx image providersWhich image engines are configured, reachable and in what order
apx image capabilitiesModels, samplers and schedulers a server offers (--provider <id>)

CommandWhat it does
apx voice say "text"TTS via daemon (--provider <id> --voice <name> --no-play)
apx voice listenMic → /api/voice/turn → reply (--seconds N --no-play)
apx voice providersList configured TTS / STT providers
apx transcribe <file…|dir>STT of audio/video through the warm daemon whisper; bulk-capable (--lang es --provider <id> --json)
apx desktop startLaunch the floating Electron voice window (--debug)
apx desktop stopStop the desktop window
apx desktop statusShow process state, PID, and autostart status
apx desktop installActivate autostart at user login (no sudo needed)
apx desktop uninstallDeactivate autostart

CommandWhat it does
apx pair [label]QR pairing for the Deck app / companion clients
apx pair webQR + link to pair a browser on the LAN
apx pair listList paired clients
apx pair revoke <id>Revoke a paired client token

FlagEffect
--project <name|id|path>Pin a command to a specific project
--helpShow help for any command
--versionPrint version