Skip to main content
The ao CLI is the primary interface for managing Agent Orchestrator. It provides commands for initialization, session management, and monitoring agent workflows.

​
Installation

Agent Orchestrator is installed from source: 
git clone https://github.com/ComposioHQ/agent-orchestrator.git
cd agent-orchestrator
bash scripts/setup.sh
The ao CLI will be available in your PATH after installation.

​
Basic Usage

# Initialize a new project
ao init

# Start orchestrator and dashboard
ao start

# Spawn an agent session
ao spawn my-project ISSUE-123

# Check session status
ao status

# Send a message to a session
ao send my-session "fix the type errors"

# Open the dashboard
ao dashboard

​
Command Structure

The ao command follows this pattern: 
ao <command> [arguments] [options]

​
Available Commands

init

Interactive setup wizard for creating configuration

start

Start orchestrator agent and dashboard

stop

Stop orchestrator agent and dashboard

spawn

Create new agent sessions

status

View all sessions with PR and CI status

session

Manage sessions (ls, kill, cleanup, restore)

send

Send messages to running sessions

open

Open sessions in terminal tabs

review-check

Check PRs for review comments

dashboard

Start the web dashboard

​
Global Options

All commands support these options:
​
--help
flag
Display help information for the command
​
--version
flag
Display the version number

​
Configuration

The CLI reads configuration from agent-orchestrator.yaml in your current directory. Create this file using: 
ao init
See Configuration for details on the config format.

​
Environment Variables

​
LINEAR_API_KEY
string
API key for Linear integration (optional)
​
SLACK_WEBHOOK_URL
string
Webhook URL for Slack notifications (optional)

​
Exit Codes

  • 0 - Success
  • 1 - Error (configuration, validation, runtime error)
Most commands require agent-orchestrator.yaml to exist. Run ao init first if you see “No config found” errors.

​
Prerequisites

The default runtime requires tmux to be installed:
# macOS
brew install tmux

# Ubuntu/Debian
sudo apt-get install tmux
For GitHub integration: 
# Install GitHub CLI
brew install gh  # macOS

# Authenticate
gh auth login

​
Next Steps

Initialize Project

Set up your first Agent Orchestrator project

Spawn Sessions

Learn how to create and manage agent sessions

Build docs developers (and LLMs) love

Get started for freeTalk to us