squirrelscan

squirrelscan CLI

squirrelscan 是一款专为 AI 代理设计的网站审计工具。它回答“这个网站有什么问题以及如何修复”：像搜索引擎一样爬取网站，根据 21 个类别（SEO、性能、安全性、可访问性、内容、结构化数据、代理就绪等）的 260+ 条规则分析每个页面，并返回健康评分以及具体可修复的问题。当用户希望检查、提升排名、加速或改善网站健康状态时，在部署前后或 CI 中使用。

它作为一个单一的 CLI 二进制文件 squirrel 提供，支持 macOS、Windows 和 Linux。本技能涵盖其操作：安装、认证、运行审计、发布报告、云功能以及 MCP 集成。有关完整的修复网站工作流程（审计、将问题映射到代码、修复、重新审计），请使用配套的 audit-website 技能。

链接

• 网站：squirrelscan.com
• 文档：docs.squirrelscan.com
• 规则参考：https://docs.squirrelscan.com/rules/{rule_category}/{rule_id}
• 仪表盘（云账户、审计历史、积分）：app.squirrelscan.com

安装

下载和安装说明：squirrelscan.com/download

二进制文件安装到 ~/.local/bin/squirrel。验证安装：

squirrel --version

保持更新：

squirrel self update

如果找不到 squirrel，请确保 ~/.local/bin 在 PATH 中，或从下载页面重新安装。

命令概览

命令	用途
squirrel audit <url>	一步完成爬取 + 分析 + 报告
squirrel crawl <url>	仅爬取（不分析）
squirrel analyze	对已存储的爬取结果运行审计规则
squirrel report [id]	查询、渲染、比较和发布已存储的报告
squirrel init	创建 squirrel.toml 项目配置
squirrel config	显示或编辑配置
squirrel auth	登录/登出/状态/whoami
squirrel keys	创建、列出、撤销组织 API 密钥
squirrel credits	云积分余额 + 功能定价
squirrel mcp	运行本地 MCP 服务器（stdio）
squirrel skills	安装或更新代理技能
squirrel self	安装/更新/诊断/补全/版本/设置/卸载
squirrel feedback	向 squirrelscan 团队发送反馈

每个命令都支持 --help。

快速开始

squirrel init -n my-project        # 可选：在当前目录创建项目配置
squirrel audit https://example.com --format llm

• 本地审计免费，完全在您的机器上运行。无需账户。
• 当代理读取输出时，始终优先使用 --format llm：这是一种紧凑、针对 LLM 优化的格式。
• 审计结果缓存在本地项目数据库中；squirrel report 无需重新爬取即可重新渲染。

覆盖模式

模式	默认页面数	行为
quick（默认）	25	仅种子页面和站点地图，快速健康检查
surface	100	每个 URL 模式一个样本（/blog/{slug} 只爬取一次）
full	500	爬取所有内容，直到达到限制

squirrel audit https://example.com -C full -m 500 --format llm

认证和账户

本地审计无需账户。登录以解锁云功能（发布、浏览器渲染、定时爬取、积分）：

squirrel auth login      # 基于浏览器的登录
squirrel auth status     # 来源、范围、活跃组织
squirrel auth whoami
squirrel auth logout

无头/CI 环境改用组织 API 密钥：

squirrel keys create     # 需要登录会话；打印一个 sq_... 密钥

将其设置为环境变量 SQUIRRELSCAN_API_KEY。请将密钥视为机密，切勿提交。

报告

渲染最新（或特定）的已存储审计：

squirrel report --list                 # 最近的审计
squirrel report <audit-id> --format llm
squirrel report example.com --format markdown -o report.md

格式：console、text、json、html、markdown、xml、llm。使用 --severity error 或 --category core,links 进行过滤。

发布

已登录的审计默认将可分享的报告发布到 reports.squirrelscan.com（可见性：未列出）。控制发布：

