Skip to main content

CLI

EventCatalog provides a set of scripts to help you generate, serve, and deploy your website.

Once your catalog is bootstrapped, the source will contain the EventCatalog scripts that you can invoke with your package manager:

package.json
{
  // ...
  "scripts": {
    "dev": "eventcatalog dev",
    "start": "eventcatalog start",
    "build": "eventcatalog build",
    "generate": "eventcatalog generate",
  }
}

EventCatalog CLI commands​

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

eventcatalog start​

Starts the built EventCatalog (post-build phase)

eventcatalog build​

Compiles your site for production.

Starts the built EventCatalog (post-build phase)

eventcatalog dev​

Runs your catalog in dev mode

eventcatalog generate​

Used to generate your documentation from third party systems.