squirrelscan
squirrelscan audits websites for SEO, performance, security, accessibility, content, and structured data issues (260+ rules) and scores site health, via the squirrel CLI. Use when the user wants to check, audit, or improve a website's SEO, ranking, speed, or health, and for anything squirrelscan itself, installing or updating the CLI, login and API keys, running audits, publishing and sharing reports, cloud credits, MCP server setup, configuration, or troubleshooting.
squirrelscan · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add squirrelscan/skills --skill squirrelscan技能说明
name: squirrelscan description: squirrelscan audits websites for SEO, performance, security, accessibility, content, and structured data issues (260+ rules) and scores site health, via the squirrel CLI. Use when the user wants to check, audit, or improve a website's SEO, ranking, speed, or health, and for anything squirrelscan itself, installing or updating the CLI, login and API keys, running audits, publishing and sharing reports, cloud credits, MCP server setup, configuration, or troubleshooting. license: See LICENSE file in repository root compatibility: Requires squirrel CLI installed and accessible in PATH (or guides the user to install it) metadata: author: squirrelscan version: "1.2" allowed-tools: Bash(squirrel:*) Read
squirrelscan CLI
squirrelscan is a website audit tool built for AI agents. It answers "what's wrong with this website and how do I fix it": it crawls a site like a search engine, analyzes every page against 260+ rules in 21 categories (SEO, performance, security, accessibility, content, structured data, agent readiness, and more), and returns a health score plus concrete, fixable issues. Use it whenever a user wants their site checked, ranked better, faster, or healthier, before/after a deploy, or in CI.
It ships as a single CLI binary, squirrel, for macOS, Windows, and Linux. This skill covers operating it: installing, authenticating, running audits, publishing reports, cloud features, and MCP integration. For the full fix-the-website workflow (audit, map issues to code, fix, re-audit), use the companion audit-website skill.
Links
- Website: squirrelscan.com
- Docs: docs.squirrelscan.com
- Rule reference:
https://docs.squirrelscan.com/rules/{rule_category}/{rule_id} - Dashboard (cloud account, audit history, credits): app.squirrelscan.com
Install
Download and install instructions: squirrelscan.com/download
The binary installs to ~/.local/bin/squirrel. Verify with:
squirrel --version
Keep it current:
squirrel self update
If squirrel is not found, ensure ~/.local/bin is in PATH, or reinstall from the download page.
Command overview
| Command | Purpose |
|---|---|
squirrel audit <url> | Crawl + analyze + report in one step |
squirrel crawl <url> | Crawl only (no analysis) |
squirrel analyze | Run audit rules on a stored crawl |
squirrel report [id] | Query, render, diff, and publish stored reports |
squirrel init | Create squirrel.toml project config |
squirrel config | Show or edit configuration |
squirrel auth | login / logout / status / whoami |
squirrel keys | Mint, list, revoke org API keys |
squirrel credits | Cloud credit balance + feature pricing |
squirrel mcp | Run the local MCP server (stdio) |
squirrel skills | Install or update agent skills |
squirrel self | install / update / doctor / completion / version / settings / uninstall |
squirrel feedback | Send feedback to the squirrelscan team |
Every command supports --help.
Quickstart
squirrel init -n my-project # optional: project config in cwd
squirrel audit https://example.com --format llm
- Local audits are free and run entirely on your machine. No account needed.
- Use
--format llmwhen an agent is reading the output: it is a compact, token-optimized format built for LLMs. - Audits are cached in a local project database;
squirrel reportre-renders without re-crawling.
Coverage modes
| Mode | Default pages | Behavior |
|---|---|---|
quick (default) | 25 | Seed + sitemaps only, fast health check |
surface | 100 | One sample per URL pattern (/blog/{slug} crawled once) |
full | 500 | Crawl everything up to the limit |
squirrel audit https://example.com -C full -m 500 --format llm
Authentication and accounts
Local audits never require an account. Sign in to unlock cloud features (publishing, browser rendering, scheduled crawls, credits):
squirrel auth login # browser-based login
squirrel auth status # source, scopes, active org
squirrel auth whoami
squirrel auth logout
Headless / CI environments use an org API key instead:
squirrel keys create # requires a login session; prints an sq_... key
Set it as SQUIRRELSCAN_API_KEY in the environment. Treat keys as secrets; never commit them.
Reports
Render the latest (or a specific) stored audit:
squirrel report --list # recent audits
squirrel report <audit-id> --format llm
squirrel report example.com --format markdown -o report.md
Formats: console, text, json, html, markdown, xml, llm. Filter with --severity error or --category core,links.
Publishing
Signed-in audits publish a shareable report to reports.squirrelscan.com by default (visibility: unlisted). Control it:
squirrel report <audit-id> --publish --visibility unlisted # public | unlisted | private
squirrel audit https://example.com --no-publish # skip publishing for a run
squirrel audit https://example.com --offline # fully offline: no cloud, no publish, no telemetry
Regression diffs
squirrel report --diff <baseline-audit-id> --format llm
squirrel report --regression-since example.com --format llm
Diff mode supports console, text, json, llm, and markdown.
Cloud features and credits
Cloud features are pay-as-you-go with credits (nothing charged up front). Check balance and pricing:
squirrel credits
--render/--render-mode auto|all|off: cloud browser rendering for client-rendered pages (uses credits, requires login).--yesskips spend confirmations up to the configured per-audit credit cap.--fail-on "score<90"(repeatable) makes CI runs exit non-zer