URL: /index

---
title: "Introduction"
description: "CLI Website Audits for Humans, Agents & LLMs"
---

A comprehensive website audit tool for SEO, performance, content and more that fits into your AI workflow. Single binary, zero dependencies.

<CardGroup cols={2}>
  <Card
    title="Quickstart"
    icon="rocket"
    href="/quickstart"
  >
    Install squirrelscan and run your first audit in under 2 minutes.
  </Card>
  <Card
    title="AI Agent Integration"
    icon="sparkles"
    href="/agents"
  >
    Use squirrelscan with Claude Code, Cursor, and other AI coding assistants.
  </Card>
</CardGroup>

## Three Ways to Use squirrelscan

<Tabs>
  <Tab title="CLI for Humans">
    Run audits directly in your terminal with beautiful, human-readable output:

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

    Perfect for:
    - Manual audits during development
    - Quick site health checks
    - Terminal-first workflows
  </Tab>

  <Tab title="Pipe to AI">
    Pipe clean, LLM-optimized output to any AI assistant:

    ```bash
    squirrel audit example.com --format text | claude
    ```

    Perfect for:
    - Ad-hoc AI assistance with audits
    - Custom AI workflows and scripts
    - Agents without skill support
  </Tab>

  <Tab title="AI Agent Skills">
    Install the skill for fully autonomous AI workflows:

    ```bash
    npx skills install squirrelscan/skills
    ```

    Then prompt your AI agent:
    ```
    Use the audit-website skill to audit this site and fix all issues
    ```

    Perfect for:
    - Autonomous fixing of SEO/accessibility issues
    - Multi-step AI workflows with plan mode
    - Continuous monitoring and regression detection
  </Tab>
</Tabs>

## Why squirrelscan?

<Columns cols={2}>
  <Card
    title="AI-Native Design"
    icon="microchip"
  >
    Built for coding agents. LLM-optimised output works seamlessly with Claude Code, Cursor, and any AI assistant.
  </Card>
  <Card
    title="Developer-First CLI"
    icon="terminal"
  >
    Single binary, zero dependencies. Shell completions, self-update, and CI/CD compatible exit codes.
  </Card>
  <Card
    title="230+ Rules, 21 Categories"
    icon="list-check"
  >
    Comprehensive coverage across SEO, accessibility, performance, and security audits.
  </Card>
  <Card
    title="Smart Incremental Crawling"
    icon="bolt"
  >
    ETag, Last-Modified, and content hashing. Skip unchanged pages. Resume interrupted crawls.
  </Card>
  <Card
    title="E-E-A-T Auditing"
    icon="shield-check"
  >
    Dedicated rules for Experience, Expertise, Authority, and Trust—Google's top ranking signals.
  </Card>
  <Card
    title="Multiple Output Formats"
    icon="files"
  >
    Console, JSON, HTML reports, LLM-friendly output. Export exactly what you need.
  </Card>
</Columns>

## Works Where You Work

<Columns cols={2}>
  <Card
    title="Terminal"
    icon="terminal"
  >
    Run anywhere with a single command.
  </Card>
  <Card
    title="Claude Code"
    icon="sparkles"
  >
    Install the audit-website skill for autonomous workflows.
  </Card>
  <Card
    title="Cursor"
    icon="code"
  >
    Native skill integration with composer mode.
  </Card>
  <Card
    title="Any AI Agent"
    icon="brain"
  >
    Pipe text/JSON/markdown to any LLM.
  </Card>
  <Card
    title="CI/CD"
    icon="git-branch"
  >
    Fail pipelines on audit errors with exit codes.
  </Card>
  <Card
    title="Shell Scripts"
    icon="file-code"
  >
    Integrate into your automation workflows.
  </Card>
</Columns>

## Rule Categories

squirrelscan runs **230+ rules** across **21 categories**:

| Category | Description |
|----------|-------------|
| **Accessibility** | ARIA, focus, landmarks |
| **AI** | LLM parsability, AI content detection |
| **Analytics** | GTM, consent mode |
| **Content** | Quality, readability, freshness |
| **Core SEO** | Meta tags, canonical URLs, h1, favicon |
| **Crawl** | Robots.txt, sitemap, indexing |
| **E-E-A-T** | Experience, expertise, trust signals |
| **i18n** | Hreflang, lang attribute |
| **Images** | Alt text, dimensions, formats |
| **Legal** | Privacy, cookies, TOS |
| **Links** | Internal, external, broken links |
| **Local SEO** | NAP consistency, geo meta |
| **Mobile** | Viewport, tap targets |
| **Performance** | Core Web Vitals, LCP/CLS/INP |
| **Schema** | JSON-LD structured data |
| **Security** | HTTPS, CSP, headers |
| **Social** | Open Graph, Twitter cards |
| **URL Structure** | Length, hyphens, keywords |
| **Video** | VideoObject schema, accessibility |

## Resources

<Columns cols={2}>
  <Card
    title="GitHub"
    icon="github"
    href="https://github.com/squirrelscan/squirrelscan"
  >
    View source, report issues, contribute.
  </Card>
  <Card
    title="Website"
    icon="globe"
    href="https://squirrelscan.com"
  >
    Learn more about squirrelscan.
  </Card>
</Columns>