Custom Docs CLI Commands

Manage custom docs in your EventCatalog from the command line.

getCustomDoc

Returns a custom doc from EventCatalog by its path

Arguments:

Name	Type	Required	Description
path	string	Yes	Path to the custom doc

Examples:

# Get a custom doc
npx @eventcatalog/sdk getCustomDoc "/getting-started"

---

getCustomDocs

Returns all custom docs from EventCatalog

Arguments:

Name	Type	Required	Description
options	json	No	Options: {path?}

Examples:

# Get all custom docs
npx @eventcatalog/sdk getCustomDocs

---

writeCustomDoc

Writes a custom doc to EventCatalog

Arguments:

Name	Type	Required	Description
customDoc	json	Yes	Custom doc object with id, title, and markdown
options	json	No	Options: {path?, override?}

---

rmCustomDoc

Removes a custom doc by its path

Arguments:

Name	Type	Required	Description
path	string	Yes	Path to the custom doc to remove

Examples:

# Remove a custom doc
npx @eventcatalog/sdk rmCustomDoc "/getting-started"

---