Understanding Scanner Output Across Formats

Every Vibgrate scan produces output that carries the DriftScore and the findings from each scanner. The same results can be emitted in different formats for different consumers. This reference explains what the output contains and how to choose a format. It is for developers reading results and engineers wiring scans into tooling.

What the output contains

A scan's output reports the overall DriftScore and the findings that produced it, organized by the scanner that found them. The findings describe what was detected and where, so you can move from the headline number to specific, actionable items.

Choosing a format

Vibgrate supports four output formats, each suited to a different audience:

• Text — the default, human-readable output for reading results in a terminal.
• JSON — structured output for programmatic consumption and custom tooling.
• SARIF — the standard format for code-scanning tools and security dashboards, ideal for surfacing findings inline in pull requests.
• Markdown — formatted output for reports, comments, and documentation.

Select a format with the format flag:

vg scan --format sarif

For a no-install trial, the same applies through the published package:

npx @vibgrate/cli scan

Why format choice matters

The right format makes results usable by the right consumer. Text is best for a human at a terminal. JSON lets you build custom gates and dashboards on top of scan data. SARIF plugs directly into code-scanning surfaces so findings appear where reviewers already work. Markdown produces readable reports and pull-request comments. Choosing well removes friction between a scan and the action it should drive.

Generating reports

When you want a polished, human-readable document from scan artifacts, generate a report:

vg report

Reports render findings in Markdown, text, or JSON for sharing with teammates and stakeholders.

Tips

• Use SARIF in CI so findings appear inline on pull requests.
• Use JSON when building custom thresholds or dashboards.
• Use Markdown reports for stakeholder updates.

Related

See the Output Formats guide for full detail, the Reading and Triaging Scanner Findings article for prioritization, and the Exit Codes reference for scripting around results.