Docs
Product documentation for local architecture validation and ArchPilot Cloud governance.
Explore a user-facing documentation center for the ArchPilot VS Code extension, CLI, and ArchPilot Cloud. Learn how architecture validation works locally, how governance upload connects to Cloud, and how teams use Cloud for architecture governance across repositories.
Use these docs to evaluate ArchPilot for deterministic software architecture guardrails, GitHub Actions workflows, governance upload, and engineering team rollout.
Docs focus
- Architecture validation in VS Code and the CLI
- Guardrails for keeping architecture intact during AI-assisted development
- Architecture as code, dependency validation, and policy workflows
- Governance upload and ArchPilot Cloud operations
What this enables
- Faster evaluation of the VS Code extension and CLI workflow
- Clear setup guidance for engineering teams using GitHub Actions
- Practical steps for governance upload, findings, and repository snapshots
- Contextual plan notes where Cloud behavior varies by plan
- One place to learn ArchPilot Cloud workflows end to end
Search docs
Find docs, rule IDs, and fix guidance.
Browse ArchPilot validation rules, rule IDs, severities, finding types, and rule-level fix guidance.
Rule Catalog / DocumentationAP-ADR-001 - ADR directory missingChecks that the configured ADR directory exists.
Rule Catalog / DocumentationAP-ADR-002 - ADR file missing titleChecks that ADR files include a top-level title.
Rule Catalog / DocumentationAP-ADR-003 - ADR status missing or invalidChecks that ADR files include a recognized decision status.
Rule Catalog / DocumentationAP-ADR-004 - Required ADR missing for architecture contextChecks that key architecture topics have ADR coverage.
Rule Catalog / APIAP-API-001 - OpenAPI contract existsChecks that an OpenAPI contract is present for REST API review.
Documentation hubs
Start with the product area you’re evaluating.
The docs are split into two hubs so local architecture validation and Cloud governance stay clear, connected, and easy to navigate.
Featured topics
Jump directly into common architecture validation evaluation questions.
These pages are the fastest way to understand what ArchPilot validates, how architecture policy enforcement works, and how Cloud fits into the local-first model.
Rule Catalog
Look up validation rule IDs, severity, finding type, and practical fix guidance for ArchPilot findings.
Connect a Repository
Follow the exact Cloud sign-in, API token, validate, and governance upload steps for connecting a repository to ArchPilot Cloud.
GitHub CI Integration
Set up GitHub Actions with a validation-first workflow, required Cloud connection values, and plan-aware main-branch Cloud upload behavior.
CLI Command Reference
Use the workflow-grouped command reference to understand what each major ArchPilot CLI command does, when to use it, and what it produces.
Upload Troubleshooting
Diagnose skipped uploads, wrong token or server values, missing Cloud records, and CI runs that validated but did not upload.
Documentation map
Browse the full docs information architecture.
Each hub is organized into focused workflow pages so engineering teams can go deeper without reading one long README-style document.
ArchPilot Extension & CLI
Use these docs when you want to initialize architecture metadata, run architecture validation locally, enforce dependency and policy rules, review findings, and optionally upload governance snapshots to ArchPilot Cloud.
ArchPilot Cloud
Use these docs when you want to understand how ArchPilot Cloud relates to local validation, how governance upload works, what data is stored in Cloud, and how teams use the workspace for organization-wide architecture governance.