ArchScript for VS Code

Write your software architecture as code — and see it as a live diagram that checks itself.

ArchScript in VS Code

ArchScript is a small language for software architecture: domains, services, databases, queues and deployments (cluster → server → Docker container). This extension brings the free ArchScript Playground into VS Code.

Features

Live diagram beside your code (Cmd+K V). It lays itself out automatically and follows the active file. Click an element to jump to its line.
Visual editing: right-click the diagram to insert elements and containers, connect services, rename, recolour, move or delete. Every change becomes a small, undoable edit in the .archs file — the text stays the source of truth.
Language support: errors as you type, completion, hover docs, go to definition, outline, formatting and quick fixes.
Architecture rules: the Rules view lists every built-in rule. Click one to make it an error, warning, info or hint, or switch it off — ArchScript writes it into rules { … }. Write your own rules with rule my_rule { … } or ArchScript: New Rule….
Archpacks — your own elements: .archpack files add custom element types (label, base shape, colour, required properties) and rules. Every pack in the workspace is active automatically, and Import Archpack… makes a pack available everywhere. They're the same files as in ArchScript for Mac.
Element Library: all types, built-in and custom, grouped by category. Click one to insert it into the container at your cursor.
Exports (same branding as archscript.dev): PDF architecture report, SVG, PNG, Markdown documentation, Mermaid, PlantUML and JSON.
Review score in the status bar.

Quick start

Create shop.archs:

project Shop

domain Orders {
  element service "Order API" as orders { owner "Orders Team"; tech "Rust" }
  element database "Orders DB" as orders_db
}

element frontend "Web Shop" as web

relation web -> orders : HTTPS
relation orders -> orders_db : SQL

Press Cmd+K V (Ctrl+K V) to open the diagram.
Open the ArchScript view in the activity bar for rules, the element library and Archpacks.

Archpack example

pack "Team Pack" {
  version "1.0"
  author "Platform Team"
}

type payment_gateway {
  label "Payment Gateway"
  base service
  category external
  color "#a855f7"
  required [owner, provider]
}

rule services_need_owner {
  title "Services need an owner"
  severity warning
  require owner on element where category component
}

Settings

Setting	Description
`archscript.packs`	Extra `.archpack` files or globs (workspace packs and imported packs are always active)
`archscript.diagram.theme`	`auto`, `blueprint-dark` or `blueprint-light`
`archscript.diagram.openAutomatically`	Open the diagram when an `.archs` file is opened

Privacy

Everything runs locally: the ArchScript core is compiled to WebAssembly and ships with the extension. No telemetry, no network requests.

Language reference: archscript.dev/docs
Templates: archscript.dev/templates
ArchScript for Mac adds an iCloud element library, Terraform export and a local MCP server so Claude can plan your architecture with you: Mac App Store

ArchScript – Architecture as Code

ArchScript