CLI

The autoranq CLI is the terminal-native version of the platform. Login once, then every other command just works — no key juggling, no copy-paste, no Postman.

MVP shipped — v0.1.0

Login and read commands work today. Live log streaming (tail), webhook forwarding (listen), and OAuth browser-confirm login are landing in v0.2. Until then, --with-key covers CI use cases.

Install

npm

npm install -g @autoranq/cli
autoranq --version

Homebrew (v0.2)

# Tap coming with v0.2
brew install autoranq/tap/autoranq

Curl install (v0.2)

# Same pattern as Stripe / gh — shipping with v0.2
curl -fsSL https://docs.autoranq.ai/install.sh | sh

The CLI needs Node 20+ on your machine.

Login

$ autoranq login
Paste your AutoRanq API key (starts with ar_live_ or ar_test_): ar_test_...
Validating key against API…
✓ Authenticated (test mode)
  Token saved to ~/.autoranq/config.json

For CI environments without a TTY:

$ autoranq login --with-key ar_live_your_key
✓ Authenticated (live mode)

Browser-confirm login — coming in v0.2

The next release adds OAuth 2.0 Device Authorization Grant — same UX as stripe login and gh auth login. No key paste, just confirm in the browser.

Commands

autoranq config

autoranq config show          # show current config (key is masked)
autoranq config set apiUrl https://api.autoranq.ai/api/public/v1
autoranq config set defaultProject clxprj123def456ghi789
autoranq config use test      # switch between live and test mode
autoranq config clear         # delete stored credentials

autoranq projects

autoranq projects list
autoranq projects list --json | jq '.[] | .id'

autoranq articles

autoranq articles list
autoranq articles list --project clxprj... --status PUBLISHED --limit 20
autoranq articles get clxart123def456ghi789
autoranq articles get clxart123def456ghi789 --json | jq '.content_html'

autoranq generations

autoranq generations list --status FAILED
autoranq generations get clxgen123def456ghi789
autoranq generations retry clxgen123def456ghi789 --from-step CONTENT

Live tail — coming in v0.2

autoranq generations tail <id> will stream generation logs over SSE in real-time. For now, poll autoranq generations get <id> every few seconds — or set up a webhook to be notified when status flips to COMPLETED.

autoranq keywords

autoranq keywords search "best CRM for startups" --location nl-NL
autoranq keywords search "best CRM for startups" --project clxprj... --json

Global flags

Flag	Effect
--json	Output raw JSON instead of a formatted table. Pipe into jq.
--help	Show help for the current command. Works at every level (autoranq articles get --help).
--version	Print the CLI version.

Roadmap (v0.2 — Phase 3.5)

1. OAuth device-flow login — autoranq login opens browser, you confirm, no key paste needed.

2. autoranq generations tail <id> — SSE-streamed live logs for any generation. Backend SSE endpoint lands here.

3. autoranq logs tail — global tail across all projects, with --level ERROR --since 1h filters.

4. autoranq listen --forward-to <url> — local webhook forwarding (the stripe listen pattern). Hits a test webhook subscription endpoint and replays deliveries to your local URL with the correct HMAC signature.

5. Homebrew tap + curl installer — brew install autoranq/tap/autoranq and curl -fsSL https://docs.autoranq.ai/install.sh | sh.

Troubleshooting

”Not authenticated. Run autoranq login.”

Your config doesn’t have a stored key. Run autoranq login and paste the key from app.autoranq.ai → Settings → API.

”API key was rejected (401 Unauthorized).”

The key was revoked or rotated. Run autoranq login again with the new value.

”Insufficient scope (403 Forbidden).”

Your key has only read scope but you tried a write action (e.g. generations retry). Create a read,write key in the dashboard.

”Rate limit exceeded (429).”

Default limit is 1000 requests/hour per key. Wait or request a higher rate-limit. See Authentication → Rate limits.

Next steps

• Quickstart — same workflow via raw cURL if you skip the CLI
• MCP — conversational alternative via your AI assistant
• Webhooks — what autoranq listen will forward in v0.2
• Authentication — manage API keys, scopes, rotation