Installation
npm (recommended)
npm install -g @airmy/cli
Homebrew (macOS)
brew install airmy
curl installer
curl -fsSL https://get.airmy.dev | sh
Verify installation
airmy --version
# airmy 2.4.1
Authentication
Login with browser OAuth (recommended):
airmy login
Or use an API key directly:
airmy login --api-key sk-airmy-xxxxxxxxxxxxxxxxxxxx
Credentials are stored in ~/.airmy/config.json. To log out: airmy logout.
Command Reference
Agent Commands
| Command | Description |
|---|
| airmy agents list | List all agents in the workspace |
| airmy agents create --config agent.yaml | Create agent from a YAML config file |
| airmy agents get <id> | Get agent details |
| airmy agents delete <id> | Delete agent (prompts for confirmation) |
Deployment Commands
| Command | Description |
|---|
| airmy deploy <agent-id> | Deploy agent to production |
| airmy deploy --canary 10% <id> | Deploy as canary with 10% traffic |
| airmy rollback <deployment-id> | Rollback to previous version |
| airmy deployments list | List all deployments |
Run Commands
| Command | Description |
|---|
| airmy run <agent-id> --input '{"query":"..."}' | Invoke an agent and print the result |
| airmy runs list | List recent runs (last 20) |
| airmy runs logs <run-id> | Stream run execution logs |
Monitoring Commands
| Command | Description |
|---|
| airmy metrics <agent-id> | Show key metrics for an agent |
| airmy logs tail | Tail live execution logs across all agents |
Webhook Commands
| Command | Description |
|---|
| airmy webhooks list | List all configured webhooks |
| airmy webhooks create --url https://... | Create a new webhook endpoint |
| airmy webhooks test <id> | Send a test event to the webhook |
Global Flags
| Flag | Description |
|---|
| --api-key <key> | Override API key from config |
| --region <region> | Target a specific region (e.g. us-west-2) |
| --format json|table|yaml | Output format (default: table) |
| --quiet | Suppress non-essential output |
| --version | Print CLI version and exit |
Config File
The CLI reads configuration from ~/.airmy/config.json:
{
"api_key": "sk-airmy-xxxxxxxxxxxxxxxxxxxx",
"default_region": "us-west-2",
"format": "table",
"workspace_id": "ws_01HXYZ"
}
Individual flags override config file values. Environment variables override both: AIRMY_API_KEY, AIRMY_REGION.