Skip to content

archlint scan

The scan command performs a complete architectural analysis of your project.

Usage

bash
archlint scan [path] [options]

Options

OptionDefaultDescription
-f, --format <format>tableOutput format: table, json, markdown, sarif
-j, --jsonfalseShortcut for --format json
-r, --report <file>stdoutSave the report to a file
-s, --min-severity <sev>lowFilter by severity: low, medium, high, critical
-S, --min-score <score>noneFilter by minimum health score
-d, --detectors <ids>allComma-separated list of detectors to run
-e, --exclude-detectors <ids>noneDetectors to skip
-A, --allfalseRun all detectors (including disabled by default)
--no-cachefalseDisable analysis caching
--no-gitfalseDisable git integration (skip churn analysis)

Examples

Scan with Markdown report

bash
archlint scan --format markdown --report report.md

Export to SARIF (for GitHub Code Scanning)

bash
archlint scan --format sarif --report results.sarif

Only run cycle detection

bash
archlint scan --detectors cycles,circular_type_deps

High severity only

bash
archlint scan --min-severity high

Released under the MIT License.