Skip to main content

EventCatalog CLI

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:

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",
  }
}

EventCatalog CLI commands​

Below is a list of EventCatalog CLI commands and their usages:

eventcatalog dev​

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​

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​

Builds your catalog for production, and outputs the catalog to the dist folder.