CLI Reference

Installation

npm install -g @ao-ai/cli

Initializes AO in your current project directory. Creates an ao.toml configuration file if one doesn’t already exist.

ao init

Example output:

Initialized AO configuration file at: /your/project/ao.toml

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 login

Removes your stored API key from the system keychain.

ao logout

Zips your current project, builds a Docker image, and deploys your agent to AO’s infrastructure.

ao deploy

Requirements before deploying:

Example output:

Deploying agent...
Packing project...
Deployment successful!
View your deployment at: https://aodeploy.com/dashboard/deployments

Triggers a run of a deployed agent.

ao run --deployment <deployment-id> --input '{"messages": ["your input here"]}'

Options:

Option	Required	Description
`--deployment`, `-d`	Yes	The deployment ID to run
`--input`	Yes	Input string passed to your agent

Example:

ao run --deployment abc123 --input "summarize last week's sales data"

Manage environment variables for your deployments.

ao env set KEY VALUE
ao env list
ao env delete KEY

Subcommand	Description
`set <KEY> <VALUE>`	Set an environment variable
`list`	List all environment variables
`delete <KEY>`	Delete an environment variable

Flag	Description
`--version`	Print the CLI version
`--help`	Show help for any command