Catalog

Run the Catalog to browse definitions, reusable Schemas, routing rules, conditions, Targets, tests, matrix cases, dependencies, and Git history.

npx eventvisor catalog

The command exports the Catalog to out/, starts a local server, and prints its URL. It watches the project definitions and configuration while it runs. After a change, Eventvisor rebuilds the Catalog data and reloads open browser pages automatically.

Catalog URLs use browser routing by default, so entity pages have clean, shareable paths. Configure a deployed host to serve index.html for application routes.

When hosting below a URL prefix, pass --base-path. This updates asset, data, and browser routes consistently:

npx eventvisor catalog export --base-path /event-catalog

Use hash routing only when the host cannot provide that fallback:

npx eventvisor catalog --hash-router

For automation, export without starting a server:

npx eventvisor catalog export

catalog export and catalog serve are intentionally one-shot commands. Use the plain catalog command for watching and live reload during local development.

Use --out-dir <directory> to choose another dedicated export location. Eventvisor refuses unsafe locations such as the project root, your home directory, or a directory containing the project. Add --no-assets when only generated Catalog data is needed.

To serve an existing export:

npx eventvisor catalog serve --port 3000

Entity and assertion URLs are shareable. Keys are URL encoded so namespaced definitions remain addressable.

Schema pages show the shared structure and where it is used. Their Target count is derived from the events and attributes selected by each Target.