Utilities CLI Commands
Manage utilities in your EventCatalog from the command line.
dumpCatalog
Dumps the entire catalog to a JSON structure
Arguments: None
Examples:
# Dump entire catalog
npx @eventcatalog/cli dumpCatalog
# Dump and save to file
npx @eventcatalog/cli dumpCatalog > catalog.json
getResourcesByProperty
Returns the resources with a custom property (an x- field in their frontmatter), optionally with a given value. Values are compared as text, and a list matches when any of its items does
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| property | string | Yes | The custom property, e.g. x-public |
Examples:
# Everything with x-public
npx @eventcatalog/cli getResourcesByProperty "x-public"
getEventCatalogConfigurationFile
Returns the EventCatalog configuration file
Arguments: None
Examples:
# Get config file
npx @eventcatalog/cli getEventCatalogConfigurationFile