# EventCatalog Editor

Copy as Markdown[View as Markdown](/docs/editor/overview.md)

***

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](/assets/images/editor-cb04fe252a011dca91668794595d1dda.png)

## Who the editor is for[​](#who-the-editor-is-for "Direct link to Who the editor is for")

The editor is for people who maintain an EventCatalog:

* Architects documenting [domains](/docs/development/guides/domains/introduction.md), [services](/docs/development/guides/services/introduction.md), [messages](/docs/development/guides/messages/overview.md), and [ownership](/docs/owners.md)
* 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](/docs/development/getting-started/installation.md), then come back here.

## What the editor does[​](#what-the-editor-does "Direct link to What the editor does")

Use EventCatalog Editor to:

* Open a local EventCatalog project
* Browse [domains](/docs/development/guides/domains/introduction.md), [services](/docs/development/guides/services/introduction.md), [messages](/docs/development/guides/messages/overview.md), [channels](/docs/development/guides/channels/introduction.md), [entities](/docs/development/guides/domains/entities/introduction.md), [data stores](/docs/development/guides/data/introduction.md), [flows](/docs/development/guides/flows/introduction.md), [users](/docs/development/guides/owners/users/introduction.md), and [teams](/docs/development/guides/owners/teams/introduction.md)
* Edit documentation in a rich editor or source editor
* Update common frontmatter fields through forms
* Add schemas to [events](/docs/development/guides/messages/events/introduction.md), [commands](/docs/development/guides/messages/commands/introduction.md), and [queries](/docs/development/guides/messages/queries/introduction.md)
* 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](https://eventcatalog.cloud) and assign editor seats

## Local workflow[​](#local-workflow "Direct link to 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[​](#beta-status "Direct link to 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](/pricing.md) for current plan details.

If you want to help shape the editor, join the [EventCatalog Discord](https://eventcatalog.dev/discord) or [open an issue in the editor repository](https://github.com/event-catalog/eventcatalog-editor-code/issues).

## Next steps[​](#next-steps "Direct link to Next steps")

* Follow the [first edit tutorial](/docs/editor/first-edit.md).
* Learn how to [run the editor locally](/docs/editor/how-to/run-locally.md).
* Learn how to [use the Flow Editor](/docs/editor/how-to/use-flow-editor.md).
* Learn how to [invite editors](/docs/editor/how-to/invite-editors.md).
* Understand [how the editor works](/docs/editor/explanation/how-it-works.md).