Docs · CLI
The actuity CLI.
Check how AI agents experience your website from your terminal or your build. It runs with npx, so there is nothing to install. It needs Node.js 18.17 or newer.
npx actuity scan example.comexample.com 82.1/100
Agents can mostly use this site, with gaps
We checked 12 of about 73 pages we found.
2 things to fix:
1. The page does not clearly mark its main content (on 3 pages)
2. Contact, about or policy pages are hard to find
Fix prompts: actuity fixes <scan-id>
Full report: https://actuity.tech/scan/<scan-id>Commands
| Command | What it does |
|---|---|
| actuity scan <url> | Scans the site and prints what agents run into, with a link to the full report. |
| actuity check <url> | The same scan for a build: exits 1 when there is anything to fix, or below --min-score. |
| actuity fixes <scan-id> | Prints the fix prompts for a scan, ready to paste into your coding tool. |
| actuity mcp | Runs the MCP server for coding tools. See MCP in coding tools. |
Options
| Option | What it does |
|---|---|
| --fresh | Scan now instead of using a report saved in the last 24 hours. Needs a key. |
| --json | Print the result as JSON. |
| --markdown | Print the full report as Markdown. |
| --platform <name> | Word the fixes for your platform: nextjs, shopify, wordpress, webflow, sitebuilder or generic. |
| --min-score <0-100> | For check: fail when the score is lower. |
| --fail-on problems|none | For check: fail when there is any problem (the default), or never on problems. |
| --timeout <sec> | How long to wait for a scan (default 300). |
| --api-key <key> | Your API key, if it isn’t in ACTUITY_API_KEY. |
Sign in with a key
Without a key a scan is anonymous. With one, the scan joins your site’s fix list, can scan again right away with --fresh, and gets your plan’s depth and fix prompts. Make a key in Settings → API keys, then:
export ACTUITY_API_KEY=act_...
npx actuity scan example.com --freshGet the fix prompts
Each scan prints its id. Ask for the prompts, worded for your platform:
npx actuity fixes <scan-id> --platform nextjsNext: MCP in coding tools →