# Hookdeck Generator CLI

Copy as Markdown[View as Markdown](/docs/plugins/hookdeck/cli.md)

***

## Overview[​](#overview "Direct link to Overview")

The Hookdeck EventCatalog plugin can be run as a CLI.

## Run the generator as a CLI[​](#run-the-generator-as-a-cli "Direct link to Run the generator as a CLI")

```
npx @hookdeck/eventcatalog-generator {flags}
```

Supported flags are:

* `dir`: **Required**. Path the the EventCatalog install directory
* `api-key`: **Required**. Hookdeck Project API Key
* `log-level`: The level to log at - "fatal" | "error" | "warn" | "info" | "debug" | "trace"
* `match`: Regular expression match for Source names on Connections
* `max-events`: The maximum number of Requests/Events to process per Source/Destination

Example:

```
npx @hookdeck/eventcatalog-generator \
    --dir ./path/to/eventcatalog/install \
    --api-key {HOOKDECK_API_KEY} \
    --log-level debug \
    --match "stripe-production" \
    --domain Payments \
    --max-events 200
```

The CLI will also use the following environment variables:

* `PROJECT_DIR`: Path the the EventCatalog install directory
* `HOOKDECK_PROJECT_API_KEY`: Hookdeck Project API Key

The environment variables can be within a `.env` file that will automatically be detected.