audit-website
from squirrelscan/skills
Agent skills for squirrelscan website audit tool
npx skills add https://github.com/squirrelscan/skills --skill audit-websiteSKILL.md
Website Audit Skill
Audit websites for SEO, technical, content, performance and security issues using the squirrelscan cli.
squirrelscan provides a cli tool squirrel - available for macos, windows and linux. It carries out extensive website auditing by emulating a browser, search crawler, and analyzing the website's structure and content against over 140+ rules.
It will provide you a list of issues as well as suggestions on how to fix them.
Links
- squirrelscan website is at https://squirrelscan.com
- documentation (including rule references) are at docs.squirrelscan.com
You can look up the docs for any rule with this template:
https://docs.squirrelscan.com/rules/{rule_category}/{rule_id}
example:
https://docs.squirrelscan.com/rules/links/external-links
What This Skill Does
This skill enables AI agents to audit websites for over 140 rules in 20 categories, including:
- SEO issues: Meta tags, titles, descriptions, canonical URLs, Open Graph tags
- Technical problems: Broken links, redirect chains, page speed, mobile-friendliness
- Performance: Page load time, resource usage, caching
- Content quality: Heading structure, image alt text, content analysis
- Security: Leaked secrets, HTTPS usage, security headers, mixed content
- Accessibility: Alt text, color contrast, keyboard navigation
- Usability: Form validation, error handling, user flow
- Links: Checks for broken internal and external links
- E-E-A-T: Expertise, Experience, Authority, Trustworthiness
- User Experience: User flow, error handling, form validation
- Mobile: Checks for mobile-friendliness, responsive design, touch-friendly elements
- Crawlability: Checks for crawlability, robots.txt, sitemap.xml and more
- Schema: Schema.org markup, structured data, rich snippets
- Legal: Compliance with legal requirements, privacy policies, terms of service
- Social: Open graph, twitter cards and validating schemas, snippets etc.
- Url Structure: Length, hyphens, keywords
- Keywords: Keyword stuffing
- Content: Content structure, headings
- Images: Alt text, color contrast, image size, image format
- Local SEO: NAP consistency, geo metadata
- Video: VideoObject schema, accessibility
and more!
The audit crawls the website, analyzes each page against audit rules, and returns a comprehensive report with:
- Overall health score (0-100)
- Category breakdowns (core SEO, technical SEO, content, security)
- Specific issues with affected URLs
- Broken link detection
- Actionable recommendations
When to Use
Use this skill when you need to:
- Analyze a website's health
- Debug technical SEO issues
- Fix all of the issues mentioned above
- Check for broken links
- Validate meta tags and structured data
- Generate site audit reports
- Compare site health before/after changes
- Improve website performance, accessibility, SEO, security and more.
Prerequisites
This skill requires the squirrel CLI to be installed and available in your PATH.
Installation
If squirrel is not already installed, you can install it using:
curl -fsSL https://squirrelscan.com/install | bash
This will:
- Download the latest release binary
- Install to
~/.local/share/squirrel/releases/{version}/ - Create a symlink at
~/.local/bin/squirrel - Initialize settings at
~/.squirrel/settings.json
If ~/.local/bin is not in your PATH, add it to your shell configuration:
export PATH="$HOME/.local/bin:$PATH"
Windows Installation
Install using PowerShell:
irm https://squirrelscan.com/install.ps1 | iex
This will:
- Download the latest release binary
- Install to
%LOCALAPPDATA%\squirrel\ - Add squirrel to your PATH
If using Command Prompt, you may need to restart your terminal for PATH changes to take effect.
Verify Installation
Check that squirrel is installed and accessible:
squirrel --version
Setup
Running squirrel init will setup a squirrel.toml file for configuration in the current directory.
Each project should have a squirrel project name for the database - by default this is the name of the website you audit - but you can set it yourself so that you can place all audits for a project in one database
You do this either on init with:
squirrel init --project-name my-project
or config:
squirrel config set project.name my-project
If there is no squirrel.toml in the directory you're running from CREATE ONE with squirrel init and specify the '-n'
parameter for a project name (infer this)
The project name is used to identify the project in the database and is used to generate the database name.
It is stored in ~/.squirrel/projects/
Usage
Intro
There are three processes that you can run and they're all cached in the local project database:
- crawl - subcommand to run a crawl or refres
...