GitLabgitlab-org

cli

main
ply7 git calls62 ms99 KiB6 cachedprotocol v2
109 lines4.0 KiBRaw

Create a new CI/CD pipeline.

Synopsis

Use --branch to specify a branch or reference. Defaults to the current branch.

The variable flags (--variables, --variables-env, --variables-file, --variables-from) cannot be used with --mr. If both are used, the command fails.

Specify one or more pipeline inputs using the -i or --input flag for each input. Each input flag uses the format key:value.

The values are typed and will default to string unless a type is explicitly specified. To specify a type, use the type(value) syntax. For example, key:string(value) will pass the string value as the input.

Valid types are:

  • string: A string value. This type is the default. For example, key:string(value).
  • int: An integer value. For example, key:int(42).
  • float: A floating-point value. For example, key:float(3.14).
  • bool: A boolean value. For example, key:bool(true).
  • array: An array of strings. For example, key:array(foo,bar).

An array of strings can be specified with a trailing comma. For example, key:array(foo,bar,) will pass the array [foo, bar]. array() specifies an empty array. To pass an array with the empty string, use array(,).

Value arguments containing parentheses should be escaped from the shell with quotes. For example, --input key:array(foo,bar) should be written as --input 'key:array(foo,bar)'.

plaintext
glab ci run [flags]

Aliases

plaintext
create

Examples

console
glab ci run
glab ci run --variables \"key1:value,with,comma\"
glab ci run -b main
glab ci run --web
glab ci run --mr

# Specify CI variables
glab ci run -b main --variables-env key1:val1
glab ci run -b main --variables-env key1:val1,key2:val2
glab ci run -b main --variables-env key1:val1 --variables-env key2:val2
glab ci run -b main --variables-file MYKEY:file1 --variables KEY2:some_value

# Specify CI inputs
glab ci run -b main --input key1:val1 --input key2:val2
glab ci run -b main --input "replicas:int(3)" --input "debug:bool(false)" --input "regions:array(us-east,eu-west)"

# Load variables from JSON file
# Create variables.json with this format:
# [
#   {
#     "key": "CI_PIPELINE_SOURCE",
#     "value": "web",
#     "variable_type": "env_var"
#   },
#   {
#     "key": "DEPLOY_ENV",
#     "value": "production"
#   }
# ]
glab ci run -b main --variables-from variables.json

Options

