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.

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

10 rules

API

2 rules

Database

2 rules

Documentation

11 rules

Safety Controls

3 rules

Data & Query Risk

4 rules
Rule Catalog | ArchPilot Docs