squirrelscan 0.0.75 → 0.0.77

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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +87 -52
  3. package/package.json +6 -28
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 squirrelscan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -6,58 +6,96 @@
6
6
 
7
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
8
 
9
- ## Features
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)
10
14
 
11
- - **260+ 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
15
+ ## Add to your coding agent
18
16
 
19
- ## Three Ways to Use
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.
20
18
 
21
- ### 1. CLI for Humans
19
+ ### Cursor
22
20
 
23
- Run audits directly in your terminal:
21
+ Click the **Add to Cursor** badge above, or add it manually to `~/.cursor/mcp.json`:
24
22
 
25
- ```bash
26
- squirrel audit example.com
23
+ ```json
24
+ {
25
+ "mcpServers": {
26
+ "squirrelscan": { "url": "https://mcp.squirrelscan.com/mcp" }
27
+ }
28
+ }
27
29
  ```
28
30
 
29
- ### 2. AI Coding Agent Skill
31
+ Skills: `npx skills add squirrelscan/squirrelscan`
32
+
33
+ ### Claude Code
30
34
 
31
- Install the skill for autonomous workflows:
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:
32
43
 
33
44
  ```bash
34
- npx skills install squirrelscan/skills
45
+ claude mcp add --transport http squirrelscan https://mcp.squirrelscan.com/mcp
35
46
  ```
36
47
 
37
- Use the slash command:
48
+ ### OpenAI Codex
49
+
50
+ Add the server to `~/.codex/config.toml`:
38
51
 
52
+ ```toml
53
+ [mcp_servers.squirrelscan]
54
+ url = "https://mcp.squirrelscan.com/mcp"
39
55
  ```
40
- /audit-website
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
+ }
41
74
  ```
42
75
 
43
- Or prompt your AI agent more specifically:
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:
44
79
 
45
80
  ```
46
- Use the audit-website skill to audit this site and fix all issues but only crawl 10 pages
81
+ https://mcp.squirrelscan.com/mcp
47
82
  ```
48
83
 
49
- More information [in the skills repository](https://github.com/squirrelscan/skills) and our [Getting started with AI Agents](https://docs.squirrelscan.com/agents) documentation.
50
-
51
- ### 3. Pipe to AI agent
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/`.
52
85
 
53
- Pipe clean output to any AI assistant:
86
+ ## Features
54
87
 
55
- ```bash
56
- squirrel audit example.com --format llm | claude
57
- ```
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
58
95
 
96
+ ## CLI
59
97
 
60
- ## Installation
98
+ ### Installation
61
99
 
62
100
  **macOS / Linux:**
63
101
  ```bash
@@ -79,7 +117,7 @@ npm install -g squirrelscan
79
117
  npx squirrelscan audit example.com
80
118
  ```
81
119
 
82
- ## Quick Start
120
+ ### Quick Start
83
121
 
84
122
  ```bash
85
123
  # Audit a website
@@ -95,11 +133,22 @@ squirrel audit https://example.com --format llm | claude
95
133
  squirrel audit https://example.com -m 10
96
134
  ```
97
135
 
98
- ## Resources
136
+ ## Skills
99
137
 
100
- - **Website:** [squirrelscan.com](https://squirrelscan.com)
101
- - **Documentation:** [docs.squirrelscan.com](https://docs.squirrelscan.com)
102
- - **AI Agent Skills:** [github.com/squirrelscan/skills](https://github.com/squirrelscan/skills)
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
+ ```
103
152
 
104
153
  ## Rule Categories
105
154
 
@@ -131,24 +180,6 @@ squirrel audit https://example.com -m 10
131
180
 
132
181
  See the [rules reference](https://docs.squirrelscan.com/rules) for full details.
133
182
 
134
- ## AI Agent Integration
135
-
136
- squirrelscan is designed for autonomous AI workflows:
137
-
138
- ```bash
139
- # Install the skill for Claude Code, Cursor, etc.
140
- npx skills install squirrelscan/skills
141
- ```
142
-
143
- Example AI prompts:
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"
149
-
150
- See [AI Agent Integration docs](https://docs.squirrelscan.com/agents) for advanced workflows.
151
-
152
183
  ## Output Formats
153
184
 
154
185
  | Format | Flag | Use Case |
@@ -168,7 +199,11 @@ squirrelscan is in **active beta**. Expect rapid iteration and breaking changes.
168
199
 
169
200
  - [Website](https://squirrelscan.com)
170
201
  - [Documentation](https://docs.squirrelscan.com)
171
- - [AI Agent Skills](https://github.com/squirrelscan/skills)
202
+ - [AI Agent Integration](https://docs.squirrelscan.com/agents)
172
203
  - [Share Feedback](https://squirrelscan.com/feedback)
173
204
  - [Bugs, Issues & Feature Requests](https://github.com/squirrelscan/squirrelscan/issues)
174
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.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "squirrelscan",
3
- "version": "0.0.75",
4
- "description": "Website audit tool built for AI agents. 249+ SEO, performance & security rules from the CLI, your coding agent, the cloud, or MCP.",
3
+ "version": "0.0.77",
4
+ "description": "Website QA tool built for coding agents. 260+ rules across SEO, performance, security, accessibility & agent experience, from the CLI, cloud, or MCP.",
5
5
  "bin": {
6
6
  "squirrel": "bin/squirrel.js"
7
7
  },
@@ -16,35 +16,13 @@
16
16
  "bugs": {
17
17
  "url": "https://github.com/squirrelscan/squirrelscan/issues"
18
18
  },
19
- "keywords": [
20
- "seo",
21
- "audit",
22
- "cli",
23
- "website",
24
- "llm",
25
- "accessibility",
26
- "performance",
27
- "security",
28
- "crawler"
29
- ],
19
+ "keywords": ["seo", "audit", "cli", "website", "llm", "accessibility", "performance", "security", "crawler"],
30
20
  "author": "squirrelscan",
31
21
  "license": "UNLICENSED",
32
22
  "engines": {
33
23
  "node": ">=18"
34
24
  },
35
- "os": [
36
- "darwin",
37
- "linux",
38
- "win32"
39
- ],
40
- "cpu": [
41
- "x64",
42
- "arm64"
43
- ],
44
- "files": [
45
- "bin/",
46
- "lib/",
47
- "scripts/",
48
- "README.md"
49
- ]
25
+ "os": ["darwin", "linux", "win32"],
26
+ "cpu": ["x64", "arm64"],
27
+ "files": ["bin/", "lib/", "scripts/", "README.md"]
50
28
  }