GitLabgitlab-org

cli

main
ply7 git calls284 ms99 KiB4 cachedprotocol v2
102 lines4.3 KiBRaw

Clone a GitLab repository or project.

Synopsis

Clone a GitLab repository to your local machine. Specify the repository by name, namespace/repo path, full URL, or project ID.

The command uses your configured protocol (SSH or HTTPS).

To pass Git clone flags, add them after --. For example: glab repo clone <repo> -- --branch <branch-name>

When you clone a fork you own, the command adds an upstream remote that points to the parent project.

Use --wiki to clone the wiki repository associated with a project.

plaintext
glab repo clone [<repo> | -g <group>] [<dir>] [flags] [-- <gitflags>...]

Examples

console
# Clones repository into current directory
glab repo clone gitlab-org/cli
glab repo clone https://gitlab.com/gitlab-org/cli

# Clones repository into 'mydirectory'
glab repo clone gitlab-org/cli mydirectory

# Clones a project's wiki repository
glab repo clone --wiki gitlab-org/cli

# Clones repository 'glab' for current user
glab repo clone glab

# Finds the project by the ID provided and clones it
glab repo clone 4356677

# Clones a specific branch
glab repo clone gitlab-org/cli -- --branch development

# Clones with a shallow clone (depth 1)
glab repo clone gitlab-org/cli -- --depth 1

# Clones with multiple Git flags
glab repo clone gitlab-org/cli -- --branch main --single-branch --depth 1

# Clones all repos in a group
glab repo clone -g everyonecancontribute --paginate

# Clones all repos in a group, except those in one subgroup
glab repo clone -g mygroup --exclude-subgroup domain/backend --paginate

# Clones all non-archived repos in a group
glab repo clone -g everyonecancontribute --archived=false --paginate

# Clones only active projects in a group
glab repo clone -g everyonecancontribute --active=true --paginate

# Clones from a GitLab Self-Managed or GitLab Dedicated instance
GITLAB_HOST=salsa.debian.org glab repo clone myrepo

Options

