vg init: A Complete Walkthrough for Your First Project

This guide walks a new user through initializing Vibgrate CLI in a project for the first time. It is written for developers adopting Vibgrate as well as leads who want to understand what the tool writes into a repository.

Overview

vg init prepares a repository to use Vibgrate. It creates the .vibgrate directory and a configuration file so your scans, baselines, and other artifacts have a consistent home. You only need to run it once per repository; after that, the everyday command is a bare vg, which scans the current directory.

Prerequisites

Install the Vibgrate CLI first. If you prefer not to install, you can try a scan with npx @vibgrate/cli scan, but initializing a long-lived project benefits from a local install so the vg binary is available.

Step by step

From the root of your repository, run:

vg init

This creates the .vibgrate directory and a config file. With the project initialized, run your first scan:

vg

A bare vg scans the current directory and prints an DriftScore (DriftScore) from 0 to 100, along with the findings that drive it. Lower scores mean less upgrade drift.

Verify the setup

After vg init, confirm that the .vibgrate directory exists at the repository root and that your config file is present. Commit the configuration so the rest of your team shares the same scanner settings and exclusions.

What to do next

• Create a baseline with vg baseline so future scans can compare against a known-good snapshot.
• Read the Configuration help article to tune scanner toggles and exclusions.
• When you are ready for team visibility, sign in with vg login and push results with vg push.

Related

See the DriftScore explainer to interpret your first result, and the baseline guides to lock in a reference point.