hunch-audit
v0.1.0
Published
Retrieve completed Hunch agent-readiness audit reports from the terminal. Read-only.
Maintainers
Readme
hunch-audit
Retrieve a completed Hunch agent-readiness report for any public website, straight from the terminal.
npx hunch-audit example.com example.com — agent readiness: 42/100 (partial, grade C)
scanned 6 pages · snapshot 2026-08-21What it does
- Prints the 0–100 readiness score, letter grade, summary, signal counts, form-operability verdicts, and top recommendations.
--jsonprints the unchanged structured API response (stable shape, safe for scripts and agents).--markdownprints the compact Markdown representation served viaAccept: text/markdowncontent negotiation.
What it deliberately does not do
The CLI is read-only. It never starts a scan against the target site. If no completed report exists yet, run the free audit in your browser at https://hunchbank.com/agent-readiness-audit — then this command returns the stored result immediately.
Machine access
| Resource | URL |
| ---------------------------- | --------------------------------------------------------------------- |
| Report API (JSON / Markdown) | GET https://api.hunchbank.com/api/v1/report?url=https://example.com |
| Methodology | GET https://api.hunchbank.com/api/v1/methodology |
| OpenAPI spec | https://api.hunchbank.com/openapi.json |
| API catalog (RFC 9727) | https://api.hunchbank.com/.well-known/api-catalog |
| AI catalog | https://api.hunchbank.com/.well-known/ai-catalog.json |
| MCP server manifest | https://api.hunchbank.com/server.json |
Errors use RFC 9457 application/problem+json. The public endpoint permits 1000 requests per client per 60 seconds (RateLimit-Policy: 1000;w=60); 429 responses include Retry-After.
Environment
HUNCH_AUDIT_API_URL— override the API base URL (useful for local development).
Publishing
cd cli/hunch-audit
npm publish