Skip to content

Commit 7be3e05

Browse files
authored
Merge pull request #35 from sonukapoor/docs/readme-osv-endpoint
docs: document custom OSV endpoint support
2 parents b0cfbef + 9789c8e commit 7be3e05

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="./assets/logo-with-title.png" alt="CVE Lite CLI" width="320"/>
2+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/logo-with-title.png" alt="CVE Lite CLI" width="320"/>
33

44
<h1>CVE Lite CLI</h1>
55
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects.</p>
@@ -65,6 +65,9 @@ cve-lite /path/to/project --json
6565

6666
# SARIF output
6767
cve-lite /path/to/project --sarif --output reports/scan.sarif
68+
69+
# Use a custom advisory endpoint
70+
cve-lite /path/to/project --osv-url https://security.company.internal/osv
6871
```
6972

7073
## What it looks like
@@ -96,16 +99,16 @@ cve-lite .
9699
```
97100

98101
<p align="center">
99-
<img src="./assets/default-output.png" alt="CVE Lite CLI default output screenshot" width="900"/>
102+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/default-output.png" alt="CVE Lite CLI default output screenshot" width="900"/>
100103
</p>
101104

102105
Verbose examples:
103106

104107
<p align="center">
105-
<img src="./assets/verbose-output-1.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
106-
<img src="./assets/verbose-output-2.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
107-
<img src="./assets/verbose-output-3.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
108-
<img src="./assets/verbose-output-4.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
108+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/verbose-output-1.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
109+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/verbose-output-2.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
110+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/verbose-output-3.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
111+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/verbose-output-4.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
109112
</p>
110113

111114
## Why this tool exists
@@ -136,6 +139,7 @@ The project emphasizes:
136139
- direct vs transitive visibility
137140
- top-priority fixes and a suggested remediation plan
138141
- JSON and SARIF output for automation
142+
- configurable advisory endpoint support via `--osv-url` for internal proxies or mirrors
139143
- a small, reviewable runtime footprint
140144

141145
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.
@@ -176,7 +180,7 @@ Support for stricter network-controlled environments is planned on the roadmap,
176180
CVE Lite CLI is designed as a **local-first, metadata-only** scanner. Unlike traditional SaaS security platforms that require code uploads or heavy agent installations, this tool operates directly within the developer's environment. It focuses on the "moment of release"—providing a high-speed, low-noise assessment of the dependency tree by analyzing resolved versions in project lockfiles.
177181

178182
<p align="center">
179-
<img src="./assets/diagram.png" alt="CVE Lite CLI Workflow" width="800"/>
183+
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/diagram.png" alt="CVE Lite CLI Workflow" width="800"/>
180184
</p>
181185

182186
### Workflow Specifications

0 commit comments

Comments
 (0)