Copy as Markdown[View as Markdown](/docs/cli/cli-custom-docs.md)

***

# Custom Docs CLI Commands

Manage custom docs in your EventCatalog from the command line.

## getCustomDoc[​](#getcustomdoc "Direct link to 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/cli getCustomDoc "/getting-started"
```

***

## getCustomDocs[​](#getcustomdocs "Direct link to getCustomDocs")

Returns all custom docs from EventCatalog

**Arguments:**

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

**Examples:**

```
# Get all custom docs
npx @eventcatalog/cli getCustomDocs
```

***

## writeCustomDoc[​](#writecustomdoc "Direct link to 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[​](#rmcustomdoc "Direct link to 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/cli rmCustomDoc "/getting-started"
```

***