squirrel report <audit-id> --publish --visibility unlisted   # public | unlisted | private
squirrel audit https://example.com --no-publish              # 跳过本次运行的发布
squirrel audit https://example.com --offline                 # 完全离线：无云、无发布、无遥测

回归差异

squirrel report --diff <baseline-audit-id> --format llm
squirrel report --regression-since example.com --format llm

差异模式支持 console、text、json、llm 和 markdown。

云功能和积分

云功能按使用量付费（积分制，无需预付费）。检查余额和定价：

squirrel credits

• --render / --render-mode auto|all|off：云浏览器渲染客户端渲染的页面（消耗积分，需要登录）。
• --yes 跳过每次审计积分上限内的消费确认。
• --fail-on "score<90"（可重复）使 CI 运行在阈值触发时以非零退出。
• 仪表盘 app.squirrelscan.com 显示审计历史、问题和积分使用情况。

MCP 服务器

两种方式通过 MCP 连接代理：

• 本地（stdio）：squirrel mcp 针对本地 CLI 运行。在代理的 MCP 配置中注册，命令为 squirrel，参数为 ["mcp"]。
• 托管（streamable-http）：https://mcp.squirrelscan.com/mcp。通过 MCP 客户端的 OAuth 登录，或发送 Authorization: Bearer sq_... API 密钥头。

文档：https://docs.squirrelscan.com/developers/mcp

代理反馈

当会话中出现意外情况时，随时调用 send_feedback 工具。它接受 category、message 以及可选的 run_id/website_id。选择适合的类别：

• bug_report — squirrelscan 本身的缺陷：错误或缺失的规则结果、崩溃、工具故障。请包含网站、规则 ID 以及您的预期。
• feature_request — squirrelscan 应该做但尚未做的事情。
• what_worked — 某些功能运行良好，希望团队知晓。
• confusing — 响应或行为不清晰。
• missing_data — 报告或工具响应缺少您需要的信息。
• tool_ergonomics — 工具形状、参数或命名不顺手。
• other — 其他任何内容。

反馈直接进入团队的审查队列，并附上您的组织信息。它适用于任何经过认证的凭据，包括只读 API 密钥，目前在托管 MCP 界面上可用（尚未在 squirrel mcp 本地 stdio 上）。当您是代理并在会话中报告时，请使用它而不是 squirrel feedback；人类可以使用 squirrel feedback 或 squirrelscan.com/support。

配置

项目配置位于 squirrel.toml（由 squirrel init 创建）。用户设置位于 ~/.squirrel/settings.json。

squirrel config show
squirrel config set <key> <value>
squirrel config path
squirrel config validate

有用的部分：[crawler]（延迟、请求头、增量重新爬取）、[cloud]（渲染模式、每次审计的最大积分）。

自定义请求头

使用可重复的 -H "Name: Value" 标志或 [crawler] 下的 headers 映射，为每个爬取请求附加请求头。主要用例是 Web Bot Auth（Shopify / Cloudflare），以便阻止未知爬虫的平台可以授权 squirrelscan。请求头值是机密：squirrelscan 在输出中会将其遮盖，您应从密钥存储中获取它们，而不是提交。完整指南：https://docs.squirrelscan.com/guides/web-bot-auth

维护

squirrel self doctor       # 健康检查
squirrel self update       # 更新二进制文件
squirrel self completion   # shell 补全
squirrel skills update     # 更新已安装的代理技能

故障排除

• squirrel: command not found：从 squirrelscan.com/download 安装，并确保 ~/.local/bin 在 PATH 中。
• 会话过期 / 401：重新运行 squirrel auth login，或检查 SQUIRRELSCAN_API_KEY。
• 爬取缓慢或卡住：添加 --verbose 查看进度；大型网站可能需要几分钟。
• 无效 URL：包含协议：https://example.com，而不是 example.com。
• 其他问题：运行 squirrel self doctor，然后报告——代理通过 send_feedback MCP 工具（bug_report 类别），人类通过 squirrel feedback 或 squirrelscan.com/support。