Search docs

Docs search

Getting Started

Get started with ArchPilot by initializing architecture metadata, reviewing the proposed model, and running your first architecture validation pass.

Why it matters

The first-run workflow is built around initialization, validation, and follow-up guidance so teams can start architecture validation without building a custom process first.

First-run workflow

ArchPilot is Inspector-first. When architecture metadata is missing, the extension guides you through initialization before the rest of the architecture workflows unlock.

The initialization flow is designed to capture only what ArchPilot needs to start modeling your repository and validating architecture rules.

  1. Open the ArchPilot inspector in VS Code.
  2. Review the detected repository structure and proposed architecture values.
  3. Fill in only the missing details that ArchPilot could not resolve automatically.
  4. Apply the initialization so ArchPilot can write the local architecture metadata and supporting files.
  5. Run validation to generate your first findings, score, readiness signal, and reports.

What to expect after init

  • A local architecture configuration becomes the reference point for architecture validation.
  • ArchPilot generates reports that explain findings, fix suggestions, and next steps.
  • If setup gaps remain, ArchPilot highlights them separately from deeper architecture problems so bootstrap work does not look like architecture failure.

A practical rollout pattern

Most teams begin by validating locally, reviewing the first set of findings, and tightening dependency or policy rules as the architecture model becomes clearer.

Once the local workflow feels trustworthy, the same architecture validation flow can move into CI and, optionally, into ArchPilot Cloud for shared history and governance visibility.

Getting Started | ArchPilot Docs