squirrelscan 0.0.79 → 0.0.81

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.
Files changed (5) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +3 -202
  3. package/THIRD_PARTY_NOTICES.md +3282 -0
  4. package/package.json +6 -3
  5. package/scripts/postinstall.js +41 -31
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2025 squirrelscan
3
+ Copyright (c) 2026 squirrelscan
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,209 +1,10 @@
1
- ![squirrelscan](https://mintcdn.com/squirrelscan/CCMTmLbI4xfnpJbQ/logo/light.svg?fit=max&auto=format&n=CCMTmLbI4xfnpJbQ&q=85&s=1303484a4ea3c154c29dd5f6245e55cd)
2
-
3
1
  # squirrelscan
4
2
 
5
- **The website QA tool for your coding agent**
6
-
7
- squirrelscan audits your website for SEO, performance, security, accessibility and agent experience issues, and gives your coding agent exact fixes. Run it from the CLI, inside your coding agent, in the cloud, or over MCP. Local audits are always free.
8
-
9
- [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://squirrelscan.com/add/cursor)
10
- [![Add to Claude Code](https://img.shields.io/badge/Add_to-Claude_Code-d97757?style=for-the-badge)](https://squirrelscan.com/add/claude)
11
- [![Add to Codex](https://img.shields.io/badge/Add_to-Codex-000000?style=for-the-badge)](https://squirrelscan.com/add/codex)
12
- [![Add to opencode](https://img.shields.io/badge/Add_to-opencode-383838?style=for-the-badge)](https://squirrelscan.com/add/opencode)
13
- [![MCP Registry](https://img.shields.io/badge/MCP-Registry-1f6feb?style=for-the-badge)](https://registry.modelcontextprotocol.io)
14
-
15
- ## Add to your coding agent
16
-
17
- squirrelscan ships as an **MCP server** (hosted at `mcp.squirrelscan.com`), **skills** (autonomous audit + fix workflows), and a **plugin** for Claude Code and Cursor. Cursor installs in one click from the badge above; the rest are a single copy-paste.
18
-
19
- ### Cursor
20
-
21
- Click the **Add to Cursor** badge above, or add it manually to `~/.cursor/mcp.json`:
22
-
23
- ```json
24
- {
25
- "mcpServers": {
26
- "squirrelscan": { "url": "https://mcp.squirrelscan.com/mcp" }
27
- }
28
- }
29
- ```
30
-
31
- Skills: `npx skills add squirrelscan/squirrelscan`
32
-
33
- ### Claude Code
34
-
35
- Install the plugin (bundles skills + the MCP server):
36
-
37
- ```
38
- /plugin marketplace add squirrelscan/squirrelscan
39
- /plugin install squirrelscan@squirrelscan
40
- ```
41
-
42
- Or add just the MCP server:
43
-
44
- ```bash
45
- claude mcp add --transport http squirrelscan https://mcp.squirrelscan.com/mcp
46
- ```
47
-
48
- ### OpenAI Codex
49
-
50
- Add the server to `~/.codex/config.toml`:
51
-
52
- ```toml
53
- [mcp_servers.squirrelscan]
54
- url = "https://mcp.squirrelscan.com/mcp"
55
- ```
56
-
57
- Codex reads Agent Skills from `~/.agents/skills`, so skills work too: `npx skills add squirrelscan/squirrelscan`
58
-
59
- ### opencode
60
-
61
- Add the server to `opencode.json`:
62
-
63
- ```json
64
- {
65
- "$schema": "https://opencode.ai/config.json",
66
- "mcp": {
67
- "squirrelscan": {
68
- "type": "remote",
69
- "url": "https://mcp.squirrelscan.com/mcp",
70
- "enabled": true
71
- }
72
- }
73
- }
74
- ```
75
-
76
- ### Any MCP client
77
-
78
- squirrelscan is in the [MCP Registry](https://registry.modelcontextprotocol.io) as `com.squirrelscan/squirrelscan`. Point any client at the remote server:
79
-
80
- ```
81
- https://mcp.squirrelscan.com/mcp
82
- ```
83
-
84
- Authentication is per-user OAuth (or pass a squirrelscan API key as a Bearer token). Skills follow the [Agent Skills standard](https://agentskills.io): `npx skills add squirrelscan/squirrelscan` lands them in `.agents/skills/`.
85
-
86
- ## Features
87
-
88
- - **260+ Rules, 21 Categories** - Comprehensive coverage across SEO, accessibility, performance, and security
89
- - **AI-Native Design** - LLM-optimised output for Claude Code, Cursor, and any AI assistant
90
- - **Smart Incremental Crawling** - ETag, Last-Modified, content hashing. Resume from checkpoints.
91
- - **Developer-First CLI** - Single binary, zero dependencies, shell completions, self-update
92
- - **E-E-A-T Auditing** - Dedicated rules for Experience, Expertise, Authority, Trust
93
- - **Crawl History & Changes** - Track site evolution, compare crawls, spot regressions
94
- - **Multiple Output Formats** - Console, JSON, HTML, Markdown, Text, LLM, XML
95
-
96
- ## CLI
3
+ This package installs the `squirrel` CLI binary for macOS, Linux, and Windows.
97
4
 
98
- ### Installation
99
-
100
- **macOS / Linux:**
101
- ```bash
102
- curl -fsSL https://install.squirrelscan.com | bash
103
- ```
104
-
105
- **Windows:**
106
- ```powershell
107
- iwr -useb https://install.squirrelscan.com/install.ps1 | iex
108
- ```
109
-
110
- **npm (all platforms):**
111
5
  ```bash
112
- npm install -g squirrelscan
113
- ```
114
-
115
- **npx (run without installing):**
116
- ```bash
117
- npx squirrelscan audit example.com
118
- ```
119
-
120
- ### Quick Start
121
-
122
- ```bash
123
- # Audit a website
6
+ npm install --global squirrelscan
124
7
  squirrel audit https://example.com
125
-
126
- # Generate HTML report
127
- squirrel audit https://example.com -f html -o report.html
128
-
129
- # Pipe to Claude for AI analysis
130
- squirrel audit https://example.com --format llm | claude
131
-
132
- # Limit pages for faster results
133
- squirrel audit https://example.com -m 10
134
8
  ```
135
9
 
136
- ## Skills
137
-
138
- Two skills drive agent workflows:
139
-
140
- - **`squirrelscan`** - operating the CLI: install, login, keys, credits, running audits, publishing reports, MCP setup, config, troubleshooting.
141
- - **`audit-website`** - the full fix loop: audit, map issues to source files, fix in batches, re-audit until the site scores well.
142
-
143
- ```bash
144
- npx skills add squirrelscan/squirrelscan
145
- ```
146
-
147
- Then, in your agent:
148
-
149
- ```
150
- Use the audit-website skill to audit this site and fix all issues but only crawl 10 pages
151
- ```
152
-
153
- ## Rule Categories
154
-
155
- | Category | Rules | Focus |
156
- |----------|-------|-------|
157
- | Accessibility | 59 | ARIA, button/input names, landmarks, lists, tables, focus |
158
- | Performance | 29 | Core Web Vitals, compression, caching, JS optimization |
159
- | Crawlability | 17 | Robots.txt, sitemaps, indexability |
160
- | Agent Experience | 17 | How ready a site is for AI agents to read, discover, operate |
161
- | Security | 16 | HTTPS, CSP, cookies, leaked secrets |
162
- | Images | 15 | Alt text, formats, lazy loading, optimization |
163
- | E-E-A-T | 15 | Authority, trust, expertise signals |
164
- | Links | 14 | Broken links, redirects, anchor text |
165
- | Core SEO | 13 | Meta tags, canonical, doctype, charset |
166
- | Content | 12 | Readability, freshness, word count |
167
- | Structured Data | 10 | JSON-LD, schema validation |
168
- | Site Integrity | 9 | Injected pages, phishing kits, malware, SEO spam |
169
- | URL Structure | 8 | Length, format, parameters |
170
- | Mobile | 6 | Viewport, tap targets, responsive |
171
- | Social Media | 4 | Open Graph, Twitter Cards |
172
- | Legal Compliance | 4 | Privacy policy, cookie consent |
173
- | Video | 3 | Schema, captions, thumbnails |
174
- | Local SEO | 3 | NAP, geo tags, service areas |
175
- | Blocking | 3 | Content, links, trackers that ad/privacy blockers block |
176
- | Internationalization | 2 | Hreflang, lang attribute |
177
- | Analytics | 2 | GTM, consent mode |
178
-
179
- **Total: 261 rules across 21 categories**
180
-
181
- See the [rules reference](https://docs.squirrelscan.com/rules) for full details.
182
-
183
- ## Output Formats
184
-
185
- | Format | Flag | Use Case |
186
- |--------|------|----------|
187
- | Console | (default) | Human-readable terminal output |
188
- | JSON | `-f json` | CI/CD, programmatic processing |
189
- | HTML | `-f html` | Visual reports for sharing |
190
- | Markdown | `-f markdown` | Documentation, GitHub |
191
- | Text | `-f text` | Clean output for piping to LLMs |
192
- | LLM | `-f llm` | LLM optimized output |
193
-
194
- ## Development Status
195
-
196
- squirrelscan is in **active beta**. Expect rapid iteration and breaking changes. Feedback and issue reports welcome!
197
-
198
- ## Links
199
-
200
- - [Website](https://squirrelscan.com)
201
- - [Documentation](https://docs.squirrelscan.com)
202
- - [AI Agent Integration](https://docs.squirrelscan.com/agents)
203
- - [Share Feedback](https://squirrelscan.com/feedback)
204
- - [Bugs, Issues & Feature Requests](https://github.com/squirrelscan/squirrelscan/issues)
205
- - [Twitter/X](https://x.com/squirrelscan_)
206
-
207
- ## License
208
-
209
- The skills, plugin manifests, MCP configuration, and install scripts in this repository are MIT licensed (see [LICENSE](LICENSE)). The squirrelscan CLI binary itself is distributed as a standalone executable and is not open source.
10
+ The CLI source is available in [`apps/cli`](https://github.com/squirrelscan/squirrelscan/tree/main/apps/cli) under the MIT License.