Installation
- macOS / Linux
- Windows
~/.local/bin/squirrel and adds it to your PATH.
Up and Running in 3 Steps
1
Install
2
Run audit
3
Pipe to Claude
Run Your First Audit
Audit a website with a single command:Common Options
1
Limit pages crawled
For large sites, limit pages to get faster results:
2
Export to JSON
Output machine-readable JSON for CI/CD or AI processing:
3
Generate HTML report
Create a visual HTML report:
4
Fresh crawl
Ignore cache and fetch all pages fresh:
Output Formats
| Format | Flag | Use Case |
|---|---|---|
console | (default) | Human-readable terminal output |
json | -f json | CI/CD pipelines, AI processing |
html | -f html | Visual reports for sharing |
claude | --output claude | Optimized for Claude Code |
llm | --output llm | Generic LLM-friendly format |
Using with Claude Code
squirrelscan is designed for AI agents. Pipe output directly to Claude:--output claude flag formats results in a way that’s optimized for Claude to understand and act on.
Next Steps
- Run
squirrel --helpfor all available commands - See Configuration to customize audit behavior
- Check CLI Reference for full audit options
- View the GitHub repo for updates