Skip to main content

EventCatalog Editor

View as Markdown

EventCatalog Editor is a local visual editor for maintaining an EventCatalog.

It runs on your machine, opens your catalog from disk, lets you edit architecture resources without working directly in Markdown or MDX, and gives you a Git-backed view of the changes before you commit them.

EventCatalog Editor open on a service resource

Who the editor is for​

The editor is for people who maintain an EventCatalog:

  • Architects documenting domains, services, messages, and ownership
  • Developers keeping resource documentation, schemas, and specifications up to date
  • Analysts, product owners, or domain experts who can improve catalog content but do not want to edit MDX files directly

You still own your catalog as files. The editor makes those files easier to browse, edit, preview, review, and commit.

Need an EventCatalog first?

These docs assume you already have an EventCatalog project. If you are just getting started, create a catalog first with the EventCatalog installation guide, then come back here.

What the editor does​

Use EventCatalog Editor to:

  • Open a local EventCatalog project
  • Browse domains, services, messages, channels, entities, data stores, flows, users, and teams
  • Edit documentation in a rich editor or source editor
  • Update common frontmatter fields through forms
  • Add schemas to events, commands, and queries
  • Add OpenAPI, AsyncAPI, and GraphQL specifications to domains and services
  • Preview resources in a running EventCatalog site
  • Inspect local Git changes, view diffs, revert files, and commit work
  • Invite editors through EventCatalog Cloud and assign editor seats

Local workflow​

The editor sits on top of the same files that EventCatalog already uses.

The editor does not replace Git, Markdown, MDX, or your deployment process. It gives catalog maintainers a safer interface for making changes before those changes go through the workflow your team already uses.

Beta status​

EventCatalog Editor is in beta. You can use it today, but some workflows and features may change before general availability.

The editor is a seat-based paid product. Community includes 1 editor seat, Starter includes 3 editor seats, Scale includes 10 editor seats, and Enterprise includes unlimited editor seats. See the pricing page for current plan details.

If you want to help shape the editor, join the EventCatalog Discord or open an issue in the editor repository.

Next steps​