coverme-scanner 1.0.25 → 1.2.0

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.
@@ -1,6 +1,6 @@
1
1
  # CoverMe - Ultimate AI Security Scanner
2
2
 
3
- The most comprehensive AI-powered code scanner. 10 specialized agents + 3 validators + deep analysis.
3
+ The most comprehensive AI-powered code scanner. 15 specialized agents + 3 validators + deep analysis.
4
4
 
5
5
  $ARGUMENTS
6
6
 
@@ -10,7 +10,7 @@ $ARGUMENTS
10
10
  2. **DO NOT STOP FOR CONFIRMATION** - Just keep going through all phases
11
11
  3. **DO NOT ASK ABOUT FILE CHANGES** - Automatically update/overwrite scan.json
12
12
  4. **DO NOT ASK TO OPEN REPORT** - Just open it automatically at the end
13
- 5. **COMPLETE EVERYTHING IN ONE GO** - All 5 phases without interruption
13
+ 5. **COMPLETE EVERYTHING IN ONE GO** - All 6 phases without interruption
14
14
  6. **RUN AGENTS IN BACKGROUND** - Use `run_in_background: true` for all Task tool calls
15
15
  7. **RUN BASH IN BACKGROUND** - Use `run_in_background: true` for long Bash commands
16
16
 
@@ -18,9 +18,27 @@ Execute ALL phases automatically. Do NOT stop until the HTML report is open.
18
18
 
19
19
  ---
20
20
 
21
- ## Phase 0: Load Custom Agents (if exists)
21
+ ## Phase 0: Project Discovery & Load Custom Agents
22
22
 
23
- **FIRST**, check if `.coverme/agents.json` exists:
23
+ ### Step 1: Understand the Project
24
+ Before scanning, understand what you're scanning. Run these commands:
25
+ ```bash
26
+ # Get project info
27
+ cat package.json 2>/dev/null | head -20
28
+ cat README.md 2>/dev/null | head -50
29
+ ls -la
30
+ ```
31
+
32
+ Create a mental model of:
33
+ - **Project type**: Backend API, Frontend SPA, Full-stack, CLI tool, Library, etc.
34
+ - **Tech stack**: Node.js, Python, React, Next.js, etc.
35
+ - **Main purpose**: What does this project do? (1-2 sentences)
36
+ - **Architecture**: Monolith, microservices, serverless, etc.
37
+
38
+ This context will be included in the final report.
39
+
40
+ ### Step 2: Load Custom Agents (if exists)
41
+ Check if `.coverme/agents.json` exists:
24
42
  ```bash
25
43
  cat .coverme/agents.json 2>/dev/null || echo "NO_CUSTOM_AGENTS"
26
44
  ```
package/README.md CHANGED
@@ -1,127 +1,416 @@
1
- # CoverMe Scanner
1
+ <div align="center">
2
2
 
3
- **Multi-Agent AI Code Scanner for Claude Code**
3
+ # CoverMe
4
4
 
