Skip to main content

Getting started with Vibgrate for Go projects

Scan a Go module for upgrade drift with the Vibgrate CLI, understand the DriftScore it reports, and set up a baseline so you can track drift over time.

Vibgrate Docs

Vibgrate Help

Vibgrate scans Go modules for upgrade drift alongside many other ecosystems. This guide gets a Go developer from install to first scan and baseline.

Prerequisites

  • The Vibgrate CLI installed (or use npx @vibgrate/cli scan)
  • A Go project with a go.mod file at its root

If you have not installed the CLI yet, see install the Vibgrate CLI on macOS and Linux or install on Windows.

Run your first scan

From the module root, run the bare command to scan the current directory:

vg

Vibgrate reads your go.mod and go.sum, analyzes the module graph, and prints a DriftScore from 0 to 100 along with the findings it detected. A higher score means more upgrade drift to address.

Initialize project config

To store Vibgrate settings in the repository, initialize it once:

vg init

This creates the .vibgrate directory and a config file you can commit.

Establish a baseline

Capture the current state so future scans can report only what changed:

vg baseline

Later scans can compare against it:

vg scan --baseline .vibgrate/baseline.json

This is the foundation for drift quality gates in CI.

Output for pipelines

For machine-readable results, choose a format:

vg scan --format sarif

Troubleshooting

  • No dependencies detected — run from the directory containing go.mod.
  • Multi-module repositories — scan each module directory, or run from the workspace root depending on your layout.

Related

Learn what the number means in understanding your first DriftScore, and set up gates with drift baselines. You can also serve version-correct Go library docs to your AI assistant with Vibgrate AI Context via vg serve.