Documentation
ArchLang is a language for describing system architecture as text. Every diagram, view, dependency graph, and impact report is derived from .arch source files.
The ArchLang Book
Section titled “The ArchLang Book”The docs are organized as a single linear book in seven sections.
Start here
Section titled “Start here”- Foreword — what ArchLang is, who it’s for, the three commitments that drive everything else.
- Chapter 1: Setup — install the CLI, configure your editor.
- Chapter 2: Your First Architecture — write
.arch, see a diagram, in five minutes.
Sections
Section titled “Sections”| Section | Chapters | What it covers |
|---|---|---|
| Foundations | 0–3 | Foreword, setup, first system, first diff |
| The Language | 4–10 | Bare-type language: modules, interfaces, facets, processes, views, fields/aspects, descriptions |
| Stdlib & Projects | 11–14 | Standard library types, packages, stable IDs, diffs |
| The Metamodel | 15–20 | Types, required blanks, propagation, refinement, widgets |
| Tooling | 21–24 | CLI, editor integration, embedding diagrams, library APIs |
| Worked Designs | 25–30 | SaaS backend, event pipeline, external integration, compliance, metamodel design, EA migration |
Appendices
Section titled “Appendices”- A: Grammar — EBNF for every construct.
- B: Keywords — every reserved word, where it’s legal.
- C: Stdlib Types — built-in module and interface types.
- D: Cheatsheet — every construct in 1-2 lines.