squirrelscan

https://docs.squirrelscan.com
Admin
squirrelscan is a comprehensive CLI website audit tool for SEO, performance, content, and...
Tokens:539,611
Snippets:5,424
Trust Score:3.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run squirrel setup

Source: https://docs.squirrelscan.com/cli/setup

Starts the interactive setup wizard. It walks through signing in, installing agent skills, and configuring updates, then prints the command for your first audit.

```bash
squirrel setup
```

--------------------------------

### Agent setup prompt for squirrelscan

Source: https://docs.squirrelscan.com/agent-setup

Paste this one-line prompt into any coding agent. It instructs the agent to fetch and follow the setup instructions for squirrelscan at the given URL, which installs the CLI, wires up MCP, audits the website, and starts fixing findings.

```text
Fetch and follow the setup instructions for squirrelscan at https://docs.squirrelscan.com/agent-setup/prompt.md
```

--------------------------------

### squirrel skills status output example

Source: https://docs.squirrelscan.com/cli/skills

Example output from running `squirrel skills` (same as `squirrel skills status`). It shows installed and latest versions, where skills are installed, and notes about updates and auto-update.

```bash
$ squirrel skills
squirrelscan skills  (github.com/squirrelscan/skills @ e23765f)

  skill           installed   latest   where
  squirrelscan    1.4.1       1.4.1    ~/.claude/skills, ~/.agents/skills
  audit-website   2.1         2.2 ↑    ~/.claude/skills, ~/.agents/skills

1 update available: run `squirrel skills update`.
Auto-update is on: skills update with the CLI.
```

--------------------------------

### Install with SQUIRREL_FORCE_MIRROR=1

Source: https://docs.squirrelscan.com/quickstart

Install squirrelscan using the mirror from the start when GitHub is blocked. The variable must reach the shell that runs the script, so it goes on the right of the pipe. The checksum is verified either way.

```bash
curl -fsSL https://install.squirrelscan.com | SQUIRREL_FORCE_MIRROR=1 bash
```

```powershell
$env:SQUIRREL_FORCE_MIRROR='1'; iwr -useb https://install.squirrelscan.com/install.ps1 | iex
```

--------------------------------

### AGENTS.md example content

Source: https://docs.squirrelscan.com/rules/ax/agents-md

Example Markdown content for an AGENTS.md file, including setup, test, and convention instructions. Commit it at the repository root.

```markdown
# AGENTS.md

## Setup
`bun install`

## Tests
`bun test <file>` runs one file. Never run the suite bare.

## Conventions
TypeScript only. Format with oxfmt before committing.
```

--------------------------------

### Install squirrel CLI: squirrel self install

Source: https://docs.squirrelscan.com/cli/self

Bootstrap the local installation by creating necessary directories and symlinking the binary. Uses the default bin directory ~/.local/bin unless overridden with --bin-dir.

```bash
squirrel self install
```

--------------------------------

### Log format example

Source: https://docs.squirrelscan.com/cli/debug

Example lines from the log file showing the format for debug and info messages.

```text
2025-01-10T14:30:45.123Z [debug] [request] url="https://example.com" status=200 loadTimeMs=120
2025-01-10T14:30:45.200Z [info] ========== COMMAND END: audit (success, 5432ms) ==========
```

--------------------------------

### Install squirrelscan CLI with curl

Source: https://docs.squirrelscan.com/agent-setup/prompt.md

Downloads and runs the official squirrelscan installer. Requires a network connection and a shell with curl. The installer places the binary in ~/.local/bin/squirrel if it is not already on PATH.

```bash
curl -fsSL --connect-timeout 10 --max-time 120 https://install.squirrelscan.com | bash
```

--------------------------------

### Example .squirrel/settings.json

Source: https://docs.squirrelscan.com/configuration/index

Example content of .squirrel/settings.json showing project-scoped CLI settings: notifications disabled and update channel set to beta.

```json
{
  "notifications": false,
  "channel": "beta"
}
```

--------------------------------

### content/word-count blog posts example

Source: https://docs.squirrelscan.com/configuration/rule-options

Example configuration for blog posts, which require longer content. Raises the minimum word count to 500 and the optimal threshold to 1000.

```toml
[rule_options."content/word-count"]
min_words = 500
warn_threshold = 1000
```

--------------------------------

### content/word-count product pages example

Source: https://docs.squirrelscan.com/configuration/rule-options

