The open source documentation tool for software architectures.

Snapshot 2026-08-03 23:56:39 UTC · version 1

published
INDEXABLE MARKDOWN SNAPSHOT

Research document

Open canonical .md

The open source documentation tool for software architectures.

A documentation tool designed for software architecture not generic pages.

Document systems, domains, services, messages and schemas. Document your architecture they way you build it.

Customize your documentation to fit your workflow. Automate it, customize it, visualize it.

40,000+ catalogs created


Documentation | Live Demo | Discord


Get started in seconds

npx @eventcatalog/create-eventcatalog@latest my-catalog

That's it. Open http://localhost:3000 and start documenting your architecture.

Looking for a guided walkthrough? Check out the Getting Started guide.


Core Features

Document your architecture

Document domains, services and messages across your architecture.

AI-powered discovery

Ask questions about your architecture and business in natural language. The built-in AI chat and MCP server let you and your tools query your catalog.

Schema explorer

Quickly find any schema across your catalog — OpenAPI, AsyncAPI, Protobuf, JSON Schema, Avro, and more. All in one searchable place.

Schema fields

Filter and find any property on any field across your entire catalog. See how fields are used across services and messages.

Bring your own docs

Attach architecture decision records, runbooks, and any custom documentation to your domains, services, and teams. Version them alongside your architecture.

Document business flows

Tell the end-to-end story of your business workflows. Reference the services and messages you already have to build a higher-level picture of how everything fits together.

And much more...

  • Version your resources — Full semantic versioning for events, commands, services, and more
  • 15+ generators — Auto-generate from AsyncAPI, OpenAPI, Kafka, Confluent, AWS EventBridge, and more
  • Customizable — Themes, custom MDX components, and configurable layouts
  • Enterprise ready — OAuth2, RBAC, schema governance, breaking change detection

Demos

See EventCatalog powering real-world architectures:

E-Commerce Finance Healthcare
SaaS

Packages

Package Description
@eventcatalog/core Main catalog application (Astro + React)
@eventcatalog/sdk Node.js SDK for programmatic catalog management
@eventcatalog/create-eventcatalog CLI scaffolding tool
@eventcatalog/visualiser Standalone React visualiser component

Documentation

Visit the official docs to learn more.


Support

Need help? Join the EventCatalog Discord.


Contributing

We welcome contributions! See the contributing guidelines to get started.


Contributors ✨

Thanks goes to these wonderful people (emoji key):


David Boyne

💻 🖋 🎨 💡 🤔 📖

Benjamin Otto

💻 🤔 📖 🐛

Tiago Oliveira

📖 🐛

Jay McGuinness

📖

David Khourshid

📖

thim81

🤔 🐛 💻

Muthu

🐛

Dan Tavelli

📖

steppi91

📖

Donald Pipowitch

🐛 💻

Ken

📖

Rodolfo Toro

💻

Drew Marsh

💻

Dec Kolakowski

💻 📖

Yevhenii Dytyniuk

💻

lcsbltm

💻

Matt Martz

💻

Michel Grootjans

💻

Arturo Abruzzini

💻

Ad L'Ecluse

💻

Rafael Renan Pacheco

💻 📖

Luis Diego

💻

Daniel Ruf

📖

Fredrik Johansson

💻

Naresh Kumar Reddy Gaddam

💻

Andre Deutmeyer

💻

Pebbz

💻

Alexander Holbreich

📖

José Delgado

💻

jlee-spt

💻

Kim Rejström

💻

Christophe Gabard

💻

Carlo Bertini

💻

David Regla

💻

Marcio Vinicius

💻

Daniel Andres Castillo Ardila

💻

Baerten Dennis

💻

Ryan Cormack

💻

Nathan Birrell

💻

Jack Tomlinson

💻

Carlos Rodrigues

💻

omid eidivandi

💻

Simone Fumagalli

📖

d-o-h

💻

Cristian Pallarés

💻

Sebastian Rendon

💻

Craig Roberts

💻

Ivan Milosavljevic

📖

Martin Meredith

💻

Ruud Welling

💻

Kevin Pouget

💻

Vitalii Balash

💻

Arnaud Babilone

💻

Alexander Horner

💻

simonwfarrow

💻

Augusto Romero Arango

💻

cc-stjm

💻

Lucian Lature

🐛 💻

Vilas Chauvhan

💻

Eric Hoffman

🐛

wimhaesen-kine

💻

Ondrej Musil

🐛 🤔

Anatoly Bolshakov

💻

reisingerf

📖

Jonathan Barette

💻

mumundum

💻

Piotr Rybarczyk

🐛

ZakaryaCH

🐛

Jasper Boeijenga

💻

Tom Kirkpatrick

💻

Machul

🐛

ugostack

💻

Jean de Barochez

💻

cog06

🐛

Dominik Szczepaniak

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!


Website | Docs | Discord | Twitter

Made with ❤️ by the EventCatalog community


License

MIT.

MARKDOWN METRICS
2691words
17headings
25links
1code blocks
MDRSS ASSESSMENT
Evidence46/100medium confidence
Why MDRSS assigned this score
  • Production catalog audit 2026-08-04
  • Taxonomy classified from title, annotation, source and Markdown signals
  • Agent usefulness evaluated from structure, procedures, examples, evidence and retrieval value
Evidence (1)

Discussion 0

Sign in to join the discussion.