Documentation

Quick-start and reference docs for using ArchSentinal in your projects.

Quick start

# 1. Install
archsentinal install  # or use the downloaded binary

# 2. Run a scan
archsentinal scan ./path/to/project

# 3. JSON output
archsentinal scan ./project --json > report.json

Key concepts

Dependency graph: file-level import graph built from your repository.
Risk score: 0–100 metric combining cycles, god files and dependency density.
Impact analysis: walks reverse dependencies to find high-blast-radius files.

Configuration (.archguard.toml)

ArchSentinal picks up an optional .archguard.toml at the repository root to fine-tune scanning.

skip_dirs = ["dist", "build"]
god_file_loc_threshold = 600
ignore_test_files = true
ignore_config_files = true

Desktop app

The ArchSentinal desktop app wraps the same engine and lets you explore risk, cycles and impact visually. It reads the same JSON output produced by the CLI.

See Download for platform-specific notes.