# EventCatalog Editor CLI reference

Copy as Markdown[View as Markdown](/docs/editor/reference/cli.md)

***

Run the editor with:

```
npx @eventcatalog/editor
```

## Requirements[​](#requirements "Direct link to Requirements")

* Node.js 22 or later
* Git
* An EventCatalog directory containing `eventcatalog.config.js`

## Options[​](#options "Direct link to Options")

| Option                    | Description                                                 | Default                                                           |
| ------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------- |
| `--catalog <path>`        | Path to the EventCatalog root to edit.                      | Current directory, a detected child catalog, or browser selection |
| `--port <n>`              | Port for the editor server.                                 | `3900`                                                            |
| `--eventcatalog-port <n>` | Port where local EventCatalog preview is running.           | `3000`                                                            |
| `--no-open`               | Start the editor without opening the browser automatically. | Opens browser                                                     |
| `--help`, `-h`            | Show CLI help.                                              |                                                                   |
| `--version`, `-v`         | Show the installed editor version.                          |                                                                   |

## Examples[​](#examples "Direct link to Examples")

Run from a catalog directory:

```
npx @eventcatalog/editor
```

Run against a specific catalog:

```
npx @eventcatalog/editor --catalog /Users/me/dev/my-catalog
```

Use a different editor port:

```
npx @eventcatalog/editor --port 3999
```

Use a different EventCatalog preview port:

```
npx @eventcatalog/editor --eventcatalog-port 3001
```

Start without opening a browser:

```
npx @eventcatalog/editor --no-open
```