GitLabgitlab-org

cli

main
ply7 git calls239 ms98 KiB5 cachedprotocol v2
84 lines3.2 KiBRaw

Download one or more secure files from a project.

Synopsis

To download a single file, identify it by its numeric ID (as a positional argument or with --id) or by its name with --name. To download every secure file in the project, use --all.

Use --path to save a single download to a specific filename, or --output-dir to choose the destination directory when downloading multiple files.

By default, downloaded files are verified against their checksum. Use --no-verify to skip verification, or --force-download to keep files even when verification fails. Both options can allow corrupted or tampered files; use with caution.

By default, files are downloaded from the current project. Use --repo to target another project.

plaintext
glab securefile download [<id> | --id <id> | --name <name>] [flags]

Examples

console
# Download a file by ID (positional or flag)
glab securefile download 1
glab securefile download --id 1

# Download a file by ID to a specific path
glab securefile download 1 --path "securefiles/file.txt"

# Download a file to an absolute path
glab securefile download 1 --path /tmp/secure/file.txt

# Download a file by name to the current directory
glab securefile download --name my-secure-file.pem

# Download a file by name to a chosen path
glab securefile download --name my-secure-file.pem --path securefiles/some-other-name.pem

# Download without verifying the checksum
glab securefile download 1 --no-verify

# Download all secure files in the project
glab securefile download --all

# Download all secure files to a specific directory
glab securefile download --all --output-dir secure_files/

Options

plaintext
      --all                 Download all of a project's secure files. Files are downloaded with their original name and file extension.
      --force-download      Force download file(s) even if checksum verification fails. Warning: when enabled, this setting allows the download of files that are corrupt or tampered with.
      --id int              ID of the secure file to download.
      --name string         Name of the secure file to download. Saves the file with this name, or to the path specified by --path.
      --no-verify           Do not verify the checksum of the downloaded file(s). Warning: when enabled, this setting allows the download of files that are corrupt or tampered with.
      --output-dir string   Output directory for files downloaded with --all. (default ".")
  -p, --path string         Path to download the secure file to, including filename and extension. (default "./downloaded.tmp")

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 securefile download`'
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-->
13Download one or more secure files from a project.
15## Synopsis
17To download a single file, identify it by its numeric ID (as a positional
18argument or with `--id`) or by its name with `--name`. To download every
19secure file in the project, use `--all`.
21Use `--path` to save a single download to a specific filename, or
22`--output-dir` to choose the destination directory when downloading
23multiple files.
25By default, downloaded files are verified against their checksum.
26Use `--no-verify` to skip verification, or `--force-download` to keep
27files even when verification fails. Both options can allow corrupted
28or tampered files; use with caution.
30By default, files are downloaded from the current project. Use
31`--repo` to target another project.
33```plaintext
34glab securefile download [<id> | --id <id> | --name <name>] [flags]
35```
37## Examples
39```console
40# Download a file by ID (positional or flag)
41glab securefile download 1
42glab securefile download --id 1
44# Download a file by ID to a specific path
45glab securefile download 1 --path "securefiles/file.txt"
47# Download a file to an absolute path
48glab securefile download 1 --path /tmp/secure/file.txt
50# Download a file by name to the current directory
51glab securefile download --name my-secure-file.pem
53# Download a file by name to a chosen path
54glab securefile download --name my-secure-file.pem --path securefiles/some-other-name.pem
56# Download without verifying the checksum
57glab securefile download 1 --no-verify
59# Download all secure files in the project
60glab securefile download --all
62# Download all secure files to a specific directory
63glab securefile download --all --output-dir secure_files/
65```
67## Options
69```plaintext
70 --all Download all of a project's secure files. Files are downloaded with their original name and file extension.
71 --force-download Force download file(s) even if checksum verification fails. Warning: when enabled, this setting allows the download of files that are corrupt or tampered with.
72 --id int ID of the secure file to download.
73 --name string Name of the secure file to download. Saves the file with this name, or to the path specified by --path.
74 --no-verify Do not verify the checksum of the downloaded file(s). Warning: when enabled, this setting allows the download of files that are corrupt or tampered with.
75 --output-dir string Output directory for files downloaded with --all. (default ".")
76 -p, --path string Path to download the secure file to, including filename and extension. (default "./downloaded.tmp")
77```
79## Options inherited from parent commands
81```plaintext
82 -h, --help Show help for this command.
83 -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.
84```
Diagnostics7 git calls · 239 ms
CallStatusSizeTime0239 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
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 KiB · hit3 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=HIT
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 · hit7 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=4
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=7
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 · hit8 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=8
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=8
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 · hit3 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=3
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:0200287 B · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=4
git.response.bytes=287
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=1b5a77e6722da18ebe0d7400e761e4fa034a2a2d
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=287
git.pkt.payload.max=260
git.sideband.band1.bytes=260
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=260
git.pack.trailer=1eabef2f2754a3e72107aa650ec255dea771a727
Open pack map
fetch2001.3 KiB221 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=221
git.response.bytes=1321
git.response.cache=MISS
git.response.duration_ms=221
git.fetch.wants=157e6d1735faa0c1e9de8e60f18506a4d7f77ae2
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=1321
git.pkt.payload.max=1294
git.sideband.band1.bytes=1294
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
a5e22d993926a594
Request
3c14fb42…
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