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

# Interface: CommitlintOptions

Defined in: [packages/relizy/src/commands/commitlint.ts:11](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L11)

## Properties

### config?

> `optional` **config?**: [`ResolvedRelizyConfig`](../type-aliases/ResolvedRelizyConfig.md)

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

Pre-loaded config

***

### configName?

> `optional` **configName?**: `string`

Defined in: [packages/relizy/src/commands/commitlint.ts:49](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L49)

Custom config file name (e.g. `relizy.standalone` for `relizy.standalone.config.ts`)

***

### edit?

> `optional` **edit?**: `string` | `boolean`

Defined in: [packages/relizy/src/commands/commitlint.ts:16](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L16)

Lint the message of the commit being created: the file given to the
`commit-msg` hook, or `.git/COMMIT_EDITMSG` when `true`.

***

### force?

> `optional` **force?**: `boolean`

Defined in: [packages/relizy/src/commands/commitlint.ts:47](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L47)

Replace an existing `commit-msg` hook with `install`

***

### format?

> `optional` **format?**: `"json"` | `"text"`

Defined in: [packages/relizy/src/commands/commitlint.ts:41](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L41)

`text` for people (colors in a terminal or a CI), `json` for programs and AI agents

#### Default

```ts
'text'
```

***

### from?

> `optional` **from?**: `string`

Defined in: [packages/relizy/src/commands/commitlint.ts:23](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L23)

Lint the commits after this ref. Defaults to the merge-base with the target
branch of the pull/merge request in CI, otherwise the last tag.

***

### install?

> `optional` **install?**: `boolean`

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

Write the `commit-msg` hook instead of linting

***

### logLevel?

> `optional` **logLevel?**: `"debug"` | `"silent"` | `"error"` | `"warning"` | `"normal"` | `"default"` | `"trace"` | `"verbose"`

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

***

### message?

> `optional` **message?**: `string`

Defined in: [packages/relizy/src/commands/commitlint.ts:18](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L18)

Lint this message

***

### preview?

> `optional` **preview?**: `boolean`

Defined in: [packages/relizy/src/commands/commitlint.ts:36](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L36)

Print the changelog entry of each commit

***

### quiet?

> `optional` **quiet?**: `boolean`

Defined in: [packages/relizy/src/commands/commitlint.ts:43](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L43)

In the text format, only print the commits with problems, and the summary

***

### title?

> `optional` **title?**: `boolean` | [`CommitlintTitleMode`](../type-aliases/CommitlintTitleMode.md)

Defined in: [packages/relizy/src/commands/commitlint.ts:34](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L34)

In the CI of a pull/merge request, how to lint its title, which becomes the
commit message of a squash merge (see `CommitlintTitleMode`): `true` is `'error'`, `false` is `'off'`

#### Default

```ts
config.commitlint.title
```

***

### to?

> `optional` **to?**: `string`

Defined in: [packages/relizy/src/commands/commitlint.ts:28](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/commitlint.ts#L28)

Last commit of the range

#### Default

```ts
'HEAD'
```
