Canary CLI

Run tests, query issues, and manage AI agent skill templates from the command line.

Install

npm install -g @canaryai/cli
# or
bun add -g @canaryai/cli

Login

Authenticate with your Canary account before using the CLI:

canary login

Options:

• --org <name> - Select organization by name or ID (for multi-org users)
• --app-url <url> - Custom app URL (e.g. http://localhost:5173 for local dev)
• --api-url <url> - Custom API URL (e.g. http://localhost:3000 for local dev)
• --no-open - Don't auto-open browser

To switch environments, set CANARY_API_URL:

export CANARY_API_URL=http://localhost:3000
canary login --app-url http://localhost:5173

Run Tests

Local Playwright tests

canary test
canary test --grep "login" --headed --workers 1

All standard Playwright options are passed through.

Remote workflow tests

canary test --remote
canary test --remote --tag smoke
canary test --remote --property "My App" --environment staging

Options:

• --token <key> - API key (or set CANARY_API_TOKEN)
• --api-url <url> - API URL (default: https://api.trycanary.ai)
• --property <name|id> - Target a specific property
• --environment <name|id> - Target a specific environment
• --tag <tag> - Filter workflows by tag
• --name-pattern <pat> - Filter workflows by name pattern
• --verbose, -v - Show all events

Issues

Search and inspect QA issues detected by Canary.

List issues

canary issues list
canary issues list --severity high --status open
canary issues list --search "timeout" --format markdown

Options:

• --search <query> - Full-text search
• --severity <level> - Filter: low, medium, high, unknown
• --status <statuses> - Filter: open, closed, not_a_bug (comma-separated)
• --property-id <uuid> - Filter by property
• --page <n> - Page number (default: 1)
• --page-size <n> - Page size (default: 25)
• --json - Output raw JSON
• --format markdown - Output as markdown

Get issue details

canary issues get <issue-id>
canary issues get <issue-id> --format markdown

AI Agent Skill Templates

Output reusable skill templates that teach AI agents (Claude Code, Cursor, etc.) how to use the Canary CLI:

canary skill help                    # list available templates
canary skill issue-log-xref          # output a template to stdout
canary skill issue-log-xref > .claude/skills/issue-log-xref.md  # install it

Release QA (CI/CD)

Trigger and monitor Release QA runs from CI pipelines:

canary release trigger --property-id <uuid>
canary release status <run-id>
canary release run --property-id <uuid> --timeout 600

Environment Variables

| Variable | Default | Description | |----------|---------|-------------| | CANARY_API_URL | https://api.trycanary.ai | API endpoint | | CANARY_APP_URL | https://app.trycanary.ai | App URL for login | | CANARY_API_TOKEN | — | API key (alternative to canary login) | | CANARY_LOCAL_PORT | — | Default port for canary run / canary tunnel |