CODYGIENE

Report Formats

CODYGIENE supports four report formats. Machine-readable reports contain ALL findings, not just the prioritized subset shown in the terminal.

Terminal (default)

codygiene scan

Human-readable output with prioritized findings. Low-priority findings are clustered by rule to avoid flooding the terminal.

JSON

codygiene scan --format json
codygiene scan --json -o report.json

Structured JSON with all findings, scores, coverage, and metadata. Suitable for programmatic processing and CI/CD integration.

SARIF

codygiene scan --format sarif -o report.sarif

SARIF (Static Analysis Results Interchange Format) for integration with GitHub Code Scanning, Azure DevOps, and other SARIF-compatible tools.

Markdown

codygiene scan --format markdown -o report.md

Human-readable Markdown report suitable for sharing in pull requests, wikis, or documentation.

Report contents

All machine-readable reports include:

  • Findings · all findings with full details
  • Scores · overall and per-category scores
  • Coverage · file discovery and analysis coverage
  • Rule IDs · the rule that produced each finding
  • Severities · critical, high, medium, low
  • Fingerprints · stable hashes for tracking across scans
  • Locations · file, line, column where available
  • Confidence · 0.0–1.0 per finding
  • Duration · scan time in milliseconds

Output to file vs stdout

Use -o or --output to write to a file:

codygiene scan --format json -o report.json

Without -o, output goes to stdout. Terminal format goes to stdout by default.