Getting Started

Install DevCompass globally, run it against any Node.js project, and optionally wire up CVE severity scoring — all in a few commands.

On this page

Installation
First Analysis
Security

Installation

Three ways to install DevCompass.

# Global installation (recommended)
$ npm install -g devcompass
 
# Local project installation
$ npm install --save-dev devcompass
 
# One-time use with npx
$ npx devcompass analyze

First Analysis

Run it inside any project.

# Run your first analysis (shows Top 3 critical issues)
$ devcompass analyze
 
# Get full detailed report
$ devcompass analyze --deep
 
# Get AI-powered recommendations
$ devcompass analyze --ai
 
# Generate interactive dependency graph
$ devcompass graph --open

Health score icons

9.0 – 10.0Excellent— Outstanding health

8.0 – 8.9Good— Healthy project

6.0 – 7.9Needs Attention— Some issues

4.0 – 5.9Poor— Many issues

0.0 – 3.9Critical— Urgent action needed

Configure Security Scanning

OSV works out of the box. NVD is optional, for CVSS scores.

# Get a free NVD API key from nvd.nist.gov/developers/request-an-api-key
$ devcompass cve key --set --api-key YOUR_KEY
 
# Test connection
$ devcompass cve test
 
# Run analysis with CVE detection
$ devcompass analyze

DevCompass never needs an API key to start scanning — OSV (Open Source Vulnerabilities) is free and always available. See the full Security & CVE Detection breakdown for how the two databases work together.