Skip to content

CLI

The apx binary is the main entry point for everything APX does. It talks to the local daemon over HTTP (127.0.0.1:7430) and auto-starts it on first use, so you never need to boot the daemon separately.

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

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

Bootstrap     init · setup · status · update
Projects      project add|list|remove|rebuild
Agents        agent add|list|get|remove · agent vault …
APX Profile   identity show|set|wizard
Config        config show|set · model · permission
Sessions      session new|list|resume|find · sessions list
MCPs          mcp list|add|remove|enable|run|tools|logs|check
Daemon        daemon start|stop|reload|status · log
Telegram      telegram send|status · messages tail|chat|search
LLM / Code    exec · chat · code · search
Runtimes      run --runtime … · env detect
Routines      routine add|list|run · task add|list|done
Voice         voice say|listen|providers · desktop · pair

Run 'apx <command> --help' for details.
apx --help — all command groups at a glance
FlagDescription
--project <name|id|path>Pin every command to a specific project. Useful when working across multiple registered projects from one shell.
--helpPrint help for the current command or subcommand.
--versionPrint installed APX version.
apx
$ apx status
  Daemon
  ✓ running   port 7430   v1.38.0   uptime 2h 14m

Super-agent
  ✓ enabled
    model           anthropic:claude-sonnet-4-5
    identity        Roby  for Alex

Engines
  ✓ Anthropic     ← active
  ✓ OpenAI
  ✓ Gemini
  ✓ Ollama        http://localhost:11434

Telegram
  ✓ polling   1/1 channel
    default         ● chat 123456789

Projects
  #1  First Project    5 agents   ~/code/first-project
  #2  Acme Store        4 agents   ~/code/acme-store
  #3  Data Pipeline     3 agents   ~/code/data-pipeline
apx status — daemon health, engines, Telegram, and active projects

CommandDescription
apx init [path] [--name "<name>"]Initialize APC project files (.apc/, AGENTS.md) in the current directory or a target path.
apx setupInteractive wizard: provider → model → channels → daemon. Alias: apx install.
apx statusFull system status: daemon, super-agent, engines, Telegram, registered projects.
apx updateCheck for a published APX update and upgrade the global install. Alias: apx upgrade.

CommandDescription
apx project add [path]Register a directory with the daemon so it tracks its agents, sessions, and messages.
apx project listList all daemon-registered projects.
apx project remove <id>Remove a project entry from daemon storage (does not delete files).
apx project rebuild [id]Rebuild the daemon index from the project’s filesystem context.
apx project config show <project>Print effective + project-only config.
apx project config set <project> <key> <value>Set a dotted key in .apc/config.json.
apx project config unset <project> <key>Remove a dotted key from .apc/config.json.
apx project config edit <project>Open project config in $EDITOR for a full replace on save.

See Projects for the full .apc/ layout.


CommandDescription
apx agent add <slug>Create a project-local agent. Flags: --role R, --model M, --skills a,b, --language es-AR, --description D.
apx agent listList agents in the current project.
apx agent get <slug>Print one agent definition.
apx agent import <slug>Import an agent template from the vault into the current project.
apx agent vault listList global vault templates (bundled defaults + user overrides).
apx agent vault add <slug>Create or promote an agent to the vault under ~/.apx/agents/.
apx agent vault rm <slug>Tombstone a vault template (bundled defaults are hidden, not erased).
apx agent vault restore <slug>Lift a tombstone so a previously-removed bundled default reappears.

See Agents.


CommandDescription
apx identity showPrint current APX identity (name, owner, personality) from ~/.apx/identity.json.
apx identity set <key> <value>Set one identity field, e.g. apx identity set agent_name Ada.
apx identity wizardInteractive identity setup.

CommandDescription
apx config show [--effective] [--only-overrides]Print .apc/config.json (or the merged effective config).
apx config set <key.path> <value>JSON-aware set, e.g. apx config set engines.openai.model gpt-5.2.
apx config unset <key.path>Remove a key from .apc/config.json.
apx model statusProvider health check + active model from the fallback router.
apx model order <p1> <p2> …Set the fallback attempt order, e.g. ollama openrouter groq.
apx model key <provider> <api-key>Store an API key for groq or openrouter in ~/.apx/config.json.
apx model testResolve which model the router picks right now.
apx permission showShow the current APX tool permission mode.
apx permission set <mode>Set permission mode: total, automatico, or permiso.

See Configuration.


CommandDescription
apx memory <slug>Print an agent’s memory.md file.
apx memory <slug> --append "<note>"Append a durable note under ## Recent context.
apx memory <slug> --replaceReplace the entire memory from stdin.

APX sessions are local Markdown files under ~/.apx/projects/<id>/agents/<slug>/sessions/.

CommandDescription
apx session new <slug> --title "T"Create a session file. Optional: --task-ref REF, --body -|"text".
apx session list [slug] [--last N]List sessions, optionally scoped to one agent.
apx session get <id> [--body]Print session metadata or the full body.
apx session update <id>Update frontmatter: --status S, --result R, --title T.
apx session close <id> [--result "text"]Mark a session complete.
apx session checkExit 1 if an active session exists (collision guard for scripts).
apx session close-staleAuto-close sessions older than 1 hour.
apx session resume <id>Show a session and optionally continue it: --summary, --full, --continue, --into apx[:slug].
apx session compact <slug>Collapse conversation history into a durable summary.
apx session find "<text>"Find sessions by title across all engines. --deep also searches content.
apx session summary <id>LLM summary of any session by id (resolves engine automatically).
apx session ask <id> "<q>"Ask a free-form question about a session transcript. --max-chunks N.
apx sessions listCross-engine session list. --engine claude|codex|apx, --project P, --dir D.

