squirrelscan 0.0.24 → 0.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -36
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
# squirrelscan
|
|
4
4
|
|
|
5
|
-
**Website audit tool built for your agent
|
|
5
|
+
**Website audit tool built for your coding agent**
|
|
6
6
|
|
|
7
|
-
Free CLI for SEO, performance & security audits. Built for Claude Code, Cursor, and AI workflows.
|
|
7
|
+
Free CLI for SEO, performance & security audits. Built for Claude Code, Cursor, and AI workflows. 230+ rules, LLM-optimized reports, single binary install.
|
|
8
8
|
|
|
9
9
|
## Features
|
|
10
10
|
|
|
11
|
-
- **
|
|
12
|
-
- **AI-Native Design**
|
|
13
|
-
- **Smart Incremental Crawling**
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
16
|
-
- **
|
|
17
|
-
- **
|
|
11
|
+
- **230+ Rules, 21 Categories** - Comprehensive coverage across SEO, accessibility, performance, and security
|
|
12
|
+
- **AI-Native Design** - LLM-optimised output for Claude Code, Cursor, and any AI assistant
|
|
13
|
+
- **Smart Incremental Crawling** - ETag, Last-Modified, content hashing. Resume from checkpoints.
|
|
14
|
+
- **Developer-First CLI** - Single binary, zero dependencies, shell completions, self-update
|
|
15
|
+
- **E-E-A-T Auditing** - Dedicated rules for Experience, Expertise, Authority, Trust
|
|
16
|
+
- **Crawl History & Changes** - Track site evolution, compare crawls, spot regressions
|
|
17
|
+
- **Multiple Output Formats** - Console, JSON, HTML, Markdown, Text, LLM, XML
|
|
18
18
|
|
|
19
19
|
## Three Ways to Use
|
|
20
20
|
|
|
@@ -59,16 +59,6 @@ squirrel audit example.com --format llm | claude
|
|
|
59
59
|
|
|
60
60
|
## Installation
|
|
61
61
|
|
|
62
|
-
**npm (all platforms):**
|
|
63
|
-
```bash
|
|
64
|
-
npm install -g squirrelscan
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
Or run without installing:
|
|
68
|
-
```bash
|
|
69
|
-
npx squirrelscan audit example.com
|
|
70
|
-
```
|
|
71
|
-
|
|
72
62
|
**macOS / Linux:**
|
|
73
63
|
```bash
|
|
74
64
|
curl -fsSL https://squirrelscan.com/install | bash
|
|
@@ -79,6 +69,16 @@ curl -fsSL https://squirrelscan.com/install | bash
|
|
|
79
69
|
iwr -useb https://squirrelscan.com/install.ps1 | iex
|
|
80
70
|
```
|
|
81
71
|
|
|
72
|
+
**npm (all platforms):**
|
|
73
|
+
```bash
|
|
74
|
+
npm install -g squirrelscan
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**npx (run without installing):**
|
|
78
|
+
```bash
|
|
79
|
+
npx squirrelscan audit example.com
|
|
80
|
+
```
|
|
81
|
+
|
|
82
82
|
## Quick Start
|
|
83
83
|
|
|
84
84
|
```bash
|
|
@@ -103,20 +103,33 @@ squirrel audit https://example.com -m 10
|
|
|
103
103
|
|
|
104
104
|
## Rule Categories
|
|
105
105
|
|
|
106
|
-
| Category |
|
|
107
|
-
|
|
108
|
-
|
|
|
109
|
-
|
|
|
110
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
119
|
-
|
|
106
|
+
| Category | Rules | Focus |
|
|
107
|
+
|----------|-------|-------|
|
|
108
|
+
| Accessibility | 56 | ARIA, button/input names, landmarks, lists, tables, focus |
|
|
109
|
+
| Performance | 24 | Core Web Vitals, compression, caching, JS optimization |
|
|
110
|
+
| Crawlability | 15 | Robots.txt, sitemaps, indexability |
|
|
111
|
+
| Security | 15 | HTTPS, CSP, cookies, leaked secrets (96 patterns) |
|
|
112
|
+
| Links | 15 | Broken links, redirects, anchor text |
|
|
113
|
+
| Images | 15 | Alt text, formats, lazy loading, optimization |
|
|
114
|
+
| Content | 15 | Readability, freshness, word count |
|
|
115
|
+
| E-E-A-T | 14 | Authority, trust, expertise signals |
|
|
116
|
+
| Core | 13 | Meta tags, canonical, doctype, charset |
|
|
117
|
+
| Structured Data | 11 | JSON-LD, schema validation |
|
|
118
|
+
| URL Structure | 8 | Length, format, parameters |
|
|
119
|
+
| Mobile | 6 | Viewport, tap targets, responsive |
|
|
120
|
+
| Social Media | 4 | Open Graph, Twitter Cards |
|
|
121
|
+
| SEO | 4 | Meta robots, indexability |
|
|
122
|
+
| Video | 3 | Schema, captions, thumbnails |
|
|
123
|
+
| Local SEO | 3 | NAP, geo tags, service areas |
|
|
124
|
+
| Legal | 3 | Privacy policy, cookie consent |
|
|
125
|
+
| Internationalization | 2 | Hreflang, lang attribute |
|
|
126
|
+
| Analytics | 2 | GTM, consent mode |
|
|
127
|
+
| AI Detection | 2 | AI content signals |
|
|
128
|
+
| Adblock Detection | 2 | Blocked elements, tracking |
|
|
129
|
+
|
|
130
|
+
**Total: 230+ rules across 21 categories**
|
|
131
|
+
|
|
132
|
+
See the [rules reference](https://docs.squirrelscan.com/rules) for full details.
|
|
120
133
|
|
|
121
134
|
## AI Agent Integration
|
|
122
135
|
|
|
@@ -128,9 +141,11 @@ npx skills install squirrelscan/skills
|
|
|
128
141
|
```
|
|
129
142
|
|
|
130
143
|
Example AI prompts:
|
|
131
|
-
- "
|
|
132
|
-
- "
|
|
133
|
-
- "
|
|
144
|
+
- "Audit example.com and fix all critical issues"
|
|
145
|
+
- "Check for SEO regressions after my recent changes"
|
|
146
|
+
- "Generate a comprehensive audit report and enter plan mode to fix issues"
|
|
147
|
+
- "Audit only the /blog section and focus on E-E-A-T signals"
|
|
148
|
+
- "Run a security-focused audit and check for leaked secrets"
|
|
134
149
|
|
|
135
150
|
See [AI Agent Integration docs](https://docs.squirrelscan.com/agents) for advanced workflows.
|
|
136
151
|
|