CLI Reference
Complete reference for squirrel CLI commands
The squirrel CLI provides commands for website auditing, crawling, and self-management.
Top-Level Commands
Project Commands
Commands that operate on websites and projects:
| Command | Description |
|---|---|
audit |
Run full website audit (crawl + analyze) |
crawl |
Crawl website without analysis |
analyze |
Run audit rules on stored crawl |
report |
View and query stored audit reports |
init |
Create squirrel.toml config file |
config |
View and modify configuration |
feedback |
Send feedback to squirrelscan team |
auth |
Authentication for cloud features and publishing |
credits |
Show cloud credit balance and pricing |
mcp |
Run the local MCP server for agents |
Self-Management Commands
Commands for managing the CLI itself:
| Command | Description |
|---|---|
self install |
Bootstrap local installation |
self update |
Check and apply updates |
self completion |
Generate shell completions |
self doctor |
Run health checks |
self version |
Show version information |
self settings |
Manage CLI settings |
self uninstall |
Remove squirrel from system |
Quick Examples
Run audit on website
squirrel audit https://example.com
Crawl 200 pages and export as JSON
squirrel audit https://example.com -m 200 -f json -o report.json
View latest audit report
squirrel report
List all stored audits
squirrel report --list
Update to latest version
squirrel self update
Global Options
All commands support:
| Option | Description |
|---|---|
-c, --config-file |
Path to config file (default: auto-discover) |
Getting Help
View help for any command:
squirrel --help
squirrel audit --help
squirrel self update --help
Next Steps
- audit - Full audit command reference
- Configuration - Config file documentation
- Rules Reference - Available audit rules
