Search docs

Docs search

Rule Catalog

Look up ArchPilot validation rules by ID, category, severity, and fix path.

How to use this catalog

Start with the rule ID from a local validation report, CI output, VS Code finding, or Cloud finding. Each rule page explains what the finding means and the safest next fix to try.

Application Layering

5 rules

Architecture

11 rules
AP-ARCH-001error
Modular monolith folder structure exists

Checks that the configured module root exists and contains the expected module directories.

setup-gapNo auto-fix
AP-ARCH-002info
Implementation profile not fully supported

Reports when ArchPilot falls back from a specific implementation profile to default validation behavior.

guidanceNo auto-fix
AP-ARCH-003error
Architecture overview artifact exists

Checks that the architecture overview document exists.

setup-gapNo auto-fix
AP-ARCH-004warning
Module baseline files exist

Checks that expected module baseline artifacts are present.

setup-gapNo auto-fix
AP-ARCH-005error
Module registry path exists

Checks that registered module paths exist as directories.

setup-gapNo auto-fix
AP-ARCH-006error
Module contract file exists

Checks that every registered module contract file resolves.

setup-gapNo auto-fix
AP-ARCH-007error
Module contract identity matches registry

Checks that module contract identity and field shape align with the registry.

setup-gapNo auto-fix
AP-ARCH-008error
Module public entrypoints are aligned

Checks that registered module public entrypoints match the public surfaces declared in module contracts.

setup-gapNo auto-fix
AP-ARCH-009error
Project rule configuration file is valid

Checks that the project rule configuration file can be parsed and used.

setup-gapNo auto-fix
AP-ARCH-010error
Invalid ArchPilot project configuration JSON

Checks that the ArchPilot project configuration is valid JSON.

setup-gapNo auto-fix
AP-ARCH-011error
Invalid ArchPilot project identity configuration

Checks that project identity fields are present and usable.

setup-gapNo auto-fix

Dependency

11 rules
AP-DEP-001error
Circular module dependency detected

Flags direct circular dependencies between modules.

violationNo auto-fix
AP-DEP-002error
Forbidden cross-module dependency detected

Flags dependencies blocked by dependency rule configuration.

violationNo auto-fix
AP-DEP-003error
Non-public cross-module import detected

Flags cross-module imports that do not use a public module entrypoint.

violationNo auto-fix
AP-DEP-004error
Cross-module dependency missing from module contract

Flags an actual cross-module import that is not declared in the source module contract.

violationNo auto-fix
AP-DEP-005error
Cross-module import bypasses public module surface

Flags imports that reach into another module's internals instead of its public entrypoint.

violationNo auto-fix
AP-DEP-006warning
Declared module dependency not used

Flags a module contract dependency that no longer appears in implementation imports.

violationNo auto-fix
AP-DEP-007warning
Potential orphan module detected

Flags modules with no declared or actual inbound/outbound module dependencies.

violationAuto-fix available
AP-DEP-008error
Transitive circular module dependency detected

Flags dependency cycles that emerge through multiple module hops.

violationNo auto-fix
AP-DEP-009warning
Module has high inbound dependency count

Flags modules with a high number of inbound dependencies.

violationNo auto-fix
AP-DEP-010error
Dependency violates architecture layer direction

Flags dependencies that point against the configured architecture layer direction.

violationNo auto-fix
AP-DEP-011error
Cross-component dependency policy violation

Flags dependencies between components that violate the configured cross-component policy.

violationNo auto-fix

API

2 rules

API Design

6 rules

Authorization

3 rules

Database

2 rules

Domain Model Quality

5 rules

Documentation

11 rules

Event Architecture

4 rules

Data / Query Risk

8 rules

Safety Controls

3 rules

Tenant Isolation

4 rules

Transaction Boundaries

4 rules
Rule Catalog | ArchPilot Docs