Skip to main content

Getting started with Vibgrate for Ruby projects

Scan a Bundler-based Ruby project for upgrade drift with the Vibgrate CLI, read the DriftScore, and capture a baseline to track drift over time.

Vibgrate Docs

Vibgrate Help

Vibgrate scans Bundler-based Ruby projects for upgrade drift as part of its multi-ecosystem coverage. This guide takes a Ruby developer from install to first scan and baseline.

Prerequisites

  • The Vibgrate CLI installed (or use npx @vibgrate/cli scan)
  • A Ruby project with a Gemfile and Gemfile.lock

New to installing? See install the Vibgrate CLI on macOS and Linux or install on Windows.

Run your first scan

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

vg

Vibgrate reads your Gemfile and Gemfile.lock, analyzes the gem graph, and prints a DriftScore from 0 to 100 along with the findings. A higher score indicates more upgrade drift.

Initialize project config

Store Vibgrate settings in the repository:

vg init

This creates the .vibgrate directory and config file to commit.

Establish a baseline

Snapshot the current state so later scans report deltas:

vg baseline

Compare future scans against it:

vg scan --baseline .vibgrate/baseline.json

Output for pipelines

Produce structured output for CI:

vg scan --format sarif

Troubleshooting

  • Missing lockfile — run bundle install to generate Gemfile.lock.
  • Multiple apps in one repo — scan each directory that has its own Gemfile.

Related

Read understanding your first DriftScore and drift baselines. You can also serve version-correct Ruby gem docs to your AI assistant with Vibgrate AI Context via vg serve.