## The source-available 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. [![main](https://github.com/event-catalog/eventcatalog/actions/workflows/verify-build.yml/badge.svg)](https://github.com/event-catalog/eventcatalog/actions/workflows/verify-build.yml) [![License: BSL 1.1](https://img.shields.io/badge/License-BSL%201.1-blue.svg)](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE) [![npm version](https://badge.fury.io/js/@eventcatalog%2Fcore.svg)](https://badge.fury.io/js/@eventcatalog/core) [![All Contributors](https://img.shields.io/badge/all_contributors-69-orange.svg?style=flat-square)](#contributors-) **40,000+ catalogs created**

Architecture visualiser

[Documentation](https://www.eventcatalog.dev/docs) | [Live Demo](https://demo.eventcatalog.dev) | [Discord](https://discord.gg/3rjaZMmrAm)
## Get started in seconds ```bash 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](https://www.eventcatalog.dev/docs/development/getting-started/installation) guide. --- ## Core Features ### Document your architecture Document domains, services and messages across your architecture.

EventCatalog overview

### 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.

AI-powered discovery

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

Schema explorer

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

Schema fields explorer

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

Bring your own docs

### 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.

Business flow documentation

### 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**](https://demo.eventcatalog.dev/) | [**Finance**](https://eventcatalog-examples-finance.vercel.app/) | [**Healthcare**](https://eventcatalog-examples-healthcare.vercel.app/) | | [**SaaS**](https://eventcatalog-examples-saas.vercel.app/) | | | --- ## Packages | Package | Description | |---------|-------------| | [@eventcatalog/core](./packages/core) | Main catalog application (Astro + React) | | [@eventcatalog/sdk](./packages/sdk) | Node.js SDK for programmatic catalog management | | [@eventcatalog/create-eventcatalog](./packages/create-eventcatalog) | CLI scaffolding tool | | [@eventcatalog/visualiser](./packages/visualiser) | Standalone React visualiser component | --- ## Documentation Visit the [official docs](https://www.eventcatalog.dev/docs/development/getting-started) to learn more. --- ## Support Need help? Join the [EventCatalog Discord](https://discord.gg/3rjaZMmrAm). --- ## Contributing We welcome contributions! See the [contributing guidelines](https://eventcatalog.dev/docs/contributing/overview) to get started. --- ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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} 🐛	_{Lucas Chabalier} 💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ---

**[Website](https://eventcatalog.dev)** | **[Docs](https://www.eventcatalog.dev/docs)** | **[Discord](https://discord.gg/3rjaZMmrAm)** | **[Twitter](https://twitter.com/eventcatalog)** _{Made with ❤️ by the EventCatalog community}

--- ## License EventCatalog is source-available under the [Business Source License 1.1](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE). It is free for eligible organisations (under USD 10M revenue and under USD 10M funding). Otherwise it is covered by a subscription. See [pricing](https://www.eventcatalog.dev/pricing). Version 5.0.0 (including its pre-releases) and later is covered by that licence. Releases up to and including 4.x remain available under the MIT License (see [NOTICE](NOTICE)). The ecosystem packages (the SDK, CLI, connectors, diff, linter, visualiser, breaking-changes and create-eventcatalog) are licensed under MIT.