19 lines (14 loc) · 568 Bytes

Report formats

Supported in v0.1:

table: compact human-readable console output.
markdown: GitHub Step Summary and README-friendly report.
json: versioned machine-readable AuditReport.
oneline: single-line status for hooks and CI.

Examples:

npx pr-audit analyze --diff changes.diff --format table
npx pr-audit analyze --diff changes.diff --format markdown --output pr-audit.md
npx pr-audit analyze --diff changes.diff --format json
npx pr-audit analyze --staged --format oneline

SARIF is planned for v0.2. HTML is planned for v1.0.