1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
.Dd @PACKAGE_DATE@
.Dt GCLI-PIPELINES 1
.Os @PACKAGE_STRING@
.Sh NAME
.Nm gcli\ pipelines
.Nd Inspect and manage GitLab Pipelines
.Sh SYNOPSIS
.Nm
.Op Fl n Ar n
.Op Fl o Ar owner Fl r Ar repo
.Op Fl a
.Nm
.Fl p Ar pipeline-id
.Op Fl o Ar owner Fl r Ar repo
.Ar pipeline-actions...
.Nm
.Fl j Ar job-id
.Op Fl o Ar owner Fl r Ar repo
.Ar job-actions...
.Sh DESCRIPTION
.Nm
is used to display data about the Continuous Integration (CI) service
of GitLab. You can list pipelines of a given repository, list jobs in
a given pipeline or perform actions such as restarting jobs or
fetching their logs.
.Pp
If you have set
.Sq restrict-pipelines-to-branch
in the
.Sq defaults
section of your
.Xr gcli 5
config file,
.Nm
will only list pipelines for the currently checked out branch unless the
.Fl a
flag has been specified.
.Sh OPTIONS
.Bl -tag -width indent
.It Fl o , -owner Ar owner
Operate on the repository of the given owner. This option can only be
used in combination with
.Fl r .
.It Fl r , -repo Ar repo
Operate on the given repository. This option can only be used in
combination with
.Fl o .
.It Fl n , -count Ar n
Fetch at least
.Ar n
items. Setting
.Ar n
to -1 will fetch all items. Default: 30. Note that on large
repositories fetching all items can take a considerable amount of time
and may result in rate limiting by the GitLab API.
.It Fl p , -pipeline Ar pipeline-id
Execute the given actions for the specified
.Ar pipeline-id .
.It Fl j , -job Ar job
execute the given
.Ar actions
for the specified
.Ar job .
.It Fl a , -all
Do not restrict the pipelines list to pipelines running on the current branch.
This option only applies if you have enabled
.Sq restrict-pipelines-to-branch
inside the
.Sq defaults
section of
.Xr gcli 5 .
.El
.Sh ACTIONS
.Ar job-actions...
may be one or more of the following:
.Bl -tag -width artifacts
.It Cm log
Dump the log of the job.
.It Cm status
Print a short summary of the job.
.It Cm cancel
Cancel the job.
.It Cm retry
Retry the job.
.It Cm artifacts Op Fl o Ar outfile
Download the artifacts archive as a zip to disk. The default output file is
.Pa artifacts.zip
but it can be overridden by using the
.Fl o
flag.
.El
.Pp
.Pp
.Ar pipeline-actions...
may be one or more of the following:
.Bl -tag -width children
.It Cm all
Print a summary with all information about the pipeline.
.It Cm status
Print a short status summary of the pipeline.
.It Cm jobs
Print a list of jobs running in the pipeline.
.It Cm children
Print a list of child pipelines triggered by this pipeline.
.It Cm open
Opens the pipeline in a web browser.
.El
.Sh EXAMPLES
Print a list of the last 30 pipelines in the current project:
.Bd -literal -offset indent
$ gcli pipelines
.Ed
.Pp
When
.Sq restrict-pipelines-to-branch
is set and you are on the
.Sq foobar
branch which is up-to-date with
.Sq origin/foobar
then
.Nm
will give you all pipelines that ran on the
.Sq foobar
branch.
.Pp
Print a summary of pipeline 420:
.Bd -literal -offset indent
$ gcli pipelines -p 420 all
.Ed
.Pp
List only jobs of pipeline #3316:
.Bd -literal -offset indent
$ gcli pipelines -p3316 jobs
.Ed
.Pp
Dump the log of Job #423141 in herrhotzenplotz/gcli:
.Bd -literal -offset indent
$ gcli pipelines -o herrhotzenplotz -r gcli -j 423141 log
.Ed
.Sh SEE ALSO
.Xr git 1 ,
.Xr gcli 1
.Sh AUTHORS
.An Nico Sonack aka. herrhotzenplotz Aq Mt nsonack@herrhotzenplotz.de
and contributors.
.Sh BUGS
None currently known.
.Pp
Please report bugs via E-Mail to
.Mt @PACKAGE_BUGREPORT@ .
.Pp
Alternatively you can report them on any of the forges linked at
.Lk @PACKAGE_URL@ .
However, the preferred and quickest method is to use the mailing
list.
|
