Skip to content
Arxo Arxo

Quick Start

Quick Start

Section titled “Quick Start”

This guide walks you through running your first analysis with Arxo.

Run Your First Analysis

Section titled “Run Your First Analysis”
Section titled “Option 1: Interactive Mode (Recommended for Beginners)”

The easiest way to get started:

Terminal window
arxo analyze --interactive

Interactive mode will guide you through:

  1. Selecting the project directory
  2. Choosing an analysis preset
  3. Saving the report (optional)

See the Interactive Mode guide for details.

Option 2: Command Line

Section titled “Option 2: Command Line”

From the root of a TypeScript, JavaScript, Rust, Python, or Java project:

Terminal window
arxo analyze --path /path/to/your/project

If you are already inside the project directory:

Terminal window
arxo analyze --path .

Arxo will:

  1. Detect the language (TypeScript/JavaScript, Rust, Python, or Java)
  2. Parse imports and build the dependency graph
  3. Run enabled metrics (by default, SCC and others if configured)
  4. Print results to the console

Understanding the Output

Section titled “Understanding the Output”
  • Console format: Metric IDs and values (e.g. scc.cycle_count, scc.max_cycle_size) plus policy pass/fail
  • Exit code: 0 if all policy invariants pass, non-zero otherwise

For more control over which metrics run and which directories are excluded, use a configuration file.

Next Steps

Section titled “Next Steps”