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

# Interface: SyncOptions

Defined in: [packages/relizy/src/commands/sync.ts:12](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L12)

The options of `relizy sync`

## Properties

### branches?

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

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

The branches to merge the released branch into, instead of the rules of `sync`

***

### config?

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

Defined in: [packages/relizy/src/commands/sync.ts:31](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L31)

Config already resolved by `loadRelizyConfig()`, used instead of loading the config file

***

### configName?

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

Defined in: [packages/relizy/src/commands/sync.ts:27](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L27)

***

### dryRun?

> `optional` **dryRun?**: `boolean`

Defined in: [packages/relizy/src/commands/sync.ts:25](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L25)

***

### from?

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

Defined in: [packages/relizy/src/commands/sync.ts:24](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L24)

The released branch, the current branch by default: its remote branch is merged

***

### logLevel?

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

Defined in: [packages/relizy/src/commands/sync.ts:26](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L26)

***

### mode?

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

Defined in: [packages/relizy/src/commands/sync.ts:20](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L20)

Override of `sync.mode` and of the modes of its rules for this run

***

### onProgress?

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

Defined in: [packages/relizy/src/commands/sync.ts:37](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L37)

Called with each event of the run, see `ReleaseOptions.onProgress`

***

### overrides?

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

Defined in: [packages/relizy/src/commands/sync.ts:33](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L33)

Options applied over the config file, under the options of the call

***

### profile?

> `optional` **profile?**: `string`

Defined in: [packages/relizy/src/commands/sync.ts:29](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L29)

Profile of `profiles` to apply, as `--profile`

***

### safetyCheck?

> `optional` **safetyCheck?**: `boolean`

Defined in: [packages/relizy/src/commands/sync.ts:35](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/sync.ts#L35)

Run the safety checks before merging: the branches exist, the release can push to them or open the pull requests
