Installation
npm (recommended)
npm install -g @airmy/cli
Verify installation
airmy --version
# airmy 0.1.0
Authentication
The v0.1 CLI authenticates with an AIRMY API key created in the dashboard.
airmy login --api-key ak_xxxxxxxxxxxxxxxxxxxx
Credentials are stored in ~/.airmy/config.json. To log out: airmy logout.
Command Reference
Agent Commands
| Command | Description |
|---|
| airmy agents | List catalog agents and deployed status |
| airmy deploy <catalog-key> | Deploy a catalog agent into the workspace |
| airmy run <agent-id> <prompt> | Create a synchronous agent run |
| airmy stream <agent-id> <prompt> | Stream a run over Server-Sent Events |
Deployment Commands
| Command | Description |
|---|
| airmy deploy <catalog-key> | Deploy a catalog agent |
| airmy deploy <catalog-key> --name <name> | Deploy with a workspace-specific name |
Run Commands
| Command | Description |
|---|
| airmy run <agent-id> <prompt> | Invoke an agent and print JSON |
| airmy stream <agent-id> <prompt> | Stream response text |
Monitoring Commands
| Command | Description |
|---|
| airmy usage | Show monthly usage and quota |
| airmy readiness | Show API readiness checks |
Webhook Commands
| Command | Description |
|---|
| airmy webhooks list | List configured webhooks |
Global Flags
| Flag | Description |
|---|
| --api-key <key> | Override API key from config |
| --base-url <url> | Override API base URL from config |
Config File
The CLI reads configuration from ~/.airmy/config.json:
{
"apiKey": "ak_xxxxxxxxxxxxxxxxxxxx",
"baseUrl": "https://api.airmy.dev"
}
Individual flags override config file values. Environment variables override both: AIRMY_API_KEY, AIRMY_API_URL.