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

# Function: listProfiles()

> **listProfiles**(`config`): [`ProfileInfo`](../interfaces/ProfileInfo.md)\[]

Defined in: [packages/relizy/src/core/profiles.ts:333](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/profiles.ts#L333)

The profiles of a config (`profiles`): their name, description and what they
change, e.g. to show them as release workflows. Works on the config of
`loadRelizyConfig()`, or on a config file as written. The secrets a profile
sets (tokens, API keys, webhook URLs) are masked in `options` and `settings`.

## Parameters

### config

`Pick`<[`RelizyConfig`](../interfaces/RelizyConfig.md), `"profiles"`>

## Returns

[`ProfileInfo`](../interfaces/ProfileInfo.md)\[]

## Example

```ts
const profiles = listProfiles(await loadRelizyConfig())
// [{ name: 'beta', description: '...', canary: false, settings: [{ path: 'publish.tag', value: 'beta' }] }]
```
