Osv Ui README

The full upstream README, mirrored for reference. Install config, tool schemas, adoption signals and our own overview live on the Osv Ui listing page.

osv-ui dashboard

osv-ui

A beautiful, zero-config visual CVE dashboard for npm, Python, Go, Rust, Java, PHP, and Ruby projects.
One command. No signup. No API key. Runs 100% locally β€” your code never leaves your machine.

npm version npm version (mcp) npm downloads License: MIT PRs Welcome Node.js

πŸ‡»πŸ‡³ TiαΊΏng Việt Β· πŸ‡ΊπŸ‡Έ English Β· πŸ‡¨πŸ‡³ δΈ­ζ–‡ Β· πŸ‡―πŸ‡΅ ζ—₯本θͺž


The problem

bash
$ npm audit

# ... 300 lines of this ...
# moderate  Regular Expression Denial of Service in semver
# package   semver
# patched in >=7.5.2
# ...
# 12 vulnerabilities (3 moderate, 6 high, 3 critical)

Nobody reads that. Security gets ignored. Dependencies stay vulnerable.

The solution

Terminal
npx osv-ui

β†’ Opens a dashboard. Every CVE, every fix, all your services. Done.

Why give it a try?

  • Zero-config: No complex setup, no signup, no API key required.
  • Privacy First: Analysis is done 100% on your machine.
  • Fast & Visual: Real-time Risk Scores, vulnerability charts, and clear upgrade guides in seconds.
  • Multi-platform: Native support for Node.js (npm), Python, Go, Rust, Java, PHP, and Ruby.

Features

🌐 Multi-EcosystemScans package-lock.json, pnpm-lock.yaml, yarn.lock, Pipfile.lock, poetry.lock, requirements.txt, go.sum, Cargo.lock, pom.xml, composer.lock, Gemfile.lock
πŸ“‘ Live CVE dataPowered by OSV.dev β€” updated daily from NVD, GitHub Advisory, PyPI Advisory. No API key.
🏒 Multi-serviceScan your entire monorepo in one command β€” frontend, backend, workers, ML services
πŸ’Š Fix guideDependabot-style upgrade table: current version β†’ safe version + one-click copy command
πŸ”Œ Built-in REST APIPower your own security dashboards with GET /api/data or CLI export flags
🎯 Risk score0–100 per service so you know where to focus first
πŸ” CVE drill-downClick any row β€” CVSS score, description, NVD link, GitHub Advisory link
πŸŒ™ Dark ModeEye-friendly security audits, day or night

Quick start

Scan current directory:

Terminal
npx osv-ui

Scan a monorepo (multiple services at once):

Terminal
npx osv-ui ./frontend ./api ./worker ./ml-service

Auto-discover all services under the current directory:

Terminal
npx osv-ui -d

Add to your package.json scripts:

config.json
{
  "scripts": {
    "audit:ui":  "npx osv-ui",
    "audit:all": "npx osv-ui ./frontend ./api ./worker"
  }
}
Code
--discover, -d    Auto-find service dirs that contain a supported manifest
--port=2003       Use a custom port (default: 2003)
--json[=file]     Save report as JSON without opening browser (defaults to osv-report.json)
--html[=file]     Save report as HTML without opening browser (defaults to osv-report.html)
--cyclonedx[=file] Save CycloneDX SBOM JSON (defaults to osv-sbom.cdx.json)
--spdx[=file]     Save SPDX SBOM JSON (defaults to osv-sbom.spdx.json)
--baseline=file   Compare with a previous --json report
--markdown[=file] Save a Markdown PR/comment report (defaults to osv-report.md)
--fail-on=level   Exit non-zero for critical/high/moderate/low findings
--webhook-url=url POST matching findings to a webhook
--webhook-severity=level Webhook threshold (default: critical)
--watch           Keep dashboard running and re-scan when manifests change
--no-open         Don't auto-open the browser
--offline         Skip OSV.dev lookup β€” parse manifests only
-h, --help        Show help message

πŸ€– AI Agent Integration (MCP)

osv-ui is now a Model Context Protocol (MCP) server. This allows AI agents like Claude Desktop, Cursor, and Claude Code to:

  1. Scan your project for CVEs automatically.
  2. Open the visual dashboard for you to review findings (Human-in-the-loop).
  3. Apply fixes after your explicit confirmation.

Quick setup (npx):

config.json
{
  "mcpServers": {
    "osv-ui": {
      "command": "npx",
      "args": ["-y", "osv-ui-mcp"]
    }
  }
}

See the MCP Package README for detailed setup instructions.


πŸ”Œ Powerful built-in API

osv-ui isn't just a dashboard; it's a security data engine.
Once the dashboard is running, you can pull the raw security data for your whole project:

bash
# Get full JSON payload for all services
curl http://localhost:2003/api/data

# Use it in your custom scripts
curl -s http://localhost:2003/api/data | jq '.[0].vulns'

CI reports, PR diffs, and SBOMs

Generate machine-readable reports without opening the browser:

Terminal
npx osv-ui -d --json=osv-report.json --markdown=osv-report.md --cyclonedx=sbom.cdx.json --spdx=sbom.spdx.json --no-open

Compare a PR scan against a baseline report and fail on newly introduced high+ findings:

