---
url: https://relizy.dev/typedoc/functions/getConfigOptions.md
---
[relizy](../index.md) / getConfigOptions

# Function: getConfigOptions()

> **getConfigOptions**(`options?`): `Promise`<[`ConfigOptionNode`](../interfaces/ConfigOptionNode.md)\[]>

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

The options of `relizy.config.ts` of the installed relizy as a tree, for a tool
showing or editing a config: path, type, accepted values, default, description
and the options nested in each one. It reads the same reference as the
`get_config_option` tool of the MCP server, extracted from the types of relizy.
The options of the `profiles` are under `profiles.*`.

## Parameters

### options?

[`GetConfigOptionsOptions`](../interfaces/GetConfigOptionsOptions.md) = `{}`

## Returns

`Promise`<[`ConfigOptionNode`](../interfaces/ConfigOptionNode.md)\[]>

## Example

```ts
const options = await getConfigOptions()
const bump = options.find(option => option.path === 'bump')
bump.children.map(option => [option.path, option.type, option.default])
```
