Getting Started with the Vibgrate CLI

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 with Node.js, .NET, Python, and Java projects, producing a deterministic Upgrade Drift Score (0–100) and actionable findings.

Core drift analysis does not execute source code. Only manifest and config files are read. Dashboard upload is always optional.

Requirements

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

Installation

Install Vibgrate as a dev dependency in your project, or run it directly with npx.

npm install -D @vibgrate/cli

Your First Scan

Once installed, run a scan against the current directory:

vibgrate scan .

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 Upgrade Drift Score
5. Produces findings and a JSON artifact

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

Understanding Your Score

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 vibgrate baseline . to track drift over time
• Push results to the dashboard with vibgrate 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.