5
- One command. 7 AI agents. Complete code analysis with cross-validation.
5
+ ### The Most Comprehensive AI Security Scanner for Your Codebase
6
+
7
+ **21 AI Agents | Auto-Detection | Zero Config | One Command**
8
+
9
+ [![npm version](https://img.shields.io/npm/v/coverme-scanner.svg?style=flat-square)](https://www.npmjs.com/package/coverme-scanner)
10
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
11
+ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
12
+
13
+ <img src="https://raw.githubusercontent.com/vibecode/coverme-scanner/main/assets/demo.gif" alt="CoverMe Demo" width="600">
14
+
15
+ [Quick Start](#quick-start) | [Features](#features) | [Agents](#-21-specialized-agents) | [Reports](#-beautiful-reports) | [Custom Agents](#-custom-agents)
16
+
17
+ </div>
18
+
19
+ ---
20
+
21
+ ## Why CoverMe?
22
+
23
+ Traditional security scanners are **noisy** (too many false positives) and **blind** (miss context-specific issues).
24
+
25
+ CoverMe is different:
26
+
27
+ | Traditional Scanners | CoverMe |
28
+ |---------------------|---------|
29
+ | Single-pass analysis | **21 specialized AI agents** working in parallel |
30
+ | Pattern matching | **Deep understanding** of your code's intent |
31
+ | Generic rules | **Auto-detects** your stack and adapts |
32
+ | 60%+ false positives | **Cross-validation** eliminates noise |
33
+ | Requires configuration | **Zero config** - just run it |
34
+
35
+ ---
6
36
 
7
37
  ## Quick Start
8
38
 
9
39
  ```bash
10
- # Install
40
+ # Install globally
11
41
  npm install -g coverme-scanner
12
42
 
13
- # Initialize in your project
43
+ # Initialize in your project (one-time)
14
44
  coverme init
15
45
 
16
- # In Claude Code, run:
46
+ # Run the scan (in Claude Code)
17
47
  /coverme
18
48
  ```
19
49
 
20
- That's it! The scan will analyze your codebase and generate an HTML report.
50
+ **That's it.** Watch 21 AI agents analyze your entire codebase and generate a beautiful HTML report.
51
+
52
+ ---
53
+
54
+ ## Features
55
+
56
+ ### Auto-Detection
57
+
58
+ CoverMe automatically detects your stack and adapts its scanning:
59
+
60
+ | Category | Auto-Detected |
61
+ |----------|---------------|
62
+ | **Auth** | OAuth, JWT, Session, Clerk, Auth0, NextAuth, Supabase Auth, Firebase, Passport.js, API Keys |
63
+ | **Database** | PostgreSQL, MySQL, MongoDB, Redis, DynamoDB, Supabase, Prisma, TypeORM, Drizzle, PlanetScale, Neon, Turso |
64
+ | **Framework** | React, Next.js, Express, Fastify, NestJS, Django, FastAPI, Flask |
65
+ | **AI/LLM** | OpenAI, Anthropic, LangChain, Ollama, HuggingFace, Bedrock, Vertex AI |
66
+ | **Infra** | Docker, Kubernetes, Terraform, GitHub Actions, GitLab CI |
67
+
68
+ ### Smart Skipping
69
+
70
+ Agents that aren't relevant to your project **automatically skip**:
71
+ - No AI code? AI Security Scanner skips.
72
+ - No Redis? Redis Scanner skips.
73
+ - No enclaves? Enclave Scanner skips.
74
+
75
+ **Zero noise. Maximum relevance.**
76
+
77
+ ---
78
+
79
+ ## 21 Specialized Agents
80
+
81
+ <details>
82
+ <summary><b>Security Agents (Click to expand)</b></summary>
83
+
84
+ | Agent | What It Finds |
85
+ |-------|---------------|
86
+ | **Security Core** | OWASP Top 10, SQL/NoSQL injection, XSS, Command injection, SSRF, Path traversal |
87
+ | **Auth & Session** | OAuth flaws, JWT vulnerabilities, session fixation, cookie security, MFA bypass |
88
+ | **API Security** | CORS misconfiguration, rate limiting, IDOR, mass assignment, webhook security |
89
+ | **Database** | SQL injection, ORM-specific issues, connection security, RLS bypass |
90
+ | **Redis & Cache** | KEYS command abuse, Lua injection, cache poisoning, session security |
91
+ | **AI/LLM** | Prompt injection, content filter bypass, PII in prompts, jailbreak vectors |
92
+
93
+ </details>
94
+
95
+ <details>
96
+ <summary><b>Quality & Architecture Agents (Click to expand)</b></summary>
97
+
98
+ | Agent | What It Finds |
99
+ |-------|---------------|
100
+ | **Infrastructure** | Docker security, K8s misconfig, CI/CD secrets, IaC issues |
101
+ | **Data & Privacy** | PII exposure, GDPR violations, encryption gaps, data retention |
102
+ | **Performance** | N+1 queries, memory leaks, ReDoS, blocking operations |
103
+ | **Business Logic** | Race conditions, TOCTOU, workflow bypass, pricing exploits |
104
+ | **Code Quality** | Complexity, dead code, error handling, anti-patterns |
105
+ | **Dead Code** | Unused dependencies, unreachable code, stale feature flags |
106
+
107
+ </details>
108
+
109
+ <details>
110
+ <summary><b>Validation Agents (Click to expand)</b></summary>
111
+
112
+ | Agent | What It Does |
113
+ |-------|--------------|
114
+ | **Design Decision Detector** | Identifies intentional patterns to prevent false positives |
115
+ | **Context-Aware Validator** | Understands deployment context (K8s, API gateway, WAF) |
116
+ | **Network & Architecture** | Service boundaries, trust zones, NetworkPolicy gaps |
117
+ | **Resilience & Fallback** | Circuit breakers, retry patterns, graceful degradation |
118
+ | **Testing & Reliability** | Test coverage gaps, missing health checks |
119
+ | **Duplicate Scanner** | Finds existing solutions in your codebase |
120
+ | **Executive Summary** | Generates high-level risk overview |
121
+
122
+ </details>
123
+
124
+ ---
125
+
126
+ ## Beautiful Reports
127
+
128
+ CoverMe generates **professional HTML reports** with:
129
+
130
+ <table>
131
+ <tr>
132
+ <td width="50%">
133
+
134
+ **Executive Summary**
135
+ - Risk level assessment
136
+ - Top risks bullet points
137
+ - Findings by owner (Dev/DevOps/Architect)
138
+
139
+ **Project Overview**
140
+ - Auto-detected stack
141
+ - Architecture type
142
+ - Key components
143
+
144
+ </td>
145
+ <td width="50%">
146
+
147
+ **Detailed Findings**
148
+ - Severity scoring (DREAD)
149
+ - Code snippets with line numbers
150
+ - Copy-paste fix recommendations
151
+ - Claude Code prompts ready to use
152
+
153
+ **Smart Filtering**
154
+ - By severity
155
+ - By file
156
+ - By category
157
+ - By owner
158
+
159
+ </td>
160
+ </tr>
161
+ </table>
162
+
163
+ ### Sample Report Sections
164
+
165
+ ```
166
+ Executive Summary
167
+ -----------------
168
+ Risk Level: HIGH
169
+
170
+ Top Risks:
171
+ - SQL injection in user search allows database access
172
+ - Missing rate limiting enables brute force attacks
173
+ - Admin API exposed without IP restriction
174
+
175
+ Findings by Owner:
176
+ Developer: 5
177
+ DevOps: 3
178
+ Architect: 1
179
+ ```
180
+
181
+ ---
182
+
183
+ ## Custom Agents
184
+
185
+ Add your own specialized agents in seconds:
186
+
187
+ ```bash
188
+ # Add a custom agent
189
+ coverme agent add "John" "Check all .env files for exposed secrets"
190
+ coverme agent add "Sarah" "Find regex patterns vulnerable to ReDoS"
191
+ coverme agent add "Compliance" "Check for GDPR and PCI-DSS violations"
192
+
193
+ # List your agents
194
+ coverme agent list
195
+
196
+ # Remove an agent
197
+ coverme agent remove "John"
198
+ ```
199
+
200
+ Your custom agents run **alongside the 21 built-in agents** and appear in the same report.
201
+
202
+ ---
21
203
 
22
204
  ## How It Works
23
205
 
24
206
  ```
25
- ┌─────────────────────────────────────────────────────────────────┐
26
- │ COVERME ORCHESTRATOR │
27
- ├─────────────────────────────────────────────────────────────────┤
28
- │ │
29
- Phase 1: DISCOVERY (5 agents in parallel) │
30
- │ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌────────┐│
31
- │ │ Security │ │ Quality │ │ Arch │ │ Deps │ │ Perf ││
32
- │ │ Agent │ │ Agent │ │ Agent │ │ Agent │ Agent ││
33
- │ └────┬─────┘ └────┬─────┘ └────┬─────┘ └────┬─────┘ └───┬────┘│
34
- │ │ │ │ │ │
35
- │ └────────────┴────────────┴────────────┴───────────┘ │
36
- │ │ │
37
- │ ▼ │
38
- Phase 2: CROSS-VALIDATION (2 agents in parallel) │
39
- │ ┌──────────────────────────────────────────────────────────┐
40
- │ │ Cross-Validator: Challenge findings, find false positives │
41
- │ │ Deep-Dive Expert: Analyze disputed/complex issues │
42
- │ └──────────────────────────────────────────────────────────┘
43
- │ │ │
44
- │ ▼ │
45
- Phase 3: CONSENSUS & REPORT │
46
- ┌──────────────────────────────────────────────────────────┐ │
47
- │ │ Merge findings, calculate confidence, generate report │
48
- │ └──────────────────────────────────────────────────────────┘
49
- │ │
50
- └─────────────────────────────────────────────────────────────────┘
51
- ```
52
-
53
- ## What It Finds
54
-
55
- ### Security Issues
56
- - SQL/NoSQL Injection
57
- - Cross-Site Scripting (XSS)
58
- - Command Injection
59
- - Authentication/Authorization flaws
60
- - Hardcoded secrets
61
- - SSRF, Path Traversal
62
-
63
- ### Code Quality
64
- - DRY violations
65
- - High complexity functions
66
- - Dead code
67
- - Anti-patterns
68
- - Error handling problems
69
-
70
- ### Architecture Issues
71
- - Layer violations
72
- - Circular dependencies
73
- - Missing abstractions
74
- - Coupling problems
75
-
76
- ### Dependency Issues
77
- - Known CVEs
78
- - Outdated packages
79
- - License compliance
80
-
81
- ### Performance Issues
82
- - N+1 queries
83
- - Memory leaks
84
- - Blocking operations
85
-
86
- ## Why Multi-Agent?
87
-
88
- Traditional scanners have high false positive rates. CoverMe uses a unique approach:
89
-
90
- 1. **Multiple perspectives**: 5 specialized agents scan independently
91
- 2. **Cross-validation**: 2 validators challenge the findings
92
- 3. **Consensus**: Only high-confidence findings make the report
93
-
94
- This results in:
95
- - **Lower false positive rate** - Validators catch mistakes
96
- - **Higher coverage** - Multiple agents find different issues
97
- - **Confidence scores** - Know how certain each finding is
98
-
99
- ## Report Output
100
-
101
- The scan produces an HTML report in `.coverme/` folder:
102
-
103
- - **Score** - A-F grade with severity breakdown
104
- - **Critical/High/Medium/Low Issues** - With code context and fixes
105
- - **Claude Code Prompts** - Copy-paste ready fix instructions
106
- - **Positive Observations** - Good patterns found in your code
107
-
108
- ## Requirements
109
-
110
- - Claude Code CLI installed and authenticated
111
- - Node.js 18+
207
+ COVERME ORCHESTRATOR
208
+ ________________________________________________________________
209
+ | |
210
+ | PHASE 0: PROJECT DISCOVERY |
211
+ | [Auto-detect stack, auth, databases, frameworks] |
212
+ |________________________________________________________________|
213
+ | |
214
+ | PHASE 1: PARALLEL DISCOVERY (21 agents) |
215
+ | |
216
+ | Security Auth API Infra Data AI/LLM |
217
+ | | | | | | | |
218
+ | Database Redis Quality Logic Perf Dead |
219
+ | | | | | | | |
220
+ | PII Resil Network Design CTX Custom... |
221
+ | | | | | | | |
222
+ | +----+----+--------+----+----+--------+----+---+ |
223
+ | | | | |
224
+ | v v v |
225
+ |________________________________________________________________|
226
+ | |
227
+ | PHASE 2: CROSS-VALIDATION |
228
+ | [Challenge findings, find mitigations, detect false positives]|
229
+ |________________________________________________________________|
230
+ | |
231
+ | PHASE 3: CONSENSUS |
232
+ | [Merge, dedupe, calculate confidence, generate report] |
233
+ |________________________________________________________________|
234
+ ```
235
+
236
+ ---
237
+
238
+ ## Installation
239
+
240
+ ### Requirements
241
+
242
+ - **Node.js 18+**
243
+ - **Claude Code** CLI installed and authenticated
112
244
  - No external API keys needed (uses your Claude Code session)
113
245
 
114
- ## Commands
246
+ ### Install
247
+
248
+ ```bash
249
+ npm install -g coverme-scanner
250
+ ```
251
+
252
+ ### Initialize (once per project)
253
+
254
+ ```bash
255
+ cd your-project
256
+ coverme init
257
+ ```
258
+
259
+ This creates:
260
+ - `.coverme/` folder for reports
261
+ - `.claude/commands/coverme.md` slash command
262
+
263
+ ### Run
264
+
265
+ In Claude Code:
266
+ ```
267
+ /coverme
268
+ ```
269
+
270
+ Or with arguments:
271
+ ```
272
+ /coverme src/
273
+ ```
274
+
275
+ ---
276
+
277
+ ## CLI Commands
115
278
 
116
279
  ```bash
117
- # Initialize in current project
280
+ # Initialize CoverMe in a project
118
281
  coverme init
119
282
 
120
- # Generate report from JSON
283
+ # Generate HTML report from JSON
121
284
  coverme report scan.json -f html -o report.html
285
+
286
+ # Custom Agents
287
+ coverme agent add "Name" "Task description"
288
+ coverme agent list
289
+ coverme agent remove "Name"
290
+
291
+ # Help
292
+ coverme --help
293
+ ```
294
+
295
+ ---
296
+
297
+ ## Configuration
298
+
299
+ CoverMe works **zero-config** out of the box, but you can customize:
300
+
301
+ ### Custom Agents
302
+
303
+ Create `.coverme/agents.json`:
304
+
305
+ ```json
306
+ {
307
+ "agents": [
308
+ { "name": "Security Lead", "task": "Review all auth flows for OWASP compliance" },
309
+ { "name": "Performance", "task": "Find N+1 queries and memory leaks" }
310
+ ]
311
+ }
312
+ ```
313
+
314
+ ### Ignore Patterns
315
+
316
+ Add to `.coverme/config.json`:
317
+
318
+ ```json
319
+ {
320
+ "ignore": [
321
+ "node_modules",
322
+ "dist",
323
+ "*.test.ts",
324
+ "**/__mocks__/**"
325
+ ]
326
+ }
327
+ ```
328
+
329
+ ---
330
+
331
+ ## FAQ
332
+
333
+ <details>
334
+ <summary><b>How long does a scan take?</b></summary>
335
+
336
+ Typically 2-5 minutes depending on codebase size. All 21 agents run in parallel.
337
+
338
+ </details>
339
+
340
+ <details>
341
+ <summary><b>Does it send my code anywhere?</b></summary>
342
+
343
+ CoverMe runs entirely through your local Claude Code session. Your code is processed by the same Claude API you're already using.
344
+
345
+ </details>
346
+
347
+ <details>
348
+ <summary><b>Can I use it in CI/CD?</b></summary>
349
+
350
+ Not yet, but it's on the roadmap. Currently CoverMe requires an interactive Claude Code session.
351
+
352
+ </details>
353
+
354
+ <details>
355
+ <summary><b>What languages does it support?</b></summary>
356
+
357
+ Any language Claude understands: TypeScript, JavaScript, Python, Go, Rust, Java, C#, Ruby, PHP, and more.
358
+
359
+ </details>
360
+
361
+ <details>
362
+ <summary><b>How do I reduce false positives?</b></summary>
363
+
364
+ CoverMe already has multiple validation agents that eliminate most false positives. For remaining cases:
365
+ 1. Add comments like `// Intentional: ...` to document design decisions
366
+ 2. Create custom agents for your specific patterns
367
+ 3. The Design Decision Detector will learn from these
368
+
369
+ </details>
370
+
371
+ ---
372
+
373
+ ## Roadmap
374
+
375
+ - [ ] CI/CD integration (GitHub Action)
376
+ - [ ] VS Code extension
377
+ - [ ] Baseline comparison (diff between scans)
378
+ - [ ] Custom rule definitions
379
+ - [ ] Team dashboard
380
+ - [ ] Slack/Discord notifications
381
+
382
+ ---
383
+
384
+ ## Contributing
385
+
386
+ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) first.
387
+
388
+ ```bash
389
+ # Clone the repo
390
+ git clone https://github.com/vibecode/coverme-scanner.git
391
+
392
+ # Install dependencies
393
+ npm install
394
+
395
+ # Build
396
+ npm run build
397
+
398
+ # Test locally
399
+ npm link
122
400
  ```
123
401
 
402
+ ---
403
+
124
404
  ## License
125
405
 
126
- MIT
406
+ MIT - see [LICENSE](LICENSE)
407
+
408
+ ---
409
+
410
+ <div align="center">
411
+
412
+ **Built with Claude Code**
413
+
414
+ [Report Bug](https://github.com/vibecode/coverme-scanner/issues) | [Request Feature](https://github.com/vibecode/coverme-scanner/issues) | [Star on GitHub](https://github.com/vibecode/coverme-scanner)
127
415
 
416
+ </div>