Quickstart

Install squirrelscan and run your first SEO audit

Installation

bash

curl -fsSL https://squirrelscan.com/install | bash

powershell

iwr -useb https://squirrelscan.com/install.ps1 | iex

This downloads the binary to ~/.local/bin/squirrel and adds it to your PATH.

Three Ways to Use squirrelscan

Run audits directly with human-readable terminal output:

bash

squirrel audit example.com

Install the skill for autonomous AI workflows:

bash

npx skills install squirrelscan/skills

Then run /audit-website or prompt your AI agent:

Use the audit-website skill to audit this site and fix all issues

Export reports to Claude or other AI assistants:

bash

squirrel audit example.com --format llm | claude

Run Your First Audit

Audit a website with a single command:

bash

squirrel audit https://example.com

You’ll see output like:

 ▄█▀ ▄▀█ █ █ █ █▀▄ █▀▄ █▀▀ █   ▄█▀ ▄▀▀ ▄▀█ █▄ █
 ▀▄  █ █ █ █ █ ██▀ ██▀ █▀  █   ▀▄  █   █▀█ █ ▀█
 █▄▀ ▀▀█ ▀▄▀ █ █ █ █ █ █▄▄ █▄▄ █▄▀ ▀▄▄ █ █ █  █

  v0.0.16 (beta)  •  https://squirrelscan.com
────────────────────────────────────────────
Auditing  https://example.com
Coverage  surface · max 100 pages
Config    defaults
Account   you@example.com · 500 credits
Dashboard https://app.squirrelscan.com

✓ Audited 12 pages in 2.1s

──────────────────────────────────────────────────
SQUIRRELSCAN REPORT
https://example.com • 12 pages • 72/100 (C)
──────────────────────────────────────────────────

Category Breakdown:
--------------------------------------------------
Core SEO             ███████░░░ 75%
Content              ████████░░ 82%
Links                █████████░ 91%
...

ISSUES

Core SEO (1 error, 3 warnings)
  core/meta-description Meta Description (error)
    ✗ meta-description: Missing meta description
      → /about
      → /contact

  core/og-tags Open Graph Tags (warning)
    ⚠ og-image: Missing og:image
      → /

Content (2 warnings)
  content/word-count Word Count (warning)
    ⚠ word-count: Thin content: 150 words (min 300)
      → /landing

──────────────────────────────────────────────────
87 passed • 12 warnings • 3 failed
──────────────────────────────────────────────────

Common Options

Limit pages crawled
For large sites, limit pages to get faster results:
bash
```
squirrel audit https://example.com -m 10
```
Export to JSON
Output machine-readable JSON for CI/CD or AI processing:
bash
```
squirrel audit https://example.com -f json -o report.json
```

Generate HTML report

Create a visual HTML report:

bash

squirrel audit https://example.com -f html -o report.html

Fresh crawl
Ignore cache and fetch all pages fresh:
bash
```
squirrel audit https://example.com --refresh
```

Output Formats

Format	Flag	Use Case
`console`	(default)	Human-readable terminal output
`json`	`-f json`	CI/CD pipelines, programmatic processing
`html`	`-f html`	Visual reports for sharing
`markdown`	`-f markdown`	Documentation, GitHub
`text`	`-f text`	Plain text output
`llm`	`-f llm`	Compact AI-optimized (40% smaller than XML)
`xml`	`-f xml`	Verbose structured XML for enterprise

Using with AI Agents

squirrelscan is designed for AI workflows. Two primary methods:

1. Install the Skill (Recommended)

bash

npx skills install squirrelscan/skills

Then use with Claude Code, Cursor, or any skill-compatible agent:

Use the audit-website skill to audit example.com and fix all issues

2. Pipe Output to AI

bash

# Audit and pipe directly to Claude
squirrel audit example.com --format llm | claude "analyze and prioritize fixes"

The --format llm provides compact, token-optimized output designed specifically for AI agents.

Next Steps

Run squirrel --help for all available commands
See Configuration to customize audit behavior
Check CLI Reference for full audit options
View the GitHub repo for updates

Edit this page