squirrelscan

squirrelscan CLI

squirrelscan は AI エージェント向けに構築されたウェブサイト監査ツールです。「このウェブサイトの問題点と、その修正方法」を明らかにします。検索エンジンのようにサイトをクロールし、21 カテゴリー（SEO、パフォーマンス、セキュリティ、アクセシビリティ、コンテンツ、構造化データ、エージェント対応状況など）にわたる 260 以上のルールに基づいて各ページを分析し、健全性スコアと具体的で修正可能な問題を返します。ユーザーがサイトのチェック、検索順位の改善、高速化、健全性の向上を求めているとき、デプロイの前後、または CI で使用してください。

macOS、Windows、Linux 向けに、squirrel という単一の CLI バイナリとして提供されています。このスキルでは、インストール、認証、監査の実行、レポートの公開、クラウド機能、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	ログイン／ログアウト／ステータス／ユーザー情報の表示
squirrel keys	組織の API キーを発行、一覧表示、無効化
squirrel credits	クラウドクレジット残高と機能の料金
squirrel mcp	ローカル MCP サーバーを実行（stdio）
squirrel skills	エージェントスキルをインストールまたは更新
squirrel self	インストール／更新／診断／ディスク／補完／バージョン／設定／アンインストール
squirrel feedback	squirrelscan チームにフィードバックを送信

すべてのコマンドで --help を利用できます。

クイックスタート

squirrel init -n my-project        # optional: project config in cwd
squirrel audit https://example.com --format llm

• ローカル監査は無料で、すべてお使いのマシン上で実行されます。アカウントは不要です。
• エージェントが出力を読み取る場合は --format llm を使用してください。LLM 向けに最適化された、コンパクトな形式です。
• 監査結果はローカルのプロジェクトデータベースにキャッシュされるため、squirrel report は再クロールせずにレポートを再レンダリングします。

カバレッジモード

モード	デフォルトのページ数	動作
quick（デフォルト）	25	起点 URL とサイトマップのみを対象にした、高速な健全性チェック
surface	100	URL パターンごとにサンプルを 1 件クロール（/blog/{slug} は 1 回のみクロール）
full	500	上限まで全ページをクロール

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

認証とアカウント

ローカル監査にアカウントは必要ありません。サインインすると、クラウド機能（公開、ブラウザーレンダリング、スケジュール済みクロール、クレジット）を利用できます。

squirrel auth login      # browser-based login
squirrel auth status     # source, scopes, active org
squirrel auth whoami
squirrel auth logout

ヘッドレス環境／CI 環境では、代わりに組織の API キーを使用します。

squirrel keys create     # requires a login session; prints an sq_... key

環境変数 SQUIRRELSCAN_API_KEY に設定してください。キーはシークレットとして扱い、決してコミットしないでください。

レポート

最新の監査結果、または指定した監査結果を保存済みデータからレンダリングします。

squirrel report --list                 # recent audits
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              # skip publishing for a run
squirrel audit https://example.com --offline                 # fully offline: no cloud, no publish, no telemetry

リグレッション差分

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 経由でエージェントを接続する方法は 2 つあります。

• ローカル（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 で利用可能です（ローカル stdio の squirrel mcp ではまだ利用できません）。セッション中にエージェントとして報告する場合は、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       # health checks
squirrel self update       # update the binary
squirrel self completion   # shell completions
squirrel skills update     # update installed agent skills
squirrel self disk         # per-project and total ~/.squirrel disk use

ディスク領域の確保

監査の完全な履歴はすべてプロジェクトデータベースに保存されるため、同じサイトを再監査するたびに ~/.squirrel はおよそ監査 1 回分ずつ増加します（1,000 ページのサイトでは、監査 1 回あたり約 95 MB です）。squirrel self disk で領域の使用状況を確認できます。--prune は最新の --keep 件を超える監査を整理し、データベースを再構築して、領域をファイルシステムに戻します。

squirrel self disk --prune --keep 3 --dry-run   # list what would go, delete nothing
squirrel self disk --prune --keep 3             # prints the plan, asks, then retires
squirrel self disk --prune --keep 3 --project my-project --yes

• --keep <n> は必須です。整理した監査のレポートは再生成できません。また、report --list、--diff、--regression-since はその履歴を参照するため、どの範囲を残すかはユーザーが決めます。ユーザーに代わって選ぶ前に確認してください。
• 整理後も、次回の監査で読み込むすべてのデータ（URL ごとの最新ページレコード、サブリソース、リンク、画像）は保持されます。そのため、差分再クロールでは引き続き ETag を取得でき、サイトを再取得しません。
• 監査が自動的に整理されることはありません。squirrel 0.0.92 以降が必要です。それ以前のバージョンでは、先に squirrel self update を実行してください。

トラブルシューティング

• squirrel: command not found： squirrelscan.com/download からインストールし、~/.local/bin が PATH に含まれていることを確認してください。
• セッションの有効期限切れ／401：squirrel auth login を再実行するか、SQUIRRELSCAN_API_KEY を確認してください。
• クロールが遅い、または停止している：進行状況を確認するには --verbose を追加してください。大規模なサイトでは数分かかることがあります。
• URL が無効です：example.com ではなく、https://example.com のようにプロトコルを含めてください。
• その他の問題：squirrel self doctor を実行してから報告してください。エージェントは send_feedback MCP ツール（bug_report カテゴリ）から、人間は squirrel feedback または squirrelscan.com/support から報告できます。