GitHub Actions Manager (GAMA)

GAMA is a powerful terminal-based user interface tool designed to streamline the management of GitHub Actions workflows. It allows developers to list, trigger, and manage workflows with ease directly from the terminal.

Table of Contents

• Key Features
• Live Mode
• Getting Started
  • Prerequisites
  • Configuration
• Build & Installation
• Contributing
• License
• Contact & Author

Key Features

• Extended Workflow Inputs: Supports more than 10 workflow inputs using JSON format.
• Workflow History: Conveniently list all historical runs of workflows in a repository.
• Discoverability: Easily list all triggerable (dispatchable) workflows in a repository.
• Workflow Management: Trigger specific workflows with custom inputs.
• Live Updates: Automatically refresh workflow status at configurable intervals.
• Docker Support: Run directly from a container for easy deployment.

Live Mode

GAMA includes a live mode feature that automatically refreshes the workflow status at regular intervals:

• Toggle Live Updates: Press ctrl+l to turn live mode on/off
• Auto-start: Set settings.live_mode.enabled: true to start GAMA with live mode enabled
• Refresh Interval: Configure how often the view updates with settings.live_mode.interval (e.g., "15s", "1m")

Live mode is particularly useful when monitoring ongoing workflow runs, as it eliminates the need for manual refreshing.

Getting Started

Prerequisites

Before using GAMA, you need to generate a GitHub token. Follow these instructions to create your token.

Configuration

YAML Configuration

Place a ~/.config/gama/config.yaml file in your home directory with the following content:

github:
  token: <your github token>

keys:
  switch_tab_right: shift+right
  switch_tab_left: shift+left
  quit: ctrl+c
  refresh: ctrl+r
  live_mode: ctrl+l  # Toggle live mode on/off
  enter: enter
  tab: tab

settings:
  live_mode:
    enabled: true    # Enable live mode at startup
    interval: 15s    # Refresh interval for live updates

Environment Variable Configuration

Alternatively, you can use an environment variable:

GITHUB_TOKEN="<your github token>" gama

You can also make it an alias for a better experience:

alias gama='GITHUB_TOKEN="<your github token>" command gama'

If you have the GitHub CLI installed, you automatically insert the var via:

GITHUB_TOKEN="$(gh auth token)" gama

This will skip needing to generate a token via the GitHub website.

[!WARNING] For security reasons, you should not export your token globally in your shell. That would make it available to any app that can read environment variables. You should avoid committing it to your dotfiles repository, too.

Build & Installation

Using Docker

Run GAMA in a Docker container:

docker run --rm -it --env GITHUB_TOKEN="<your github token>" termkit/gama:latest

Download Binary

Download the latest binary from the releases page.

Build from Source

make build
# output: ./release/gama

---

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the GNU GENERAL PUBLIC LICENSE Version 3 or later. See LICENSE for more information.

Contact & Author

Engin Açıkgöz

Stargazers over time