gh-rivet

module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 10, 2026 License: MIT

README

Rivet

Rivet

A TUI for organizing and managing GitHub Actions workflows.

Go Version License


Demo

What is this?

A terminal UI for organizing GitHub Actions workflows into groups. Navigate workflows with vim keys, pin favorites, and avoid the messy default GitHub interface.

Wraps the GitHub CLI (gh) — uses your existing auth, no tokens needed.

Requirements

Installation

go install github.com/Cloudsky01/gh-rivet/cmd/rivet@latest

Or build from source:

git clone https://github.com/Cloudsky01/gh-rivet
cd gh-rivet
make build

Quick Start

1. Initialize inside your repo:

cd your-repo
rivet init  # Auto-detects repo, scans workflows, guides you through grouping

2. Run:

rivet  # Uses repository from .rivet.yaml

Update repo later:

rivet update-repo owner/repo

Configuration

rivet init creates a .rivet.yaml file. Commit it to share the structure with your team.

Example:

repository: owner/repo

groups:
  # Simple grouping
  - id: ci
    name: "CI/CD"
    workflows:
      - test.yml
      - build.yml

  # Nested grouping
  - id: services
    name: "Microservices"
    groups:
      - id: auth
        name: "Auth Service"
        workflows:
          - auth-test.yml
      - id: api
        name: "API Gateway"
        workflows:
          - api-deploy.yml

  # Custom display names & Pinning
  - id: infra
    name: "Infrastructure"
    workflowDefs:
      - file: terraform.yml
        name: "Terraform Apply (Prod)"
    pinnedWorkflows:
      - terraform.yml

FAQ

Does this require a GitHub Token? No. Uses your local gh CLI. If gh run list works, Rivet works.

Why is it slow? Fetches live data from GitHub on demand. No aggressive caching = always fresh status.

Works with GitHub Enterprise? Yes, if your gh CLI is authenticated to your instance.

License

MIT

Directories

Path Synopsis
cmd
rivet command
internal
git
tui
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL