This article covers the human-readable output formats of the Vibgrate CLI: the default text table for terminals and Markdown for documents and pull request comments. It is for developers who want results people can read at a glance.
Overview
Of the four Vibgrate output formats, two are designed for people. The default text table is what you see when you run a scan in a terminal. Markdown produces a report you can paste into a pull request, a wiki, or a ticket.
Step-by-step
The default format needs no flag. Just run the scan:
vg
To request Markdown explicitly, pass --format:
vg scan --format markdown
To save a Markdown report to a file:
vg scan --format markdown --out drift-report.md
When to choose each
- Use the default table when you are working interactively and want a quick DriftScore and summary in your terminal.
- Use Markdown when the result will live in a document or a code review, where formatting and links matter.
If you want a richer standalone report from existing scan artifacts, also look at vg report, which renders human-readable reports in Markdown, text, or JSON.
Related
See the output formats guide, the report command reference, the JSON output guide, and the scan command reference.