> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/ComposioHQ/agent-orchestrator/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Overview

> Command-line interface for managing Agent Orchestrator sessions

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:

```bash theme={null}
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

```bash theme={null}
# 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:

```bash theme={null}
ao <command> [arguments] [options]
```

## Available Commands

<CardGroup cols={2}>
  <Card title="init" icon="gear" href="/cli/init">
    Interactive setup wizard for creating configuration
  </Card>

  <Card title="start" icon="play" href="/cli/start-stop">
    Start orchestrator agent and dashboard
  </Card>

  <Card title="stop" icon="stop" href="/cli/start-stop">
    Stop orchestrator agent and dashboard
  </Card>

  <Card title="spawn" icon="rocket" href="/cli/spawn">
    Create new agent sessions
  </Card>

  <Card title="status" icon="chart-line" href="/cli/status">
    View all sessions with PR and CI status
  </Card>

  <Card title="session" icon="terminal" href="/cli/session">
    Manage sessions (ls, kill, cleanup, restore)
  </Card>

  <Card title="send" icon="paper-plane" href="/cli/send">
    Send messages to running sessions
  </Card>

  <Card title="open" icon="window" href="/cli/open">
    Open sessions in terminal tabs
  </Card>

  <Card title="review-check" icon="check-circle" href="/cli/review-check">
    Check PRs for review comments
  </Card>

  <Card title="dashboard" icon="browser" href="/cli/dashboard">
    Start the web dashboard
  </Card>
</CardGroup>

## Global Options

All commands support these options:

<ParamField path="--help" type="flag">
  Display help information for the command
</ParamField>

<ParamField path="--version" type="flag">
  Display the version number
</ParamField>

## Configuration

The CLI reads configuration from `agent-orchestrator.yaml` in your current directory. Create this file using:

```bash theme={null}
ao init
```

See [Configuration](/configuration/overview) for details on the config format.

## Environment Variables

<ParamField path="LINEAR_API_KEY" type="string">
  API key for Linear integration (optional)
</ParamField>

<ParamField path="SLACK_WEBHOOK_URL" type="string">
  Webhook URL for Slack notifications (optional)
</ParamField>

## Exit Codes

* `0` - Success
* `1` - Error (configuration, validation, runtime error)

<Note>
  Most commands require `agent-orchestrator.yaml` to exist. Run `ao init` first if you see "No config found" errors.
</Note>

## Prerequisites

<Warning>
  The default runtime requires **tmux** to be installed:

  ```bash theme={null}
  # macOS
  brew install tmux

  # Ubuntu/Debian
  sudo apt-get install tmux
  ```
</Warning>

For GitHub integration:

```bash theme={null}
# Install GitHub CLI
brew install gh  # macOS

# Authenticate
gh auth login
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Initialize Project" icon="flag" href="/cli/init">
    Set up your first Agent Orchestrator project
  </Card>

  <Card title="Spawn Sessions" icon="rocket" href="/cli/spawn">
    Learn how to create and manage agent sessions
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.