Skip to main content

TUI that watches a GitHub Actions run for a branch/tag as a live job graph

Project description

gha-watcher-tui

A terminal UI that watches the latest GitHub Actions run for a branch or tag and renders its jobs as a live node graph — boxes connected by dependency edges, colored by state — similar to GitHub's web workflow visualization.

Usage

gha-watch <branch-or-tag> [--repo owner/name] [--poll SECONDS] [--no-exit]
  • The repository defaults to the origin remote of the current directory; override with --repo owner/name.
  • Authentication uses a token from GITHUB_TOKEN or GH_TOKEN (e.g. GITHUB_TOKEN=$(gh auth token) gha-watch main).
  • The graph polls every 5 seconds (--poll to change) and updates node colors as jobs progress. Press q to quit.

When the run finishes the app exits automatically with a status code. With --no-exit it stays open showing the final graph instead; pressing q then exits with the run's status code.

Code Meaning
0 run concluded successfully
1 run failed or was cancelled
2 usage or API error (no token, unknown repo/ref, …)
130 quit manually before the run finished

Notes

  • Dependency edges come from parsing the workflow YAML (needs:), since the REST jobs API doesn't expose them. Matrix jobs (test (3.12)) are matched back to their YAML job heuristically; unmatched jobs render as disconnected nodes.
  • Only the single latest run for the ref is watched; a newer run starting mid-watch is ignored.

Development

uv sync
uv run pytest

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

gha_watcher_tui-0.1.0.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

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

gha_watcher_tui-0.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gha_watcher_tui-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8b4e0ac902b11ceed28fb49d60bdf0816df18bb4639adbedd04bb6f472f74f46
MD5 2aec7d390a1937a14edf08be2e5cccd8
BLAKE2b-256 2e55030992191bbf495c0f8ccc634baf242bbbedc5bc1a9f3aa096f99334c287

See more details on using hashes here.

Provenance

The following attestation bundles were made for gha_watcher_tui-0.1.0.tar.gz:

Publisher: publish.yml on ulope/gha-watcher-tui

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

File details

Details for the file gha_watcher_tui-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for gha_watcher_tui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c77b1ae821e572df572965f689bee153d73f1e7dc8e57467346dc188c8486c5
MD5 7f0515a1411567c6737912d688f0264c
BLAKE2b-256 168cb537dae0c06d431459f9042acf1fcb44dff5db29a109ad475965ee4b1949

See more details on using hashes here.

Provenance

The following attestation bundles were made for gha_watcher_tui-0.1.0-py3-none-any.whl:

Publisher: publish.yml on ulope/gha-watcher-tui

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