Terminal
npx osv-ui -d --json=current.json --baseline=main-osv-report.json --markdown=osv-pr.md --fail-on=high --no-open

Minimal GitHub Actions flow:

yaml
name: osv-ui
on: [pull_request]
jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 24
      - run: npx osv-ui -d --json=current.json --markdown=osv-pr.md --cyclonedx=sbom.cdx.json --fail-on=high --no-open
      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: osv-ui-report
          path: |
            current.json
            osv-pr.md
            sbom.cdx.json

Send new critical findings to a webhook:

Terminal
npx osv-ui -d --baseline=main-osv-report.json --webhook-url="$SECURITY_WEBHOOK_URL" --webhook-severity=critical --json=current.json

Supported manifest files

EcosystemFiles
npm / JSpackage-lock.json Β· pnpm-lock.yaml Β· yarn.lock
Pythonrequirements.txt Β· Pipfile.lock Β· poetry.lock Β· pyproject.toml Β· uv.lock
Gogo.sum
RustCargo.lock
Javapom.xml (Maven)
PHPcomposer.json Β· composer.lock
RubyGemfile Β· Gemfile.lock

More ecosystems coming β€” see Roadmap.


How it works

Code
Your project files
    β”‚
    β”œβ”€ package-lock.json   ──┐
    β”œβ”€ Pipfile / poetry    ─────► parser ──► package list
    β”œβ”€ go.sum / Cargo.lock β”€β”€β”˜
                                    β”‚
                                    β–Ό
                             OSV.dev batch API  (free, no key)
                                    β”‚
                                    β–Ό
                             CVE matches + fix versions
                                    β”‚
                                    β–Ό
                         Express server β†’ browser dashboard
                              http://localhost:2003

CVE data comes from OSV.dev β€” a free, open database maintained by Google that aggregates:

Updated daily. No account. No rate limit. No vendor lock-in.


Works great alongside osv-scanner (Google)

osv-ui and osv-scanner use the same OSV.dev data source. osv-ui adds the visual layer that osv-scanner lacks:

  • Browser dashboard instead of terminal output
  • Multi-service sidebar
  • Dependabot-style upgrade guide with copy commands

vs alternatives

osv-uinpm auditSnykDependabot
Visual dashboardβœ…βŒ terminal onlyβœ…βœ…
npm supportβœ…βœ…βœ…βœ…
Python supportβœ…βŒβœ…βœ…
Multi-service in one viewβœ…βŒβœ… paidβœ…
No signup requiredβœ…βœ…βŒβŒ
Works on GitLab Freeβœ…βœ…βŒβŒ
Self-hosted / localβœ…βœ…βŒβŒ
Fix commandsβœ…partialβœ…βœ…
Open sourceβœ…βœ…βŒβŒ

GitLab CI β€” block deploys on critical CVEs

No Dependabot on GitLab Free? Add this to .gitlab-ci.yml:

server.ts
audit:
  stage: test
  image: node:24-alpine
  script:
    - npm audit --json > /tmp/audit.json || true
    - |
      node -e "
        const r = require('/tmp/audit.json');
        const crit = Object.values(r.vulnerabilities || {})
          .filter(v => v.severity === 'critical').length;
        if (crit > 0) {
          console.error('BLOCKED: ' + crit + ' critical CVE(s). Run: npx osv-ui');
          process.exit(1);
        }
        console.log('OK: no critical vulnerabilities');
      "
  artifacts:
    paths: [/tmp/audit.json]
    when: always

Requirements

  • Node.js >= 22
  • Internet access for OSV.dev queries β€” or use --offline
  • npm projects: run npm install first so package-lock.json exists
  • Python projects: any of the supported manifest files listed above

Roadmap

All contributions are welcome. If you want to work on something, open an issue first so we can coordinate.

  • Go support β€” parse go.sum / go.mod
  • Rust support β€” parse Cargo.lock
  • Java / Maven β€” parse pom.xml
  • PHP / Composer β€” parse composer.lock
  • Ruby / Bundler β€” parse Gemfile.lock
  • Export report β€” save as HTML / JSON
  • Dark mode β€” eye-friendly dashboard UI
  • GitHub Actions / CI diff β€” generate Markdown PR comments and fail on new CVEs
  • SBOM export β€” CycloneDX / SPDX format
  • Watch mode β€” re-scan on manifest file changes
  • Slack / webhook β€” notify on new critical CVEs
  • Parser hardening β€” Maven property inheritance, lockfile edge cases, workspace layouts
  • Live dashboard refresh β€” push watch-mode updates to an open browser tab without reload

Contributing

This project is built by the community. All skill levels welcome.

Good first issues:

  • Write unit tests for the parsers
  • Improve Python parser edge cases
  • Improve Maven/Gradle and workspace parser edge cases
bash
# Clone and run locally
git clone https://github.com/toan203/osv-ui
cd osv-ui
npm install

# Run against your own project
node bin/cli.js /path/to/your/project

# Run against multiple services
node bin/cli.js ./frontend ./backend

Please read CONTRIBUTING.md for code style and PR process.


License

MIT β€” use it, fork it, embed it, build on it. Attribution appreciated but not required.


Did osv-ui catch a real CVE in your project?
A ⭐ helps other developers find this tool.

Sponsor this project

Share on Twitter Β· Post on Reddit