🧭

archipilot

Enterprise Architecture Copilot · inside VS Code


Interactive Onboarding — Hands-On

Pick your role on the next slide · follow the steps · try every command live in VS Code

ext install enzomar.archipilot

Who are you today?

Click your role — you'll jump straight into a hands-on scenario tailored for you.

💻

Developer

You build software and need to document the architecture — fast, without leaving VS Code.

⏱ ~6 steps · 10 min
🗺️

Architect

You manage a live EA programme — decisions, risks, impact analysis, governance.

⏱ ~6 steps · 10 min
🔭

Curious

You want to explore what archipilot can do. No existing project needed — start from zero.

⏱ ~7 steps · 12 min
💻 Developer Track

Your Scenario

ShopEngine — you just finished building a microservice backend for a new e-commerce platform. Your manager asks: "Can you share the architecture docs for the sprint review?"
You have 30 minutes and no Confluence page yet.

🎯 Goal

Go from zero documentation to a structured, version-controlled architecture with diagrams and decisions — all from inside VS Code.

🛠 What you'll use

  • /scan — auto-generate vault from source code
  • /diagram — auto-generate a context diagram
  • /c4 — generate a C4 model
  • /adr — record a design decision
  • /status — check completeness
💻 Developer · Step 1 / 6

Generate Your Architecture Vault from Code

Open VS Code in your ShopEngine repo, then in Copilot Chat type:
@architect /scan
What happens:
  • archipilot scans your workspace — package files, models, services, Dockerfiles, API specs, README
  • A TOGAF vault is created with 27 template files — then auto-populated with real information from your code
  • Tech stack → D2_Technology_Standards_Catalog.md with actual package versions
  • Services / controllers → C1_Application_Architecture.md with real component names
  • Data models → C2_Data_Architecture.md · Dockerfile/Terraform → D1_Technology_Architecture.md
  • Diff preview shown before any file is written — apply with one click
💡 No existing vault? Skip /scan and use @architect /new ShopEngine-Architecture to scaffold a blank template instead.
💻 Developer · Step 2 / 6

Review & Add What Code Can't Say

Open C1_Application_Architecture.md — the scan auto-populated it. Add anything it missed (business context, cross-cutting concerns):

## Target State - **API Gateway** (AWS API Gateway) — entry point for all external traffic - **Auth Service** (Node.js + Cognito) — OAuth2 / JWT - **Product Catalogue** (Node.js) → DynamoDB - **Order Management** (Java / Spring Boot) → Aurora PostgreSQL - **Notification Service** (Python) → SES + SNS - **Event Bus** (Kafka MSK) — async decoupling - **Frontend** (Next.js) → CloudFront + S3 ## Dependencies - [[D1_Technology_Architecture]] - [[X1_ADR_Decision_Log]]
💡 The [[WikiLink]] syntax creates the knowledge graph archipilot uses for impact analysis. Add any services the scan didn't pick up automatically.
💻 Developer · Step 3 / 6

Generate a Context Diagram

With C1 open, run:
@architect /diagram
Expected: Mermaid flowchart LR inserted under a new ## Context Diagram section — auto-generated from the services you listed above.
Want a C4 model instead? Run:
@architect /c4
C4 Context diagram — shows ShopEngine, customers, and all external systems (Cognito, Kafka, CloudFront) in standard C4 notation.
💻 Developer · Step 4 / 6

Record a Design Decision

You chose Redis for session caching. Let's document it properly:

@architect /adr Adopt Redis (ElastiCache) for session caching — stateless API tier requires shared session store; Redis gives sub-ms latency at horizontal scale
Expected:
  • Entry appended to X1_ADR_Decision_Log.md — chat confirms with ✅
  • AD-01 · Status: 🟡 Proposed · Date: today · Owner: TBD
  • Template sections: Context, Options, Decision — ready to fill
  • Suggestion: use /decide next to get AI analysis on this decision
💡 Every decision is traceable. Future architects (or you in 6 months) will know exactly why each choice was made.
💻 Developer · Step 5 / 6

Check What's Still Missing

@architect /status
Expected output:
  • 📊 Document Maturity table — how many files are draft / in-review / approved
  • Key Metrics with RAG status: open decisions, risks, questions, broken links, TBD ownership
  • Open Items by ADM Phase — which phases need the most attention
Try this: Run @architect /todo to get a prioritised list of exactly what to fill next.
@architect /todo
💻 Developer Track

What You Just Did

🎉

In under 10 minutes you went from zero docs to a versioned architecture vault, a context diagram, and your first ADR.

✅ You learned

  • /scan — generate a TOGAF vault from source code in one command
  • /diagram and /c4 — generate diagrams from prose
  • /adr — record design decisions with governance
  • /status and /todo — know what's missing, what's next

Next to explore: /scan --append to add another microservice repo to this vault · /audit to run a unified health check (status + review + gate) · /archimate to export to Archi, BiZZdesign or Sparx EA · /drawio for stakeholder diagrams · /analyze for impact analysis

