Skip to content

Commit 22dedcd

Browse files
authored
Merge pull request #96 from sonukapoor/feature/issue-95-readme-toc
[Docs] Add a multi-column README table of contents
2 parents 7f3b3a5 + 4a3ca34 commit 22dedcd

1 file changed

Lines changed: 48 additions & 7 deletions

File tree

README.md

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![License](https://img.shields.io/github/license/sonukapoor/cve-lite-cli)](https://github.com/sonukapoor/cve-lite-cli/blob/main/LICENSE)
66

77
<div align="center">
8-
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/logo-with-title.png" alt="CVE Lite CLI" width="320"/>
8+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/logo-with-title.png" alt="CVE Lite CLI" width="320"/>
99

1010
<h1>CVE Lite CLI</h1>
1111
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects, with offline support for restricted environments.</p>
@@ -23,6 +23,47 @@
2323

2424
---
2525

26+
## Contents
27+
28+
<table>
29+
<tr>
30+
<td valign="top">
31+
<strong>Overview</strong><br/>
32+
<a href="#what-is-cve-lite-cli">What is CVE Lite CLI</a><br/>
33+
<a href="#new-offline-advisory-db-support">Offline advisory DB support</a><br/>
34+
<a href="#why-offline-mode-matters">Why offline mode matters</a><br/>
35+
<a href="#what-it-looks-like">What it looks like</a><br/>
36+
<a href="#why-this-tool-exists">Why this tool exists</a><br/>
37+
<a href="#project-scope-and-differentiation">Project scope and differentiation</a>
38+
</td>
39+
<td valign="top">
40+
<strong>Usage</strong><br/>
41+
<a href="#quick-start">Quick start</a><br/>
42+
<a href="#usage">Usage</a><br/>
43+
<a href="#workflow-modes">Workflow modes</a><br/>
44+
<a href="#network-behavior-and-privacy">Network behavior and privacy</a><br/>
45+
<a href="#features">Features</a><br/>
46+
<a href="#supported-workflows">Supported workflows</a>
47+
</td>
48+
<td valign="top">
49+
<strong>CI and Offline</strong><br/>
50+
<a href="#dependency-footprint">Dependency footprint</a><br/>
51+
<a href="#example-use-cases">Example use cases</a><br/>
52+
<a href="#recommended-workflow-patterns">Recommended workflow patterns</a><br/>
53+
<a href="#comparison-with-other-tools">Comparison with other tools</a><br/>
54+
<a href="#current-limitations">Current limitations</a><br/>
55+
<a href="#positioning">Positioning</a>
56+
</td>
57+
<td valign="top">
58+
<strong>Project</strong><br/>
59+
<a href="#roadmap">Roadmap</a><br/>
60+
<a href="#contributing">Contributing</a><br/>
61+
<a href="#community-and-support">Community and support</a><br/>
62+
<a href="#license">License</a>
63+
</td>
64+
</tr>
65+
</table>
66+
2667
## What is CVE Lite CLI
2768

2869
**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.
@@ -185,16 +226,16 @@ cve-lite .
185226
```
186227

187228
<p align="center">
188-
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/default-output.png" alt="CVE Lite CLI default output screenshot" width="900"/>
229+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/default-output.png" alt="CVE Lite CLI default output screenshot" width="900"/>
189230
</p>
190231

191232
Verbose examples:
192233

193234
<p align="center">
194-
<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"/>
195-
<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"/>
196-
<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"/>
197-
<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"/>
235+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-1.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
236+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-2.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
237+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-3.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
238+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/verbose-output-4.png" alt="CVE Lite CLI verbose output screenshot" width="900"/>
198239
</p>
199240

200241
## Why this tool exists
@@ -338,7 +379,7 @@ So the practical model is: **local lockfile scan + advisory matching**. When mal
338379
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.
339380

340381
<p align="center">
341-
<img src="https://github.com/sonukapoor/cve-lite-cli/blob/main/assets/diagram.png" alt="CVE Lite CLI Workflow" width="800"/>
382+
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/diagram.png" alt="CVE Lite CLI Workflow" width="800"/>
342383
</p>
343384

344385
### Workflow Specifications

0 commit comments

Comments
 (0)