report

Render a human-readable (or CI-readable) report from a scan.

Synopsis

archora report [path] [--format md|html|junit|json] [--base <file>] [options]

Options

Option	Default	Meaning
--format <fmt>	md	One of md (alias markdown), html, junit, json.
--output, -o <file>	—	Write report to file. Otherwise printed to stdout.
--base <file>	—	Baseline snapshot. Currently affects only the Markdown format.
--quiet	—	Suppress the "Wrote …" line on stderr.

Formats

Format	Best for	Notes
md	PR comments, team chats, GitHub issues	If --base is supplied, includes a "What changed" section.
html	Self-contained artifact for archiving	Single file, no external assets.
junit	CI test reporters (GitLab, Jenkins, GitHub)	Each cycle / layer violation becomes a <testcase failure>.
json	Same as analyze output	Identical to archora analyze JSON.

Examples

# Markdown for a PR comment
archora report . --format md -o report.md

# HTML you can open locally or attach to a build
archora report . --format html -o report.html

# JUnit for GitHub's "Tests" tab via dorny/test-reporter
archora report . --format junit -o reports/archora.xml

# Markdown that diffs against a stored baseline
archora report . --format md --base baseline.json -o report.md

Pairing with check

report doesn't fail the build — it always exits 0 (or 2 on bad invocation). Pair it with check when you want to both publish a nice report and fail the build:

archora report . --format md -o report.md --quiet
archora check . --fail-on grade:D --fail-on cycles:0