🌐 Documentation ⭐ Star on GitHub
🗺️ Architect Track

Your Scenario

HealthConnect — you've just joined a mid-flight project. Architecture decisions are buried in email threads. Risks are in someone's head. Three work packages are blocked. Your first stand-up is in 2 hours.

🎯 Goal

Get full situational awareness, surface the critical blockers, resolve an open decision, and record the outcome — with governance — before the stand-up.

🛠 What you'll use

  • /status — instant health dashboard
  • /todo — prioritised action list
  • /decide — vault-grounded analysis
  • /adr — record the decision
  • /analyze — impact analysis
  • /update — update risk / doc
Before you start: copy demo/sample-vault/ to a local folder and open it in VS Code — this gives you a realistic pre-populated vault to work from.
🗺️ Architect · Step 1 / 6

Monday Morning Dashboard

Run this first — every morning:
@architect /status
Expected — instant situational awareness:
  • 📊 Document Maturity table — draft / in-review / approved counts
  • Key Metrics with RAG (🔴🟡✅): open decisions, proposed decisions, open risks, risks without owners
  • Open questions, broken WikiLinks, TBD ownership — all counted
  • Open Items by ADM Phase — see which phases are blocking
💡 This replaces the 30-minute "what's the status?" email chain. Everything in the vault, summarised in seconds.
🗺️ Architect · Step 2 / 6

What's the Highest Priority?

@architect /todo
Expected — cross-vault priority list:
  • Overview table — total items, by priority (🔴 critical · 🟠 high · 🟡 medium · ⚪ low), unassigned count
  • Per-category tables: 🔷 Open Decisions · ⚠️ Open Risks · ❓ Open Questions · 📦 Work Packages · 🔗 Broken Links …
  • Each row: Priority | ID | Action | Owner | Phase | Detail
  • Distribution by ADM Phase + AI prioritisation & analysis
💡 archipilot traces across all vault files to find blockers — decisions, risks, open questions, and requirement gaps — sorted by business impact.
🗺️ Architect · Step 3 / 6

Resolve the Blocker — Decision Analysis

@architect /decide AD-01 — evaluate Kong, AWS API Gateway, and Azure APIM as the API gateway for HealthConnect given PCI-DSS requirements, multi-cloud strategy Q-04, and the team's limited infra ops capacity
Expected — vault-grounded analysis (Step 1 of 2):
  • AI reads your full vault context — PCI-DSS risk, team skills, multi-cloud question
  • Structured analysis streamed as markdown in chat (pros / cons, recommendation)
  • No vault changes at this stage — this is analysis-only
  • Confirm to proceed to Step 2: Yes, go with AWS API Gateway — records the decision
💡 The analysis references your actual vault content — not generic internet knowledge. The PCI-DSS risk, your team profile, your constraints. This is architecture intelligence, not a Google search.
🗺️ Architect · Step 4 / 6

Record the Decision — Governed

@architect /adr Adopt AWS API Gateway as the API entry point for HealthConnect — managed, PCI-DSS ready, no infra ops overhead. Revisit at Phase 3 if multi-cloud needed.
Chat confirms:
+ ✅ Recorded: AD-04 — Adopt AWS API Gateway
+ Status: 🟡 Proposed · Date: today · Owner: TBD
+ Template: Context, Options, Decision sections
💡 Entry is appended directly to X1_ADR_Decision_Log.md. Automatic timestamped backup created before every write. Nothing is lost.
🗺️ Architect · Step 5 / 6

Impact Analysis — Before You Change Anything

@architect /analyze What is the impact of migrating HealthConnect from VPN-based remote access to a zero-trust network architecture?
Expected — vault-grounded AI analysis:
  • AI reads your full vault and reasons about the impact of the change
  • Affected components, requirements, risks, and decisions — traced across files
  • Recommended actions streamed as markdown in chat
  • May include structured vault update proposals — review in diff preview before applying
💡 Safe to run at any time — no changes are made unless the AI proposes updates and you explicitly click Apply All in the diff preview.
🗺️ Architect Track

What You Just Did

🏛️

Hour 1 on an inherited project → full situational awareness, one critical blocker resolved, decision documented, impact assessed.

✅ You learned

  • /status — Monday morning EA dashboard
  • /todo — prioritised cross-vault action list
  • /decide — vault-grounded decision analysis
  • /adr — governed decision recording with diff + backup
  • /analyze — impact analysis before making changes

Next to explore: /archimate — export your vault to Archi or BiZZdesign · /drawio — prepare stakeholder slides · /audit — unified vault health check · /update — governed document updates

🌐 Documentation ⭐ Star on GitHub
🔭 Curious Track

Your Scenario

You've heard of TOGAF, ArchiMate, EA tools. You're not sure if this is for you. No existing project needed. Follow the steps and you'll have a full architecture model — with diagrams and ArchiMate export — in under 12 minutes.

🎯 Goal

Go from zero to a complete architecture vault with AI-generated diagrams and a standards-compliant ArchiMate model — so you can judge for yourself if archipilot fits your workflow.

