Skip to content
@Archimaid

ArchiMaid

Write the architecture. Get the diagram. A tool to write plain text and convert it to ArchiMate diagrams.

Archimaid

Enterprise architecture diagrams as code. Archimaid is an open-source project for writing ArchiMate® 3.2 diagrams in plain text, checking them in CI, and rendering them through Mermaid.

Architecture diagrams usually live in binary files that are hard to review, diff, or keep next to the systems they describe. Archimaid treats them like any other source file: written in a readable syntax, reviewed in pull requests, validated before they are published, and rendered wherever Mermaid runs.

Application components and services supporting an order fulfilment process

archimate-beta
  element businessRole clerk "Fulfilment clerk"
  element businessProcess fulfil "Fulfil order"
  clerk @==> fulfil

Projects

Repository Description
archimaid The Mermaid diagram plugin, language API and archimaid command-line tool. Published on npm.
playground A browser playground for trying the syntax without installing anything. In development.

Get started

npm install archimaid mermaid
npx archimaid validate docs/

The archimaid README covers the syntax, layouts, host integration and the language API. More information is available at archimaid.org.

Principles

  • Open source, non-commercial. Archimaid is free to use under the MIT License. There is no paid edition, hosted service or commercial roadmap.
  • Authoring, not model management. The focus is writing and reviewing diagrams. Archimaid does not aim to replace modelling tools or model repositories.
  • Grounded in the standard. Element and relationship types follow the ArchiMate 3.2 Specification, and documentation cites its sources.
  • Built for review. Plain text, stable IDs and precise diagnostics make diagrams practical to keep in Git and check in CI.

Contributing

Contributions are welcome, from bug reports and documentation fixes to new syntax proposals. Start with the contributing guide and the code of conduct. For a change to the diagram syntax, open an issue with a proposal before starting work, so the design can be agreed first. Report security issues as described in the security policy.

Trademarks

Archimaid is an independent community project and is not affiliated with or endorsed by The Open Group. ArchiMate is a registered trademark of The Open Group in the United States and other countries. Mermaid is a separate open-source project and is not affiliated with Archimaid.

Pinned Loading

  1. archimaid archimaid Public

    ArchiMate® diagrams as code for Mermaid. Write, validate and render enterprise architecture views in plain text.

    TypeScript 8

  2. playground playground Public archive

    Archived. Former browser playground for ArchiMate® diagrams, replaced by the designer at design.archimaid.org.

    TypeScript 1

Repositories

Showing 5 of 5 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…