plaintext
  -g, --group string               Specify the group to clone repositories from.
  -p, --preserve-namespace         Clone the repository in a subdirectory based on namespace.
      --active                     Limit by project status. When true, returns active projects. When false, returns projects that are archived or marked for deletion. Used with the --group flag.
  -a, --archived                   Limit by archived status. Use with '-a=false' to exclude archived repositories. Used with the --group flag.
  -G, --include-subgroups          Include projects in subgroups of this group. Default is true. Used with the --group flag. (default true)
      --exclude-subgroup strings   Skip projects in this subgroup, as a path relative to the group, not a numeric ID. Repeat the flag, or separate values with commas, to skip more than one. Projects shared from other namespaces are not affected. Used with the --group flag.
  -m, --mine                       Limit by projects in the group owned by the current authenticated user. Used with the --group flag.
  -v, --visibility string          Limit by visibility: public, internal, private. Used with the --group flag.
  -I, --with-issues-enabled        Limit by projects with the issues feature enabled. Default is false. Used with the --group flag.
  -M, --with-mr-enabled            Limit by projects with the merge request feature enabled. Default is false. Used with the --group flag.
  -S, --with-shared                Include projects shared to this group. Default is true. Used with the --group flag. (default true)
      --paginate                   Make additional HTTP requests to fetch all pages of projects before cloning. Respects --per-page.
      --page int                   Page number. (default 1)
      --per-page int               Number of items to list per page. (default 30)
      --wiki                       Clone the project's wiki repository.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab repo clone`'
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-->
13Clone a GitLab repository or project.
15## Synopsis
17Clone a GitLab repository to your local machine. Specify the
18repository by name, namespace/repo path, full URL, or project ID.
20The command uses your configured protocol (SSH or HTTPS).
22To pass Git clone flags, add them after `--`. For example:
23`glab repo clone <repo> -- --branch <branch-name>`
25When you clone a fork you own, the command adds an `upstream`
26remote that points to the parent project.
28Use `--wiki` to clone the wiki repository associated with a project.
30```plaintext
31glab repo clone [<repo> | -g <group>] [<dir>] [flags] [-- <gitflags>...]
32```
34## Examples
36```console
37# Clones repository into current directory
38glab repo clone gitlab-org/cli
39glab repo clone https://gitlab.com/gitlab-org/cli
41# Clones repository into 'mydirectory'
42glab repo clone gitlab-org/cli mydirectory
44# Clones a project's wiki repository
45glab repo clone --wiki gitlab-org/cli
47# Clones repository 'glab' for current user
48glab repo clone glab
50# Finds the project by the ID provided and clones it
51glab repo clone 4356677
53# Clones a specific branch
54glab repo clone gitlab-org/cli -- --branch development
56# Clones with a shallow clone (depth 1)
57glab repo clone gitlab-org/cli -- --depth 1
59# Clones with multiple Git flags
60glab repo clone gitlab-org/cli -- --branch main --single-branch --depth 1
62# Clones all repos in a group
63glab repo clone -g everyonecancontribute --paginate
65# Clones all repos in a group, except those in one subgroup
66glab repo clone -g mygroup --exclude-subgroup domain/backend --paginate
68# Clones all non-archived repos in a group
69glab repo clone -g everyonecancontribute --archived=false --paginate
71# Clones only active projects in a group
72glab repo clone -g everyonecancontribute --active=true --paginate
74# Clones from a GitLab Self-Managed or GitLab Dedicated instance
75GITLAB_HOST=salsa.debian.org glab repo clone myrepo
76```
78## Options
80```plaintext
81 -g, --group string Specify the group to clone repositories from.
82 -p, --preserve-namespace Clone the repository in a subdirectory based on namespace.
83 --active Limit by project status. When true, returns active projects. When false, returns projects that are archived or marked for deletion. Used with the --group flag.
84 -a, --archived Limit by archived status. Use with '-a=false' to exclude archived repositories. Used with the --group flag.
85 -G, --include-subgroups Include projects in subgroups of this group. Default is true. Used with the --group flag. (default true)
86 --exclude-subgroup strings Skip projects in this subgroup, as a path relative to the group, not a numeric ID. Repeat the flag, or separate values with commas, to skip more than one. Projects shared from other namespaces are not affected. Used with the --group flag.
87 -m, --mine Limit by projects in the group owned by the current authenticated user. Used with the --group flag.
88 -v, --visibility string Limit by visibility: public, internal, private. Used with the --group flag.
89 -I, --with-issues-enabled Limit by projects with the issues feature enabled. Default is false. Used with the --group flag.
90 -M, --with-mr-enabled Limit by projects with the merge request feature enabled. Default is false. Used with the --group flag.
91 -S, --with-shared Include projects shared to this group. Default is true. Used with the --group flag. (default true)
92 --paginate Make additional HTTP requests to fetch all pages of projects before cloning. Respects --per-page.
93 --page int Page number. (default 1)
94 --per-page int Number of items to list per page. (default 30)
95 --wiki Clone the project's wiki repository.
96```
98## Options inherited from parent commands
100```plaintext
101 -h, --help Show help for this command.
102```
Diagnostics7 git calls · 284 ms
CallStatusSizeTime0284 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 KiB2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=2
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
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 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=2
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: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=2
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
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:0200594 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=274
git.response.bytes=594
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=8c893c6ca66ed299ac6c67444dad7529c6f1cb76
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=594
git.pkt.payload.max=567
git.sideband.band1.bytes=567
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=567
git.pack.trailer=e9b8ab0109823c026cdae1074e580843e5061d9f
Open pack map
fetch2001.6 KiB274 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1650
git.response.cache=MISS
git.response.duration_ms=274
git.fetch.wants=e5906f2b116bb66f37a151552457e207ec1fbb51
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=1650
git.pkt.payload.max=1623
git.sideband.band1.bytes=1623
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
a5e16dd7f8304b2a
Request
fd6ede49…
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