---
url: https://relizy.dev/typedoc/interfaces/ConfigOptionNode.md
---
[relizy](../index.md) / ConfigOptionNode

# Interface: ConfigOptionNode

Defined in: [packages/relizy/src/core/config-options.ts:8](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L8)

One option of `relizy.config.ts`, with the options nested in it

## Properties

### children

> **children**: `ConfigOptionNode`\[]

Defined in: [packages/relizy/src/core/config-options.ts:29](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L29)

***

### default?

> `optional` **default?**: `unknown`

Defined in: [packages/relizy/src/core/config-options.ts:18](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L18)

The default of the option, none when it depends on the project or has no default

***

### deprecated?

> `optional` **deprecated?**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:23](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L23)

***

### description

> **description**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:20](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L20)

What the option does, in markdown

***

### docId

> **docId**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:26](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L26)

Doc page of the option, for `get_doc` of the MCP server: `config/bump`

***

### docUrl

> **docUrl**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:28](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L28)

URL of the doc page

***

### key

> **key**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:12](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L12)

Last segment of the path: `type`

***

### path

> **path**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:10](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L10)

Dotted path, `[]` for the items of an array and `*` for the entries of a record: `bump.type`, `monorepo.groups[].name`, `profiles.*.bump.type`

***

### see?

> `optional` **see?**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:24](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L24)

***

### summary

> **summary**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:22](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L22)

The first paragraph of the description, on one line

***

### type

> **type**: `string`

Defined in: [packages/relizy/src/core/config-options.ts:14](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L14)

The type as written in the types of relizy: `boolean`, `string[]`, `VersionMode`, `BumpConfig`

***

### values?

> `optional` **values?**: `string`\[]

Defined in: [packages/relizy/src/core/config-options.ts:16](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/config-options.ts#L16)

The values the type accepts when it hides them behind an alias: `['unified', 'selective', 'independent']`
