This guide shows the simplest way to run an upgrade drift scan with the Vibgrate CLI. It is written for developers who want a quick read on a project's health and for technical leaders evaluating the tool.
Overview
scan is the default subcommand of the Vibgrate CLI. Running the bare binary scans the directory you are currently in, analyzes your dependencies and configuration across ~19 ecosystems, and reports a DriftScore from 0 to 100.
Prerequisites
- Node.js installed (for the npx form) or the Vibgrate CLI installed globally.
- A project directory with a lockfile or manifest (for example
package.json,*.csproj,requirements.txt,go.mod).
Step-by-step
To try it with no install, run it through npx from your project root:
npx @vibgrate/cli scan
Once the CLI is installed, simply run the bare binary from the directory you want to scan:
vg
That single command scans the current directory. You never need to pass the directory path, and you should never append a trailing path argument.
Reading the result
The scan prints a DriftScore from 0 to 100 alongside a breakdown of findings. A higher score indicates more upgrade drift and more risk. See the DriftScore concept page for how the metric is calculated and what each risk band means.
The scan exits with code 0 on success. You can change that behavior with quality gates such as --fail-on and --drift-budget, covered in their own help articles.
Next steps
- Capture a snapshot of today's state with
vg baselineso future scans can show the delta. - Choose an output format with
--formatwhen you want JSON, SARIF, or Markdown instead of the default table. - Push results to Vibgrate Cloud with
vg pushfor team trends.
Related
See the scan command reference, the DriftScore concept page, and the output formats guide.