cve-lite-cli 1.0.1 → 1.0.3
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 +197 -60
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -4,6 +4,48 @@ Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript pr
|
|
|
4
4
|
|
|
5
5
|
**CVE Lite CLI** helps developers scan their projects for known package vulnerabilities without signing up for an expensive platform. It is built for the moment right before release, when you want a clear answer, a practical fix plan, and a tool you can actually afford to use.
|
|
6
6
|
|
|
7
|
+
## Quick start
|
|
8
|
+
|
|
9
|
+
Install globally:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g cve-lite-cli
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Then run:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
cve-lite /path/to/project
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Or run it one-off with `npx`:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npx cve-lite-cli /path/to/project
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Common examples:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Basic scan
|
|
31
|
+
cve-lite /path/to/project
|
|
32
|
+
|
|
33
|
+
# Show all findings
|
|
34
|
+
cve-lite /path/to/project --all
|
|
35
|
+
|
|
36
|
+
# Focus only on urgent findings
|
|
37
|
+
cve-lite /path/to/project --min-severity high
|
|
38
|
+
|
|
39
|
+
# Fail a build on high severity and above
|
|
40
|
+
cve-lite /path/to/project --fail-on high
|
|
41
|
+
|
|
42
|
+
# JSON output
|
|
43
|
+
cve-lite /path/to/project --json
|
|
44
|
+
|
|
45
|
+
# SARIF output
|
|
46
|
+
cve-lite /path/to/project --sarif --output reports/scan.sarif
|
|
47
|
+
```
|
|
48
|
+
|
|
7
49
|
## What it looks like
|
|
8
50
|
|
|
9
51
|
Below is a real example of the console experience. In a terminal, the severity labels, summaries, and section headers are colorized for readability.
|
|
@@ -17,24 +59,73 @@ The final status line also gives the scan a clear ending, which makes terminal u
|
|
|
17
59
|
|
|
18
60
|
## Why this tool exists
|
|
19
61
|
|
|
20
|
-
A lot of developers want
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
62
|
+
A lot of developers want a practical dependency scan right before release, but they do not want the cost, complexity, or friction of a larger platform just to answer a simple question:
|
|
63
|
+
|
|
64
|
+
**Do we have known vulnerable packages in this project, and what should we fix first?**
|
|
65
|
+
|
|
66
|
+
CVE Lite CLI is built for that workflow.
|
|
67
|
+
|
|
68
|
+
It focuses on being:
|
|
69
|
+
|
|
70
|
+
- fast
|
|
71
|
+
- local-first
|
|
72
|
+
- easy to understand
|
|
73
|
+
- useful in CI
|
|
74
|
+
- honest about what it does and does not do
|
|
75
|
+
|
|
76
|
+
## Project scope and differentiation
|
|
77
|
+
|
|
78
|
+
CVE Lite CLI is intentionally focused.
|
|
79
|
+
|
|
80
|
+
It is built for JavaScript and TypeScript dependency scanning, especially in the workflows where developers want a fast local check before release or a simple CI gate during dependency review.
|
|
81
|
+
|
|
82
|
+
The project emphasizes:
|
|
83
|
+
|
|
84
|
+
- npm, pnpm, and Yarn lockfile support
|
|
85
|
+
- direct vs transitive visibility
|
|
86
|
+
- top-priority fixes and a suggested remediation plan
|
|
87
|
+
- JSON and SARIF output for automation
|
|
88
|
+
- a small, reviewable runtime footprint
|
|
89
|
+
|
|
90
|
+
That narrow scope is deliberate. CVE Lite CLI is not trying to be a full application security platform or a broad multi-surface scanner. It is trying to be a lightweight, understandable, developer-first tool for teams that want practical vulnerability scanning without extra cost or complexity.
|
|
91
|
+
|
|
92
|
+
## Relationship to similar OWASP projects
|
|
93
|
+
|
|
94
|
+
CVE Lite CLI is not trying to replace broader OWASP security tooling.
|
|
24
95
|
|
|
25
|
-
|
|
96
|
+
Its role is narrower and workflow-focused:
|
|
26
97
|
|
|
27
|
-
|
|
98
|
+
- focused on JavaScript and TypeScript dependency scanning
|
|
99
|
+
- designed for fast local checks and simple CI release gates
|
|
100
|
+
- centered on direct vs transitive visibility
|
|
101
|
+
- built to highlight top-priority fixes and a suggested remediation plan
|
|
102
|
+
- intentionally lightweight in runtime footprint and setup
|
|
103
|
+
|
|
104
|
+
This section is here to make the scope clear. CVE Lite CLI aims to complement the broader security ecosystem by being a practical, low-friction option for JS/TS dependency checks close to release time.
|
|
105
|
+
|
|
106
|
+
## How it works
|
|
107
|
+
|
|
108
|
+
CVE Lite CLI follows a simple workflow:
|
|
109
|
+
|
|
110
|
+
1. Read a supported lockfile from your project.
|
|
111
|
+
2. Resolve package names and versions locally.
|
|
112
|
+
3. Match those packages against OSV advisory data.
|
|
113
|
+
4. Classify findings as direct or transitive where possible.
|
|
114
|
+
5. Highlight the most important fixes first.
|
|
115
|
+
6. Produce terminal, JSON, or SARIF output.
|
|
116
|
+
|
|
117
|
+
The goal is to keep vulnerability scanning practical, understandable, and easy to act on.
|
|
28
118
|
|
|
29
119
|
## What makes it stand out
|
|
30
120
|
|
|
31
|
-
|
|
121
|
+
- **fast, low-friction workflow**
|
|
122
|
+
Run it locally against a project without adopting a large security platform.
|
|
32
123
|
|
|
33
|
-
- **
|
|
34
|
-
|
|
124
|
+
- **practical remediation guidance**
|
|
125
|
+
It does not stop at raw advisory output. It highlights top-priority fixes and suggests a fix plan.
|
|
35
126
|
|
|
36
|
-
- **
|
|
37
|
-
|
|
127
|
+
- **direct vs transitive visibility**
|
|
128
|
+
The output makes it easier to see whether the risk comes from something you installed directly or from a nested package.
|
|
38
129
|
|
|
39
130
|
- **developer-first**
|
|
40
131
|
It is optimized for developers working with npm, pnpm, and Yarn lockfiles.
|
|
@@ -144,91 +235,116 @@ CVE Lite CLI is a good fit for:
|
|
|
144
235
|
- developers who want a second opinion alongside other tools
|
|
145
236
|
- OSS maintainers who need a practical scan before publishing
|
|
146
237
|
|
|
147
|
-
##
|
|
238
|
+
## Supported workflows
|
|
239
|
+
|
|
240
|
+
### Local development
|
|
148
241
|
|
|
149
|
-
|
|
242
|
+
Run it before a release, during dependency cleanup, or after a major package upgrade.
|
|
150
243
|
|
|
151
|
-
|
|
152
|
-
npm install -g cve-lite-cli
|
|
153
|
-
```
|
|
244
|
+
### CI/CD
|
|
154
245
|
|
|
155
|
-
|
|
246
|
+
This repository also uses CVE Lite CLI in its own GitHub Actions workflow to scan itself as part of CI. See [`self-scan.yml`](./.github/workflows/self-scan.yml).
|
|
247
|
+
|
|
248
|
+
Use it as a release gate in CI:
|
|
156
249
|
|
|
157
250
|
```bash
|
|
158
|
-
cve-lite
|
|
251
|
+
cve-lite . --fail-on high
|
|
159
252
|
```
|
|
160
253
|
|
|
161
|
-
|
|
254
|
+
Export SARIF in CI:
|
|
162
255
|
|
|
163
256
|
```bash
|
|
164
|
-
|
|
257
|
+
cve-lite . --sarif --output reports/scan.sarif
|
|
165
258
|
```
|
|
166
259
|
|
|
167
|
-
|
|
260
|
+
### Scripted automation
|
|
168
261
|
|
|
169
|
-
|
|
262
|
+
Use JSON output for custom reporting:
|
|
170
263
|
|
|
171
264
|
```bash
|
|
172
|
-
cve-lite
|
|
265
|
+
cve-lite . --json > cve-lite-report.json
|
|
173
266
|
```
|
|
174
267
|
|
|
175
|
-
|
|
268
|
+
## Comparison with other tools
|
|
176
269
|
|
|
177
|
-
|
|
178
|
-
cve-lite /path/to/project --all
|
|
179
|
-
```
|
|
270
|
+
CVE Lite CLI is not trying to be everything for everyone. It is designed to be one of the easiest and most actionable vulnerability scanners for JavaScript and TypeScript developers who want fast release-time checks without the cost and complexity of a full security platform.
|
|
180
271
|
|
|
181
|
-
|
|
272
|
+
### Where CVE Lite CLI stands out
|
|
182
273
|
|
|
183
|
-
|
|
184
|
-
cve-lite /path/to/project --min-severity high
|
|
185
|
-
```
|
|
274
|
+
Compared with other tools in this space, CVE Lite CLI focuses on:
|
|
186
275
|
|
|
187
|
-
|
|
276
|
+
- **free to use**
|
|
277
|
+
- **fast to run**
|
|
278
|
+
- **easy to understand**
|
|
279
|
+
- **practical remediation guidance** instead of just raw advisory dumps
|
|
280
|
+
- **clear direct vs transitive visibility**
|
|
281
|
+
- **top priority fixes** and a suggested fix plan
|
|
282
|
+
- support for **npm**, **pnpm**, and **Yarn** lockfiles
|
|
283
|
+
- **SARIF** and **JSON** output for CI and automation
|
|
284
|
+
- a **lightweight**, **security-conscious** dependency footprint
|
|
285
|
+
- a **developer-friendly** option for teams that want useful **CVE scanning without paying for a larger commercial product**
|
|
188
286
|
|
|
189
|
-
|
|
190
|
-
cve-lite /path/to/project --fail-on high
|
|
191
|
-
```
|
|
287
|
+
### At a glance
|
|
192
288
|
|
|
193
|
-
JSON
|
|
289
|
+
| Tool | Best at | Ecosystem scope | Lockfile support | Guided remediation | JSON/SARIF | Best fit |
|
|
290
|
+
|---|---|---|---|---|---|---|
|
|
291
|
+
| **CVE Lite CLI** | Fast, developer-friendly pre-release CVE scanning | Focused on JS/TS | npm, pnpm, Yarn | **Yes** | **Yes** | Developers and small teams who want a free, practical release-time check |
|
|
292
|
+
| `npm audit` | Built-in npm auditing | npm-centric | npm | Basic remediation info | Limited compared to dedicated scanner workflows | Teams already living fully inside npm |
|
|
293
|
+
| OSV-Scanner | Broad multi-ecosystem scanning | Broad | Many ecosystems and lockfiles | More general-purpose | Strong machine-readable workflows | Teams needing wider ecosystem coverage |
|
|
294
|
+
| Snyk CLI | Broader enterprise security workflows | Broad | Strong ecosystem coverage | Strong commercial guidance | Strong | Teams adopting a larger security platform |
|
|
295
|
+
| Socket CLI | Broader package and supply-chain risk visibility | Broad | Multi-ecosystem/package-risk focus | Strong for package risk workflows | Strong | Teams that want more than CVE scanning alone |
|
|
194
296
|
|
|
195
|
-
|
|
196
|
-
cve-lite /path/to/project --json
|
|
197
|
-
```
|
|
297
|
+
### CVE Lite CLI vs npm audit
|
|
198
298
|
|
|
199
|
-
|
|
299
|
+
`npm audit` is the built-in default for npm users, which makes it convenient when your workflow is entirely npm-based.
|
|
200
300
|
|
|
201
|
-
|
|
202
|
-
cve-lite /path/to/project --sarif --output reports/scan.sarif
|
|
203
|
-
```
|
|
301
|
+
CVE Lite CLI stands out when you want:
|
|
204
302
|
|
|
205
|
-
|
|
303
|
+
- support across npm, pnpm, and Yarn lockfiles
|
|
304
|
+
- cleaner, more guided console output
|
|
305
|
+
- priority fixes and a suggested remediation plan
|
|
306
|
+
- a more focused pre-release scanning experience for JS/TS teams
|
|
206
307
|
|
|
207
|
-
###
|
|
308
|
+
### CVE Lite CLI vs OSV-Scanner
|
|
208
309
|
|
|
209
|
-
|
|
310
|
+
OSV-Scanner supports many ecosystems and lockfile types, which makes it broader overall.
|
|
210
311
|
|
|
211
|
-
|
|
312
|
+
CVE Lite CLI stands out when you want:
|
|
212
313
|
|
|
213
|
-
|
|
314
|
+
- a narrower, easier-to-understand tool built specifically around JS/TS dependency workflows
|
|
315
|
+
- remediation-first output instead of a more general multi-ecosystem scanner experience
|
|
316
|
+
- a more approachable local workflow for everyday developers
|
|
214
317
|
|
|
215
|
-
|
|
216
|
-
cve-lite . --fail-on high
|
|
217
|
-
```
|
|
318
|
+
### CVE Lite CLI vs Snyk CLI
|
|
218
319
|
|
|
219
|
-
|
|
320
|
+
Snyk CLI is part of a much broader commercial platform with wider enterprise coverage.
|
|
220
321
|
|
|
221
|
-
|
|
222
|
-
cve-lite . --sarif --output reports/scan.sarif
|
|
223
|
-
```
|
|
322
|
+
CVE Lite CLI stands out when you want:
|
|
224
323
|
|
|
225
|
-
|
|
324
|
+
- a simpler and lighter dependency CVE workflow
|
|
325
|
+
- an affordable option for small teams, startups, consultants, and independent developers
|
|
326
|
+
- a focused tool for lockfile-based release checks without adopting a larger platform
|
|
226
327
|
|
|
227
|
-
|
|
328
|
+
### CVE Lite CLI vs Socket CLI
|
|
228
329
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
330
|
+
Socket CLI goes beyond CVEs into broader package and supply-chain risk signals.
|
|
331
|
+
|
|
332
|
+
CVE Lite CLI stands out when you want:
|
|
333
|
+
|
|
334
|
+
- a focused dependency vulnerability scanner
|
|
335
|
+
- a straightforward answer to “what should I fix before release?”
|
|
336
|
+
- readable output centered on known vulnerability findings and practical next steps
|
|
337
|
+
|
|
338
|
+
### Best fit
|
|
339
|
+
|
|
340
|
+
CVE Lite CLI is best for:
|
|
341
|
+
|
|
342
|
+
- developers shipping JavaScript or TypeScript applications
|
|
343
|
+
- teams that want a lightweight release gate
|
|
344
|
+
- maintainers who want actionable vulnerability output without heavy platform overhead
|
|
345
|
+
- users who care about simplicity, readability, and fast adoption
|
|
346
|
+
|
|
347
|
+
If your goal is a practical developer-first CVE scan right before release, CVE Lite CLI is designed to be one of the most approachable options in that workflow.
|
|
232
348
|
|
|
233
349
|
## Philosophy
|
|
234
350
|
|
|
@@ -276,6 +392,27 @@ Planned or possible future improvements include:
|
|
|
276
392
|
|
|
277
393
|
This project is being shaped around real-world developer usability. Feedback on output clarity, remediation guidance, ecosystem coverage, and CI usage is especially valuable.
|
|
278
394
|
|
|
395
|
+
To get started, see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
396
|
+
|
|
397
|
+
## Community and support
|
|
398
|
+
|
|
399
|
+
CVE Lite CLI is being shaped in public and feedback is welcome.
|
|
400
|
+
|
|
401
|
+
If you run into a bug, want to suggest an improvement, or have a lockfile edge case that the tool should handle better, please open an issue in the repository.
|
|
402
|
+
|
|
403
|
+
Helpful feedback includes:
|
|
404
|
+
|
|
405
|
+
- reproducible bug reports
|
|
406
|
+
- real-world lockfile edge cases
|
|
407
|
+
- ideas for clearer output and remediation guidance
|
|
408
|
+
- CI usage examples
|
|
409
|
+
- JSON and SARIF workflow feedback
|
|
410
|
+
- comparison feedback based on real usage
|
|
411
|
+
|
|
412
|
+
As the project grows, contribution and security guidance will be expanded further in dedicated project docs.
|
|
413
|
+
|
|
414
|
+
For bug reports and feature requests, please use [GitHub Issues](https://github.com/sonukapoor/cve-lite-cli/issues). For contribution guidance, see [CONTRIBUTING.md](./CONTRIBUTING.md). For security-related reporting, see [SECURITY.md](./SECURITY.md).
|
|
415
|
+
|
|
279
416
|
## License
|
|
280
417
|
|
|
281
418
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cve-lite-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Developer-friendly CLI for scanning JS/TS projects for dependency vulnerabilities using local lockfiles and OSV",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -40,4 +40,4 @@
|
|
|
40
40
|
"README.md",
|
|
41
41
|
"LICENSE"
|
|
42
42
|
]
|
|
43
|
-
}
|
|
43
|
+
}
|