Skip to content

docs: add new-here onboarding and feedback CTA #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sonukapoor merged 1 commit into from
Apr 8, 2026
Merged

docs: add new-here onboarding and feedback CTA #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

<p>
<a href="#quick-start">Quick Start</a> •
<a href="#new-here-start-here">New Here? Start Here</a> •
<a href="#features">Features</a> •
<a href="#usage">Usage</a> •
<a href="https://github.com/sonukapoor/cve-lite-cli/blob/main/src/docs/CONTRIBUTING.md">Contributing</a>
Expand All @@ -31,6 +32,7 @@
<td valign="top">
<strong>Overview</strong><br/>
<a href="#what-is-cve-lite-cli">What is CVE Lite CLI</a><br/>
<a href="#new-here-start-here">New here? Start here</a><br/>
<a href="#new-offline-advisory-db-support">Offline advisory DB support</a><br/>
<a href="#why-offline-mode-matters">Why offline mode matters</a><br/>
<a href="docs/case-studies/owasp-juice-shop.md">OWASP Juice Shop case study</a><br/>
Expand Down Expand Up @@ -80,6 +82,24 @@ It is designed to be:

For real-world remediation examples, see the [OWASP Juice Shop case study](docs/case-studies/owasp-juice-shop.md) and the [NestJS case study](docs/case-studies/nestjs.md).

## New here? Start here

1. run one scan on a real project with `npx cve-lite-cli /path/to/project --verbose`
2. review direct vs transitive findings and the `Copy And Run These Fix Commands` section
3. compare the output with your current scanner workflow
4. check a real walkthrough:
- [OWASP Juice Shop case study](docs/case-studies/owasp-juice-shop.md)
- [NestJS case study](docs/case-studies/nestjs.md)

If CVE Lite CLI helps your release workflow, a GitHub star helps more developers discover it: [Star CVE Lite CLI](https://github.com/sonukapoor/cve-lite-cli).

If you want to shape the roadmap, open an issue with feedback on:

- whether the direct vs transitive split is useful in practice
- where remediation guidance is still missing
- what increases or decreases trust in a CLI security tool
- what would make frontend-heavy CI workflows smoother

## New: Offline advisory DB support

CVE Lite CLI now supports a local advisory database workflow for teams that cannot allow runtime outbound advisory API calls.
Expand Down
Loading