GCLI-PIPELINES(1)

📦
version 2.13.0 · 5 versions
, in nixpkgs unstable, ubuntu stonking

💅 GCLI-PIPELINES(1) — the manual, bestie edition ✨

okay so you picked up the gcli pipelines page from the General Commands Manual, and honestly? you ate. let's get into it 🫶

✨ NAME ✨

gcli pipelines — inspect and manage CI Services 👑

🎀 SYNOPSIS 🎀

like, the whole vibe of how you call it:

gcli pipelines [forge-path] [-n n] [-o owner -r repo] [-a]
gcli pipelines [forge-path] -p pipeline-id [-o owner -r repo]
               pipeline-actions...
gcli pipelines -j job-id [-o owner -r repo] job-actions...

🌸 DESCRIPTION 🌸

so gcli pipelines is your girl for showing you data about the Continuous Integration (CI) service of git forges. you can list pipelines of a given repository, list jobs inside a given pipeline, or do actual actions — like restarting jobs or pulling their logs. main character energy fr.

and listen, lowkey important: if you've set restrict-pipelines-to-branch in the defaults section of your gcli(5) config file, then gcli pipelines will only list pipelines for the currently checked out branch — unless you passed the -a flag. no cap. 🦋

💅 OPTIONS 💅

  • -o, --owner owner — operate on the repository of the given owner. this one can only be used together with -r. they're a package deal, bestie 💖
  • -r, --repo repo — operate on the given repo. and yeah, this can only be used together with -o. same package, same deal.
  • -n, --count n — fetch at least n items. setting n to -1 will fetch all items. default is 30. ngl though: on large repositories, fetching all items can take a considerable amount of time and may get you rate limited by the GitLab API. 😭 be careful out there.
  • -p, --pipeline pipeline-id — execute the given actions for the specified pipeline-id.
  • -j, --job job — execute the given actions for the specified job.
  • -a, --all — do not restrict the pipelines list to pipelines running on the current branch. this option only applies if you've enabled restrict-pipelines-to-branch inside the defaults section of gcli(5). it's giving "let me see everything" ✨

🔥 ACTIONS 🔥

job-actions...

okay so job-actions... may be one or more of the following:

  • log — dump the log of the job. the receipts, basically 📜
  • status — print a short summary of the job.
  • cancel — cancel the job. bye bestie 👋
  • retry — retry the job. we try again, periodt 🔁
  • artifacts [-o outfile] — download the artifacts archive as a zip to disk. the default output file is artifacts.zip, but you can override it with the -o flag. 🍓

pipeline-actions...

and pipeline-actions... may be one or more of the following:

  • all — print a summary with all information about the pipeline.
  • status — print a short status summary of the pipeline.
  • jobs — print a list of jobs running in the pipeline.
  • children — print a list of child pipelines triggered by this pipeline. the pipeline's little babies 🧚
  • open — opens the pipeline in a web browser. ✨
  • monitor [-d secs] — continuously monitor the jobs of this pipeline. this presents a view of the jobs list that is refreshed live. the action exits once the pipeline has completed.
⚠️ heads up: this action requires an xterm(1) compatible terminal emulator, because control characters are printed to stdout. it's literally required, no workaround.

the refresh interval can be configured via the monitor-delay option in the defaults section of the gcli(5) config file. alternatively you can override the delay by passing it via the -d flag. the command line flag takes prescendence over the config file. 💅

🌈 EXAMPLES 🌈

print a list of the last 30 pipelines in the current project:

$ gcli pipelines

when restrict-pipelines-to-branch is set and you are on the foobar branch which is up-to-date with origin/foobar then gcli pipelines will give you all pipelines that ran on the foobar branch.

print a summary of pipeline 420:

$ gcli pipelines -p 420 all

list only jobs of pipeline #3316:

$ gcli pipelines -p3316 jobs

dump the log of Job #423141 in herrhotzenplotz/gcli:

$ gcli pipelines -o herrhotzenplotz -r gcli -j 423141 log

list pipelines in herrhotzenplotz/gcli using the forge path shorthand:

$ gcli pipelines gl:herrhotzenplotz/gcli

🦋 SEE ALSO 🦋

git(1), gcli(1) — go read those too, they're iconic 💜

👑 AUTHORS 👑

Nico Sonack aka. herrhotzenplotz <nsonack@herrhotzenplotz.de> and contributors. shoutout to the contributors fr fr 🫶

💀 BUGS 💀

  • The interface has been modelled after the GitLab CI service. GitHub behaves differently in some cases. so yeah, don't assume it's 1:1, ngl.
  • The command gcli pipelines -a only fetches checks for the HEAD ref on GitHub. that's the whole thing, that's the limitation 🙈

please report bugs via E-Mail to https://lists.sr.ht/~herrhotzenplotz/gcli-discuss.

alternatively you can report them on any of the forges linked at https://sr.ht/~herrhotzenplotz/gcli. however, the preferred and quickest method is to use the mailing list. ✨

okay and that's the whole page bestie, written by the gcli crew — version 2.13.0, dated 05-Aug-2026. slay, go run some pipelines 💖🌈🎀

📦 where this page comes from