{"id":50409527,"url":"https://github.com/mlava/agent-ready-cli","last_synced_at":"2026-05-31T03:00:57.114Z","repository":{"id":361512846,"uuid":"1254742979","full_name":"mlava/agent-ready-cli","owner":"mlava","description":"Command-line client for Agent Ready — scan any URL for AI-agent readability against the Vercel Agent Readability Spec, llms.txt, and agent protocols (MCP, A2A, agents.json, NLWeb), with per-check fix guidance. Installs the `agent-ready` command; on npm as agent-ready-scanner.","archived":false,"fork":false,"pushed_at":"2026-05-31T01:07:37.000Z","size":42,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-31T02:25:23.925Z","etag":null,"topics":["agent-readability","agents-md","ai-search","cli","command-line","llms-txt","nlweb","scanner","seo","validator","vercel-spec"],"latest_commit_sha":null,"homepage":"https://agent-ready.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mlava.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-31T00:25:14.000Z","updated_at":"2026-05-31T01:06:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mlava/agent-ready-cli","commit_stats":null,"previous_names":["mlava/agent-ready-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mlava/agent-ready-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlava%2Fagent-ready-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlava%2Fagent-ready-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlava%2Fagent-ready-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlava%2Fagent-ready-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mlava","download_url":"https://codeload.github.com/mlava/agent-ready-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlava%2Fagent-ready-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33717419,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent-readability","agents-md","ai-search","cli","command-line","llms-txt","nlweb","scanner","seo","validator","vercel-spec"],"created_at":"2026-05-31T03:00:47.344Z","updated_at":"2026-05-31T03:00:57.105Z","avatar_url":"https://github.com/mlava.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# agent-ready-scanner\n\nCommand-line client for [Agent Ready](https://agent-ready.dev) — scan any URL for **AI-agent readability** against the Vercel Agent Readability Spec, the [llmstxt.org](https://llmstxt.org) standard, and agent-protocol manifests (MCP server cards, A2A, `agents.json`, `agent-permissions.json`, UCP, x402, NLWeb).\n\nIt's a thin wrapper over the hosted [agent-ready.dev REST API](https://agent-ready.dev/api/v1/openapi.json) — no scanning happens locally. For tool-native access from an AI assistant, see [`agent-ready-mcp`](https://github.com/mlava/agent-ready-mcp) instead.\n\n## Install\n\n```bash\nnpm install -g agent-ready-scanner\n```\n\nThis installs the `agent-ready` command. Or run without installing:\n\n```bash\nnpx agent-ready-scanner scan https://example.com\n```\n\n\u003e **Why `agent-ready-scanner`?** The bare `agent-ready` name is blocked by\n\u003e npm's package-name similarity policy (it collides with an unrelated\n\u003e `agentready` package). The installed command is still `agent-ready`.\n\nRequires Node.js ≥ 20.10.\n\n## Authentication\n\n`scan`, `get`, and `list` require a **Pro API key**. Issue one from the\n[dashboard](https://agent-ready.dev/dashboard/api-keys), then either:\n\n```bash\nexport AGENT_READY_API_KEY=\"ar_live_...\"\n# or pass per-command:\nagent-ready scan https://example.com --api-key ar_live_...\n```\n\n`ask` is public and needs no key.\n\n## Commands\n\n### `scan \u003curl\u003e`\n\nStarts a scan, polls until it finishes, and prints a readability summary.\n\n```bash\nagent-ready scan https://example.com\nagent-ready scan https://example.com --page-limit 25\nagent-ready scan https://example.com --no-wait      # queue only, print the id\nagent-ready scan https://example.com --json         # raw JSON\n```\n\n| Option | Description |\n| --- | --- |\n| `--page-limit \u003cn\u003e` | Max pages to crawl |\n| `--no-wait` | Queue the scan and print its id without polling |\n| `--poll-interval \u003cs\u003e` | Seconds between status polls (default 2) |\n| `--timeout \u003cs\u003e` | Max seconds to wait for completion (default 120) |\n\n### `get \u003cid\u003e`\n\nFetch a scan by id (e.g. one started earlier with `--no-wait`).\n\n```bash\nagent-ready get V1StGXR8_Z\nagent-ready get V1StGXR8_Z --json\n```\n\n### `list`\n\nList your recent scans, newest first.\n\n```bash\nagent-ready list\nagent-ready list --limit 5\nagent-ready list --cursor 2026-05-30T00:00:00.000Z   # next page\n```\n\n### `ask \u003cquery...\u003e`\n\nNatural-language search over Agent Ready's own docs (methodology, the check\nregistry, supported specs). Public — no API key.\n\n```bash\nagent-ready ask \"how is the score calculated?\"\nagent-ready ask \"what does check S4 do?\" --type checks\nagent-ready ask \"summarize the llms.txt requirements\" --mode summarize\n```\n\n## Global options\n\n| Option | Description |\n| --- | --- |\n| `--json` | Output raw JSON instead of formatted text |\n| `--api-key \u003ckey\u003e` | Override `AGENT_READY_API_KEY` |\n| `--base-url \u003curl\u003e` | Override `AGENT_READY_API_URL` (e.g. for local dev) |\n| `--no-color` | Disable coloured output ([`NO_COLOR`](https://no-color.org) is also honoured) |\n| `-h, --help` | Show help |\n| `-v, --version` | Show version |\n\n## Environment variables\n\n| Variable | Default | Purpose |\n| --- | --- | --- |\n| `AGENT_READY_API_KEY` | — | Pro API key for `scan`/`get`/`list` |\n| `AGENT_READY_API_URL` | `https://agent-ready.dev` | API base URL |\n| `AGENT_READY_SCAN_TIMEOUT_MS` | `120000` | Overall scan wait budget |\n| `AGENT_READY_GET_TIMEOUT_MS` | `10000` | Per-request timeout |\n\n## Exit codes\n\n| Code | Meaning |\n| --- | --- |\n| `0` | Success |\n| `1` | API error, scan failed, or scan timed out |\n| `2` | Usage error (bad arguments) |\n\n`--json` output goes to stdout; progress and errors go to stderr, so you can\nsafely pipe JSON into other tools.\n\n## Development\n\n```bash\nnpm install\nnpm test          # vitest\nnpm run typecheck # tsc --noEmit\nnpm run build     # bundle to dist/cli.mjs\n```\n\n## License\n\nMIT © Agent Ready\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlava%2Fagent-ready-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlava%2Fagent-ready-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlava%2Fagent-ready-cli/lists"}