@autoranq/cli
v0.1.0
Published
Official AutoRanq CLI — drive the SEO content platform from your terminal.
Readme
@autoranq/cli
Official AutoRanq CLI — drive the SEO content platform from your terminal.
Install
npm install -g @autoranq/cli
autoranq --versionQuickstart
# 1. Authenticate (paste your API key from app.autoranq.ai → Settings → API)
autoranq login
# 2. List your projects
autoranq projects list
# 3. List recent articles
autoranq articles list
# 4. Fire a generation (via the API directly for now — generate command coming in v0.2)
# See https://docs.autoranq.ai/quickstart/ for the curl commandCommands
| Command | What it does |
|---|---|
| autoranq login | Authenticate by pasting your API key. Stores it at ~/.autoranq/config.json |
| autoranq config show | Show current config (key prefix only, never the full key) |
| autoranq config set <key> <value> | Set a config value (e.g. project, apiUrl) |
| autoranq config use <test\|live> | Switch between test-mode and live-mode |
| autoranq config clear | Delete stored credentials |
| autoranq projects list | List your projects |
| autoranq articles list [--project <id>] [--status <s>] | List articles with optional filters |
| autoranq articles get <id> | Get article details + content |
| autoranq generations list [--project <id>] [--status <s>] | List generations |
| autoranq generations get <id> | Get generation details + step results |
| autoranq generations retry <id> [--from-step <s>] | Retry a failed generation |
| autoranq keywords search <term> [--project <id>] | Search SERP for a keyword |
Add --json to any command to get raw JSON output for piping into jq or your scripts.
Coming in v2
- Device-auth flow (no key paste) —
autoranq loginbecomes browser-confirm autoranq generations tail <id>— live SSE stream of generation logsautoranq logs tail— global log tailautoranq listen --forward-to <url>— local webhook forwarding (likestripe listen)
Docs
Full docs: https://docs.autoranq.ai/cli/
License
MIT
