gh-rivet

module
v0.1.0 Latest Latest
Warning

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

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

README

Rivet

Rivet

A TUI for organizing and managing GitHub Actions workflows.

Go Version License


What is this?

If you work in a repository with dozens of workflows, the default GitHub UI and gh run list are messy.

Rivet wraps the GitHub CLI (gh) to provide a structured, hierarchical view of your actions. It lets you group workflows (e.g., by Team or Environment) and navigate them quickly without leaving your terminal.

Why use it?

  • Organize the noise: Turn a flat list of 50+ YAML files into structured folders.
  • No new auth: It uses your existing gh CLI credentials. No tokens to manage.
  • Pinning: Keep your most frequently used workflows at the top.
  • Vim keys: Navigate j/k without reaching for the mouse.

Requirements

Installation

Go Install
go install github.com/Cloudsky01/rivet/cmd/rivet@latest
From Source
git clone https://github.com/Cloudsky01/rivet
cd rivet
make build

Usage

Initialize config
# Run inside your repository
rivet init
Run
rivet -r owner/repo

Configuration

Rivet looks for a .rivet.yaml file in the directory where you run it. You should commit this file to your repository so your team shares the same structure.

Example .rivet.yaml:
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. It shells out to your local gh executable. If you can run gh run list in your terminal, Rivet works.

Why is it slow?

Rivet fetches data from GitHub on demand. It does not cache aggressively to ensure you see the latest run status. If the GitHub API is slow, the TUI will wait.

Does it work with GitHub Enterprise?

Yes, as long as your gh CLI is authenticated against your Enterprise instance.

License

MIT

Directories

Path Synopsis
cmd
rivet command
internal
tui
pkg

Jump to

Keyboard shortcuts

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