Installation
Install AO, authenticate GitHub and your agent, and run a smoke test.
AO is a single npm package. The install flow is:
- Prereqs
npm install -g @aoagents/ao- Authenticate GitHub + your agent CLI
ao doctorto verify
Prerequisites
On Windows, skip tmux and use runtime: process. See Platforms for the full story.
| Tool | Version | Required? | Why |
|---|---|---|---|
| Node.js | 20+ | required | AO is a Node CLI |
| git | 2.30+ | required | worktrees, commits |
GitHub CLI (gh) | latest | required (GitHub repos) | authenticates as you, used by the github tracker + SCM plugins |
| tmux | 3.2+ | recommended on macOS/Linux | default runtime (skip on Windows) |
| An agent binary | — | required | claude, codex, cursor-agent, aider, or opencode |
Install
npm install -g @aoagents/aopnpm add -g @aoagents/aoyarn global add @aoagents/aogit clone https://github.com/ComposioHQ/agent-orchestrator
cd agent-orchestrator
pnpm install && pnpm build
pnpm link --globalConfirm the binary is on your PATH:
ao --versionAuthenticate
GitHub CLI
AO uses the gh CLI for issues, PRs, reviews, and CI status. Log in once:
gh auth loginPick GitHub.com → HTTPS → Login with a web browser, then verify:
gh auth statusIf you use GitLab instead, authenticate with glab:
glab auth loginYour agent
AO supports five agents today. Install whichever one you want to use by default — you can mix and match per-project later.
Install Claude Code, then run claude once to sign in.
npm install -g @anthropic-ai/claude-code
claudeInstall OpenAI Codex CLI:
npm install -g @openai/codex
codexInstall Cursor Agent CLI:
curl https://cursor.com/install -fsS | bashVerify agent --help prints the Cursor Agent help text.
Install Aider:
pip install aider-install && aider-installInstall OpenCode:
npm install -g opencode-aiFirst config
Run ao start in any git repo. If no agent-orchestrator.yaml exists, AO drops a starter config in your cwd and opens the dashboard.
cd ~/projects/my-repo
ao startYou can also point AO at a repo by path or URL:
ao start ~/projects/my-repo
ao start https://github.com/ComposioHQ/agent-orchestratorThe dashboard opens at http://localhost:3000 (or the next free port).
Verify
ao doctorao doctor runs launcher, environment, plugin-resolution, and notifier checks. Use ao doctor --fix to auto-repair common issues.