# squirrelscan

> The website QA tool for your coding agent. 260+ SEO, performance, security and agent experience rules, run from the CLI, your coding agent, the cloud, or over MCP.

squirrelscan finds broken links, missing meta tags, slow pages, and security gaps, then hands you the fix, not just a score. Local audits are free and run entirely on your machine; cloud features add hosted crawling, scheduled runs, and shareable reports.

Blog posts and Nutshell entries are also served as markdown: append `.md` to the URL (for example https://squirrelscan.com/blog/hosted-mcp.md), or send `Accept: text/markdown` without `text/html`. Each HTML page advertises its markdown twin with a `Link: rel="alternate"` header.

## Getting started

Install the CLI. Local audits are free, run entirely on your machine, and need no account.

```bash
curl -fsSL https://install.squirrelscan.com | bash
squirrel self doctor
```

Run the first audit:

```bash
squirrel audit example.com
```

Add squirrelscan to a coding agent. In Claude Code the plugin bundles both the skills and the hosted MCP server:

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

For any other agent, install the skills on their own. They drive the CLI directly, so free local audits work with no auth:

```bash
npx skills add squirrelscan/squirrelscan
```

To connect the hosted MCP server by itself (streamable-http, OAuth via dynamic client registration, no client id needed):

```bash
claude mcp add --transport http squirrelscan https://mcp.squirrelscan.com/mcp
```

Sign in only for cloud features: hosted crawling, browser rendering, scheduled runs, and shareable reports.

```bash
squirrel auth login
```

Then run `/audit-website` in the agent, or pipe findings anywhere with `squirrel audit example.com --format llm`.

## Docs

- [Getting started](https://docs.squirrelscan.com/quickstart): install the CLI and run your first audit
- [CLI reference](https://docs.squirrelscan.com/cli): commands, flags, and config
- [Rule index](https://docs.squirrelscan.com/rules): the full audit rule catalog, 260+ rules by category
- [Agent experience rules](https://docs.squirrelscan.com/rules/ax): the ax category, what this file is audited against
- [MCP and developers](https://docs.squirrelscan.com/developers/mcp): connect an agent over MCP or the HTTP API
- [Claude Code setup](https://docs.squirrelscan.com/developers/agents/claude-code): plugin, skills, and MCP for Claude Code
- [Codex setup](https://docs.squirrelscan.com/developers/agents/codex): skills and MCP for Codex
- [Configuration](https://docs.squirrelscan.com/configuration): squirrel.config.ts, rule selection, and thresholds

## Integrate

- [Hosted MCP](https://mcp.squirrelscan.com/mcp): streamable-http transport, OAuth or API key auth
- [OpenAPI spec](https://squirrelscan.com/openapi.json): the public REST surface
- [integrations.json](https://squirrelscan.com/.well-known/integrations.json): machine-readable integration listing
- [Install](https://install.squirrelscan.com): one-line CLI install

## Learn

- [The Nutshell](https://squirrelscan.com/learn): knowledge base covering generative engine optimization, AI coding tools, and site health
- [Generative engine optimization](https://squirrelscan.com/learn/generative-engine-optimization): getting cited by AI answer engines

## Tools

- [Free tools](https://squirrelscan.com/tools): quick checks that run part of a squirrelscan audit
- [Website audit tool](https://squirrelscan.com/tools/website-audit): run 260+ rules across your whole site
- [llms.txt validator](https://squirrelscan.com/tools/llms-txt-validator): check your /llms.txt against the llmstxt.org spec
- [Broken link checker](https://squirrelscan.com/tools/broken-link-checker): find dead internal and external links site-wide
- [Core Web Vitals test](https://squirrelscan.com/tools/core-web-vitals-checker): check LCP, INP, and CLS and the rules behind them
- [Security headers checker](https://squirrelscan.com/tools/security-headers-checker): audit CSP, HSTS, and more across every page

## More

- [Dashboard](https://app.squirrelscan.com): audit history, issues, and credits
- [Blog](https://squirrelscan.com/blog): release notes and how squirrelscan is built
- [RSS feed](https://squirrelscan.com/blog/rss.xml): subscribe to new blog posts

## Social

- [GitHub](https://github.com/squirrelscan/squirrelscan)
- [X](https://x.com/squirrelscan_)
- [LinkedIn](https://www.linkedin.com/company/squirrelscan/)