CLI

CLI

Arxo provides two main interfaces: the CLI for command-line analysis and the Rust API for programmatic use.

CLI Reference

The Arxo CLI offers these commands:

Command	Description
analyze	Analyze a project directory for architecture metrics
init	Create a default config file
metrics	List and explain available metrics
cache	Manage analysis cache
doctor	Run environment diagnostics
config	Validate configuration
completions	Generate shell completions

Global options

These options apply to all commands. They are defined once here; command pages refer to this section when relevant.

Option	Description
--format	Output format: console, json, html, snapshot, sarif, or msgpack (default: console). Used by analyze and any command that produces report output.
--quiet	Suppress progress and non-result output (for scripting and CI).

Tip

For full option lists and examples, the CLI reference pages (e.g. analyze, init) are the authoritative source. The OpenAPI spec in this section is a summary for tooling.

Rust API Documentation

The Arxo crate exposes a Rust API for programmatic analysis. When you use the arxo crate from crates.io, API documentation is available on docs.rs (when published) or via cargo doc --open in a project that depends on arxo.

Main modules

• Core (arxo::core) — Type system, data store, orchestrator
• Metrics (arxo::metrics) — Metric plugins and computation
• Data (arxo::data) — Import graph, call graph, language parsers
• Report (arxo::report) — Console, JSON, HTML, and snapshot reporters
• Policy (arxo::policy) — Policy evaluation engine
• Config (arxo::config) — YAML configuration loading