Reports and Output Formats

Arxo can emit results in four formats. Choose the one that fits your workflow.

Formats

Format	Config value	Use case	Output
Console	`console`	Default; terminal, CI	stdout
JSON	`json`	CI, tooling, APIs	stdout or `report.file`
HTML	`html`	Human review, graphs	file (set `report.file`)
Snapshot	`snapshot` or `yaml`	Versioned summaries	YAML file (set `report.file`)

Console

Default when no config is used or report.format is console. Prints metric IDs and values plus policy pass/fail. Exit code is 0 if all invariants pass.

arxo analyze --path .

JSON

Use for CI, scripts, or feeding other tools. Pass --json or set report.format: json. Optionally set report.file to write to a path.

report:
  format: json
  file: report.json

arxo analyze --path . --config config.yaml
# or
arxo analyze --path . --json

HTML

Generates a single HTML file with charts and graph visualizations (e.g. core-periphery, cycles). Set report.format: html and report.file to the output path.

report:
  format: html
  file: report.html

Snapshot (YAML)

The snapshot reporter produces a version-controllable YAML summary of the architecture: structure, key components, dependencies, and health metrics. Use it to track architecture over time in git.

report:
  format: snapshot # or yaml
  file: snapshot.yaml

Snapshot contents include group summary, layers, modularity communities, core-periphery structure, hubs, and refactoring recommendations in a readable, diff-friendly format.

Configuration reference

See Configuration for the full report section and report.file options.