event-catalog/eventcatalog

Public

Documentation tool built for software architecture. Document your domains, services, events and schemas — for your teams and your AI agents.

  • Stars2.9k+7 tuần này
  • Forks280
  • Watchers22
  • Issues70
  • Ngày tạo19/11/2021
  • Cập nhật gần nhất15/10/2026
  • Ngôn ngữTypeScript
  • Giấy phép—
README.md53.7 KBRaw
EventCatalog overview

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.

main License npm version All Contributors

40,000+ catalogs created


Architecture visualiser

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.

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:

Nội dung README thuộc về event-catalog và cộng đồng đóng góp, giấy phép Không có giấy phép. Nguồn: github.com/event-catalog/eventcatalog