EventCatalog：面向软件架构的 source-available 文档工具
event-catalog/eventcatalog
EventCatalog 是一款面向软件架构的 source-available 文档工具，可记录领域、服务、消息与 schema，并内置 AI 聊天与 MCP server，支持用自然语言查询架构。
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.
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 |
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):
This project follows the all-contributors specification. Contributions of any kind welcome!
License
EventCatalog is source-available under the Business Source License 1.1. It is free for eligible organisations (under USD 10M revenue and under USD 10M funding). Otherwise it is covered by a subscription. See 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). The ecosystem packages (the SDK, CLI, connectors, diff, linter, visualiser, breaking-changes and create-eventcatalog) are licensed under MIT.
来源：GitHub · github.com