Skip to content

CLI · Terminal Reference ​

Agentao ships with a terminal-first interface — agentao in your shell, with slash commands, plan mode, sub-agents, memory, and replay all built in. This section documents that interface.

Install in 60 seconds ​

bash
# Clone or install
uv sync                  # installs the project
cp .env.example .env     # paste your OPENAI_API_KEY

# Start the agent
uv run agentao
# or:  ./run.sh

You drop into a chat REPL. Type a normal sentence to talk to the agent. Type / followed by a command to control the session itself.

Coverage ​

How to read ​

Your situationRecommended path
First time using agentao1. Getting Started → 3. Permissions & Modes
Coming from another agent CLI (Claude Code, codex, gemini, etc.)4. Plan Mode → 5. Skills & Crystallize
I want to plug in my company's tools8. MCP / ACP / Plugins → Part 5.3 MCP
The agent ate my budget / context blew up7. Context & Status → 6. Memory
I want to resume a session / inspect background agents11. Sessions, Agents & Tasks
I'm shipping the CLI to my team3. Permissions & Modes → 10. Configuration Reference
I want the agent to keep working on one task for many turns13. Long-Task Goals → 4. Plan Mode
I want to call Agentao from scripts, CI, or an IDE12. Non-Interactive Entry Points → Part 3 · ACP Protocol
I want to embed this engine into my own appPart 1 · Getting Started (different audience — start there)

Mental model ​

The CLI is a thin REPL on top of the Agentao harness. Slash commands manipulate the session (history, model, mode, plan, memory). Plain messages are sent to the agent (tools, skills, MCP, ACP). Everything you see in the terminal — confirmation prompts, streaming events, tool results, memory recall — is exactly what an embedding host receives through the event stream.

If you understand the CLI, you already understand most of what an embedder builds against.

→ Start with 1. Getting Started →


Where this fits

The CLI is one consumer of the Agentao harness. The same harness can be embedded into your own application — see Part 2 · Python In-Process Embed or Part 3 · ACP Protocol. What you learn here about permissions, skills, MCP, memory and replay applies identically when you embed.

Authoritative help

The single source of truth for command syntax is /help inside the CLI, backed by agentao/cli/help_text.py. The pages here explain the why and how to use; if anything ever disagrees, trust /help.