crawlready CLI

Optimize your site for AI crawlers from the command line.

Install

npm install -g crawlready
# or use without installing:
npx crawlready <command>

Commands

crawlready scan <url>         # Scan URL and get AI Readiness Score
crawlready diff <url>         # Show what AI bots are missing on your page
crawlready recommend <url>    # Get actionable improvement recommendations
crawlready score <domain>     # Get latest score for a domain (no auth)

Authentication

Set your API key (get one at https://www.crawlready.app/dashboard):

export CRAWLREADY_API_KEY=your_key_here
# or pass inline:
crawlready scan https://example.com --key your_key_here

The key can also be stored in ~/.crawlreadyrc (one key per line, first line used).

Options

All commands that call the API accept:

• --json — output raw JSON response
• --key <key> — API key (highest priority)

The score command does not require authentication.