gh-pr-merge - Man Page

• Merge the pull request associated with the current branch interactively: gh pr merge
• Merge the specified pull request, interactively: gh pr merge pr_number
• Merge the pull request, removing the branch on both the local and the remote: gh pr merge --delete-branch
• Merge the current pull request with the specified merge strategy: gh pr merge --merge|squash|rebase
• Merge the current pull request with the specified merge strategy and commit message: gh pr merge --merge|squash|rebase --subject commit_message
• Squash the current pull request into one commit with the message body and merge: gh pr merge --squash --body="commit_message_body"
• Display help: gh pr merge --help

tldr.sh

gh pr merge [<number> | <url> | <branch>] [flags]

Merge a pull request on GitHub.

Without an argument, the pull request that belongs to the current branch is selected.

When targeting a branch that requires a merge queue, no merge strategy is required. If required checks have not yet passed, auto-merge will be enabled. If required checks have passed, the pull request will be added to the merge queue. To bypass a merge queue and merge directly, pass the --admin flag.

--admin

Use administrator privileges to merge a pull request that does not meet requirements

-A, --author-email <text>

Email text for merge commit author

--auto

Automatically merge only after necessary requirements are met

-b, --body <text>

Body text for the merge commit

-F, --body-file <file>

Read body text from file (use "-" to read from standard input)

-d,  --delete-branch

Delete the local and remote branch after merge

--disable-auto

Disable auto-merge for this pull request

--match-head-commit <SHA>

Commit SHA that the pull request head must match to allow merge

-m,  --merge

Merge the commits with the base branch

-r,  --rebase

Rebase the commits onto the base branch

-s,  --squash

Squash the commits into one commit and merge it into the base branch

-t, --subject <text>

Subject text for the merge commit

-R, --repo <[HOST/]OWNER/REPO>

Select another repository using the [HOST/]OWNER/REPO format

gh-pr(1)

gh-pr(1).