1GH-PR-MERGE(1) GitHub CLI manual GH-PR-MERGE(1)
2
3
4
6 gh-pr-merge - Merge a pull request
7
8
9
11 gh pr merge [<number> | <url> | <branch>] [flags]
12
13
14
16 Merge a pull request on GitHub.
17
18
19 Without an argument, the pull request that belongs to the current
20 branch is selected.
21
22
23 When targeting a branch that requires a merge queue, no merge strategy
24 is required. If required checks have not yet passed, AutoMerge will be
25 enabled. If required checks have passed, the pull request will be
26 added to the merge queue. To bypass a merge queue and merge directly,
27 pass the '--admin' flag.
28
29
30
32 --admin
33 Use administrator privileges to merge a pull request that does
34 not meet requirements
35
36
37 --auto Automatically merge only after necessary requirements are met
38
39
40 -b, --body <text>
41 Body text for the merge commit
42
43
44 -F, --body-file <file>
45 Read body text from file (use "-" to read from standard input)
46
47
48 -d, --delete-branch
49 Delete the local and remote branch after merge
50
51
52 --disable-auto
53 Disable auto-merge for this pull request
54
55
56 -m, --merge
57 Merge the commits with the base branch
58
59
60 -r, --rebase
61 Rebase the commits onto the base branch
62
63
64 -s, --squash
65 Squash the commits into one commit and merge it into the base
66 branch
67
68
69 -t, --subject <text>
70 Subject text for the merge commit
71
72
73
75 -R, --repo <[HOST/]OWNER/REPO>
76 Select another repository using the [HOST/]OWNER/REPO format
77
78
79
81 gh-pr(1)
82
83
84
85 Jun 2022 GH-PR-MERGE(1)