Usage
vibgrate report [--in <file>] [--format md|text|json]
What It Does
vibgrate report takes an existing scan artifact and renders it into a human-readable format. This is useful when you want to share drift status with people who do not run the CLI themselves — managers, auditors, or external stakeholders.
Flags
| Flag | Default | Description |
|---|---|---|
--in | .vibgrate/scan_result.json | Input artifact file |
--format | text | Output format: md, text, or json |
Examples
Markdown report (ideal for PRs and wikis)
vibgrate report --format md
From a specific artifact
vibgrate report --in ./archives/scan-2026-01.json --format md
Text report to stdout
vibgrate report --format text
JSON for programmatic consumption
vibgrate report --format json
Use Cases
- PR comments: Generate a Markdown report and post it as a PR comment via your CI system
- Wiki pages: Pipe the Markdown output to a Confluence or GitHub Wiki page
- Audit trail: Archive JSON reports alongside release notes
- Email summaries: Convert the text report to plain text for email distribution
Tip
The report command never runs a new scan — it only reads and reformats existing artifacts. If you need fresh data, run vibgrate scan first.