Install the Vibgrate CLI Globally with npm

Installing the Vibgrate CLI globally gives you the vg command in every project on your machine. This is the most common setup for developers who scan multiple repositories for upgrade drift. In this tutorial you install @vibgrate/cli with npm and confirm it works with a first scan.

Prerequisites

• Node.js 18 or newer
• npm on your PATH
• A project to scan

Steps

1. Check Node and npm

Confirm your toolchain is ready before installing.

node --version
npm --version

2. Install @vibgrate/cli globally

A global install puts the vg binary on your PATH for all projects.

npm install -g @vibgrate/cli

3. Verify the vg binary

Confirm the install resolved and check the version.

vg --version

If the command prints a version number, the CLI is installed correctly.

4. Run your first scan

The default subcommand is scan, so a bare vg scans the current directory. Change into a project first.

vg

Vibgrate analyzes your manifests and lockfiles across ~19 ecosystems and prints a results table.

5. Read the DriftScore

The scan reports a DriftScore from 0 to 100 that summarizes how far your dependencies have drifted from current, supported versions. A lower score means less drift. Use it as the headline metric for the repository.

vg

Verification

A successful scan prints a results table and a DriftScore. The command exits 0 when no failure gate is configured. To confirm the binary is resolvable from any directory:

vg --version

Next Steps

• Prefer not to install globally? Try the no-install npx workflow.
• Use a different package manager? See the pnpm, yarn, and bun setup tutorial.
• Ready for repeatable config? Initialize a project with vg init.