Skip to content
Rulestatus

Output Formats

console

Section titled “console”

Default. Colored terminal output grouped by article.

Terminal window
rulestatus run
rulestatus run --format console

json

Section titled “json”

Machine-readable results with full provenance.

Terminal window
rulestatus run --format json

Includes: all rule results, evidence sources with SHA-256 hashes, confidence levels, CI provenance block (run ID, SHA, actor when running in GitHub Actions).

sarif

Section titled “sarif”

SARIF 2.1.0 — GitHub Code Scanning and IDE integration.

Terminal window
rulestatus run --format sarif

Upload to GitHub Code Scanning to get inline PR annotations.

junit

Section titled “junit”

JUnit-compatible XML. Use with test reporting tools.

Terminal window
rulestatus run --format junit

Results grouped into <testsuite> per article. FAIL/MAJOR → <failure>, MANUAL → <error>, SKIP → <skipped/>.

pdf

Section titled “pdf”

Evidence Readiness Report — formatted PDF for auditors.

Terminal window
rulestatus run --format pdf

Includes: executive summary, per-article results, evidence sources, legal disclaimer, run provenance.

badge

Section titled “badge”

SVG badge for README or dashboard.

Terminal window
rulestatus run --format badge

Output: compliance-badge.svg — green (all pass), yellow (warnings), red (critical gaps).

Multiple formats

Section titled “Multiple formats”
Terminal window
rulestatus run --format console,json,sarif