audit-website

Overview

What is audit-website?

The audit-website skill enables automated, in-depth audits of websites for SEO, performance, security, technical, and content issues. Powered by the squirrelscan CLI, it evaluates sites against 230+ rules across 21 categories, including meta tags, accessibility, broken links, leaked secrets, and more. The skill generates LLM-optimized reports with health scores and actionable recommendations, making it valuable for developers, SEO professionals, security auditors, and anyone responsible for website quality.

Who should use audit-website?

• Developers seeking to catch technical and security issues early
• SEO specialists aiming to optimize site visibility and fix on-page SEO problems
• Security auditors needing to detect vulnerabilities and leaked secrets
• Content managers wanting to ensure content quality and compliance
• Teams integrating website audits into CI/CD pipelines or agent workflows

Problems solved by audit-website

• Identifies SEO, performance, and security issues in one scan
• Detects broken links, missing meta tags, and accessibility problems
• Flags leaked secrets (API keys, credentials) using 96+ detection patterns
• Provides clear, actionable recommendations for remediation
• Outputs reports in multiple formats, including LLM-friendly XML/text for AI agent consumption

How to Use

Installation Steps

1. Install the skill:
   Run npx skills add https://github.com/squirrelscan/skills --skill audit-website to add audit-website to your agent or project.
2. Review key files:
   • Start with SKILL.md for a high-level overview and compatibility notes
   • Check README.md for feature details and usage scenarios
   • Explore agents/openai.yaml for agent integration details
   • Preview references/OUTPUT-FORMAT.md to understand the LLM-optimized output structure
   • Inspect the rules/, resources/, and references/ folders for rule definitions and documentation
3. Set up prerequisites:
   Ensure the squirrelscan CLI is installed and available in your system PATH. Download it from squirrelscan.com for macOS, Windows, or Linux.

Running an Audit

• Use the CLI to start a scan: squirrel scan https://yourwebsite.com --format llm
• Review the generated report for health scores, issues, and recommendations
• Integrate the skill into CI/CD or agent workflows for automated, continuous auditing

Output Formats

• LLM-optimized XML/text for AI agents
• JSON, Markdown, HTML, and console outputs for human review

FAQ

What does audit-website check for?

It audits over 230 rules across SEO, performance, security, accessibility, and content quality, including meta tags, canonical issues, broken links, and leaked secrets.

How do I install audit-website?

Install via npx skills add https://github.com/squirrelscan/skills --skill audit-website and ensure the squirrelscan CLI is in your PATH.

What are the prerequisites?

You need the squirrelscan CLI installed on your system. Visit squirrelscan.com for downloads and documentation.

Can I use audit-website in CI/CD or with AI agents?

Yes, audit-website is designed for integration into automated pipelines and agent workflows, with output formats optimized for both human and AI consumption.

Where can I find more documentation?

• squirrelscan documentation
• Rule references: https://docs.squirrelscan.com/rules/{rule_category}/{rule_id}

For a complete file tree and helper scripts, open the Files tab in the repository.