🛠 Full tour

  • /scan — auto-generate from code
  • /new — scaffold from scratch
  • /decide — AI analysis
  • /diagram + /c4 — diagrams
  • /status + /todo — health
  • /archimate — enterprise export
  • /drawio — stakeholder diagrams
Before you start: Open VS Code · open Copilot Chat (Cmd+Shift+I) · create an empty folder.
🔭 Curious · Step 1 / 7

Create a Project From Nothing

In Copilot Chat, type exactly this — use any project name you like:
@architect /new MyFirst-Architecture
Watch:
  • 27 files appear in Explorer — a complete TOGAF-aligned vault
  • Chat shows file listing grouped by ADM phase (Preliminary → A → B → … → H → Requirements → Cross-phase)
  • Every file has YAML front matter with status, ownership, and TOGAF phase info
  • Suggested next: /status, /analyze, /update
💡 These are just Markdown files. You can edit them in VS Code, commit to Git, and read them in any editor. No proprietary format.
🔭 Curious · Step 2 / 7

Give archipilot Something to Work With

Open A1_Architecture_Vision.md and add a few lines — use a project you're familiar with:

## Project: [Your project name] ## Business Drivers - BD-01: [Why does this system exist?] - BD-02: [What business problem does it solve?] - BD-03: [What would happen if we didn't build it?] ## Target State [In 1-2 sentences: what does the system look like when it's done?] ## Constraints - CON-01: [Any budget, technology, or regulatory constraints?]
💡 Even 3 bullet points are enough for archipilot to start reasoning. You don't need a perfect document — start rough.
🔭 Curious · Step 3 / 7

Ask an Architecture Question

archipilot understands plain English. Try any of these — or ask your own question:

@architect What are the riskiest architectural decisions I haven't made yet?
@architect /decide Should I use a monolith or microservices for a team of 5 developers building a B2C platform?
@architect What TOGAF phases am I missing coverage for?
💡 archipilot reads your vault before answering — so the analysis is grounded in your actual context, not generic internet knowledge.
🔭 Curious · Step 4 / 7

Generate Diagrams Automatically

Context diagram from prose

@architect /diagram
Mermaid flowchart LR — auto-generated from the components and dependencies you've listed in your vault.

C4 model

@architect /c4
C4 Context + Container diagrams in Mermaid — the standard notation used by thousands of architecture teams globally.
💡 No draw.io, no Visio, no special syntax. Diagrams live in your Markdown files — they render in GitHub, Obsidian, VS Code with the Mermaid extension.
🔭 Curious · Step 5 / 7

Check What's Missing

Health dashboard

@architect /status
Document completeness per TOGAF phase · open decisions · unmitigated risks · missing owners

Prioritised next steps

@architect /todo
Ranked action list — what's blocking, what's overdue, what's low risk to defer
💡 /status and /todo can be run any time — they're read-only and never modify your vault.
🔭 Curious · Step 6 / 7

Export to Enterprise Tools ⭐

@architect /archimate
Expected in chat:
  • ✅ File saved: exports/archimate/[name]_ArchiMate_[timestamp].xml (clickable link)
  • 📐 Export summary table — total elements, relationships & views
  • ↳ Breakdown by ArchiMate layer (Business, Application, Technology, Motivation…)
  • ↳ Breakdown by element type and list of source files
  • 🔧 Compatibility table (Archi, BiZZdesign, Sparx EA, ADOIT)
  • 🧠 AI analysis of model completeness and enrichment suggestions

Compatible tools

  • Archi — free, open source
  • BiZZdesign Horizzon
  • Sparx Enterprise Architect
  • ADOIT · BOC
Bonus: If you have Archi installed — File → Import → Open Exchange File → select the XML. You'll see your full model in a layered ArchiMate view.
🔭 Curious · Step 7 / 7

Stakeholder Diagrams — One More Command

@architect /drawio
Expected in chat:
  • ✅ 4 .drawio files saved in exports/drawio/ (clickable links)
  • Combined multi-tab file + individual As-Is · Target · Migration diagrams
  • Summary: element counts by layer, migration status breakdown (add/keep/remove)
  • Color legend: 🔴 Remove · 🟢 Add · 🔵 Keep
🎉

In under 12 minutes — from nothing — you built a TOGAF-compliant architecture vault, generated diagrams, and exported an ArchiMate model importable by enterprise tools.

✅ Full tour complete

  • /scan /new /decide /diagram /c4 /status /todo /audit /archimate /drawio
🌐 Documentation ⭐ Star on GitHub
🧭

archipilot

Enterprise Architecture Copilot · TOGAF-aligned


📦 Install

VS Code → Extensions → search enzomar.archipilot

or: ext install enzomar.archipilot

⭐ Star & Contribute

github.com/enzomar/
archipilot

🌐 Documentation

enzomar.github.io/
archipilot

🔍 /scan — vault from source code
🆓 Free · MIT License
📄 Works on Markdown files · Git-native
🏛 TOGAF ADM aligned
🔌 ArchiMate 3.2 · Draw.io export