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

# Interface: ProfileInfo

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

A profile as a consumer (the CLI, an app) shows it

## Properties

### canary

> **canary**: `boolean`

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

True when the profile releases a canary (`release.canary`)

***

### description?

> `optional` **description?**: `string`

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

***

### name

> **name**: `string`

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

***

### options

> **options**: [`ProfileOptions`](../type-aliases/ProfileOptions.md)

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

The config options the profile sets, over the config file, secrets masked (`redactSecrets` of `@relizy/core`)

***

### settings

> **settings**: [`ProfileSetting`](ProfileSetting.md)\[]

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

The same options, one entry per leaf: `{ path: 'publish.tag', value: 'beta' }`, secrets masked
