GitLabgitlab-org

cli

main
ply7 git calls204 ms98 KiB4 cachedprotocol v2
72 lines2.9 KiBRaw

Create a deploy token.

Synopsis

Create a deploy token for a project or a group.

The token value is printed only once, when the token is created, and cannot be retrieved later. Use --output json to capture it from a script.

A deploy token authenticates as a username and token pair, so both values from the output are needed to use it.

The token does not expire unless --expires-at is given.

Every token must be granted at least one scope with --scope. For the scopes you can grant, see https://docs.gitlab.com/user/project/deploy_tokens/#scope.

plaintext
glab deploy-token create <name> [flags]

Examples

console
# Create a read-only deploy token for the current project
glab deploy-token create ci-reader --scope read_repository

# Create a token that can also pull images from the container registry
glab deploy-token create ci-reader --scope read_repository --scope read_registry

# Create a token for a specific project, with a custom username
glab deploy-token create ci-reader --scope read_repository --username ci-reader --repo user/my-repo

# Create a token that is valid until the end of 2027
glab deploy-token create ci-reader --scope read_repository --expires-at 2028-01-01

# Create a group deploy token
glab deploy-token create ci-reader --scope read_repository --group group/sub-group

# Create the token that CI/CD jobs receive as CI_DEPLOY_USER and CI_DEPLOY_PASSWORD
glab deploy-token create gitlab-deploy-token --scope read_registry

# Create a token and print its username and value from a script
glab deploy-token create ci-reader --scope read_repository --output json --jq '"\(.username) \(.token)"'

Options

plaintext
  -E, --expires-at time   Expiry of the token, as YYYY-MM-DD (00:00 UTC) or an RFC 3339 timestamp. The token does not expire if omitted.
  -g, --group group       Create a deploy token for a group instead of a project. Accepts a group ID or full path.
      --jq string         Filter JSON output with a jq expression.
  -F, --output string     Format output as: text, json. (default "text")
  -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.
  -S, --scope strings     Scope to grant the token. Multiple scopes can be comma-separated or specified by repeating the flag.
      --username string   Username for the token. Defaults to 'gitlab+deploy-token-<id>'.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab deploy-token create`'
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-->
13Create a deploy token.
15## Synopsis
17Create a deploy token for a project or a group.
19The token value is printed only once, when the token is created, and cannot be retrieved later. Use `--output json` to capture it from a script.
21A deploy token authenticates as a username and token pair, so both values from the output are needed to use it.
23The token does not expire unless `--expires-at` is given.
25Every token must be granted at least one scope with `--scope`. For the scopes you can grant, see <https://docs.gitlab.com/user/project/deploy_tokens/#scope>.
27```plaintext
28glab deploy-token create <name> [flags]
29```
31## Examples
33```console
34# Create a read-only deploy token for the current project
35glab deploy-token create ci-reader --scope read_repository
37# Create a token that can also pull images from the container registry
38glab deploy-token create ci-reader --scope read_repository --scope read_registry
40# Create a token for a specific project, with a custom username
41glab deploy-token create ci-reader --scope read_repository --username ci-reader --repo user/my-repo
43# Create a token that is valid until the end of 2027
44glab deploy-token create ci-reader --scope read_repository --expires-at 2028-01-01
46# Create a group deploy token
47glab deploy-token create ci-reader --scope read_repository --group group/sub-group
49# Create the token that CI/CD jobs receive as CI_DEPLOY_USER and CI_DEPLOY_PASSWORD
50glab deploy-token create gitlab-deploy-token --scope read_registry
52# Create a token and print its username and value from a script
53glab deploy-token create ci-reader --scope read_repository --output json --jq '"\(.username) \(.token)"'
54```
56## Options
58```plaintext
59 -E, --expires-at time Expiry of the token, as YYYY-MM-DD (00:00 UTC) or an RFC 3339 timestamp. The token does not expire if omitted.
60 -g, --group group Create a deploy token for a group instead of a project. Accepts a group ID or full path.
61 --jq string Filter JSON output with a jq expression.
62 -F, --output string Format output as: text, json. (default "text")
63 -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.
64 -S, --scope strings Scope to grant the token. Multiple scopes can be comma-separated or specified by repeating the flag.
65 --username string Username for the token. Defaults to 'gitlab+deploy-token-<id>'.
66```
68## Options inherited from parent commands
70```plaintext
71 -h, --help Show help for this command.
72```
Diagnostics7 git calls · 204 ms
CallStatusSizeTime0204 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:0200225 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=191
git.response.bytes=225
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=fba8c753469c1ca16e5efa59312cca4cb4a022b0
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=225
git.pkt.payload.max=198
git.sideband.band1.bytes=198
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=198
git.pack.trailer=317990dfd68af372e8daf84931e9049b07afffb7
Open pack map
fetch2001.3 KiB191 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1316
git.response.cache=MISS
git.response.duration_ms=191
git.fetch.wants=f628a9fec6d4e1a2524d761ff87c46a50483139f
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=1316
git.pkt.payload.max=1289
git.sideband.band1.bytes=1289
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
a5e127128da57fd8
Request
cb560707…
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