@eventcatalog/core 3.35.0 → 3.35.1

package/dist/analytics/analytics.cjs

@@ -37,7 +37,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.35.0";
+var version = "3.35.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-B2LDVIVY.js";
-import "../chunk-NEWQKEP7.js";
+} from "../chunk-VJ357XOI.js";
+import "../chunk-B7C4DHFE.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -111,7 +111,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.35.0";
+var version = "3.35.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,9 +1,9 @@
 import {
   log_build_default
-} from "../chunk-DFLUDECO.js";
-import "../chunk-B2LDVIVY.js";
+} from "../chunk-JEQZWJWP.js";
+import "../chunk-VJ357XOI.js";
 import "../chunk-4UVFXLPI.js";
-import "../chunk-NEWQKEP7.js";
+import "../chunk-B7C4DHFE.js";
 import "../chunk-5T63CXKU.js";
 export {
   log_build_default as default

package/dist/{chunk-LUWCWNOR.js → chunk-4SNN54V4.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-NEWQKEP7.js";
+} from "./chunk-B7C4DHFE.js";
 
 // src/utils/cli-logger.ts
 import pc from "picocolors";

package/dist/{chunk-NEWQKEP7.js → chunk-B7C4DHFE.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "3.35.0";
+var version = "3.35.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/{chunk-DFLUDECO.js → chunk-JEQZWJWP.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-B2LDVIVY.js";
+} from "./chunk-VJ357XOI.js";
 import {
   countResources,
   serializeCounts

package/dist/{chunk-Y5O6SCX3.js → chunk-R4DR3YAH.js}

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-LUWCWNOR.js";
+} from "./chunk-4SNN54V4.js";
 import {
   cleanup,
   getEventCatalogConfigFile

package/dist/{chunk-B2LDVIVY.js → chunk-VJ357XOI.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-NEWQKEP7.js";
+} from "./chunk-B7C4DHFE.js";
 
 // src/analytics/analytics.js
 import axios from "axios";

package/dist/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 
 // package.json
-var version = "3.35.0";
+var version = "3.35.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-NEWQKEP7.js";
+} from "./chunk-B7C4DHFE.js";
 export {
   VERSION
 };

package/dist/docs/api/01-overview.md

@@ -0,0 +1,74 @@
+---
+sidebar_position: 1
+keywords:
+- EventCatalog CLI
+sidebar_label: EventCatalog CLI
+title: EventCatalog CLI
+description: Understand the CLI of EventCatalog
+---
+
+EventCatalog provides a set of scripts to help you generate, serve, and deploy your catalog.
+
+Once your catalog is bootstrapped, the source will contain the EventCatalog scripts that you can invoke with your package manager:
+
+```json title="package.json"
+{
+  // ...
+  "scripts": {
+    // Runs the dev server locally
+    "dev": "eventcatalog dev",
+    // Builds the catalog
+    "build": "eventcatalog build",
+
+    // start/preview both run the built catalog locally.
+    "start": "eventcatalog start",
+    "preview": "eventcatalog preview",
+
+    // Export your catalog as JSON
+    "export": "eventcatalog export",
+  }
+}
+```
+
+import TOCInline from "@theme/TOCInline"
+
+<TOCInline toc={toc} minHeadingLevel={3}/>
+
+## EventCatalog CLI commands {#eventcatalog-cli-commands}
+
+Below is a list of EventCatalog CLI commands and their usages:
+
+### `eventcatalog dev` {#eventcatalog-dev-sitedir}
+
+Runs your catalog in development mode.
+
+This will start the dev server and watch for changes to your catalog. You will use this as you develop your catalog.
+
+
+### `eventcatalog start/preview` {#eventcatalog-start-sitedir}
+
+Runs EventCatalog in production mode, requires a `build` first. This will serve the built catalog from the `dist` folder.
+
+Can be used to preview your catalog before deploying.
+
+### `eventcatalog build` {#eventcatalog-build-sitedir}
+
+Builds your catalog for production, and outputs the catalog to the `dist` folder.
+
+### `eventcatalog export` {#eventcatalog-export}
+
+Exports your entire catalog as a JSON file using the SDK's `dumpCatalog` function. The export is saved to the `exports/` directory in your project with a date stamp (e.g. `exports/catalog-2026-03-30.json`).
+
+**Options:**
+
+| Option | Description |
+|--------|-------------|
+| `--include-markdown` | Include markdown content in the export (default: `false`) |
+
+```bash
+# Export catalog as JSON
+eventcatalog export
+
+# Export with markdown content included
+eventcatalog export --include-markdown
+```