# archfit
[](https://github.com/alexei-led/archfit/actions/workflows/ci.yaml)
[](https://github.com/alexei-led/archfit/tags)
[](LICENSE)
**archfit checks whether code changes follow the architecture declared for a repository.**
Tests can pass while a change adds a forbidden dependency or a new cycle. archfit reads dependency facts from language tools, applies your rules, and reports a verdict with evidence. Use the same check locally and in continuous integration (CI).
The report shows measured evidence and evidence gaps. It does not reduce the repository to one score.
```text
archfit check
VERDICT NEEDS ATTENTION
BLOCKING 0 active
ATTENTION diagnostics or incomplete evidence
```
The lines above show the report shape. Counts and verdicts depend on your repository.
## How it works
```mermaid
flowchart LR
S[Source code] --> A[Language analyzers]
C[.archfit.yaml] --> G[Rules and checks]
A --> G
G --> R[Verdict and evidence]
R -->|healthy| H[Continue]
R -->|needs attention| E[Review diagnostics<br/>and missing evidence]
R -->|blocked| F[Review the change]
classDef process fill:#e0f2fe,stroke:#0284c7,color:#082f49
classDef neutral fill:#f1f5f9,stroke:#64748b,color:#0f172a
classDef healthy fill:#dcfce7,stroke:#16a34a,color:#14532d
classDef attention fill:#fef3c7,stroke:#d97706,color:#451a03
classDef blocked fill:#fee2e2,stroke:#dc2626,color:#7f1d1d
class A,G process
class S,C,R neutral
class H healthy
class E attention
class F blocked
```
The report labels each outcome. Green means healthy, amber means needs attention, and red means blocked.
## Install and start
Install the CLI with Homebrew:
```sh
brew install alexei-led/tap/archfit
```
Or install a tagged release with Go:
```sh
go install github.com/alexei-led/archfit/v3/cmd/archfit@v3.2.0
```
Run these commands from your repository root:
```sh
archfit doctor
archfit config init --root .
archfit analyze -c .archfit.yaml
```
Review the generated module paths and rules before you use the configuration as policy. Create a baseline only after you review the findings. Run `archfit check` in CI.
The Docker image includes the locked Go, TypeScript/JavaScript, Python, Rust, and .NET toolchains, plus ast-grep, SCIP indexers, jscpd, cargo-modules, and the Roslyn helper (`archfit-roslyn`). Deeper analyzers remain configuration-controlled. See [Getting started](docs/getting-started.md#use-docker) for details.
## Documentation
- [Getting started](docs/getting-started.md) — install tools and run your first check.
- [Commands](docs/commands.md) — command behavior, flags, and exit codes.
- [Configuration](docs/configuration.md) — every configuration field and default.
- [Rules](docs/rules.md) — rule types, selectors, and waivers.
- [Results](docs/results.md) — verdicts and output schemas.
- [Metrics](docs/metrics.md) and [coupling](docs/coupling.md) — what the measurements mean.
- [Language support](docs/languages.md) — analyzers, tools, and coverage.
- [CI](docs/ci.md), [agents](docs/agents.md), and [AI](docs/ai.md) — automation workflows.
- [Troubleshooting](docs/troubleshooting.md) — common errors and recovery.
- [Migration](docs/migration.md) — upgrade from v2 to v3.
- [Architecture](docs/architecture.md) and [evidence](docs/evidence.md) — contributor references.
- [Development](CONTRIBUTING.md) — build and change the project.
- [Changelog](CHANGELOG.md) — release history.