Skip to main content

Installation

System Requirements​

  • Node.js v22 or higher (check with node -v)

Installation​

To get started you can use the CLI or our Skill to create your new project.

Option 1 : Create with the CLI​

The quickest way to create a new EventCatalog is using create-eventcatalog, which sets up everything automatically for you. To create a project, run:

npx @eventcatalog/create-eventcatalog@latest my-catalog

This creates a my-catalog directory with everything you need.

Start the dev server​

Once the project is created, navigate to the project directory and start the development server.

cd my-catalog
npm run dev

Open http://localhost:3000 to see your catalog.

Option 2: Initialise from an existing codebase​

Already have a codebase and want to generate a catalog from it? Use the Catalog Documentation Creator AI skill to scan your project and generate EventCatalog documentation automatically.

  1. Add the EventCatalog skill to your project
npx skills add event-catalog/skills --skill catalog-documentation-creator
  1. Ask your AI agent to scan your codebase:
Look at my directory and generate EventCatalog documentation from information you find.

Learn more about AI skills.

Next steps​