Skip to main content

glab-pipeline

Agent-friendly CLI for inspecting GitLab CI pipelines. Built on top of glab for authentication.

Why

The glab CLI shows pipeline status, but diagnosing a failed pipeline still means manually fetching each failing job, downloading traces, and stitching the picture together — and glab ci view is TUI-only, which doesn't help an AI agent. This tool dumps the full pipeline state to a temp directory (pipeline + jobs + bridges + full trace per job) and prints a problem-driven summary: the base header is always small, and extra sections (YAML errors, failed jobs, failed downstream pipelines, test failures) are appended only when applicable.

Conditional fetches keep dumps lean — ci/lint + merged.yml are only fetched when the pipeline has YAML errors or a job's failure_reason suggests a config issue (missing_dependency_failure, unmet_prerequisites, etc.); test_report_summary is only fetched when a failed job is in a test stage.

Installation

Install as a uv tool:

uv tool install glab-pipeline

To upgrade later:

uv tool upgrade glab-pipeline

For local development, clone and install editable instead:

git clone https://github.com/fprochazka/glab-pipeline.git
cd glab-pipeline
uv tool install --editable .

Claude Code plugin

The repo includes a Claude Code plugin with:

  • a skill that teaches AI agents how to use glab-pipeline
  • a PreToolUse hook that blocks six command shapes and redirects the agent to glab-pipeline inspect instead. This keeps the agent reasoning over a structured dump rather than wrangling pipeline JSON across many uncoordinated API calls.
claude plugin marketplace add fprochazka/glab-pipeline
claude plugin install glab-pipeline@fprochazka-glab-pipeline

To upgrade after a new release:

uv tool upgrade glab-pipeline
uv tool install --force bash-classify
claude plugin marketplace update fprochazka-glab-pipeline
claude plugin update glab-pipeline@fprochazka-glab-pipeline

The hook blocks:

Rule Shape
ci-view glab ci view
ci-get glab ci get
ci-trace glab ci trace
pipelines-api glab api against projects/<id>/pipelines/<id>...
job-trace-api glab api against projects/<id>/jobs/<id>/trace
ci-lint-api glab api against projects/<id>/ci/lint

The verdict comes from bash-classify, which parses the command and reports which of those shapes it actually invokes. Text that merely names one — a heredoc body, an echo argument, a commit message, a grep pattern — is not an invocation and is allowed, while a wrapper (sudo, timeout, bash -c, xargs) does not hide one, and neither do glab's deprecated pipe/pipeline aliases for ci.

Without bash-classify the hook still works, but in a degraded mode: it falls back to matching the raw command text. That is wrong in both directions — it denies anything that so much as mentions a blocked command, and it misses real calls it cannot see: the pattern never knew glab's pipe/pipeline aliases, so glab pipeline view 1000 passes, and a line-based pattern cannot see an endpoint written on a continuation line. Every deny issued that way says so in its reason, and a SessionStart hook says the same thing once at the start of a session, so the agent can tell you to install or upgrade the tool (plugin SessionStart hooks need Claude Code 2.1.257 or newer; versions 2.1.216 to 2.1.252 silently skipped them). A bash-classify between 0.10.0 and 0.11.0 is a quieter middle case: it runs full match mode, so none of the above applies, but it does not resolve the pipe/pipeline aliases, so those two spellings pass silently until you upgrade.

Usage

By default, the pipeline is auto-detected from the current git branch's open MR (via glab mr view). Override with --pipeline-url, --pipeline-id, --mr-url, or --hostname/--project/--mr-iid.

inspect

Dump full pipeline state to a temp directory and print a problem-driven summary.

glab-pipeline inspect                              # auto-detect from current branch's MR
glab-pipeline inspect --pipeline-url <url>         # explicit pipeline
glab-pipeline inspect --pipeline-id 1234567        # plus --hostname/--project, or auto-detect
glab-pipeline inspect --mr-iid 42 --project g/r --hostname gitlab.com
glab-pipeline inspect --output-dir /path/to/dir    # default: $TMPDIR/glab-pipeline-<pid>-<ts>/
glab-pipeline inspect --with-merged-ci-config      # two-step lint that resolves include: against source branch
glab-pipeline inspect --with-test-report           # force test-report fetch even without failed test jobs
glab-pipeline inspect --with-downstream-pipelines  # fetch downstream detail for every bridge, not just failed
glab-pipeline inspect --with-artefacts             # download+unpack each job's artifacts archive (one zip per job)
glab-pipeline inspect --json | jq                  # print structured summary JSON to stdout (no human text)