Example configuration for product pages, which can be shorter. Sets the minimum word count to 150 and the optimal threshold to 300.

```toml
[rule_options."content/word-count"]
min_words = 150
warn_threshold = 300
```

--------------------------------

### links/internal-links example: allow large navigation menus

Source: https://docs.squirrelscan.com/configuration/rule-options

Example configuration to allow more internal links by setting max_internal_links to 250.

```toml
[rule_options."links/internal-links"]
max_internal_links = 250
```

--------------------------------

### Complete squirrel configuration example

Source: https://docs.squirrelscan.com/configuration/rule-options

Complete example configuration showing project, crawler, rules, and rule-specific options. It requires longer titles (40-60 chars), enforces substantial content (500+ words), expects external citations, ignores utility pages in orphan check, and sets strict TTFB thresholds.

```toml
[project]
name = "myblog"

[crawler]
max_pages = 500

[rules]
enable = ["*"]
disable = ["ai/*"]

# Rule-specific configuration
[rule_options."core/meta-title"]
min_length = 40
max_length = 60

[rule_options."core/meta-description"]
min_length = 120
max_length = 160

[rule_options."content/word-count"]
min_words = 500
warn_threshold = 1000

[rule_options."content/article-links"]
short_min_external = 2
medium_min_external = 2
long_min_external = 2

[rule_options."links/orphan-pages"]
excludePatterns = ["/404", "/500", "/.well-known/"]

[rule_options."perf/ttfb"]
good_threshold = 600
poor_threshold = 1000
```

--------------------------------

### Example of loading React once from unpkg

Source: https://docs.squirrelscan.com/rules/perf/duplicate-js

Shows a single script tag loading React from unpkg, illustrating the recommended fix of loading each library once from one place.

```html
<script src="https://unpkg.com/react@18.3.1/umd/react.production.min.js"></script>
```

--------------------------------

### Example output: squirrel credits

Source: https://docs.squirrelscan.com/cli/credits

Shows the default output for a Pro plan with a balance of 2340 credits. Includes pricing details and a top-up URL.

```bash
squirrel credits
```

```text
Plan:    Pro
Balance: 2340 credits (2000 monthly + 340 purchased)
         monthly credits reset 2026-07-08

Pricing:
  audit                 50 base + 2 per audited page
                           (analysis, tech detection, publishing included)
  external links         1 per link a cloud audit checks
                           (internal links and the CLI's own checks are free)
  content_gaps          25 per run
  issue_enrich           3 per issue
  keyword_gaps          25 per run

Top up: https://app.squirrelscan.com/upgrade?plan=pro&interval=month&org=01J0ORGEXAMPLE0000000000A&src=cli
```

--------------------------------

### per_host_delay_ms: Very polite example

Source: https://docs.squirrelscan.com/configuration/crawler

Sets the minimum delay between consecutive request starts to the same host to 1000ms (1 second).

```toml
[crawler]
per_host_delay_ms = 1000  # 1 second

```

--------------------------------

### Preview a configuration change with --dry-run

Source: https://docs.squirrelscan.com/cli/config

Previews what would change without writing to disk.

```bash
squirrel config set crawler.max_pages 100 --dry-run
```

```text
Would set crawler.max_pages = 100

[project]
domains = []

[crawler]
max_pages = 100
...
```

--------------------------------

### Install squirrelscan skills plugin

Source: https://docs.squirrelscan.com/cli/skills

Installs all skills plus the hosted MCP server as a Claude Code plugin. Every commit to the skills repository is a new plugin version. Claude Code does not auto-update third-party marketplaces unless enabled in `/plugin`; use `/plugin marketplace update squirrelscan` and `/plugin update squirrelscan@squirrelscan` to get new versions.

```text
/plugin marketplace add squirrelscan/skills
/plugin install squirrelscan@squirrelscan
```

--------------------------------

### Show create command usage

Source: https://docs.squirrelscan.com/cli/keys

Displays the usage for the create subcommand.

```bash
squirrel keys create [options]
```

--------------------------------

### Sitemap index XML example

Source: https://docs.squirrelscan.com/rules/crawl/sitemap-valid

Shard past 50,000 entries behind an index. For parse errors, look for unescaped ampersands and raw angle brackets in URLs, which is what hand-built or string-concatenated sitemaps usually get wrong.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap><loc>https://example.com/sitemap-posts-1.xml</loc></sitemap>
  <sitemap><loc>https://example.com/sitemap-posts-2.xml</loc></sitemap>
