Skip to main content

Installation

curl -fsSL https://squirrelscan.com/install | bash
This downloads the binary to ~/.local/bin/squirrel and adds it to your PATH.
After installation, run squirrel self doctor to verify everything is set up correctly.

Up and Running in 3 Steps

1

Install

curl -fsSL https://squirrelscan.com/install | bash
2

Run audit

squirrel audit example.com --output claude
3

Pipe to Claude

squirrel audit example.com --output claude | claude

Run Your First Audit

Audit a website with a single command:
squirrel audit https://example.com
You’ll see output like:
SquirrelScan v2.0
========================================
Auditing: https://example.com
Max pages: 50

Crawled 12 pages

ISSUES

[high] Missing meta description
  → /about
  → /contact

[medium] Image missing alt text
  → /images/hero.png on /

[low] Non-HTTPS link
  → http://oldsite.com on /links

Common Options

1

Limit pages crawled

For large sites, limit pages to get faster results:
squirrel audit https://example.com -m 10
2

Export to JSON

Output machine-readable JSON for CI/CD or AI processing:
squirrel audit https://example.com -f json -o report.json
3

Generate HTML report

Create a visual HTML report:
squirrel audit https://example.com -f html -o report.html
4

Fresh crawl

Ignore cache and fetch all pages fresh:
squirrel audit https://example.com --refresh

Output Formats

FormatFlagUse Case
console(default)Human-readable terminal output
json-f jsonCI/CD pipelines, AI processing
html-f htmlVisual reports for sharing
claude--output claudeOptimized for Claude Code
llm--output llmGeneric LLM-friendly format

Using with Claude Code

squirrelscan is designed for AI agents. Pipe output directly to Claude:
squirrel audit https://example.com --output claude | claude
The --output claude flag formats results in a way that’s optimized for Claude to understand and act on.

Next Steps