Scheduled Freezes

Schedule and manage merge freezes for release windows and maintenance.

Learn more: Scheduled freezes

mergify freeze list #

List scheduled freezes for a repository

Usage 
mergify freeze list [OPTIONS]
Options
--json flag

Emit the raw scheduled_freezes array as a single JSON document

Global options
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

-t, --token <TOKEN> string

Mergify or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

mergify freeze create #

Create a new scheduled freeze

Usage 
mergify freeze create [OPTIONS] --reason <REASON>
Options
--reason <REASON> string required

Reason for the freeze

--timezone <TIMEZONE> string

IANA timezone name (e.g. Europe/Paris, US/Eastern). Defaults to the system timezone when omitted

-c, --condition <CONDITION> string

Matching condition (repeatable, e.g. -c base=main)

--start <START> string

Start time in ISO 8601 format (default: now)

--end <END> string

End time in ISO 8601 format (default: no end / emergency freeze)

-e, --exclude <EXCLUDE> string

Exclude condition (repeatable, e.g. -e label=hotfix)

Global options
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

-t, --token <TOKEN> string

Mergify or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

mergify freeze update #

Update an existing scheduled freeze

Usage 
mergify freeze update [OPTIONS] <FREEZE_ID>
Arguments
<FREEZE_ID> string required

Freeze ID (UUID)

Options
--reason <REASON> string

Reason for the freeze

--timezone <TIMEZONE> string

IANA timezone name

-c, --condition <CONDITION> string

Matching condition (repeatable, e.g. -c base=main). Passing the flag one or more times replaces the existing list with the values supplied. Omitting -c entirely leaves the stored list untouched

--start <START> string

Start time in ISO 8601 format

--end <END> string

End time in ISO 8601 format

-e, --exclude <EXCLUDE> string

Exclude condition (repeatable)

Global options
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

-t, --token <TOKEN> string

Mergify or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

mergify freeze delete #

Delete a scheduled freeze

Usage 
mergify freeze delete [OPTIONS] <FREEZE_ID>
Arguments
<FREEZE_ID> string required

Freeze ID (UUID)

Options
--reason <DELETE_REASON> string

Reason for deleting the freeze (required if the freeze is currently active)

Global options
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

-t, --token <TOKEN> string

Mergify or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

Was this page helpful?