Skip to main content

Getting Started with the Vibgrate CLI

Install the Vibgrate CLI, run your first scan, and understand your DriftScore in under five minutes. This guide covers installation on every major platform and walks through the essential first-scan workflow.

Vibgrate Docs

Vibgrate Help

What Is the Vibgrate CLI?

The Vibgrate CLI is a command-line tool that scans your codebase for upgrade drift — the gap between the dependency versions you run and the versions you should run. It works across ~19 ecosystems — including Node.js, .NET, Python, Java, Go, Rust, PHP, and Ruby — producing a deterministic DriftScore (0–100) and actionable findings.

Core drift analysis does not execute source code. Only manifest and config files are read. Uploading to Vibgrate Cloud is always optional.

Requirements

  • Node.js >= 22.0.0
  • Works on macOS, Linux, and Windows

Installation

Install the Vibgrate CLI using your preferred package manager:

# Run without installing anything
npx @vibgrate/cli scan

# Pin a version or see every command
npx @vibgrate/cli@latest --help

no install·Nothing is installed globally — ideal for CI or a one-off scan.

Your First Scan

Once installed, run a scan against the current directory:

vg

The scan recursively discovers projects — package.json for Node/TypeScript, .sln/.csproj for .NET, Python manifests, and Java build files. For each project it:

  1. Detects the runtime version, target framework, and all dependencies
  2. Queries the npm/NuGet registry for latest stable versions
  3. Computes how far behind each component is
  4. Generates an DriftScore
  5. Produces findings and a JSON artifact

The default output is a colored, human-readable report in your terminal.

Understanding Your Score

Lower scores are healthier: 0 means no drift (fully current) and 100 means maximum drift — higher is worse.

ScoreRisk LevelWhat It Means
0–30LowYou're in good shape
31–60ModerateSome attention needed
61–100HighSignificant upgrade debt

The score is a weighted combination of four components: Runtime (Node.js or .NET runtime version lag), Frameworks (major version distance for core frameworks), Dependencies (age distribution across all deps), and EOL Risk (proximity to end-of-life for runtimes).

What Happens Next

After your first scan, you have several options:

  • Create a baseline with vg baseline to track drift over time
  • Push results to Vibgrate Cloud with vg push for team visibility
  • Generate a report in Markdown or SARIF format
  • Integrate into CI to prevent drift regression

See the individual help articles on each command for detailed guidance.