event-catalog/eventcatalog

EventCatalog とは？

EventCatalog は ソフトウェアアーキテクチャ 専用に構築されたオープンソースのウェブベースのドキュメントプラットフォームです。チームがシステムの動きの要素（ドメイン、サービス、メッセージ、スキーマ、ビジネスフロー）を1つの検索可能なUIで記録・探索できます。

コア機能（READMEに記載）

機能	機能の内容	重要性
アーキテクチャドキュメント	ドメイン、サービス、イベント、コマンド、メッセージ用のページを作成。	システムの構造を常に最新の状態に保つ「生きているマップ」を維持。Markdownファイルを分散して管理するよりもメンテナンスが容易。
AI駆動の発見	カタログに関する自然言語質問に答える組み込みチャットインターフェース。	エンジニアや非技術者も、正確な名前を覚えていなくても情報を素早く検索可能。
スキーマエクスプローラー	OpenAPI、AsyncAPI、Protobuf、JSON Schema、Avro などをインデックス化し、検索可能に。	すべての契約定義を1か所で見つけられ、サービス連携時の障壁を低減。
スキーマフィールド検索	すべてのスキーマ内で特定のフィールド名を検索し、使用場所を確認。	変更の影響を評価し、破壊的変更を早期に検出可能。
独自ドキュメントの統合	ADR、ランブック、または任意のMarkdown/MDXドキュメントをカタログのエンティティに紐づけ可能。	操作ドキュメントをアーキテクチャとバージョン同期。
ビジネスフローの可視化	既存のサービスやメッセージを参照するエンドツーエンドのワークフローダイアグラムを描画。	プロダクトオーナーや新メンバー向けの高レベルな視点を提供。
バージョニングとガバナンス	イベント、コマンド、サービスのセマンティックバージョニングと、破壊的変更検出。	大規模な分散チームでの契約の安全な進化をサポート。
ジェネレータ	AsyncAPI、OpenAPI、Kafka、Confluent、AWS EventBridge など15種類以上の自動生成ツール。	既存のインフラ定義からカタログを迅速に構築可能。
カスタマイズとエンタープライズ機能	テーマ、MDXコンポーネント、OAuth2、RBAC、スキーマガバナンス。	既存のセキュリティおよびブランド要件に適合。

すぐに始める方法

# 1行でスケルトン作成 – 新しいフォルダに実行可能なカタログを作成
npx @eventcatalog/create-eventcatalog@latest my-catalog

その後、http://localhost:3000 を開き、UIまたは提供されたSDKを使ってドメイン、サービス、メッセージを追加し始めましょう。

プロジェクト構造（概要）

パッケージ	役割
@eventcatalog/core	カタログUIをレンダリングするメインのAstro + Reactアプリ。
@eventcatalog/sdk	プログラム的にカタログエンティティの作成・更新・削除を行うNode.jsライブラリ。
@eventcatalog/create-eventcatalog	新しいカタログリポジトリをスケルトン化するCLIツール。
@eventcatalog/visualiser	カタログを他の場所に埋め込むために使用できるスタンドアロンのReactコンポーネント。

どんな人が使うべき？

• イベント駆動型またはマイクロサービスアーキテクチャの単一の真実のソースが必要な エンジニアチーム。
• コードリポジトリを掘り下げる必要なく、ビジネスフローとランブックを閲覧したい プロダクト・オペレーション担当者。
• RBACとバージョン管理された契約を備えた自己ホスト型でカスタマイズ可能なソリューションを探している エンタープライズ。

コミュニティとサポート

• 実際の小売、金融、医療、SaaSのカタログを紹介するライブデモサイト。
• ドキュメントサイト: https://www.eventcatalog.dev/docs
• ヘルプや機能議論のためのDiscordコミュニティ。
• MIT + 商用ライセンス、CIが正常に動作していることを示すバッジ（verify-build.yml）。

---

TL;DR: EventCatalogは、特にイベント駆動システムに特化したオープンソースのツールで、ソフトウェアアーキテクチャのドキュメント化と探索を可能にします。検索可能なスキーマインデックス、AI支援のQ&A、視覚的なフローダイアグラム、エンタープライズレベルの機能を、モダンなWeb UIとnpmパッケージ群で提供しています。