GitLabgitlab-org

cli

main
ply7 git calls219 ms98 KiB4 cachedprotocol v2
60 lines2.2 KiBRaw

Check out an open merge request.

Synopsis

Defaults to the currently checked-out branch. Use --branch to override the local branch name used for the checkout.

Use --worktree to check out the merge request into a Git worktree at the given path. Your current working directory and any work in progress stay untouched. If you run the command again with the same path, it updates the existing worktree.

You can only check out a branch in one worktree at a time. If a branch is already checked out elsewhere, use --branch to check it out under a different name.

To remove the worktree when you are done, run git worktree remove <path>.

plaintext
glab mr checkout [<id> | <branch> | <url>] [flags]

Examples

console
glab mr checkout 1
glab mr checkout branch
glab mr checkout 12 --branch todo-fix
glab mr checkout new-feature --set-upstream-to=upstream/main
glab mr checkout https://gitlab.com/gitlab-org/cli/-/merge_requests/1234

# Check out into a separate worktree
glab mr checkout 123 --worktree ../review-mr-123

# Uses the checked-out branch
glab mr checkout

Options

plaintext
  -b, --branch string            Check out merge request with name <branch>.
  -f, --force                    Reset local branch to remote when they have diverged. Refuses if working tree has changes that would be lost.
  -u, --set-upstream-to string   Set tracking of checked-out branch to [REMOTE/]BRANCH.
      --worktree string          Check out the merge request into a Git worktree at <path> instead of the current working directory. Re-running updates an existing worktree at that path.

Options inherited from parent commands

plaintext
  -h, --help          Show help for this command.
  -R, --repo string   Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
1---
2title: '`glab mr checkout`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Check out an open merge request.
15## Synopsis
17Defaults to the currently checked-out branch. Use `--branch` to
18override the local branch name used for the checkout.
20Use `--worktree` to check out the merge request into a Git worktree at the given path. Your current working directory and any work in progress stay untouched. If you run the command again with the same path, it updates the existing worktree.
22You can only check out a branch in one worktree at a time. If a branch is already checked out elsewhere, use `--branch` to check it out under a different name.
24To remove the worktree when you are done, run `git worktree remove <path>`.
26```plaintext
27glab mr checkout [<id> | <branch> | <url>] [flags]
28```
30## Examples
32```console
33glab mr checkout 1
34glab mr checkout branch
35glab mr checkout 12 --branch todo-fix
36glab mr checkout new-feature --set-upstream-to=upstream/main
37glab mr checkout https://gitlab.com/gitlab-org/cli/-/merge_requests/1234
39# Check out into a separate worktree
40glab mr checkout 123 --worktree ../review-mr-123
42# Uses the checked-out branch
43glab mr checkout
44```
46## Options
48```plaintext
49 -b, --branch string Check out merge request with name <branch>.
50 -f, --force Reset local branch to remote when they have diverged. Refuses if working tree has changes that would be lost.
51 -u, --set-upstream-to string Set tracking of checked-out branch to [REMOTE/]BRANCH.
52 --worktree string Check out the merge request into a Git worktree at <path> instead of the current working directory. Re-running updates an existing worktree at that path.
53```
55## Options inherited from parent commands
57```plaintext
58 -h, --help Show help for this command.
59 -R, --repo string Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
60```
Diagnostics7 git calls · 219 ms
CallStatusSizeTime0219 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=5
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit5 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=5
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:02001.7 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=1744
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200669 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=206
git.response.bytes=669
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=e7f366ff56d25d838386e3ceead4278af75f7180
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=669
git.pkt.payload.max=642
git.sideband.band1.bytes=642
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=642
git.pack.trailer=8973f4a733afcd554e109d2cd1877fb7b7210224
Open pack map
fetch2001.1 KiB206 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1117
git.response.cache=MISS
git.response.duration_ms=206
git.fetch.wants=8c12bb79bbaab5827c4bfedad581b7b7f6fe749c
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1117
git.pkt.payload.max=1090
git.sideband.band1.bytes=1090
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e1b2f09a59f54b
Request
ed5c5513…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format