event-catalog/eventcatalog
Documentation tool built for software architecture. Document your domains, services, events and schemas — for your teams and your AI agents.
event-catalog/eventcatalog – Overview
What it is – EventCatalog is a source‑available documentation platform built specifically for describing software architectures that rely on events, messages, services and domains. It lets teams capture the shape of their system (services, APIs, schemas, business flows) and explore it through a web UI.
Key capabilities
- Architecture documentation – model domains, services, events/commands and link them together.
- AI‑powered discovery – a built‑in chat interface that can answer natural‑language questions about the catalog (e.g., “Which services publish the
OrderCreatedevent?”). - Schema explorer – centralised view of OpenAPI, AsyncAPI, Protobuf, JSON‑Schema, Avro, etc., with full‑text search.
- Schema‑field search – find any property across all schemas and see where it is used.
- Business‑flow visualisation – draw end‑to‑end workflow diagrams that reference existing services and messages.
- Versioning & governance – semantic versioning for events, commands, services; breaking‑change detection; RBAC/OAuth2 for enterprise use.
- Extensible generators – 15+ generators to import definitions from AsyncAPI, OpenAPI, Kafka, Confluent, AWS EventBridge, etc.
- Custom docs – attach ADRs, runbooks, markdown/MDX files to any catalog entity.
How you start
npx @eventcatalog/create-eventcatalog@latest my-catalog
# then open http://localhost:3000
A CLI scaffolds a fresh catalog and launches a local Astro + React app.
Ecosystem
| Package | Role |
|---|---|
@eventcatalog/core |
Main web application (Astro + React) |
@eventcatalog/sdk |
Node.js SDK for programmatic catalog manipulation |
@eventcatalog/create-eventcatalog |
CLI scaffolding tool |
@eventcatalog/visualiser |
Stand‑alone React component for embedding visualisations |
Who it’s for – software teams building event‑driven or micro‑service architectures who need a living, searchable source of truth and want AI‑assisted queries.
Links – Docs: https://www.eventcatalog.dev/docs • Live demo: https://demo.eventcatalog.dev • Discord community for support.
Related
- Project
- Project
- Project
- Project
- Project