Command-line interface for ReviewWeb.site API. Create website reviews, scrape content, extract data, get SEO insights, and more.
npm install -g reviewweb-cli# Set your API key (get one at https://reviewweb.site/profile)
rws config set api-key YOUR_API_KEY
# Check API health
rws health
# Create a website review
rws review create --url https://example.com
# Convert a URL to markdown
rws convert markdown --url https://example.com
# Get SEO keyword ideas
rws seo keyword-ideas --keyword "digital marketing"The CLI resolves your API key in this order:
--api-keyflag (highest priority)RWEB_API_KEYenvironment variable- Config file (set via
rws config set api-key)
# Option 1: Flag
rws review list --api-key YOUR_API_KEY
# Option 2: Environment variable
export RWEB_API_KEY=YOUR_API_KEY
rws review list
# Option 3: Config file (recommended)
rws config set api-key YOUR_API_KEY
rws review listrws review create --url <url> [--instructions <text>]
rws review get <id>
rws review list [--page 1] [--limit 10]
rws review update <id> [--url <url>] [--instructions <text>]
rws review delete <id>rws convert markdown --url <url> [--model <model>]
rws convert markdown-batch --urls <url1,url2,url3>rws extract data --url <url> --instructions <text> --template <json>rws scrape url --url <url>
rws scrape extract --url <url> [--type all|web|image|file]rws summarize url --url <url> [--model <model>]
rws summarize website --url <url> [--max-links 10]rws seo backlinks --domain <domain>
rws seo keyword-ideas --keyword <keyword> [--country us]
rws seo keyword-difficulty --keyword <keyword>
rws seo traffic --domain <domain> [--mode subdomains]rws screenshot --url <url>
rws url-check --url <url>
rws profile
rws healthrws api-key create --name <name>
rws api-key list
rws api-key delete <id>rws config set api-key <key>
rws config set base-url <url>
rws config set default-format <json|table|raw>
rws config get <key>
rws config list
rws config pathAll commands support --format flag:
# JSON (default, great for piping)
rws review list --format json | jq '.reviews[0]'
# Table (human-readable)
rws review list --format table
# Raw (minimal processing)
rws convert markdown --url example.com --format raw > page.md# Bash
rws completion bash > /etc/bash_completion.d/rws
# Zsh
rws completion zsh > ~/.zsh/completions/_rws
# Fish
rws completion fish > ~/.config/fish/completions/rws.fish| Variable | Description |
|---|---|
RWEB_API_KEY |
API key for authentication |
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Authentication error |
Full API documentation: https://reviewweb.site/api-docs/
MIT