GeezerVison

The squirrel CLI provides commands for website auditing, crawling, and self-management.

Run squirrel on its own to see every command, grouped, with a quick start. After installing, run squirrel setup once: it signs you in, installs the agent skills, sets your defaults and offers to run your first audit.

Top-level commands

Project commands

Commands that operate on websites and projects:

Command	Description
`setup`	Sign in, install the agent skills and pick your defaults
`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
`entities`	Query the entity map of a stored audit
`pages`	List the pages of a stored audit with their titles, descriptions, links and flags
`init`	Create squirrel.toml config file
`config`	View and modify configuration
`feedback`	Send feedback to squirrelscan team
`auth`	Authentication for cloud features and publishing
`ci`	Audit a deployed URL in the cloud and fail on findings new since the previous audit
`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

Edit this page