cve-lite-cli 1.0.2 → 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 +126 -71
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,51 @@
|
|
|
1
1
|
# CVE Lite CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects.
|
|
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
|
|
24
89
|
|
|
25
|
-
CVE Lite CLI
|
|
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.
|
|
26
91
|
|
|
27
|
-
|
|
92
|
+
## Relationship to similar OWASP projects
|
|
93
|
+
|
|
94
|
+
CVE Lite CLI is not trying to replace broader OWASP security tooling.
|
|
95
|
+
|
|
96
|
+
Its role is narrower and workflow-focused:
|
|
97
|
+
|
|
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,64 +235,6 @@ 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
|
-
## Install
|
|
148
|
-
|
|
149
|
-
### Global install
|
|
150
|
-
|
|
151
|
-
```bash
|
|
152
|
-
npm install -g cve-lite-cli
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
Then run:
|
|
156
|
-
|
|
157
|
-
```bash
|
|
158
|
-
cve-lite /path/to/project
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
### One-off run with npx
|
|
162
|
-
|
|
163
|
-
```bash
|
|
164
|
-
npx cve-lite-cli /path/to/project
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
## Quick start
|
|
168
|
-
|
|
169
|
-
Basic scan:
|
|
170
|
-
|
|
171
|
-
```bash
|
|
172
|
-
cve-lite /path/to/project
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
Show all findings:
|
|
176
|
-
|
|
177
|
-
```bash
|
|
178
|
-
cve-lite /path/to/project --all
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
Focus only on urgent findings:
|
|
182
|
-
|
|
183
|
-
```bash
|
|
184
|
-
cve-lite /path/to/project --min-severity high
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
Fail a build on high severity and above:
|
|
188
|
-
|
|
189
|
-
```bash
|
|
190
|
-
cve-lite /path/to/project --fail-on high
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
JSON output:
|
|
194
|
-
|
|
195
|
-
```bash
|
|
196
|
-
cve-lite /path/to/project --json
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
SARIF output:
|
|
200
|
-
|
|
201
|
-
```bash
|
|
202
|
-
cve-lite /path/to/project --sarif --output reports/scan.sarif
|
|
203
|
-
```
|
|
204
|
-
|
|
205
238
|
## Supported workflows
|
|
206
239
|
|
|
207
240
|
### Local development
|
|
@@ -210,6 +243,8 @@ Run it before a release, during dependency cleanup, or after a major package upg
|
|
|
210
243
|
|
|
211
244
|
### CI/CD
|
|
212
245
|
|
|
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
|
+
|
|
213
248
|
Use it as a release gate in CI:
|
|
214
249
|
|
|
215
250
|
```bash
|
|
@@ -259,7 +294,6 @@ Compared with other tools in this space, CVE Lite CLI focuses on:
|
|
|
259
294
|
| Snyk CLI | Broader enterprise security workflows | Broad | Strong ecosystem coverage | Strong commercial guidance | Strong | Teams adopting a larger security platform |
|
|
260
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 |
|
|
261
296
|
|
|
262
|
-
|
|
263
297
|
### CVE Lite CLI vs npm audit
|
|
264
298
|
|
|
265
299
|
`npm audit` is the built-in default for npm users, which makes it convenient when your workflow is entirely npm-based.
|
|
@@ -358,6 +392,27 @@ Planned or possible future improvements include:
|
|
|
358
392
|
|
|
359
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.
|
|
360
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
|
+
|
|
361
416
|
## License
|
|
362
417
|
|
|
363
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
|
+
}
|