Skip to content

Commit 3ca68bb

Browse files
authored
Merge pull request #83 from sonukapoor/feature/issue-82-readme-positioning
[Enhancement] Strengthen offline support positioning in the README
2 parents 20e4000 + fd529cb commit 3ca68bb

1 file changed

Lines changed: 66 additions & 1 deletion

File tree

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/logo-with-title.png" alt="CVE Lite CLI" width="320"/>
99

1010
<h1>CVE Lite CLI</h1>
11-
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects.</p>
11+
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects, with offline support for restricted environments.</p>
1212

1313
<strong>Scan. Prioritize. Fix.</strong>
1414

@@ -27,6 +27,13 @@
2727

2828
**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.
2929

30+
It is designed to be:
31+
32+
- developer-friendly in day-to-day workflows
33+
- local-first and transparent about network behavior
34+
- usable in enterprise and restricted-network environments
35+
- capable of zero-runtime-network scans through a local advisory database
36+
3037
## New: Offline advisory DB support
3138

3239
CVE Lite CLI now supports a local advisory database workflow for teams that cannot allow runtime outbound advisory API calls.
@@ -50,6 +57,19 @@ cve-lite /path/to/project --offline
5057
cve-lite /path/to/project --offline-db /path/to/advisories.db
5158
```
5259

60+
## Why offline mode matters
61+
62+
For many teams, “works locally” is not enough. They also need a scanner that can fit into environments where runtime outbound calls are restricted, reviewed closely, or disallowed entirely.
63+
64+
Offline advisory DB support makes CVE Lite CLI more practical for:
65+
66+
- enterprise environments with strict network controls
67+
- regulated teams that need explicit advisory data handling
68+
- internal CI systems that should not depend on public runtime API access
69+
- air-gapped or partially connected workflows
70+
71+
This is one of the most important differentiators in the project today because it improves both trust and adoptability, not just convenience.
72+
5373
## Quick start
5474

5575
Install globally:
@@ -108,6 +128,34 @@ cve-lite /path/to/project --offline
108128
cve-lite /path/to/project --offline-db /path/to/advisories.db
109129
```
110130

131+
## Workflow modes
132+
133+
CVE Lite CLI now supports three clear advisory workflows:
134+
135+
### 1. Standard online scan
136+
137+
Use the default OSV-backed mode when runtime advisory API access is acceptable:
138+
139+
```bash
140+
cve-lite /path/to/project
141+
```
142+
143+
### 2. Advisory DB sync
144+
145+
Build or refresh the local advisory database ahead of time:
146+
147+
```bash
148+
cve-lite advisories sync
149+
```
150+
151+
### 3. Offline local DB scan
152+
153+
Scan against the local advisory DB with zero runtime advisory API calls:
154+
155+
```bash
156+
cve-lite /path/to/project --offline
157+
```
158+
111159
## What it looks like
112160

113161
CVE Lite CLI produces a clean, summary-first console view by default, designed for fast triage before release.
@@ -197,6 +245,8 @@ Its role is narrower and workflow-focused:
197245

198246
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.
199247

248+
One of the clearest examples of that focus is offline support: CVE Lite CLI is built to let teams explicitly sync advisory data and then scan locally, instead of forcing every environment to depend on runtime outbound vulnerability API access.
249+
200250
## Network behavior and privacy
201251

202252
CVE Lite CLI is a local-first scanner. It parses dependency information locally, uses local caching to reduce repeated lookups, and in standard mode queries OSV for advisory data needed for matching. It also now supports a local advisory database workflow for offline scans with zero runtime advisory API calls.
@@ -315,6 +365,8 @@ CVE Lite CLI is designed as a **local-first, metadata-only** scanner. Unlike tra
315365
It reads your project locally and uses package/version matching against OSV advisories.
316366
- **offline-capable**
317367
It can sync and scan against a local advisory database for zero-runtime-network workflows.
368+
- **enterprise-friendly network model**
369+
Teams can control when advisory data is synced and where offline scans run, which is valuable in restricted environments.
318370
- **release-focused**
319371
It is especially useful before a release, in CI, or during final dependency cleanup.
320372

@@ -430,6 +482,7 @@ CVE Lite CLI is a good fit for:
430482
- developers who want a second opinion alongside other tools
431483
- OSS maintainers who need a practical scan before publishing
432484
- teams that need offline or controlled-network dependency scanning
485+
- security-conscious organizations that need clear advisory data control
433486

434487
## Supported workflows
435488

@@ -507,6 +560,16 @@ Compared with other tools in this space, CVE Lite CLI focuses on:
507560
| Snyk CLI | Broader enterprise security workflows | Broad | Strong ecosystem coverage | Strong commercial guidance | Strong | Teams adopting a larger security platform |
508561
| 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 |
509562

563+
### Offline support at a glance
564+
565+
| Tool | Local advisory DB workflow | Zero runtime advisory API calls |
566+
|---|---|---|
567+
| **CVE Lite CLI** | **Yes** | **Yes** |
568+
| `npm audit` | No built-in local advisory DB workflow | No |
569+
| OSV-Scanner | Depends on broader workflow setup rather than the local DB pattern emphasized here | Varies by setup |
570+
| Snyk CLI | Not the primary workflow emphasis | Varies by product/workflow |
571+
| Socket CLI | Not the primary workflow emphasis | Varies by product/workflow |
572+
510573
### CVE Lite CLI vs npm audit
511574

512575
`npm audit` is the built-in default for npm users, which makes it convenient when your workflow is entirely npm-based.
@@ -527,6 +590,7 @@ CVE Lite CLI stands out when you want:
527590
- a narrower, easier-to-understand tool built specifically around JS/TS dependency workflows
528591
- remediation-first output instead of a more general multi-ecosystem scanner experience
529592
- a more approachable local workflow for everyday developers
593+
- a more explicit local advisory DB workflow for offline or restricted environments
530594

531595
### CVE Lite CLI vs Snyk CLI
532596

@@ -537,6 +601,7 @@ CVE Lite CLI stands out when you want:
537601
- a simpler and lighter dependency CVE workflow
538602
- an affordable option for small teams, startups, consultants, and independent developers
539603
- a focused tool for lockfile-based release checks without adopting a larger platform
604+
- a more explicit offline scanning model with local advisory DB control
540605

541606
### CVE Lite CLI vs Socket CLI
542607

0 commit comments

Comments
 (0)