Skip to main content
The squirrel CLI provides commands for website auditing, crawling, and self-management.

​
Top-Level Commands

​
Project Commands

Commands that operate on websites and projects:
CommandDescription
auditRun full website audit (crawl + analyze)
crawlCrawl website without analysis
analyzeRun audit rules on stored crawl
reportView and query stored audit reports
initCreate squirrel.toml config file
configView and modify configuration
feedbackSend feedback to squirrelscan team

​
Self-Management Commands

Commands for managing the CLI itself:
CommandDescription
self installBootstrap local installation
self updateCheck and apply updates
self completionGenerate shell completions
self doctorRun health checks
self versionShow version information
self settingsManage CLI settings
self uninstallRemove 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:
OptionDescription
-c, --config-filePath to config file (default: auto-discover)

​
Getting Help

View help for any command: 
squirrel --help
squirrel audit --help
squirrel self update --help

​
Next Steps