Documentation Index
Fetch the complete documentation index at: https://docs.aodeploy.com/llms.txt
Use this file to discover all available pages before exploring further.
Installation
npm install -g @ao-ai/cli
Commands
ao init
Initializes AO in your current project directory. Creates an ao.toml configuration file if one doesn’t already exist.
Example output:
Initialized AO configuration file at: /your/project/ao.toml
ao login
Authenticates your machine with your AO account. Opens a browser window to complete login. Your API key is stored securely in your system’s keychain.
ao logout
Removes your stored API key from the system keychain.
ao deploy
Zips your current project and deploys your agent to AO’s infrastructure.
ao deploy
ao deploy --env preview
| Option | Default | Description |
|---|
--env | production | Target environment: production, preview, development |
ao.toml must exist (run ao init first)requirements.txt must existpyproject.toml must exist
Example output:
Deploying agent to production…
Packing project…
Deployment successful!
You can view your new deployment at: https://aodeploy.com/dashboard/deployments
ao run
Triggers a run of a deployed agent. --input must be a valid JSON object.
ao run --deployment <deployment-id> --input '<json>'
| Option | Required | Description |
|---|
--deployment, -d | Yes | The deployment ID to run |
--input | Yes | A JSON object passed as input to your agent |
ao run --deployment abc123 --input '{"messages": ["summarize last week'\''s sales data"]}'
Global options
| Flag | Description |
|---|
--version | Print the CLI version |
--help | Show help for any command |
