Skip to main content
Reference

Output Formats

Understand the four output formats: Text, JSON, SARIF, and Markdown.

Overview

Vibgrate supports four output formats, each optimized for different workflows and consumers.

FormatPrimary UseBest For
📝 TextTerminalInteractive debugging
📄 JSONAutomationProgrammatic consumption
🔍 SARIFCI/CDPR annotations
📋 MarkdownDocumentationStakeholder communication

Text (Default)

A colored, human-readable report for terminal use:

vg scan

Example Output:

╭─────────────────────────────────────────────╮
│  VIBGRATE DRIFT REPORT                      │
├─────────────────────────────────────────────┤
│  DriftScore: 67/100 (High)                  │
│  Projects: 4 found                          │
│  Findings: 12 (3 errors, 7 warnings)        │
╰─────────────────────────────────────────────╯

📊 Score Breakdown
├─ Runtime:      85/100  ████████░░
├─ Frameworks:   70/100  ███████░░░
├─ Dependencies: 55/100  █████░░░░░
└─ EOL Risk:     90/100  █████████░

🔴 ERROR: Node.js 16.x is EOL
   → Upgrade to Node.js 20.x or 22.x

🟡 WARNING: 45% dependencies 2+ majors behind
   → Review dependency-risk findings

Best For: Interactive terminal use, debugging


JSON

Full scan artifact with complete data:

vg scan --format json --out scan.json

Example Output:

{
  "schemaVersion": "1.0",
  "meta": {
    "version": "1.0.0",
    "timestamp": "2025-01-15T10:30:00Z",
    "duration": 4520
  },
  "driftScore": 67,
  "scores": {
    "runtime": 85,
    "frameworks": 70,
    "dependencies": 55,
    "eolRisk": 90
  },
  "projects": [
    {
      "path": "./",
      "ecosystem": "nodejs",
      "drift": 45
    }
  ],
  "findings": [
    {
      "id": "nodejs-eol",
      "severity": "error",
      "message": "Node.js 16.x is EOL"
    }
  ]
}
FeatureDescription
Schema versionedschemaVersion: "1.0"
Complete dataAll scores, metrics, findings
Stable formatSafe for long-term storage

Best For: Automation, programmatic consumption, archival


SARIF

Static Analysis Results Interchange Format for CI integration:

vg scan --format sarif --out vibgrate.sarif

Platform Compatibility

PlatformIntegration
🐙 GitHubCode Scanning, PR annotations
🔷 Azure DevOpsSecurity alerts
🦊 GitLabSAST reports

GitHub Actions Example

- name: Run Vibgrate
  run: npx @vibgrate/cli scan --format sarif --out vibgrate.sarif

- name: Upload SARIF
  uses: github/codeql-action/upload-sarif@v3
  with:
    sarif_file: vibgrate.sarif

Best For: CI integration, PR annotations, security tabs


Markdown

Clean, portable report for documentation:

vg scan --format md --out report.md

Example Output:

# Vibgrate Drift Report

**Generated:** 2025-01-15T10:30:00Z
**DriftScore:** 67/100 (High Risk)

## Summary

| Metric | Value |
|--------|-------|
| Projects | 4 |
| Findings | 12 |
| Errors | 3 |

## Top Findings

### 🔴 Node.js 16.x is EOL
**Severity:** Error
**Recommendation:** Upgrade to Node.js 20.x or 22.x

Use Cases

Use CaseIntegration
📬 PR CommentsGitHub Actions, GitLab CI
📚 Wiki PagesConfluence, Notion, GitHub Wiki
📧 EmailNotification systems
📊 ReportsQuarterly drift reports

Best For: Stakeholder communication, documentation


Format Comparison

FeatureTextJSONSARIFMarkdown
Scores
Findings
Metrics
VCS Metadata
Colored
Machine-readable⚠️
Human-readable⚠️

Related

Related Documentation