</sitemapindex>
```

--------------------------------

### Change into the repository for the site you are fixing

Source: https://docs.squirrelscan.com/guides/fix-your-site-with-an-ai-agent

Start your agent from the project folder so it can read source, make edits, and open files that produce the pages the audit flags.

```bash
cd ~/code/my-website
```

--------------------------------

### Recipe: Shopify storefronts - crawler config and audit command

Source: https://docs.squirrelscan.com/guides/rate-limited-hosts

Configure the crawler for polite crawling of Shopify storefronts: one request at a time with a 500 ms delay, a stable user agent, and a 10-minute backoff. Then run a limited audit with --max-pages 40. Required because Shopify has no header-based allowlist.

```toml
[crawler]
# One request at a time to each host, half a second apart.
per_host_concurrency = 1
per_host_delay_ms = 500

# A stable, honest user agent. A rotating or browser-mimicking UA looks more
# like abuse, not less.
user_agent = "squirrelscan/1.0 (+https://squirrelscan.com/bot)"

# Give the storefront time to recover before giving up on it.
max_backoff_ms = 600000
```

```bash
squirrel audit https://example-store.com --max-pages 40
```

--------------------------------

### Prompt to run an audit in ChatGPT

Source: https://docs.squirrelscan.com/developers/agents/chatgpt

Use this prompt in a chat with the squirrelscan connector enabled to run an audit and get a summary. ChatGPT calls the squirrelscan tools, waits for the audit to finish, and reads the report back. Cloud audits spend credits; a base charge starts the run and pages are charged as they render.

```text
Audit https://example.com and summarize the top 10 issues by severity.
```

--------------------------------

### Install output

Source: https://docs.squirrelscan.com/cli/self

Expected output after running `squirrel self install`, showing the installed version, binary path, and symlink path.

```text
Installed v0.1.0
  Binary: ~/.local/share/squirrel/releases/0.1.0/squirrel
  Symlink: ~/.local/bin/squirrel
```

--------------------------------

### Fish completion setup

Source: https://docs.squirrelscan.com/cli/self

Add this line to ~/.config/fish/config.fish to enable shell completion for fish.

```bash
squirrel self completion fish | source
```

--------------------------------

### core/meta-description Google recommended options

Source: https://docs.squirrelscan.com/configuration/rule-options

Example matching Google's recommended description length for core/meta-description.

```toml
[rule_options."core/meta-description"]
min_length = 120
max_length = 158
```

--------------------------------

### Install squirrelscan on macOS/Linux or Windows

Source: https://docs.squirrelscan.com/quickstart

Install squirrelscan on macOS/Linux or Windows. Downloads the binary to ~/.local/bin/squirrel and adds it to PATH. On Alpine/musl Linux, the installer adds libstdc++ automatically when run as root; otherwise install it first with apk add libstdc++.

```bash
curl -fsSL --connect-timeout 10 --max-time 120 https://install.squirrelscan.com | bash
```

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

--------------------------------

### Install squirrelscan on Windows with PowerShell

Source: https://docs.squirrelscan.com/agent-setup/prompt.md

Alternative installation command for Windows using PowerShell. Uses iwr with the -useb flag to run the installer script.

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

--------------------------------

### Example robots.txt file

Source: https://docs.squirrelscan.com/rules/crawl/robots-txt

A minimal robots.txt file that allows all user agents and specifies a sitemap. Serve it from the host root with a text/plain content type.

```text
User-agent: *
Allow: /

Sitemap: https://example.com/sitemap.xml

