@eventcatalog/create-eventcatalog 4.2.3 → 4.2.5
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/LICENSE +28 -0
- package/dist/index.js +3 -1
- package/package.json +2 -1
- package/templates/amazon-api-gateway/gitignore +3 -1
- package/templates/asyncapi/README-template.md +54 -0
- package/templates/asyncapi/gitignore +3 -1
- package/templates/confluent/gitignore +3 -1
- package/templates/default/README-template.md +54 -0
- package/templates/default/gitignore +3 -1
- package/templates/empty/README-template.md +54 -0
- package/templates/empty/gitignore +3 -1
- package/templates/eventbridge/gitignore +3 -1
- package/templates/graphql/README-template.md +54 -0
- package/templates/graphql/gitignore +3 -1
- package/templates/index.ts +1 -0
- package/templates/openapi/README-template.md +58 -0
- package/templates/openapi/gitignore +3 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022-2026 boyney123
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
Note: Source code within `packages/core/eventcatalog/src/enterprise/` is
|
|
26
|
+
licensed under the EventCatalog Commercial License and is NOT covered by the
|
|
27
|
+
MIT License above. See `packages/core/eventcatalog/src/enterprise/LICENSE`
|
|
28
|
+
for the full terms.
|
package/dist/index.js
CHANGED
|
@@ -29808,7 +29808,8 @@ 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.
|
|
29811
|
+
version: "4.2.5",
|
|
29812
|
+
license: "MIT",
|
|
29812
29813
|
bin: {
|
|
29813
29814
|
"create-catalog": "./dist/index.js"
|
|
29814
29815
|
},
|
|
@@ -29910,6 +29911,7 @@ var installTemplate = async ({
|
|
|
29910
29911
|
start: "eventcatalog start",
|
|
29911
29912
|
preview: "eventcatalog preview",
|
|
29912
29913
|
generate: "eventcatalog generate",
|
|
29914
|
+
export: "eventcatalog export",
|
|
29913
29915
|
lint: "eventcatalog-linter",
|
|
29914
29916
|
test: 'echo "Error: no test specified" && exit 1'
|
|
29915
29917
|
}
|
package/package.json
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).
|
|
@@ -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).
|
|
@@ -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).
|
|
@@ -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/index.ts
CHANGED
|
@@ -42,6 +42,7 @@ export const installTemplate = async ({
|
|
|
42
42
|
start: 'eventcatalog start',
|
|
43
43
|
preview: 'eventcatalog preview',
|
|
44
44
|
generate: 'eventcatalog generate',
|
|
45
|
+
export: 'eventcatalog export',
|
|
45
46
|
lint: 'eventcatalog-linter',
|
|
46
47
|
test: 'echo "Error: no test specified" && exit 1',
|
|
47
48
|
},
|
|
@@ -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).
|