cve-lite-cli 1.8.0 โ 1.9.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.
- package/README.md +86 -41
- package/dist/cli/args.js +19 -0
- package/dist/cli/help.js +2 -0
- package/dist/index.js +24 -0
- package/dist/output/html-reporter.js +431 -0
- package/dist/output/logo-base64.js +1 -0
- package/dist/output/owasp-logo-base64.js +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,22 @@
|
|
|
1
1
|
|
|
2
|
+
[](https://owasp.org/cve-lite-cli)
|
|
2
3
|
[](https://www.npmjs.com/package/cve-lite-cli)
|
|
3
4
|
[](https://www.npmjs.com/package/cve-lite-cli)
|
|
4
|
-
[](https://github.com/OWASP/cve-lite-cli/actions)
|
|
5
6
|
[](https://github.com/marketplace/actions/cve-lite-cli)
|
|
6
|
-
[](https://github.com/
|
|
7
|
+
[](https://github.com/OWASP/cve-lite-cli/blob/main/LICENSE)
|
|
8
|
+
[](https://github.com/OWASP/cve-lite-cli)
|
|
8
9
|
|
|
9
10
|
<div align="center">
|
|
10
|
-
<
|
|
11
|
+
<a href="https://owasp.org/cve-lite-cli">
|
|
12
|
+
<img src="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/logos-combined.svg" alt="CVE Lite CLI โ An OWASP Foundation Project" width="500"/>
|
|
13
|
+
</a>
|
|
11
14
|
|
|
12
15
|
<h1>CVE Lite CLI</h1>
|
|
13
|
-
|
|
16
|
+
|
|
17
|
+
**๐ Officially recognized as an [OWASP Incubator Project](https://owasp.org/cve-lite-cli)**
|
|
18
|
+
|
|
19
|
+
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects.<br/>Practical fix guidance. Offline support. Usage-aware reachability. Clear direct vs transitive visibility.</p>
|
|
14
20
|
|
|
15
21
|
<strong>Scan. Understand. Fix.</strong>
|
|
16
22
|
|
|
@@ -30,9 +36,10 @@
|
|
|
30
36
|
<a href="#quick-start">Quick Start</a> โข
|
|
31
37
|
<a href="#usage">Usage</a> โข
|
|
32
38
|
<a href="#what-it-looks-like">Screenshots</a> โข
|
|
39
|
+
<a href="docs/html-report.md">HTML Report</a> โข
|
|
33
40
|
<a href="docs/comparison.md">Compare</a> โข
|
|
34
41
|
<a href="docs/roadmap.md">Roadmap</a> โข
|
|
35
|
-
<a href="https://github.com/
|
|
42
|
+
<a href="https://github.com/OWASP/cve-lite-cli/blob/main/src/docs/CONTRIBUTING.md">Contributing</a>
|
|
36
43
|
</p>
|
|
37
44
|
</div>
|
|
38
45
|
|
|
@@ -60,6 +67,7 @@ It is built for the moment right before release: fast, local-first, and honest a
|
|
|
60
67
|
**Key differentiators:**
|
|
61
68
|
|
|
62
69
|
- **Copy-and-run fix commands** โ turns findings into package-manager-aware `npm install`, `pnpm add`, `yarn add`, or `bun add` commands you can run immediately
|
|
70
|
+
- **Usage-aware reachability scanning** โ uses static analysis to detect if vulnerable packages are actually imported in your code, cutting alert fatigue with `--usage` and `--only-used`
|
|
63
71
|
- **Direct vs transitive visibility** โ shows whether the risk comes from something you installed directly or a nested dependency
|
|
64
72
|
- **Offline advisory DB** โ sync advisory data ahead of time and scan with zero runtime API calls, useful for enterprise and restricted-network environments
|
|
65
73
|
- **No account required** โ no sign-up, no cloud dashboard, no source code upload
|
|
@@ -72,7 +80,8 @@ It is built for the moment right before release: fast, local-first, and honest a
|
|
|
72
80
|
| JS/TS lockfile scanning | โ
| โ
| โ
| โ
| โ
|
|
|
73
81
|
| npm + pnpm + Yarn + Bun support | โ
| โ | โ
| โ
| โ
|
|
|
74
82
|
| No account required | โ
| โ
| โ
| โ | โ |
|
|
75
|
-
|
|
|
83
|
+
| Free to use | โ
| โ
| โ
| โ | โ |
|
|
84
|
+
| Usage-aware reachability scanning | โ
| โ | โ | โ
| โ ๏ธ |
|
|
76
85
|
| Direct vs transitive visibility | โ
| โ ๏ธ | โ
| โ
| โ
|
|
|
77
86
|
| Copy-and-run fix commands | โ
| โ | โ | โ
| โ ๏ธ |
|
|
78
87
|
| Suggested remediation plan | โ
| โ | โ ๏ธ | โ
| โ ๏ธ |
|
|
@@ -85,30 +94,48 @@ For detailed per-tool analysis, see [Comparison with other tools](docs/compariso
|
|
|
85
94
|
|
|
86
95
|
## What it looks like
|
|
87
96
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
97
|
+
<table>
|
|
98
|
+
<tr>
|
|
99
|
+
<th align="center">Terminal output</th>
|
|
100
|
+
<th align="center">HTML dashboard (<code>--report</code>)</th>
|
|
101
|
+
</tr>
|
|
102
|
+
<tr>
|
|
103
|
+
<td align="center">
|
|
104
|
+
<a href="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/default-output.png">
|
|
105
|
+
<img src="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/default-output.png" alt="CVE Lite CLI terminal output" width="440"/>
|
|
106
|
+
</a>
|
|
107
|
+
</td>
|
|
108
|
+
<td align="center">
|
|
109
|
+
<a href="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/html-report-dashboard.png">
|
|
110
|
+
<img src="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/html-report-dashboard.png" alt="CVE Lite CLI HTML dashboard" width="440"/>
|
|
111
|
+
</a>
|
|
112
|
+
</td>
|
|
113
|
+
</tr>
|
|
114
|
+
<tr>
|
|
115
|
+
<td align="center"><sub>Default scan output ยท <a href="docs/how-to-read-verbose-output.md">verbose output guide</a></sub></td>
|
|
116
|
+
<td align="center"><sub>Generated with <code>--report</code> ยท <a href="docs/html-report.md">HTML report guide</a></sub></td>
|
|
117
|
+
</tr>
|
|
118
|
+
</table>
|
|
119
|
+
|
|
120
|
+
<details>
|
|
121
|
+
<summary>Verbose terminal output โ includes the full fix plan</summary>
|
|
96
122
|
<p align="center">
|
|
97
|
-
<a href="https://raw.githubusercontent.com/
|
|
98
|
-
|
|
99
|
-
|
|
123
|
+
<a href="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/verbose-output-1.png"><img src="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/verbose-output-1.png" alt="Verbose output part 1" width="280"/></a>
|
|
124
|
+
<a href="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/verbose-output-2.png"><img src="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/verbose-output-2.png" alt="Verbose output part 2" width="280"/></a>
|
|
125
|
+
<a href="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/verbose-output-3.png"><img src="https://raw.githubusercontent.com/OWASP/cve-lite-cli/main/assets/verbose-output-3.png" alt="Verbose output part 3" width="280"/></a>
|
|
100
126
|
</p>
|
|
127
|
+
</details>
|
|
101
128
|
|
|
102
|
-
|
|
129
|
+
## HTML vulnerability report (`--report`)
|
|
103
130
|
|
|
104
|
-
|
|
105
|
-
<a href="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-1.png"><img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-1.png" alt="Verbose output part 1" width="280"/></a>
|
|
106
|
-
<a href="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-2.png"><img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-2.png" alt="Verbose output part 2" width="280"/></a>
|
|
107
|
-
<a href="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-3.png"><img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-3.png" alt="Verbose output part 3" width="280"/></a>
|
|
108
|
-
</p>
|
|
109
|
-
<p align="center"><sub>Click any screenshot to enlarge</sub></p>
|
|
131
|
+
Generate a self-contained HTML dashboard from any scan โ severity cards, an interactive findings table, and copy-ready fix commands, all written to a local directory and opened automatically in your browser.
|
|
110
132
|
|
|
111
|
-
|
|
133
|
+
```bash
|
|
134
|
+
cve-lite /path/to/project --report
|
|
135
|
+
cve-lite /path/to/project --report ./my-report --no-open
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
See the [HTML Report guide](docs/html-report.md) for the full option reference and output details.
|
|
112
139
|
|
|
113
140
|
## Usage
|
|
114
141
|
|
|
@@ -137,6 +164,10 @@ cve-lite /path/to/project --fail-on high
|
|
|
137
164
|
# JSON output
|
|
138
165
|
cve-lite /path/to/project --json
|
|
139
166
|
|
|
167
|
+
# Generate an HTML vulnerability dashboard (opens in browser automatically)
|
|
168
|
+
cve-lite /path/to/project --report
|
|
169
|
+
cve-lite /path/to/project --report ./my-report --no-open
|
|
170
|
+
|
|
140
171
|
# Scan project source files to check if vulnerable dependencies are actually imported
|
|
141
172
|
cve-lite /path/to/project --usage
|
|
142
173
|
|
|
@@ -159,6 +190,10 @@ cve-lite /path/to/project --osv-url https://security.company.internal/osv
|
|
|
159
190
|
cve-lite --version
|
|
160
191
|
```
|
|
161
192
|
|
|
193
|
+
### Why is `--usage` an opt-in flag?
|
|
194
|
+
|
|
195
|
+
CVE Lite CLI is designed to be blazing fast. Scanning a lockfile is nearly instantaneous, whereas running static reachability analysis across thousands of source files takes significantly more time. Furthermore, static analysis can occasionally produce false negatives (e.g., if a package is used in a build script or dynamically imported at runtime). Making `--usage` opt-in ensures the default lockfile scan remains instant and strictly reflects your dependency graph, while giving you the option to aggressively filter out unreachable noise when triaging findings.
|
|
196
|
+
|
|
162
197
|
## Auto-fix mode (`--fix`)
|
|
163
198
|
|
|
164
199
|
`--fix` applies validated direct dependency fixes using your project's package manager, then rescans automatically.
|
|
@@ -196,27 +231,37 @@ See the [Offline Advisory DB guide](docs/offline-advisory-db.md) for the full wo
|
|
|
196
231
|
The project ships a first-party [GitHub Action on the Marketplace](https://github.com/marketplace/actions/cve-lite-cli):
|
|
197
232
|
|
|
198
233
|
```yaml
|
|
199
|
-
- uses:
|
|
234
|
+
- uses: OWASP/cve-lite-cli@v1
|
|
200
235
|
with:
|
|
201
236
|
verbose: "true"
|
|
202
237
|
fail-on: high
|
|
203
238
|
```
|
|
204
239
|
|
|
205
|
-
CVE Lite CLI also uses itself in CI to scan its own dependencies. See [`self-scan.yml`](https://github.com/
|
|
240
|
+
CVE Lite CLI also uses itself in CI to scan its own dependencies. See [`self-scan.yml`](https://github.com/OWASP/cve-lite-cli/blob/main/.github/workflows/self-scan.yml).
|
|
206
241
|
|
|
207
242
|
For full CI patterns including offline workflows, git hooks, and scripted automation, see the [CI and Workflow Integration guide](docs/ci-integration.md).
|
|
208
243
|
|
|
209
|
-
##
|
|
244
|
+
## Recognized by OWASP
|
|
245
|
+
|
|
246
|
+
CVE Lite CLI is an [OWASP Incubator Project](https://owasp.org/cve-lite-cli), peer-reviewed and maintained under the Open Web Application Security Project Foundation. Being part of OWASP means:
|
|
247
|
+
|
|
248
|
+
- **Peer-reviewed** by security professionals
|
|
249
|
+
- **Community-driven** development and governance
|
|
250
|
+
- **Vendor-neutral** with no commercial platform required
|
|
251
|
+
- **Open source** with transparent security practices and a minimal dependency footprint
|
|
210
252
|
|
|
211
|
-
|
|
253
|
+
**Where it fits in the OWASP ecosystem:**
|
|
212
254
|
|
|
213
|
-
|
|
255
|
+
CVE Lite CLI fills a specific gap โ fast, local-first JS/TS dependency scanning close to release time โ that broader OWASP tools are not optimized for:
|
|
214
256
|
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
257
|
+
| Tool | Focus |
|
|
258
|
+
|---|---|
|
|
259
|
+
| CVE Lite CLI | Lockfile-first, local developer CLI, remediation-focused, JS/TS |
|
|
260
|
+
| OWASP Dependency-Check | Multi-language, SAST-style, broader ecosystem |
|
|
261
|
+
| OWASP dep-scan | Multi-language and environment, SBOM and cloud-native |
|
|
262
|
+
| OWASP Dependency-Track | Platform and SBOM management, not a local CLI |
|
|
218
263
|
|
|
219
|
-
CVE Lite CLI complements these tools
|
|
264
|
+
CVE Lite CLI complements these tools. It is not a replacement for continuous monitoring or full SBOM management โ it is the fast local check you run before pushing.
|
|
220
265
|
|
|
221
266
|
## Real-world case studies
|
|
222
267
|
|
|
@@ -272,27 +317,27 @@ See [parser-coverage.md](docs/parser-coverage.md) for supported lockfile formats
|
|
|
272
317
|
|
|
273
318
|
Feedback on output clarity, remediation guidance, ecosystem coverage, and CI usage is especially valuable.
|
|
274
319
|
|
|
275
|
-
See [CONTRIBUTING.md](https://github.com/
|
|
320
|
+
See [CONTRIBUTING.md](https://github.com/OWASP/cve-lite-cli/blob/main/src/docs/CONTRIBUTING.md) to get started.
|
|
276
321
|
|
|
277
322
|
## Add a badge to your project
|
|
278
323
|
|
|
279
324
|
If you use CVE Lite CLI in your project, add this badge to your README:
|
|
280
325
|
|
|
281
326
|
```markdown
|
|
282
|
-
[](https://github.com/
|
|
327
|
+
[](https://github.com/OWASP/cve-lite-cli)
|
|
283
328
|
```
|
|
284
329
|
|
|
285
|
-
[](https://github.com/
|
|
330
|
+
[](https://github.com/OWASP/cve-lite-cli)
|
|
286
331
|
|
|
287
332
|
## Community and support
|
|
288
333
|
|
|
289
|
-
For bug reports and feature requests: [GitHub Issues](https://github.com/
|
|
334
|
+
For bug reports and feature requests: [GitHub Issues](https://github.com/OWASP/cve-lite-cli/issues)
|
|
290
335
|
|
|
291
336
|
Helpful feedback includes reproducible bug reports, real-world lockfile edge cases, ideas for clearer output and remediation guidance, and CI or JSON workflow examples.
|
|
292
337
|
|
|
293
|
-
For security-related reporting: [SECURITY.md](https://github.com/
|
|
338
|
+
For security-related reporting: [SECURITY.md](https://github.com/OWASP/cve-lite-cli/blob/main/src/docs/SECURITY.md)
|
|
294
339
|
|
|
295
|
-
If CVE Lite CLI helps your release workflow, a [GitHub star](https://github.com/
|
|
340
|
+
If CVE Lite CLI helps your release workflow, a [GitHub star](https://github.com/OWASP/cve-lite-cli) helps more developers find it.
|
|
296
341
|
|
|
297
342
|
## License
|
|
298
343
|
|
package/dist/cli/args.js
CHANGED
|
@@ -138,6 +138,25 @@ export function parseArgs(argv) {
|
|
|
138
138
|
options.usage = true;
|
|
139
139
|
continue;
|
|
140
140
|
}
|
|
141
|
+
if (arg === "--report") {
|
|
142
|
+
const next = argv[i + 1];
|
|
143
|
+
if (next !== undefined && !next.startsWith("-")) {
|
|
144
|
+
options.report = next;
|
|
145
|
+
i++;
|
|
146
|
+
}
|
|
147
|
+
else {
|
|
148
|
+
options.report = true;
|
|
149
|
+
}
|
|
150
|
+
continue;
|
|
151
|
+
}
|
|
152
|
+
if (arg.startsWith("--report=")) {
|
|
153
|
+
options.report = arg.slice("--report=".length);
|
|
154
|
+
continue;
|
|
155
|
+
}
|
|
156
|
+
if (arg === "--no-open") {
|
|
157
|
+
options.noOpen = true;
|
|
158
|
+
continue;
|
|
159
|
+
}
|
|
141
160
|
if (arg.startsWith("-"))
|
|
142
161
|
throw new Error(`Unknown option: ${arg}`);
|
|
143
162
|
if (!projectArg) {
|
package/dist/cli/help.js
CHANGED
|
@@ -31,6 +31,8 @@ export function printHelp() {
|
|
|
31
31
|
"",
|
|
32
32
|
"Scan options:",
|
|
33
33
|
" --json Print JSON output",
|
|
34
|
+
" --report [dir] Generate an HTML report in [dir] (default: ./cve-report)",
|
|
35
|
+
" --no-open Don't auto-open the report in the browser",
|
|
34
36
|
" --fix Apply validated direct dependency fixes and rescan",
|
|
35
37
|
" --osv-url <url> Use a custom OSV-compatible advisory endpoint",
|
|
36
38
|
" --verbose Show detailed output with fix plan, paths, and full table",
|
package/dist/index.js
CHANGED
|
@@ -17,6 +17,7 @@ import { scanProjectForPackageUsage } from "./usage/scanner.js";
|
|
|
17
17
|
import { getCliVersion } from "./utils/version-info.js";
|
|
18
18
|
import { isLikelyBlockedAdvisoryRequestError } from "./utils/network.js";
|
|
19
19
|
import { logInfo, logWarn, printCacheSummary, serializeFinding, sortFindingsForOutput } from "./output/formatters.js";
|
|
20
|
+
import { buildReportData, writeHtmlReport } from "./output/html-reporter.js";
|
|
20
21
|
import { printSummary, printActionSummary, printPriorityFixes, printFixPlan, printSuggestedFixCommands, printSuggestedFixCommandSkips, printCoverage, printSkippedDependencies, printGroupSummary, printTable, printPathHints, printFinalStatus, printCompactOutput } from "./output/printers.js";
|
|
21
22
|
let parsedArgs = null;
|
|
22
23
|
try {
|
|
@@ -87,6 +88,9 @@ if (parsedArgs) {
|
|
|
87
88
|
if (options.fix && options.json) {
|
|
88
89
|
throw new Error("--fix cannot be used with --json");
|
|
89
90
|
}
|
|
91
|
+
if (options.report && options.json) {
|
|
92
|
+
throw new Error("--report cannot be used with --json");
|
|
93
|
+
}
|
|
90
94
|
let advisorySourceLine;
|
|
91
95
|
let advisoryDbFreshnessLine = null;
|
|
92
96
|
let advisoryDbWarning = null;
|
|
@@ -220,6 +224,26 @@ if (parsedArgs) {
|
|
|
220
224
|
// Simplified output - cleaner, focused view
|
|
221
225
|
printCompactOutput(scanState.sorted, scanInput);
|
|
222
226
|
}
|
|
227
|
+
if (options.report) {
|
|
228
|
+
const outputDir = path.resolve(typeof options.report === "string" ? options.report : "./cve-report");
|
|
229
|
+
const reportData = buildReportData({
|
|
230
|
+
projectPath,
|
|
231
|
+
cliVersion,
|
|
232
|
+
packageManager: scanInput.source,
|
|
233
|
+
lockfileSource: scanInput.filePath ? path.basename(scanInput.filePath) : scanInput.source,
|
|
234
|
+
packageCount: packages.length,
|
|
235
|
+
findings: scanState.sorted,
|
|
236
|
+
suggestedFixCommands: scanState.suggestedFixCommands,
|
|
237
|
+
notes: [...scanInput.notes, ...scanState.coverage],
|
|
238
|
+
warnings: scanInput.warnings,
|
|
239
|
+
});
|
|
240
|
+
const { reportPath } = await writeHtmlReport({
|
|
241
|
+
outputDir,
|
|
242
|
+
data: reportData,
|
|
243
|
+
autoOpen: !options.noOpen,
|
|
244
|
+
});
|
|
245
|
+
console.log(`${chalk.gray("Report:")} ${chalk.cyan(reportPath)}`);
|
|
246
|
+
}
|
|
223
247
|
const failLevel = normalizeSeverity(options.failOn);
|
|
224
248
|
const shouldFail = scanState.sorted.some(f => severityOrder[f.severity] >= severityOrder[failLevel]);
|
|
225
249
|
process.exit(shouldFail ? 1 : 0);
|