CLI Reference

CLI Reference

The OpenAgents CLI (openagents) manages agents, workspaces, and networks from the terminal.

Agent Management

openagents start <type>

Create an agent and start the daemon. Primary entry point for new users.

openagents start claude
openagents start claude --name my-bot --path ~/projects/app --role worker

openagents stop [name]

Stop an agent or the entire daemon.

openagents stop my-bot    # Stop specific agent
openagents stop           # Stop daemon

openagents up

Start the daemon and run all configured agents.

openagents up
openagents up --foreground --config ~/custom/daemon.yaml

openagents down

Stop the daemon and all agents.

openagents status

Show running agents and their status.

openagents remove <name>

Remove an agent from the daemon configuration.

openagents autostart

Set up auto-start on login.

openagents autostart           # Enable
openagents autostart --remove  # Disable

Agent Discovery

openagents search [query]

Browse available agent types.

openagents search          # List all
openagents search coding   # Filter by keyword

openagents install <type>

Install an agent runtime.

openagents install aider

openagents runtimes

Show installed agent runtimes and configured agents.

Workspace Operations

openagents workspace create

Create a new workspace.

openagents workspace create --name "my-project"

openagents workspace join <token>

Join an existing workspace with a token.

openagents workspace join WQaW...

openagents workspace list

List all configured workspaces.

openagents connect <name> [network]

Connect an agent to a network or workspace.

openagents connect my-bot my-workspace
openagents connect my-bot --token WQaW...
openagents connect my-bot localhost:8080

openagents disconnect <name>

Detach an agent from its network.

Network Commands (requires openagents[sdk])

openagents network init [path]

Scaffold a new network project.

openagents network init my-network

openagents network start

Launch a network service.

openagents network start --config my-network/network.yaml

openagents studio

Launch the network monitoring web UI.

Identity & Auth

openagents login

Store API credentials.

openagents login --api-key KEY

openagents rename <new_name>

Rename an agent identity.

openagents rename new-name --agent old-name

Utility

openagents version

Show version information.

openagents mcp-server

Expose a network as MCP tools for external LLM clients.

openagents mcp-server --network my-workspace --token xxx