README
¶
gh-lazydispatch
Pick a GitHub Actions workflow, fill in its workflow_dispatch inputs, and run it without leaving the terminal. Chain several workflows into one sequence and read the logs as they stream back.
Alternatives
Other tools that trigger Actions runs, read their logs, or run them somewhere other than a GitHub-hosted runner:
| Tool | Notes |
|---|---|
| act | "Think globally, act locally" |
| action-tmate | "Debug your GitHub Actions by using tmate" |
| Buildkite Test Engine | "Deliver confidently with fast and reliable tests" (Closed source) |
| Datadog CI Visibility | "Monitor & improve the performance of your business-critical builds & deployments in any CI/CD tool" (Closed source) |
| gh | "GitHub CLI brings GitHub to your terminal", including the built-in gh workflow run and gh run view --log-failed |
| gh-act | "GitHub CLI Extension to run GitHub actions locally using nektos/act" |
| gh-annotations | "list of annotations from the recently executed Workflow" |
| gh-dash | "A rich terminal UI for GitHub that doesn't break your flow" |
| gh-dispatch | "A gh CLI extension for sending GitHub dispatch events and watching the triggered GitHub Actions runs directly from your terminal" |
| ghui | "Terminal UI for keeping up with your open GitHub pull requests across repositories", with a run and job drill-down for the checks on one |
| Mergify CI Insights | "Your CI is a black box. Open it up." (Closed source) |
| Trunk Flaky Tests | "Trunk detects, quarantines, and eliminates flaky tests from your code base" (Closed source) |
| wrkflw | "A command-line tool for validating and executing GitHub Actions workflows locally" |
| Awesome Actions | "A curated list of awesome actions to use on GitHub" |
Install
# GitHub CLI extension
gh extension install kyleking/gh-lazydispatch
# Go
go install github.com/kyleking/gh-lazydispatch/cmd/gh-lazydispatch@latest
Quick start
From a git repository that has workflows:
cd your-project
gh lazydispatch
It finds every workflow with a workflow_dispatch trigger and lists them. tab moves between panes, enter runs the highlighted workflow, and ? opens the keymap.
When you do not remember a key, a lists the actions that apply to whatever has focus and : opens a command bar that completes over this repository's own branches, chains, and workflows.
Reading a failed run
gh run view --log returns the whole log, and --log-failed still returns every line of every failed job. export diagnose parses it once and returns the failure:
gh lazydispatch export diagnose 33423560774
On a real CI failure in this repository that is 2,361 bytes against 237,144 through gh run view --log-failed. It reports which steps failed, the error lines each one logged, a window of context ending at the failure, and any known failure signature it matched.
The other read-only commands are export logs, export runs, export workflows, export chains, and export ci-timing (how long all of CI takes to finish, per commit). Every one writes JSON to stdout and its line counts to stderr; none of them dispatch anything. See docs/cli.md, and skills/github-actions for the agent-facing version.
gh lazydispatch watch <run-id> chains after a push: it blocks until the run finishes, writes an errors-only digest to disk, and prints the path. --fix hands that digest to an interactive claude session to investigate. See docs/cli.md.
What it does not do
- Send
repository_dispatchevents. It readsworkflow_dispatchtriggers only, so use gh-dispatch for the other kind - Dispatch from a script. The
exportcommands only read, so usegh workflow runin CI - Run Actions locally. That is what act is for
- Edit or create workflow files. It reads them and dispatches them
- Work outside a repository. It discovers workflows from the checkout you are standing in
Full docs: ./docs
License
MIT
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
branch-demo
command
Command branch-demo is a standalone harness for exercising the branch selector modal.
|
Command branch-demo is a standalone harness for exercising the branch selector modal. |
|
gh-lazydispatch
command
Command gh-lazydispatch is a TUI gh extension for dispatching and watching GitHub Actions workflows.
|
Command gh-lazydispatch is a TUI gh extension for dispatching and watching GitHub Actions workflows. |
|
internal
|
|
|
app
Package app implements the main Bubbletea application for the interactive workflow dispatcher TUI.
|
Package app implements the main Bubbletea application for the interactive workflow dispatcher TUI. |
|
browser
Package browser provides cross-platform browser opening functionality.
|
Package browser provides cross-platform browser opening functionality. |
|
chain
Package chain provides workflow chain execution and template interpolation.
|
Package chain provides workflow chain execution and template interpolation. |
|
cli
Package cli implements gh-lazydispatch's non-interactive commands.
|
Package cli implements gh-lazydispatch's non-interactive commands. |
|
config
Package config provides configuration file parsing and management for workflow dispatch chains.
|
Package config provides configuration file parsing and management for workflow dispatch chains. |
|
demo
Package demo provides demo mode functionality for branch selection workflows.
|
Package demo provides demo mode functionality for branch selection workflows. |
|
errors
Package chainerr defines custom error types for workflow chain execution and GitHub API operations.
|
Package chainerr defines custom error types for workflow chain execution and GitHub API operations. |
|
exec
Package exec provides command execution with mocking support for testing.
|
Package exec provides command execution with mocking support for testing. |
|
frecency
Package frecency provides frequency and recency-based scoring for workflow history.
|
Package frecency provides frequency and recency-based scoring for workflow history. |
|
git
Package git reads the refs a dispatch can target.
|
Package git reads the refs a dispatch can target. |
|
github
Package github provides a client for interacting with GitHub API operations.
|
Package github provides a client for interacting with GitHub API operations. |
|
logs
Package logs provides workflow run log fetching, caching, filtering, and streaming functionality.
|
Package logs provides workflow run log fetching, caching, filtering, and streaming functionality. |
|
rule
Package rule provides parsing and validation of workflow input validation rules.
|
Package rule provides parsing and validation of workflow input validation rules. |
|
runner
Package runner provides workflow execution functionality using the GitHub CLI.
|
Package runner provides workflow execution functionality using the GitHub CLI. |
|
testrepo
Package testrepo guards what a recording is allowed to capture.
|
Package testrepo guards what a recording is allowed to capture. |
|
testutil
Package testutil provides testing utilities, fixtures, and mocks for unit tests.
|
Package testutil provides testing utilities, fixtures, and mocks for unit tests. |
|
ui
Package ui provides shared UI styling and components for the TUI application.
|
Package ui provides shared UI styling and components for the TUI application. |
|
ui/modal
Package modal provides modal dialogs for user interactions in the TUI application.
|
Package modal provides modal dialogs for user interactions in the TUI application. |
|
ui/panes
Package panes provides the main UI panes for workflow, history, and configuration views.
|
Package panes provides the main UI panes for workflow, history, and configuration views. |
|
ui/timeline
Package timeline lays out a workflow run as bars on a shared time axis.
|
Package timeline lays out a workflow run as bars on a shared time axis. |
|
validation
Package validation provides input validation and history-based suggestions for workflow inputs.
|
Package validation provides input validation and history-based suggestions for workflow inputs. |
|
watcher
Package watcher provides workflow run monitoring and status tracking functionality.
|
Package watcher provides workflow run monitoring and status tracking functionality. |
|
workflow
Package workflow provides discovery and parsing of GitHub Actions workflow files.
|
Package workflow provides discovery and parsing of GitHub Actions workflow files. |