Eventcatalog
Documentation tool built for software architecture. Document your domains, services, events and schemas — for your teams and your AI agents.
Install / Use
npx skills add event-catalog/eventcatalogInstalls into whichever agent you are using.
README
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
</div> <br/> <p align="center"> <img src="./images/visualizer-demo.gif" alt="Architecture visualiser" width="800" /> </p>Documentation | Live Demo | Discord
<br/>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.
<p align="center"> <img src="./images/overview-demo.gif" alt="EventCatalog overview" width="800" /> </p>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.
<p align="center"> <img src="./images/ai-demo.gif" alt="AI-powered discovery" width="800" /> </p>Schema explorer
Quickly find any schema across your catalog — OpenAPI, AsyncAPI, Protobuf, JSON Schema, Avro, and more. All in one searchable place.
<p align="center"> <img src="./images/schema-explorer-demo.gif" alt="Schema explorer" width="800" /> </p>Schema fields
Filter and find any property on any field across your entire catalog. See how fields are used across services and messages.
<p align="center"> <img src="./images/schema-fields-demo.gif" alt="Schema fields explorer" width="800" /> </p>Bring your own docs
Attach architecture decision records, runbooks, and any custom documentation to your domains, services, and teams. Version them alongside your architecture.
<p align="center"> <img src="./images/bring-your-own-docs.gif" alt="Bring your own docs" width="800" /> </p>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.
<p align="center"> <img src="./images/flow-demo.gif" alt="Business flow documentation" width="800" /> </p>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):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://boyney.io/"><img src="https://avatars.githubusercontent.com/u/3268013?v=4?s=100" width="100px;" alt="David Boyne"/><br /><sub><b>David Boyne</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=boyney123" title="Code">💻</a> <a href="#content-boyney123" title="Content">🖋</a> <a href="#design-boyney123" title="Design">🎨</a> <a href="#example-boyney123" title="Examples">💡</a> <a href="#ideas-boyney123" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/event-catalog/eventcatalog/commits?author=boyney123" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://otbe.io"><img src="https://avatars.githubusercontent.com/u/3391052?v=4?s=100" width="100px;" alt="Benjamin Otto"/><br /><sub><b>Benjamin Otto</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=otbe" title="Code">💻</a> <a href="#ideas-otbe" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/event-catalog/eventcatalog/commits?author=otbe" title="Documentation">📖</a> <a href="https://github.com/event-catalog/eventcatalog/issues?q=author%3Aotbe" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/pongz79"><img src="https://avatars.githubusercontent.com/u/250872?v=4?s=100" width="100px;" alt="Tiago Oliveira"/><br /><sub><b>Tiago Oliveira</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=pongz79" title="Documentation">📖</a> <a href="https://github.com/event-catalog/eventcatalog/issues?q=author%3Apongz79" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.bigjump.com/"><img src="https://avatars.githubusercontent.com/u/11387911?v=4?s=100" width="100px;" alt="Jay McGuinness"/><br /><sub><b>Jay McGuinness</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=jaymcguinness" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/davidkpiano"><img src="https://avatars.githubusercontent.com/u/1093738?v=4?s=100" width="100px;" alt="David Khourshid"/><br /><sub><b>David Khourshid</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=davidkpiano" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/thim81"><img src="https://avatars.githubusercontent.com/u/952446?v=4?s=100" width="100px;" alt="thim81"/><br /><sub><b>thim81</b></sub></a><br /><a href="#ideas-thim81" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/event-catalog/eventcatalog/issues?q=author%3Athim81" title="Bug reports">🐛</a> <a href="https://github.com/event-catalog/eventcatalog/commits?author=thim81" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Muthuveerappanv"><img src="https://avatars.githubusercontent.com/u/33663725?v=4?s=100" width="100px;" alt="Muthu"/><br /><sub><b>Muthu</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/issues?q=author%3AMuthuveerappanv" title="Bug reports">🐛</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/tavelli"><img src="https://avatars.githubusercontent.com/u/484951?v=4?s=100" width="100px;" alt="Dan Tavelli"/><br /><sub><b>Dan Tavelli</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=tavelli" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/steppi91"><img src="https://avatars.githubusercontent.com/u/25939641?v=4?s=100" width="100px;" alt="steppi91"/><br /><sub><b>steppi91</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=steppi91" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://twitter.com/PipoPeperoni"><img src="https://avatars.githubusercontent.com/u/1152805?v=4?s=100" width="100px;" alt="Donald Pipowitch"/><br /><sub><b>Donald Pipowitch</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/issues?q=author%3Adonaldpipowitch" title="Bug reports">🐛</a> <a href="https://github.com/event-catalog/eventcatalog/commits?author=donaldpipowitch" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://unravelled.dev"><img src="https://avatars.githubusercontent.com/u/2233210?v=4?s=100" width="100px;" alt="Ken"/><br /><sub><b>Ken</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=kzhen" title="Documentation">📖</a></td> <td align="center" valign="top" width="1Related Skills
obsidian
385.5kWork with Obsidian vaults using the official obsidian CLI: read/search/create/edit notes, tasks, links, properties, plugins.
prose
385.5kOpenProse VM skill pack. Activate on any `prose` command, .prose files, or OpenProse mentions; orchestrates multi-agent workflows.
Writing Hookify Rules
140.7kThis skill should be used when the user asks to "create a hookify rule", "write a hook rule", "configure hookify", "add a hookify rule", or needs guidance on hookify rule syntax and patterns.
Command Development
140.7kThis skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs gu…