plaintext
  -b, --branch string            Create pipeline on branch or reference <string>.
  -i, --input stringArray        Pass inputs to pipeline in format '<key>:<value>'. Cannot be used for merge request pipelines. See documentation for examples.
      --mr                       Run merge request pipeline instead of branch pipeline.
      --variables strings        Pass variables to the pipeline in the format <key>:<value>. Cannot be used for MR pipelines.
      --variables-env strings    Pass variables to the pipeline in the format <key>:<value>. Cannot be used for MR pipelines.
      --variables-file strings   Pass file contents as a file variable to the pipeline in the format <key>:<filename>. Cannot be used for MR pipelines.
  -f, --variables-from string    JSON file with variables for pipeline execution. Expects array of hashes, each with at least 'key' and 'value'. Cannot be used for MR pipelines.
  -w, --web                      Open pipeline in a browser. Uses default browser, or browser specified in BROWSER environment variable.

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 ci run`'
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 new CI/CD pipeline.
15## Synopsis
17Use `--branch` to specify a branch or reference. Defaults to the current branch.
19The variable flags (`--variables`, `--variables-env`,
20`--variables-file`, `--variables-from`) cannot be used with
21`--mr`. If both are used, the command fails.
23Specify one or more pipeline inputs using the `-i` or `--input` flag for each
24input. Each input flag uses the format `key:value`.
26The values are typed and will default to `string` unless a type is explicitly
27specified. To specify a type, use the `type(value)` syntax. For example,
28`key:string(value)` will pass the string `value` as the input.
30Valid types are:
32- `string`: A string value. This type is the default. For example, `key:string(value)`.
33- `int`: An integer value. For example, `key:int(42)`.
34- `float`: A floating-point value. For example, `key:float(3.14)`.
35- `bool`: A boolean value. For example, `key:bool(true)`.
36- `array`: An array of strings. For example, `key:array(foo,bar)`.
38An array of strings can be specified with a trailing comma. For example,
39`key:array(foo,bar,)` will pass the array `[foo, bar]`. `array()` specifies an
40empty array. To pass an array with the empty string, use `array(,)`.
42Value arguments containing parentheses should be escaped from the shell with
43quotes. For example, `--input key:array(foo,bar)` should be written as
44`--input 'key:array(foo,bar)'`.
46```plaintext
47glab ci run [flags]
48```
50## Aliases
52```plaintext
53create
54```
56## Examples
58```console
59glab ci run
60glab ci run --variables \"key1:value,with,comma\"
61glab ci run -b main
62glab ci run --web
63glab ci run --mr
65# Specify CI variables
66glab ci run -b main --variables-env key1:val1
67glab ci run -b main --variables-env key1:val1,key2:val2
68glab ci run -b main --variables-env key1:val1 --variables-env key2:val2
69glab ci run -b main --variables-file MYKEY:file1 --variables KEY2:some_value
71# Specify CI inputs
72glab ci run -b main --input key1:val1 --input key2:val2
73glab ci run -b main --input "replicas:int(3)" --input "debug:bool(false)" --input "regions:array(us-east,eu-west)"
75# Load variables from JSON file
76# Create variables.json with this format:
77# [
78# {
79# "key": "CI_PIPELINE_SOURCE",
80# "value": "web",
81# "variable_type": "env_var"
82# },
83# {
84# "key": "DEPLOY_ENV",
85# "value": "production"
86# }
87# ]
88glab ci run -b main --variables-from variables.json
89```
91## Options
93```plaintext
94 -b, --branch string Create pipeline on branch or reference <string>.
95 -i, --input stringArray Pass inputs to pipeline in format '<key>:<value>'. Cannot be used for merge request pipelines. See documentation for examples.
96 --mr Run merge request pipeline instead of branch pipeline.
97 --variables strings Pass variables to the pipeline in the format <key>:<value>. Cannot be used for MR pipelines.
98 --variables-env strings Pass variables to the pipeline in the format <key>:<value>. Cannot be used for MR pipelines.
99 --variables-file strings Pass file contents as a file variable to the pipeline in the format <key>:<filename>. Cannot be used for MR pipelines.
100 -f, --variables-from string JSON file with variables for pipeline execution. Expects array of hashes, each with at least 'key' and 'value'. Cannot be used for MR pipelines.
101 -w, --web Open pipeline in a browser. Uses default browser, or browser specified in BROWSER environment variable.
102```
104## Options inherited from parent commands
106```plaintext
107 -h, --help Show help for this command.
108 -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.
109```
Diagnostics7 git calls · 62 ms
CallStatusSizeTime062 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
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 · hit2 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=HIT
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
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
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · 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=4273
git.response.cache=HIT
git.response.duration_ms=4
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=2
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:0200491 B · 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=491
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=e42e3bf29ad34961a8b74fead7be10c4fd9cd851
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=491
git.pkt.payload.max=464
git.sideband.band1.bytes=464
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=464
git.pack.trailer=8a961ba05282bd7e212a5b70934329bd7f1f01df
Open pack map
fetch2001.6 KiB · hit51 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=51
git.response.bytes=1676
git.response.cache=HIT
git.response.duration_ms=51
git.fetch.wants=fef4d8c36260ca5f1f7688d752cb43d56714b069
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=1676
git.pkt.payload.max=1649
git.sideband.band1.bytes=1649
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
a5e199604dcdb86e
Request
8ebc6178…
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