```

--------------------------------

### content/word-count behavior thresholds

Source: https://docs.squirrelscan.com/configuration/rule-options

Behavior thresholds for the content/word-count rule. With these values, pages under 300 words get a 'warn', 300-499 words get 'info', and 500 or more words get 'pass'.

```toml
min_words = 300
warn_threshold = 500
```

--------------------------------

### Initialize project config with squirrel init

Source: https://docs.squirrelscan.com/configuration/index

Creates a project configuration file (squirrel.toml) in the current directory. Run this in the project root to initialize crawler settings, rule options, output format, and external link checking.

```bash
cd /path/to/project
squirrel init
```

--------------------------------

### Bug report example

Source: https://docs.squirrelscan.com/cli/feedback

Example of a bug report message to include in feedback.

```text
Bug: squirrel audit fails on localhost URLs
Expected: Should crawl localhost
Got: Error "Invalid URL"
```

--------------------------------

### squirrel init - Create a config file

Source: https://docs.squirrelscan.com/cli/init

Creates a `squirrel.toml` config file in the current directory with default settings. This is the basic usage of the `squirrel init` command.

```bash
squirrel init
```

--------------------------------

### squirrel auth logout example with output

Source: https://docs.squirrelscan.com/cli/auth

Example of signing out, showing the success message.

```bash
squirrel auth logout
```

```text
✓ Signed out successfully
```

--------------------------------

### Prompt to audit a path with a page cap

Source: https://docs.squirrelscan.com/developers/agents/copilot

Use this prompt to cap the crawl to /blog/* on example.com with a 20-page limit and fix broken links, keeping the run fast on large sites.

```text
Audit only /blog/* on example.com, cap it at 20 pages, and fix the broken links.
```

--------------------------------

### Verify squirrelscan installation

Source: https://docs.squirrelscan.com/agent-setup/prompt.md

Runs the self-diagnostic check to confirm the CLI is installed and working. If the binary is not on PATH, it installs to ~/.local/bin/squirrel; add that directory to PATH rather than moving the binary because squirrel self update expects it there.

```bash
squirrel self doctor
```

--------------------------------

### GET /v1/websites/{id}/entities/history

Source: https://docs.squirrelscan.com/guides/entity-map/cloud

Documentation for the GET endpoint that retrieves entity map history for a website.

```APIDOC
## GET /v1/websites/{id}/entities/history

### Description
Retrieves the history of entity maps for a website, providing one summary point per audit that produced a map, plus the change set between two of them. This is what the dashboard's history view draws.

### Method
GET

### Endpoint
/v1/websites/{id}/entities/history

### Parameters
#### Path Parameters
- **id** (string) - Required - The website identifier.

#### Query Parameters
- **from** (string) - Optional - Report id of the older side. Defaults to the audit immediately before `to`.
- **to** (string) - Optional - Report id of the newer side. Defaults to the latest audit with a map.
- **limit** (integer) - Optional - Points in the `series`, newest first. Default 50, maximum 200.

### Response
#### Success Response (200)
- **websiteId** (string) - The website identifier.
- **series** (array) - List of summary points, each containing `reportId`, `runId`, `auditedAt`, `summary`, and `backfilled`.
- **comparison** (object) - Contains `from` and `to` objects with `reportId` and `auditedAt`.
- **changes** (object) - Contains arrays: `added`, `removed`, `gainedId`, `lostId`, `changedId`, `occurrenceDeltas`, `newConflicts`, `resolvedConflicts`, and `summaryDelta`.

#### Response Example
```json
{
  "websiteId": "…",
  "series": [
    {
      "reportId": "…",
      "runId": "…",
      "auditedAt": "2026-09-13T05:20:00.000Z",
      "summary": { },
      "backfilled": []
    }
  ],
  "comparison": {
    "from": { "reportId": "…", "auditedAt": "2026-08-13T05:20:00.000Z" },
    "to": { "reportId": "…", "auditedAt": "2026-09-13T05:20:00.000Z" }
  },
  "changes": {
    "added": [], "removed": [], "gainedId": [], "lostId": [], "changedId": [],
    "occurrenceDeltas": [], "newConflicts": [], "resolvedConflicts": [],
    "summaryDelta": []
  }
}
```

### Error Handling
- **404** - Returned when a report id is not one of this website's snapshots.
- **400** - Returned when `from` is after `to` (inverted pair).
```

--------------------------------

### Multi-domain site configuration

Source: https://docs.squirrelscan.com/configuration/project

Allow the main site plus all its subdomains. Running `squirrel audit https://example.com` crawls the seed domain and all subdomains, including `https://blog.example.com`, `https://docs.example.com`, and `https://api.example.com`.

```toml
[project]
domains = ["example.com"]
```

--------------------------------

### links/dead-end-pages example: ignore conversion pages

Source: https://docs.squirrelscan.com/configuration/rule-options

Example configuration to ignore conversion pages by setting excludePatterns.

```toml
[rule_options."links/dead-end-pages"]
excludePatterns = [
  "/thank-you",
  "/confirmation",
  "/download",
  "/success",
  "/submitted",
  "/checkout/success"
]
```
Tokens:
Raw