Command Line Interface (CLI)

Eventvisor CLI is a command line tool for managing your Eventvisor projects.

Installation#

Use npx to initialize a project first:

$ mkdir my-project && cd my-project
$ npx @eventvisor/cli init

If you wish to initialize a specific example as available in the monorepo:

$ npx @eventvisor/cli init --project=json

You can now proceed to install the dependencies in the project:

$ npm install

You can access the Eventvisor CLI from inside the project via:

$ npx eventvisor

Learn more in quick start page.

Check if the definition files have any syntax or structural errors:

$ npx eventvisor lint

Lear more in linting page.

Generate JSON files on a per tag basis as exists in project configuration:

$ npx eventvisor build

Learn more in building datafiles page.

$ npx eventvisor test

Learn more in testing page.

Generate a browseable catalog from your project:

$ npx eventvisor catalog export

The output will be in out directory, which you can then deploy as a static site for your team or organization's internal documentation.

To start a local server to browse it:

$ npx eventvisor catalog serve

Visit http://localhost:3000 in your browser.

To view the project configuration:

$ npx eventvisor config

Printing configuration as JSON:

$ npx eventvisor config --json --pretty

Get the current version number of Eventvisor CLI, and its relevant packages:

$ npx eventvisor --version

Or do:

$ npx eventvisor -v