GitHub

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:

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
authAuthentication for cloud features and publishing
creditsShow cloud credit balance and pricing
mcpRun the local MCP server for agents

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

bash
squirrel audit https://example.com

Crawl 200 pages and export as JSON

bash
squirrel audit https://example.com -m 200 -f json -o report.json

View latest audit report

bash
squirrel report

List all stored audits

bash
squirrel report --list

Update to latest version

bash
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:

bash
squirrel --help
squirrel audit --help
squirrel self update --help

Next Steps

Type to search…

↑↓ navigate ↵ open esc close