@eventcatalog/create-eventcatalog 4.3.2 → 4.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -29808,7 +29808,7 @@ var import_os2 = __toESM(require("os"));
29808
29808
  var package_default = {
29809
29809
  name: "@eventcatalog/create-eventcatalog",
29810
29810
  description: "Create EventCatalog with one command",
29811
- version: "4.3.2",
29811
+ version: "4.3.3",
29812
29812
  license: "MIT",
29813
29813
  bin: {
29814
29814
  "create-catalog": "./dist/index.js"
@@ -29915,6 +29915,7 @@ var installTemplate = async ({
29915
29915
  private: true,
29916
29916
  scripts: {
29917
29917
  dev: "eventcatalog dev",
29918
+ editor: "npx @eventcatalog/editor@latest",
29918
29919
  build: "eventcatalog build",
29919
29920
  start: "eventcatalog start",
29920
29921
  preview: "eventcatalog preview",
@@ -30051,14 +30052,17 @@ async function createApp({
30051
30052
  console.log(` ${import_chalk3.default.dim("\u25A0")} Git initialized`);
30052
30053
  }
30053
30054
  console.log();
30054
- console.log(` ${import_chalk3.default.cyan.bold("next")} You're all set! Explore your project!`);
30055
+ console.log(` You're all set! Explore your catalog!`);
30055
30056
  console.log();
30056
- console.log(` Enter your project directory using ${import_chalk3.default.cyan("cd " + cdpath)}`);
30057
- console.log(` Run ${import_chalk3.default.cyan(`${packageManager2} run dev`)} to start the dev server. ${import_chalk3.default.dim("CTRL+C to stop.")}`);
30057
+ console.log(` ${import_chalk3.default.dim("\u25A0")} ${import_chalk3.default.cyan("cd " + cdpath)}`);
30058
+ console.log(` ${import_chalk3.default.dim("\u25A0")} Run ${import_chalk3.default.cyan(`${packageManager2} run dev`)} to start the dev server.`);
30058
30059
  console.log();
30059
30060
  console.log(` ${import_chalk3.default.dim("Star us on GitHub:")} ${import_chalk3.default.underline("https://github.com/event-catalog/eventcatalog")}`);
30060
30061
  console.log(` ${import_chalk3.default.dim("Join our Discord:")} ${import_chalk3.default.underline("https://eventcatalog.dev/discord")}`);
30061
30062
  console.log();
30063
+ console.log(` ${import_chalk3.default.dim("Want a better editing experience?")}`);
30064
+ console.log(` Run ${import_chalk3.default.cyan(`${packageManager2} run editor`)} to open EventCatalog Editor.`);
30065
+ console.log();
30062
30066
  }
30063
30067
 
30064
30068
  // helpers/get-pkg-manager.ts
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@eventcatalog/create-eventcatalog",
3
3
  "description": "Create EventCatalog with one command",
4
- "version": "4.3.2",
4
+ "version": "4.3.3",
5
5
  "license": "MIT",
6
6
  "bin": {
7
7
  "create-catalog": "./dist/index.js"
@@ -1,27 +1,54 @@
1
- # My Amazon API Gateway Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new Amazon API Gateway EventCatalog!
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. This template adds the Amazon API Gateway generator so you can import OpenAPI specs from API Gateway and document how they connect to your domains, services, and teams.
4
4
 
5
- Getting started:
5
+ ## Generate Your Catalog
6
6
 
7
- 1. Edit the `.env` file to configure your environment variables.
8
- 1. Configure the apis in the `eventcatalog.config.js` file
9
- 1. Run `npm run generate` to import your OpenAPI specs from apigateway and document them.
10
- 1. Run `npm run dev` to start the development server.
11
- 1. Go to localhost:3000 to view your catalog.
7
+ 1. Edit `.env` with your AWS settings.
8
+ 2. Configure your APIs in `eventcatalog.config.js`.
9
+ 3. Import your OpenAPI specs:
12
10
 
13
- ### What else can you do?
11
+ ```sh
12
+ npm run generate
13
+ ```
14
14
 
15
- With the ApiGateway integration you can :
15
+ 4. Start the catalog:
16
16
 
17
- - Document your apis
18
- - Assign your apis to producers and consumers
19
- - Assign resources to users and teams in your organization
20
- - Visualize your APIGateway architecture
21
- - And much more!
17
+ ```sh
18
+ npm run dev
19
+ ```
22
20
 
23
- The easiest way to get started and dive deeper is to read the [EventCatalog documentation](https://www.eventcatalog.dev/docs/plugins/amazon-apigateway/intro).
21
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
24
22
 
25
- ### Found a problem?
23
+ ## Edit Your Catalog
26
24
 
27
- If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
25
+ Your generated resources are docs-as-code. You can enrich them with ownership, domain context, Markdown, examples, and relationships that are not always available in API Gateway.
26
+
27
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
28
+
29
+ ## Keep It in Sync
30
+
31
+ Run `npm run generate` whenever your API Gateway APIs change. You can also run the generator in CI so your catalog stays aligned with AWS.
32
+
33
+ With this integration you can:
34
+
35
+ - Document APIs and OpenAPI specs
36
+ - Assign APIs to producers and consumers
37
+ - Connect resources to users and teams
38
+ - Visualize your API Gateway architecture
39
+
40
+ ## Use AI with Architecture Context
41
+
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows. Connect an MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
43
+
44
+ ## Learn by Task
45
+
46
+ - [Amazon API Gateway integration docs](https://www.eventcatalog.dev/docs/plugins/amazon-apigateway/intro)
47
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
48
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
49
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
50
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
51
+
52
+ ## Found a Problem?
53
+
54
+ Open an issue on [GitHub](https://github.com/event-catalog/generators).
@@ -1,55 +1,63 @@
1
- # My Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) the open-source documentation tool for event-driven architectures.
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
4
4
 
5
- ## Getting Started
5
+ ## Start the Catalog
6
6
 
7
7
  ```sh
8
8
  npm run dev
9
9
  ```
10
10
 
11
- Open [http://localhost:3000](http://localhost:3000) to see your catalog.
11
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
12
12
 
13
- You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
13
+ Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
14
14
 
15
- ## What Can You Do?
15
+ ## Edit Your Catalog
16
16
 
17
- - **Document services** define producers and consumers with their schemas
18
- - **Map events, commands & queries** — capture every message flowing through your system
19
- - **Organize with domains** — group resources into bounded contexts
20
- - **Visualize your architecture** — auto-generated diagrams of your services and message flows
21
- - **Version everything** — track how your architecture evolves over time
22
- - **Use AI to explore & document** — connect AI tools directly to your catalog
17
+ Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
23
18
 
24
- ## Use AI with Your Catalog
19
+ Good places to start:
25
20
 
26
- ### Skills
21
+ - `domains/` - bounded contexts, business capabilities, and ownership
22
+ - `domains/<domain>/services/` - services, APIs, and message producers or consumers
23
+ - `events/`, `commands/`, and `queries/` - the messages flowing through your system
24
+ - `teams/` and `users/` - who owns each part of the architecture
27
25
 
28
- Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
26
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
29
27
 
30
- ```sh
31
- npx skills add event-catalog/skills
32
- ```
28
+ ## Make Your First Change
29
+
30
+ 1. Add or edit a domain, service, or message.
31
+ 2. Run `npm run dev` and check the generated pages and diagrams.
32
+ 3. Commit the MDX and schema files to Git.
33
+
34
+ ## Keep It in Sync
33
35
 
34
- Skills can generate service documentation, create domain models, and map business flows all through natural language.
36
+ Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
35
37
 
36
- ### MCP Server
38
+ Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
37
39
 
38
- Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
40
+ ## Use AI with Architecture Context
39
41
 
40
- ## Automate Your Catalog
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
41
43
 
42
- Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
44
+ - Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
45
+ - Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
46
+
47
+ ```sh
48
+ npx skills add event-catalog/skills
49
+ ```
43
50
 
44
- ## Learn More
51
+ ## Learn by Task
45
52
 
46
- - [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
47
- - [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
48
- - [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
49
- - [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
50
- - [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
51
- - [Discord](https://discord.gg/3rjaZMmrAm) — join the community
53
+ - [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
54
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
55
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
56
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
57
+ - [Generate from integrations](https://www.eventcatalog.dev/integrations)
58
+ - [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
59
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
52
60
 
53
- ## Found a problem?
61
+ ## Found a Problem?
54
62
 
55
63
  Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
@@ -1,28 +1,55 @@
1
- # My Confluent Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new Confluent Event Catalog!
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. This template adds the Confluent Schema Registry generator so you can import schemas and topics, then document how they connect to your domains, services, and teams.
4
4
 
5
- Getting started:
5
+ ## Generate Your Catalog
6
6
 
7
- 1. Edit the `.env` file to configure your environment variables.
8
- 1. Run Confluent Cloud locally, or configure your `schemaRegistryUrl` in the `eventcatalog.config.js` file
9
- 1. Run `npm run generate` to import your schemas from confluent schema registry.
10
- 1. Run `npm run dev` to start the development server.
11
- 1. Go to localhost:3000 to view your catalog.
7
+ 1. Edit `.env` with your Confluent settings.
8
+ 2. Run Confluent locally, or configure `schemaRegistryUrl` in `eventcatalog.config.js`.
9
+ 3. Import your schemas:
12
10
 
13
- ### What else can you do?
11
+ ```sh
12
+ npm run generate
13
+ ```
14
14
 
15
- With the Confluent Schema Registry integration you can :
15
+ 4. Start the catalog:
16
16
 
17
- - Document your schemas, topics
18
- - Assign your schemas to producers and consumers
19
- - Assign resources to users and teams in your organization
17
+ ```sh
18
+ npm run dev
19
+ ```
20
+
21
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
22
+
23
+ ## Edit Your Catalog
24
+
25
+ Your generated resources are docs-as-code. You can enrich them with ownership, domain context, Markdown, examples, and relationships that are not always available in the schema registry.
26
+
27
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
28
+
29
+ ## Keep It in Sync
30
+
31
+ Run `npm run generate` whenever your schemas or topics change. You can also run the generator in CI so your catalog stays aligned with Confluent.
32
+
33
+ With this integration you can:
34
+
35
+ - Document schemas and topics
36
+ - Assign schemas to producers and consumers
37
+ - Connect resources to users and teams
20
38
  - Visualize your Kafka architecture
21
- - Add semantic meaning to your schemas and topics
22
- - And much more!
39
+ - Add semantic meaning to schemas and topics
40
+
41
+ ## Use AI with Architecture Context
42
+
43
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows. Connect an MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
44
+
45
+ ## Learn by Task
23
46
 
24
- The easiest way to get started and dive deeper is to read the [Event Catalog documentation](https://eventcatalog.dev/docs/plugins/confluent-schema-registry/intro).
47
+ - [Confluent Schema Registry integration docs](https://eventcatalog.dev/docs/plugins/confluent-schema-registry/intro)
48
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
49
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
50
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
51
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
25
52
 
26
- ### Found a problem?
53
+ ## Found a Problem?
27
54
 
28
- If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
55
+ Open an issue on [GitHub](https://github.com/event-catalog/generators).
@@ -1,55 +1,63 @@
1
- # My Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) the open-source documentation tool for event-driven architectures.
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
4
4
 
5
- ## Getting Started
5
+ ## Start the Catalog
6
6
 
7
7
  ```sh
8
8
  npm run dev
9
9
  ```
10
10
 
11
- Open [http://localhost:3000](http://localhost:3000) to see your catalog.
11
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
12
12
 
13
- You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
13
+ Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
14
14
 
15
- ## What Can You Do?
15
+ ## Edit Your Catalog
16
16
 
17
- - **Document services** define producers and consumers with their schemas
18
- - **Map events, commands & queries** — capture every message flowing through your system
19
- - **Organize with domains** — group resources into bounded contexts
20
- - **Visualize your architecture** — auto-generated diagrams of your services and message flows
21
- - **Version everything** — track how your architecture evolves over time
22
- - **Use AI to explore & document** — connect AI tools directly to your catalog
17
+ Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
23
18
 
24
- ## Use AI with Your Catalog
19
+ Good places to start:
25
20
 
26
- ### Skills
21
+ - `domains/` - bounded contexts, business capabilities, and ownership
22
+ - `domains/<domain>/services/` - services, APIs, and message producers or consumers
23
+ - `events/`, `commands/`, and `queries/` - the messages flowing through your system
24
+ - `teams/` and `users/` - who owns each part of the architecture
27
25
 
28
- Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
26
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
29
27
 
30
- ```sh
31
- npx skills add event-catalog/skills
32
- ```
28
+ ## Make Your First Change
29
+
30
+ 1. Add or edit a domain, service, or message.
31
+ 2. Run `npm run dev` and check the generated pages and diagrams.
32
+ 3. Commit the MDX and schema files to Git.
33
+
34
+ ## Keep It in Sync
33
35
 
34
- Skills can generate service documentation, create domain models, and map business flows all through natural language.
36
+ Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
35
37
 
36
- ### MCP Server
38
+ Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
37
39
 
38
- Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
40
+ ## Use AI with Architecture Context
39
41
 
40
- ## Automate Your Catalog
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
41
43
 
42
- Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
44
+ - Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
45
+ - Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
46
+
47
+ ```sh
48
+ npx skills add event-catalog/skills
49
+ ```
43
50
 
44
- ## Learn More
51
+ ## Learn by Task
45
52
 
46
- - [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
47
- - [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
48
- - [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
49
- - [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
50
- - [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
51
- - [Discord](https://discord.gg/3rjaZMmrAm) — join the community
53
+ - [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
54
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
55
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
56
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
57
+ - [Generate from integrations](https://www.eventcatalog.dev/integrations)
58
+ - [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
59
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
52
60
 
53
- ## Found a problem?
61
+ ## Found a Problem?
54
62
 
55
63
  Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
@@ -1,55 +1,63 @@
1
- # My Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) the open-source documentation tool for event-driven architectures.
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
4
4
 
5
- ## Getting Started
5
+ ## Start the Catalog
6
6
 
7
7
  ```sh
8
8
  npm run dev
9
9
  ```
10
10
 
11
- Open [http://localhost:3000](http://localhost:3000) to see your catalog.
11
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
12
12
 
13
- You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
13
+ Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
14
14
 
15
- ## What Can You Do?
15
+ ## Edit Your Catalog
16
16
 
17
- - **Document services** define producers and consumers with their schemas
18
- - **Map events, commands & queries** — capture every message flowing through your system
19
- - **Organize with domains** — group resources into bounded contexts
20
- - **Visualize your architecture** — auto-generated diagrams of your services and message flows
21
- - **Version everything** — track how your architecture evolves over time
22
- - **Use AI to explore & document** — connect AI tools directly to your catalog
17
+ Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
23
18
 
24
- ## Use AI with Your Catalog
19
+ Good places to start:
25
20
 
26
- ### Skills
21
+ - `domains/` - bounded contexts, business capabilities, and ownership
22
+ - `domains/<domain>/services/` - services, APIs, and message producers or consumers
23
+ - `events/`, `commands/`, and `queries/` - the messages flowing through your system
24
+ - `teams/` and `users/` - who owns each part of the architecture
27
25
 
28
- Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
26
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
29
27
 
30
- ```sh
31
- npx skills add event-catalog/skills
32
- ```
28
+ ## Make Your First Change
29
+
30
+ 1. Add or edit a domain, service, or message.
31
+ 2. Run `npm run dev` and check the generated pages and diagrams.
32
+ 3. Commit the MDX and schema files to Git.
33
+
34
+ ## Keep It in Sync
33
35
 
34
- Skills can generate service documentation, create domain models, and map business flows all through natural language.
36
+ Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
35
37
 
36
- ### MCP Server
38
+ Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
37
39
 
38
- Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
40
+ ## Use AI with Architecture Context
39
41
 
40
- ## Automate Your Catalog
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
41
43
 
42
- Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
44
+ - Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
45
+ - Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
46
+
47
+ ```sh
48
+ npx skills add event-catalog/skills
49
+ ```
43
50
 
44
- ## Learn More
51
+ ## Learn by Task
45
52
 
46
- - [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
47
- - [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
48
- - [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
49
- - [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
50
- - [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
51
- - [Discord](https://discord.gg/3rjaZMmrAm) — join the community
53
+ - [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
54
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
55
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
56
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
57
+ - [Generate from integrations](https://www.eventcatalog.dev/integrations)
58
+ - [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
59
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
52
60
 
53
- ## Found a problem?
61
+ ## Found a Problem?
54
62
 
55
63
  Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
@@ -1,27 +1,54 @@
1
- # My EventBridge Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new EventBridge EventCatalog!
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. This template adds the EventBridge generator so you can import schemas from Amazon EventBridge and document how they connect to your domains, services, and teams.
4
4
 
5
- Getting started:
5
+ ## Generate Your Catalog
6
6
 
7
- 1. Edit the `.env` file to configure your environment variables.
8
- 1. Configure the region and schema registry name in the `eventcatalog.config.js` file
9
- 1. Run `npm run generate` to import your schemas from confluent schema registry.
10
- 1. Run `npm run dev` to start the development server.
11
- 1. Go to localhost:3000 to view your catalog.
7
+ 1. Edit `.env` with your AWS settings.
8
+ 2. Configure the region and schema registry name in `eventcatalog.config.js`.
9
+ 3. Import your EventBridge schemas:
12
10
 
13
- ### What else can you do?
11
+ ```sh
12
+ npm run generate
13
+ ```
14
14
 
15
- With the EventBridge integration you can :
15
+ 4. Start the catalog:
16
16
 
17
- - Document your schemas
18
- - Assign your schemas to producers and consumers
19
- - Assign resources to users and teams in your organization
17
+ ```sh
18
+ npm run dev
19
+ ```
20
+
21
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
22
+
23
+ ## Edit Your Catalog
24
+
25
+ Your generated resources are docs-as-code. You can enrich them with ownership, domain context, Markdown, examples, and relationships that are not always available in the source schema.
26
+
27
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
28
+
29
+ ## Keep It in Sync
30
+
31
+ Run `npm run generate` whenever your EventBridge schemas change. You can also run the generator in CI so your catalog stays aligned with your registry.
32
+
33
+ With this integration you can:
34
+
35
+ - Document EventBridge schemas and events
36
+ - Assign schemas to producers and consumers
37
+ - Connect resources to users and teams
20
38
  - Visualize your EventBridge architecture
21
- - And much more!
22
39
 
23
- The easiest way to get started and dive deeper is to read the [EventCatalog documentation](https://www.eventcatalog.dev/docs/plugins/eventbridge/intro).
40
+ ## Use AI with Architecture Context
41
+
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows. Connect an MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
43
+
44
+ ## Learn by Task
45
+
46
+ - [EventBridge integration docs](https://www.eventcatalog.dev/docs/plugins/eventbridge/intro)
47
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
48
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
49
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
50
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
24
51
 
25
- ### Found a problem?
52
+ ## Found a Problem?
26
53
 
27
- If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
54
+ Open an issue on [GitHub](https://github.com/event-catalog/generators).
@@ -1,55 +1,63 @@
1
- # My Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) the open-source documentation tool for event-driven architectures.
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
4
4
 
5
- ## Getting Started
5
+ ## Start the Catalog
6
6
 
7
7
  ```sh
8
8
  npm run dev
9
9
  ```
10
10
 
11
- Open [http://localhost:3000](http://localhost:3000) to see your catalog.
11
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
12
12
 
13
- You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
13
+ Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
14
14
 
15
- ## What Can You Do?
15
+ ## Edit Your Catalog
16
16
 
17
- - **Document services** define producers and consumers with their schemas
18
- - **Map events, commands & queries** — capture every message flowing through your system
19
- - **Organize with domains** — group resources into bounded contexts
20
- - **Visualize your architecture** — auto-generated diagrams of your services and message flows
21
- - **Version everything** — track how your architecture evolves over time
22
- - **Use AI to explore & document** — connect AI tools directly to your catalog
17
+ Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
23
18
 
24
- ## Use AI with Your Catalog
19
+ Good places to start:
25
20
 
26
- ### Skills
21
+ - `domains/` - bounded contexts, business capabilities, and ownership
22
+ - `domains/<domain>/services/` - services, APIs, and message producers or consumers
23
+ - `events/`, `commands/`, and `queries/` - the messages flowing through your system
24
+ - `teams/` and `users/` - who owns each part of the architecture
27
25
 
28
- Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
26
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
29
27
 
30
- ```sh
31
- npx skills add event-catalog/skills
32
- ```
28
+ ## Make Your First Change
29
+
30
+ 1. Add or edit a domain, service, or message.
31
+ 2. Run `npm run dev` and check the generated pages and diagrams.
32
+ 3. Commit the MDX and schema files to Git.
33
+
34
+ ## Keep It in Sync
33
35
 
34
- Skills can generate service documentation, create domain models, and map business flows all through natural language.
36
+ Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
35
37
 
36
- ### MCP Server
38
+ Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
37
39
 
38
- Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
40
+ ## Use AI with Architecture Context
39
41
 
40
- ## Automate Your Catalog
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
41
43
 
42
- Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
44
+ - Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
45
+ - Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
46
+
47
+ ```sh
48
+ npx skills add event-catalog/skills
49
+ ```
43
50
 
44
- ## Learn More
51
+ ## Learn by Task
45
52
 
46
- - [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
47
- - [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
48
- - [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
49
- - [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
50
- - [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
51
- - [Discord](https://discord.gg/3rjaZMmrAm) — join the community
53
+ - [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
54
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
55
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
56
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
57
+ - [Generate from integrations](https://www.eventcatalog.dev/integrations)
58
+ - [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
59
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
52
60
 
53
- ## Found a problem?
61
+ ## Found a Problem?
54
62
 
55
63
  Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
@@ -48,6 +48,7 @@ export const installTemplate = async ({
48
48
  private: true,
49
49
  scripts: {
50
50
  dev: 'eventcatalog dev',
51
+ editor: 'npx @eventcatalog/editor@latest',
51
52
  build: 'eventcatalog build',
52
53
  start: 'eventcatalog start',
53
54
  preview: 'eventcatalog preview',
@@ -1,59 +1,63 @@
1
- # My Event Catalog
1
+ # Welcome to EventCatalog
2
2
 
3
- Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) the open-source documentation tool for event-driven architectures.
3
+ [EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
4
4
 
5
- ## Getting Started
5
+ ## Start the Catalog
6
6
 
7
7
  ```sh
8
8
  npm run dev
9
9
  ```
10
10
 
11
- Open [http://localhost:3000](http://localhost:3000) to see your catalog.
11
+ Open [http://localhost:3000](http://localhost:3000) to view your catalog.
12
12
 
13
- You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
13
+ Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
14
14
 
15
- ## What Can You Do?
15
+ ## Edit Your Catalog
16
16
 
17
- - **Document services** define producers and consumers with their schemas
18
- - **Map events, commands & queries** — capture every message flowing through your system
19
- - **Organize with domains** — group resources into bounded contexts
20
- - **Visualize your architecture** — auto-generated diagrams of your services and message flows
21
- - **Version everything** — track how your architecture evolves over time
22
- - **Use AI to explore & document** — connect AI tools directly to your catalog
17
+ Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
23
18
 
24
- ## Use AI with Your Catalog
19
+ Good places to start:
25
20
 
26
- ### Skills
21
+ - `domains/` - bounded contexts, business capabilities, and ownership
22
+ - `domains/<domain>/services/` - services, APIs, and message producers or consumers
23
+ - `events/`, `commands/`, and `queries/` - the messages flowing through your system
24
+ - `teams/` and `users/` - who owns each part of the architecture
27
25
 
28
- Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
26
+ Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
29
27
 
30
- ```sh
31
- npx skills add event-catalog/skills
32
- ```
28
+ ## Make Your First Change
29
+
30
+ 1. Add or edit a domain, service, or message.
31
+ 2. Run `npm run dev` and check the generated pages and diagrams.
32
+ 3. Commit the MDX and schema files to Git.
33
33
 
34
- Skills can generate service documentation, create domain models, and map business flows — all through natural language.
34
+ ## Keep It in Sync
35
35
 
36
- ### MCP Server
36
+ Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
37
37
 
38
- Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
38
+ Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
39
39
 
40
- ## Automate Your Catalog
40
+ ## Use AI with Architecture Context
41
41
 
42
- Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Confluent Schema Registry, AWS EventBridge, and more — so your documentation is always up to date.
42
+ EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
43
43
 
44
- ## Automate Your Catalog
44
+ - Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
45
+ - Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
45
46
 
46
- Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
47
+ ```sh
48
+ npx skills add event-catalog/skills
49
+ ```
47
50
 
48
- ## Learn More
51
+ ## Learn by Task
49
52
 
50
- - [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
51
- - [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
52
- - [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
53
- - [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
54
- - [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
55
- - [Discord](https://discord.gg/3rjaZMmrAm) — join the community
53
+ - [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
54
+ - [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
55
+ - [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
56
+ - [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
57
+ - [Generate from integrations](https://www.eventcatalog.dev/integrations)
58
+ - [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
59
+ - [Join the community](https://discord.gg/3rjaZMmrAm)
56
60
 
57
- ## Found a problem?
61
+ ## Found a Problem?
58
62
 
59
63
  Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).