Skip to main content

Agent-friendly CLI for inspecting GitLab CI pipelines — dumps full pipeline state and prints a problem-driven summary.

Project description

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

Clone the repo and install as an editable uv tool:

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

Edits to src/ are picked up immediately. To upgrade, git pull in the clone directory.

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 glab ci view|get|trace, raw glab api .../pipelines/...|/jobs/.../trace|/ci/lint calls, redirecting the agent to use 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, git pull in your clone (the editable install picks up changes automatically), then:

claude plugin marketplace update fprochazka-glab-pipeline
claude plugin update glab-pipeline@fprochazka-glab-pipeline

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 --full                       # force lint + downstream + test-report unconditionally
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
  • downstream/<bridge-name>-<dpid>.json — when a bridge failed; one level deep
  • test-report.json — when a failed job is in a test stage (heuristic on stage/name)

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+

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.

Project details


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.1.0.tar.gz (34.9 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.1.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: glab_pipeline-0.1.0.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for glab_pipeline-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b65e24b38ec713f6b5342c6edf22a9522635ca135b326f262c2f545b7a853249
MD5 8a3c6553afb5000d4a2103b99647a357
BLAKE2b-256 e134c6d65bf46e52b0b6a16c5b564194169572566d4d1b8a4bc492398ab09830

See more details on using hashes here.

Provenance

The following attestation bundles were made for glab_pipeline-0.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: glab_pipeline-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for glab_pipeline-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4bcf04287794419a1ee49d8b4acb981fb3d85207515fca294720639e23693948
MD5 7420ab38d9312759161085542e99af63
BLAKE2b-256 8c8fa252ba45838544624fbd348a7559bba2968aa5cfeddbee6ddf12a131bcab

See more details on using hashes here.

Provenance

The following attestation bundles were made for glab_pipeline-0.1.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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page