An open notation for software architecture. Compact enough to paste into a README, precise enough to validate, diff and generate from code.
service checkout "Checkout" tech Go
datastore orders_db "Orders DB" tech PostgreSQL 16
checkout writes orders_db over SQL
Mermaid and PlantUML draw shapes. ArchCode knows what a service, a broker, a gateway is, what it exposes, and where it runs — so a diagram can be checked, compared with the running system, and generated from a repository.
| Read | the specification — archcode.io/docs |
| Try | the Playground — archcode.io/play |
| See | reference examples — archcode.io/examples |
| repository | what | license |
|---|---|---|
archcode-spec |
the language: specification, grammar, schema, conformance fixtures | CC BY 4.0 · Apache-2.0 |
archcode |
the reference engine, the archcode CLI and the VS Code extension |
Apache-2.0 |
On npm: @archcode-io/engine and
archcode (npm i -g archcode@preview).
Status: v0.2 draft. The notation is young and we are not taking pull requests yet; CONTRIBUTING says what helps instead.
ArchCode is an open standard created and maintained by Baryshev Labs.