Skip to content

CLI overview

@archora/cli runs the same analyzer as the desktop app but exits with a structured JSON envelope, suitable for piping into other tools, archiving, or gating CI.

Synopsis

archora <command> [path] [options]

Commands

CommandWhat it does
analyzeRun analysis, output JSON envelope.
checkExit non-zero when --fail-on rules trip.
diffDiff a scan against a baseline JSON snapshot.
reportRender report (md, html, junit, json).

Common options

OptionMeaning
--output, -o <file>Write to file instead of stdout.
--base <file>Baseline JSON snapshot (diff / report / check).
--quietSuppress progress messages on stderr.
--help, -hShow help.
--version, -vShow CLI version.

Examples

bash
# Quick analysis
archora analyze . > scan.json

# Gate CI on grade D / any cycles
archora check . --fail-on grade:D --fail-on cycles:0

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

# Diff against last week's baseline
archora diff . --base scan-baseline.json -o diff.json

See Exit codes and CI integration for putting this in pipelines.