gh-pr-merge

Merge the pull request associated with the current branch interactively

$ gh pr merge

$ gh pr merge [pr_number] [[-m|--merge]]

$ gh pr merge [pr_number] [[-sd|--squash --delete-branch]]

$ gh pr merge [pr_number] [[-r|--rebase]]

$ gh pr merge [pr_number] --auto [[-s|--squash]]

$ gh pr merge [pr_number] --admin

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

--body <text>
    Custom body text for merge commit/PR message

--body-file <file>
    Read body from file (use - for stdin)

--delete-branch
    Delete local/remote source branch after merge (default if base is default branch)

--merge
    Create merge commit (default if base is default)

--rebase
    Rebase commits onto base branch

--squash
    Squash all commits into single commit

--subject <text>
    Custom subject line (prompts if unspecified)

--title <text>
    Custom title for resulting commit/PR (prompts if unspecified)

-R, --repo [<HOST/>]<OWNER/REPO>
    Operate on specified repository

-w, --web
    Open merged PR in browser

The gh pr merge command merges a specified GitHub pull request (PR) on the remote repository. It supports three merge methods: standard merge commit (--merge), squash all commits into one (--squash), or rebase onto the base branch (--rebase). The default method depends on repository settings, typically merge if the base is the default branch.

After merging remotely, it optionally updates the local repository by fetching changes and checking out the base branch. If no PR is specified, it prompts interactively for selection. Custom commit titles, subjects, and bodies can be provided, overriding PR details. Flags allow deleting the source branch post-merge and opening the PR in a browser.

This streamlines CI/CD workflows and team collaboration without browser interaction, ensuring consistent merge strategies. Requires GitHub CLI authentication via gh auth login.

Requires gh auth login; local updates need clean working directory; merge method must match repo branch protection rules; conflicts prompt manual resolution.

gh pr merge (interactive)
gh pr merge 42 --squash --delete-branch
gh pr merge https://github.com/owner/repo/pull/42

0: success
1: error (e.g., conflicts, permissions)

Introduced in GitHub CLI v0.5.0 (Feb 2020); evolved with merge method support in v1.0+; aligns with GitHub's web UI changes for squash/rebase defaults.

gh(1), gh-pr-checkout(1), gh-pr-view(1), git-merge(1)