diff --git a/src/content/docs/cli.mdx b/src/content/docs/cli.mdx index 42e7ad36d5..5b249e1305 100644 --- a/src/content/docs/cli.mdx +++ b/src/content/docs/cli.mdx @@ -64,6 +64,6 @@ mergify --token your_token_here |---|---|---| | `mergify stack` | Create and manage stacked pull requests | [Stacks](/stacks) | | `mergify freeze` | Schedule and manage merge freezes | [Scheduling Freezes](/merge-protections/freeze) | -| `mergify queue` | Monitor merge queue status | [Monitoring](/merge-queue/monitoring) | +| `mergify queue` | Monitor and control merge queue | [Monitoring](/merge-queue/monitoring) | | `mergify config` | Validate and simulate config | [Config](/configuration/file-format#validating-with-the-cli) | | `mergify ci` | Upload and analyze CI results | [CI Insights](/ci-insights) | diff --git a/src/content/docs/merge-queue/pause.mdx b/src/content/docs/merge-queue/pause.mdx index 3faf55f911..2088ddc86a 100644 --- a/src/content/docs/merge-queue/pause.mdx +++ b/src/content/docs/merge-queue/pause.mdx @@ -46,6 +46,20 @@ the queue. Pause button is in the top right corner in Mergify's dashboard +### Using the CLI + +Pause the queue from the terminal with an optional reason: + +```bash +mergify queue pause --reason "deploying hotfix" +``` + +Resume when ready: + +```bash +mergify queue unpause +``` + ### Using the API You can also pause the merge queue programmatically using the [Mergify