Generate a Drift Report from Scan Artifacts

A scan produces structured artifacts; a report turns those artifacts into something a person can read. This article shows how to generate a drift report with the Vibgrate CLI, who each format is for, and how to fit reporting into a normal development loop.

Overview

vg report reads the artifacts produced by a previous scan and renders them as a human-readable document. You choose the shape with --format (Markdown, text, or JSON) and where it lands with --out. The numbers in the report come from the scan, including your overall DriftScore (0-100) and the per-finding detail behind it.

Prerequisites

• The Vibgrate CLI installed, or run it with npx @vibgrate/cli scan.
• At least one completed scan in the project so there are artifacts to render.

Step-by-step

First, run a scan so there is something to report on. Bare vg scans the current directory:

vg

Then generate a report from the scan artifacts:

vg report

To control the format and write to a file, combine --format and --out:

vg report --format markdown --out drift-report.md

Markdown is ideal for pull requests and wikis; text is good for terminals and logs; JSON is for tooling. The DriftScore and the findings that drive it appear at the top so a reader gets the headline before the detail.

Examples

A quick terminal summary:

vg report --format text

A Markdown report saved for a PR description:

vg report --format markdown --out report.md

Options

• --format selects markdown, text, or json.
• --out writes the report to a path instead of stdout.

Related

Once you can generate reports locally, see Share a Drift Report with Your Team for distribution, and Push Scan Results to Vibgrate Cloud to track DriftScore trends over time on the dashboard.