Search docs

Docs search

Rule Catalog

Use the Rule Catalog to understand ArchPilot validation rules, rule categories, severity, examples, remediation guidance, and useful commands.

Why it matters

The Rule Catalog is the reference for what ArchPilot rules mean and how teams should respond when local validation uploads findings to Cloud.

Plan availability

The Rule Catalog is available on every plan. Organization-wide rule intelligence is available on Growth and above.

ALL PLANS

Rule Catalog

Browse rules, search by ID or concept, review severity and category, and use detailed rule guidance.

GROWTH AND ABOVE

Rule Intelligence

Connect rules to Governance Impact, Affected Repositories, Related Findings, and cross-repository visibility.

What the Rule Catalog is

The Rule Catalog explains implemented ArchPilot rules in product language. It is useful when a finding includes a rule ID, when a team wants to understand a validation category, or when a reviewer needs practical remediation guidance before changing code.

The catalog is available on every plan and remains useful for rule education before organization-level rule impact is available.

  • Rule IDs and rule names
  • Rule category and severity
  • Finding type and summary
  • Why This Rule Exists
  • Example Violation and Example Resolution
  • How To Fix guidance
  • Useful commands when a rule has a relevant CLI workflow

Browse, search, and filter rules

Use the Rule Catalog when you know the rule ID from a finding, when you want to browse by category, or when you are looking for a concept such as authorization, tenant isolation, transaction boundaries, or event architecture.

  • Search by rule ID, rule title, category, severity, or a phrase from the finding.
  • Filter by category when you want to review one governance area at a time.
  • Use severity to understand how urgently a rule usually needs attention.
  • Open the Rule Detail page when a catalog row needs more context than the table can show.

Rule categories and severity

Categories group rules by the architecture concern they protect. Severity communicates how strongly the rule usually affects architecture governance when it appears in findings.

Severity is not a replacement for engineering judgment. A lower-severity finding can still matter when it appears repeatedly or affects a sensitive system.

  • Application Layering
  • Authorization
  • Tenant Isolation
  • Transaction Boundaries
  • Domain Model Quality
  • API Design
  • Data / Query Risk
  • Event Architecture

Rule Detail page

The Rule Detail page keeps the educational parts of a rule separate from organization-wide intelligence. Every plan can use the overview and guidance sections to understand what the rule means and how to fix it.

When useful commands are available, the page presents them as readable command snippets so they can be copied or retyped without hunting through paragraph text.

  • Overview: rule ID, category, severity, finding type, and summary.
  • Why This Rule Exists: the architecture reason behind the rule.
  • Example Violation: a practical example of the pattern ArchPilot is warning about.
  • Example Resolution: the direction a healthy implementation should move toward.
  • How To Fix: concrete remediation steps and useful commands.

Common validation command

archpilot validate

Catalog vs Rule Intelligence

The Rule Catalog is educational and available on every plan. Rule Intelligence is organization-wide context and is available on Growth and above.

Keep those concepts separate when reviewing a finding. First use the catalog to understand the rule. Then, if the organization is on Growth or above, use Rule Intelligence to understand where the rule appears across repositories.

Rule Catalog | ArchPilot Docs