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
|
.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
.Nm
.Fl p Ar pipeline-id
.Op Fl o Ar owner Fl r Ar repo
.Op Fl n Ar n
.Nm
.Fl j Ar job-id
.Op Fl o Ar owner Fl r Ar repo
.Ar 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.
.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
List jobs in the given pipeline.
.It Fl j , -jobs Ar job
execute the given
.Ar actions
for the specified
.Ar job .
.El
.Sh ACTIONS
.Ar 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
.Sh EXAMPLES
Print a list of the last 30 pipelines in the current project:
.Bd -literal -offset indent
$ gcli pipelines
.Ed
.Pp
List all jobs of pipeline #3316:
.Bd -literal -offset indent
$ gcli pipelines -p3316
.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
We are missing a
.Fl a
flag. This is the current implied behaviour.
.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.
|