@eventcatalog/create-eventcatalog 4.2.3 → 4.2.4

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.
Files changed (7) hide show
  1. package/dist/index.js +1 -1
  2. package/package.json +1 -1
  3. package/templates/asyncapi/README-template.md +54 -0
  4. package/templates/default/README-template.md +54 -0
  5. package/templates/empty/README-template.md +54 -0
  6. package/templates/graphql/README-template.md +54 -0
  7. package/templates/openapi/README-template.md +58 -0
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.2.3",
29811
+ version: "4.2.4",
29812
29812
  bin: {
29813
29813
  "create-catalog": "./dist/index.js"
29814
29814
  },
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.2.3",
4
+ "version": "4.2.4",
5
5
  "bin": {
6
6
  "create-catalog": "./dist/index.js"
7
7
  },
package/templates/asyncapi/README-template.md CHANGED
@@ -1 +1,55 @@
1
1
  # My Event Catalog
2
+
3
+ Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
4
+
5
+ ## Getting Started
6
+
7
+ ```sh
8
+ npm run dev
9
+ ```
10
+
11
+ Open [http://localhost:3000](http://localhost:3000) to see your catalog.
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.
14
+
15
+ ## What Can You Do?
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
23
+
24
+ ## Use AI with Your Catalog
25
+
26
+ ### Skills
27
+
28
+ Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
29
+
30
+ ```sh
31
+ npx skills add event-catalog/skills
32
+ ```
33
+
34
+ Skills can generate service documentation, create domain models, and map business flows — all through natural language.
35
+
36
+ ### MCP Server
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.
39
+
40
+ ## Automate Your Catalog
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, Schema Registries, and more — so your documentation is always up to date.
43
+
44
+ ## Learn More
45
+
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
52
+
53
+ ## Found a problem?
54
+
55
+ Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
package/templates/default/README-template.md CHANGED
@@ -1 +1,55 @@
1
1
  # My Event Catalog
2
+
3
+ Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
4
+
5
+ ## Getting Started
6
+
7
+ ```sh
8
+ npm run dev
9
+ ```
10
+
11
+ Open [http://localhost:3000](http://localhost:3000) to see your catalog.
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.
14
+
15
+ ## What Can You Do?
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
23
+
24
+ ## Use AI with Your Catalog
25
+
26
+ ### Skills
27
+
28
+ Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
29
+
30
+ ```sh
31
+ npx skills add event-catalog/skills
32
+ ```
33
+
34
+ Skills can generate service documentation, create domain models, and map business flows — all through natural language.
35
+
36
+ ### MCP Server
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.
39
+
40
+ ## Automate Your Catalog
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, Schema Registries, and more — so your documentation is always up to date.
43
+
44
+ ## Learn More
45
+
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
52
+
53
+ ## Found a problem?
54
+
55
+ Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
package/templates/empty/README-template.md CHANGED
@@ -1 +1,55 @@
1
1
  # My Event Catalog
2
+
3
+ Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
4
+
5
+ ## Getting Started
6
+
7
+ ```sh
8
+ npm run dev
9
+ ```
10
+
11
+ Open [http://localhost:3000](http://localhost:3000) to see your catalog.
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.
14
+
15
+ ## What Can You Do?
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
23
+
24
+ ## Use AI with Your Catalog
25
+
26
+ ### Skills
27
+
28
+ Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
29
+
30
+ ```sh
31
+ npx skills add event-catalog/skills
32
+ ```
33
+
34
+ Skills can generate service documentation, create domain models, and map business flows — all through natural language.
35
+
36
+ ### MCP Server
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.
39
+
40
+ ## Automate Your Catalog
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, Schema Registries, and more — so your documentation is always up to date.
43
+
44
+ ## Learn More
45
+
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
52
+
53
+ ## Found a problem?
54
+
55
+ Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
package/templates/graphql/README-template.md CHANGED
@@ -1 +1,55 @@
1
1
  # My Event Catalog
2
+
3
+ Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
4
+
5
+ ## Getting Started
6
+
7
+ ```sh
8
+ npm run dev
9
+ ```
10
+
11
+ Open [http://localhost:3000](http://localhost:3000) to see your catalog.
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.
14
+
15
+ ## What Can You Do?
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
23
+
24
+ ## Use AI with Your Catalog
25
+
26
+ ### Skills
27
+
28
+ Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
29
+
30
+ ```sh
31
+ npx skills add event-catalog/skills
32
+ ```
33
+
34
+ Skills can generate service documentation, create domain models, and map business flows — all through natural language.
35
+
36
+ ### MCP Server
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.
39
+
40
+ ## Automate Your Catalog
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, Schema Registries, and more — so your documentation is always up to date.
43
+
44
+ ## Learn More
45
+
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
52
+
53
+ ## Found a problem?
54
+
55
+ Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
package/templates/openapi/README-template.md CHANGED
@@ -1 +1,59 @@
1
1
  # My Event Catalog
2
+
3
+ Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
4
+
5
+ ## Getting Started
6
+
7
+ ```sh
8
+ npm run dev
9
+ ```
10
+
11
+ Open [http://localhost:3000](http://localhost:3000) to see your catalog.
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.
14
+
15
+ ## What Can You Do?
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
23
+
24
+ ## Use AI with Your Catalog
25
+
26
+ ### Skills
27
+
28
+ Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
29
+
30
+ ```sh
31
+ npx skills add event-catalog/skills
32
+ ```
33
+
34
+ Skills can generate service documentation, create domain models, and map business flows — all through natural language.
35
+
36
+ ### MCP Server
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.
39
+
40
+ ## Automate Your Catalog
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.
43
+
44
+ ## Automate Your Catalog
45
+
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
+
48
+ ## Learn More
49
+
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
56
+
57
+ ## Found a problem?
58
+
59
+ Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).