The dump directory always contains:

  • pipeline.json — full pipeline metadata (incl. yaml_errors, detailed_status)
  • jobs.json — all jobs, including retried
  • bridges.json — trigger jobs to child/downstream pipelines (omitted if none)
  • job-logs/<stage>-<name>-<id>.logfull trace for every job, fetched in parallel
  • summary.json — canonical structured summary (single source of truth); always written. Pass --json to print this to stdout instead of the human-readable text.

And conditionally:

  • lint.json + merged.yml — when yaml_errors is set, the pipeline has 0 jobs, or any job's failure_reason hints at a config problem. With --with-merged-ci-config this switches to a two-step lint that fetches the raw .gitlab-ci.yml from the source branch and POSTs it to /ci/lint, properly resolving include: (useful when masked CI variables appear in include paths).
  • downstream/<bridge-name>-<dpid>.json — when a bridge failed; one level deep. With --with-downstream-pipelines fetched for every bridge with a downstream pipeline.
  • test-report.json — when a failed job is in a test stage (heuristic on stage/name). Forced by --with-test-report.
  • artifacts/<stage>-<name>-<id>/… — when --with-artefacts is set; each job's artifacts archive unpacked (one zip per job, then extracted). Only jobs with a live, non-expired archive artifact are fetched; expired/missing/corrupt archives are skipped per-job, never fatal.

Use the summary first to find what failed and why, then read the relevant log/lint/test-report file directly.

Requirements

  • glab CLI installed and authenticated
  • Python 3.12+

The Claude Code plugin's hook additionally needs:

  • jq
  • bash-classify 0.11.0 or newer. Without it the hook still runs, but falls back to matching raw command text, which both blocks commands that only mention a blocked command in a heredoc or a commit message, and lets glab's pipe/pipeline aliases through.
uv tool install bash-classify

Development

git clone https://github.com/fprochazka/glab-pipeline.git
cd glab-pipeline
uv sync --dev

Run tests and linting:

uv run ruff format .
uv run ruff check .
uv run pytest

Releasing

Version is derived automatically from git tags via hatch-vcs — no manual version bumping needed.

Before tagging, bump the version in both plugin manifest files:

  • coding-agent-plugins/claude-code/.claude-plugin/plugin.json
  • .claude-plugin/marketplace.json

Wait for CI to pass on master, then tag, push, and create a GitHub release:

# Review changes since last release
git log $(git describe --tags --abbrev=0)..HEAD --oneline

git tag v<version>
git push origin v<version>
gh release create v<version> --title "v<version>" --notes "..."

The publish.yml GitHub Action builds and publishes to PyPI automatically via trusted publishing.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glab_pipeline-0.3.0.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

glab_pipeline-0.3.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file glab_pipeline-0.3.0.tar.gz.

File metadata

  • Download URL: glab_pipeline-0.3.0.tar.gz
  • Upload date:
  • Size: 52.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for glab_pipeline-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e2f5e40cd5047a7467c0771d6ea5936298364a76c4a6f5c366b57722946336ac
MD5 2052d8ea9e6051ee764714420cfa6c2b
BLAKE2b-256 ad3412a16804dc5080f1783a3ad6257b34dd890a2ea750e718a073a9ee02b280

See more details on using hashes here.

Provenance

The following attestation bundles were made for glab_pipeline-0.3.0.tar.gz:

Publisher: publish.yml on fprochazka/glab-pipeline

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file glab_pipeline-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: glab_pipeline-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for glab_pipeline-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4cb6cbb3832a1c5645cd90f548b35555003ea8e8afe871a82599e10e5ba9e0d
MD5 daac8bc86a3fa9c9181df42d4e1a126d
BLAKE2b-256 334b05b9c32b3f55c872e67e3683e51ed073942c4df5276bfbbd344d6279ef74

See more details on using hashes here.

Provenance

The following attestation bundles were made for glab_pipeline-0.3.0-py3-none-any.whl:

Publisher: publish.yml on fprochazka/glab-pipeline

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page