GitLabgitlab-org

cli

main
ply7 git calls304 ms98 KiB4 cachedprotocol v2
89 lines3.2 KiBRaw

Download a file from a project's package registry.

Synopsis

Download a generic package file, identified by its package name, version, and file name.

Use --path to choose where the file is saved. If it names a directory (it ends with a separator or already exists as one), the file is saved there under its original name. Otherwise it is saved as that exact path, letting you rename the file. By default the file is saved in the current directory under its original name.

By default, the downloaded file is verified against the checksum stored in the registry. This requires extra API calls to look up the file's metadata. Use --no-verify to skip verification. This can allow corrupted or tampered files; use with caution.

If the target file already exists, the download fails. Use --force to overwrite it.

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

plaintext
glab packages download --name <package> --version <version> --filename <file> [flags]

Aliases

plaintext
dl

Examples

console
# Download a package file to the current directory
glab packages download --name my-package --version 1.0.0 --filename app.zip

# Download into a directory, keeping the original file name
glab packages download -n my-package --version 1.0.0 --filename app.zip --path ./downloads/

# Download to an exact path, renaming the file
glab packages download -n my-package --version 1.0.0 --filename app.zip --path ./downloads/renamed.zip

# Download to an absolute path
glab packages download -n my-package --version 1.0.0 --filename app.zip --path /tmp/downloads/app.zip

# Download without verifying the checksum
glab packages download -n my-package --version 1.0.0 --filename app.zip --no-verify

# Overwrite an existing file
glab packages download -n my-package --version 1.0.0 --filename app.zip --force

# Use the 'dl' alias and target another project
glab packages dl -n my-package --version 1.0.0 --filename app.zip -R owner/repo

Options

plaintext
      --filename string   Name of the file within the package to download.
      --force             Overwrite the target file if it already exists.
  -n, --name string       Name of the package.
      --no-verify         Do not verify the checksum of the downloaded file. Warning: when enabled, this setting allows the download of files that are corrupt or tampered with.
  -p, --path string       Directory to save the file in (keeps its original name) or a full file path to rename it. Defaults to the original name in the current directory.
      --version string    Version of the package.

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 packages 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 a file from a project's package registry.
15## Synopsis
17Download a generic package file, identified by its package name, version,
18and file name.
20Use `--path` to choose where the file is saved. If it names a directory
21(it ends with a separator or already exists as one), the file is saved
22there under its original name. Otherwise it is saved as that exact path,
23letting you rename the file. By default the file is saved in the current
24directory under its original name.
26By default, the downloaded file is verified against the checksum stored in
27the registry. This requires extra API calls to look up the file's metadata.
28Use `--no-verify` to skip verification. This can allow corrupted or
29tampered files; use with caution.
31If the target file already exists, the download fails. Use `--force` to
32overwrite it.
34By default, files are downloaded from the current project. Use `--repo`
35to target another project.
37```plaintext
38glab packages download --name <package> --version <version> --filename <file> [flags]
39```
41## Aliases
43```plaintext
44dl
45```
47## Examples
49```console
50# Download a package file to the current directory
51glab packages download --name my-package --version 1.0.0 --filename app.zip
53# Download into a directory, keeping the original file name
54glab packages download -n my-package --version 1.0.0 --filename app.zip --path ./downloads/
56# Download to an exact path, renaming the file
57glab packages download -n my-package --version 1.0.0 --filename app.zip --path ./downloads/renamed.zip
59# Download to an absolute path
60glab packages download -n my-package --version 1.0.0 --filename app.zip --path /tmp/downloads/app.zip
62# Download without verifying the checksum
63glab packages download -n my-package --version 1.0.0 --filename app.zip --no-verify
65# Overwrite an existing file
66glab packages download -n my-package --version 1.0.0 --filename app.zip --force
68# Use the 'dl' alias and target another project
69glab packages dl -n my-package --version 1.0.0 --filename app.zip -R owner/repo
71```
73## Options
75```plaintext
76 --filename string Name of the file within the package to download.
77 --force Overwrite the target file if it already exists.
78 -n, --name string Name of the package.
79 --no-verify Do not verify the checksum of the downloaded file. Warning: when enabled, this setting allows the download of files that are corrupt or tampered with.
80 -p, --path string Directory to save the file in (keeps its original name) or a full file path to rename it. Defaults to the original name in the current directory.
81 --version string Version of the package.
82```
84## Options inherited from parent commands
86```plaintext
87 -h, --help Show help for this command.
88 -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.
89```
Diagnostics7 git calls · 304 ms
CallStatusSizeTime0304 ms
discover200185 B2 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=3
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 · 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:0200227 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=294
git.response.bytes=227
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=aeeebadf0c5ca231537980dfeef57d34014dd91e
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=227
git.pkt.payload.max=200
git.sideband.band1.bytes=200
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=200
git.pack.trailer=b13d9f708bc989e64ffe26723f98a654348f822e
Open pack map
fetch2001.3 KiB294 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1322
git.response.cache=MISS
git.response.duration_ms=294
git.fetch.wants=25445510b0bea84ca0c7e9744d570bd2c73523fd
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=1322
git.pkt.payload.max=1295
git.sideband.band1.bytes=1295
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
a5e23375cd0fa594
Request
f066a487…
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