See Sessions.


CommandDescription
apx mcp listList MCP servers available to the current project.
apx mcp add <name> --command <cmd>Add a project-owned MCP server. --scope shared|runtime|global, --env KEY=VAL.
apx mcp remove <name>Remove a project-owned MCP server.
apx mcp enable <name>Enable a disabled MCP server.
apx mcp disable <name>Disable an MCP server without removing it.
apx mcp run <name> <tool> ['<json-args>']Call an MCP tool through the daemon.
apx mcp tools <name> [<tool>] [--json]List a server’s tools; with <tool>, show its param schema plus a ready-to-run example.
apx mcp logs <name>Show a server’s spawn/init event log and stderr tail.
apx mcp checkAudit multi-source merge order and conflicts.

See MCPs.


CommandDescription
apx daemon startStart the local daemon.
apx daemon reloadRe-read ~/.apx/config.json without restarting (does not pick up code changes).
apx daemon stopStop the daemon.
apx daemon statusShow daemon health.
apx daemon logs [--tail N]Print the daemon stdout log tail.
apx log [-f] [--tail N] [--errors]Unified log for all modules (recommended over daemon logs).

See Daemon.


CommandDescription
apx telegram send "text" [--chat <id>]Send a message through the configured bridge.
apx telegram statusShow Telegram plugin status.
apx telegram setupPrint setup guidance.
apx telegram startStart polling on every configured channel.
apx telegram stopStop polling (config stays intact).
apx telegram channel addInteractive wizard (or one-shot non-interactive) to add a channel.
apx telegram channel listList configured channels.
apx telegram channel show <name>Print one channel as JSON.
apx telegram channel set <name>Patch channel fields: --project, --agent, --respond-engine, --bot-token, --chat-id.
apx telegram channel unset <name>Clear optional channel fields.
apx telegram channel remove <name>Delete a channel.
apx telegram contactsList the known-people roster with roles and last-seen.
apx telegram role <user_id> <role>Assign a role to a contact by Telegram user_id.
apx telegram rolesList or manage role→tools capability maps.
apx telegram owner <channel> <user_id>Set who owns a channel.

See Telegram.


CommandDescription
apx messages tailPrint recent messages. --agent <slug>, --channel <ch>, -n 50, --global.
apx messages chat [--channel telegram]Readable chat view with user/agent/system type.
apx messages search "q"Search message logs.

CommandDescription
apx codeLaunch the APX terminal coding assistant (TUI). --project, --agent <slug>.
apx exec "prompt"One-shot LLM call to the super-agent. -a <agent> for an APC slug, --model <id>.
apx chat <agent>Interactive agent REPL. --conversation <id> to continue an existing thread.
apx search "query"Web search (DuckDuckGo / Brave / browser). --mode <m>, -n N.
apx conversations list <agent>List stored exec/chat conversations for an agent.
apx conversations get <agent> <id>Print one conversation.

See TUI.


CommandDescription
apx run <agent> --runtime <id> "prompt"Launch a full external runtime session. --timeout <s>.
apx env detectShow which runtime CLIs are installed on this machine.

Supported runtimes: claude-code, codex, opencode, aider, cursor-agent, gemini-cli, qwen-code.

See Runtimes.


CommandDescription
apx send <from> <to> "msg"Log an A2A message. --deliver also runs the target engine.
apx connections <agent>Print a communication map: who/how/when this agent talked.

CommandDescription
apx routine listList routines with next/last run times.
apx routine add <name>Create a routine. --kind K, --schedule S, --spec '{...}'.
apx routine get <name>Print the routine definition.
apx routine history <name>Show execution history.
apx routine run <name>Trigger manually (ignores schedule).
apx routine enable <name>Enable a disabled routine.
apx routine disable <name>Disable a routine without removing it.
apx routine remove <name>Delete a routine.

Kinds: heartbeat, exec_agent, super_agent, telegram, shell.

Schedules: every:60s, every:5m, every:1h, once:<iso-8601>.

See Routines.


CommandDescription
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 a 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>Update fields: --title T, --body B, --due D, --agent A, --tag t.

See Tasks.


CommandDescription
apx artifact create <name>Create a managed file in project storage. --content '...'.
apx artifact listList artifacts.
apx artifact show <name>Print artifact content.
apx artifact remove <name>Delete an artifact.

CommandDescription
apx command listList workflow commands from .apc/commands/.
apx command show <name>Print a command’s content.
apx skills add [targets]Install bundled skills into IDE rule files. Targets: claude-code, cursor, windsurf, copilot, trae.
apx skills add --globalInstall skills to ~/.claude/skills/ and equivalent global dirs.
apx skills listList available bundled skills.
apx skills statusShow which IDE targets currently have APX skills installed.

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

CommandDescription
apx voice say "text"TTS via the daemon. --provider <id>, --voice <name>, --no-play.
apx voice listen [--seconds N]Capture mic → send to /voice/turn → play reply. --no-play.
apx voice providersList configured TTS / STT providers.
apx desktop startLaunch the floating voice desktop window (Electron).
apx desktop stopStop the desktop window.
apx desktop statusShow desktop process and autostart state.
apx desktop installRegister the desktop window for auto-launch at login.
apx desktop uninstallRemove the auto-launch entry.

CommandDescription
apx pair [label]QR pairing for the Deck app or other companion clients.
apx pair webQR + link to pair a browser on the local network.
apx pair listList currently paired clients.
apx pair revoke <id>Revoke a paired client’s token.