CI-WORKFLOW TUI

A terminal-based UI to display project statuses from various sources like GitHub and Vercel. This tool provides a unified dashboard to monitor the status of all your projects in an elegant terminal interface.

Features

• Unified Dashboard: View the status of all your projects in a single terminal interface.
• GitHub Integration: Monitor workflow runs for the latest commit of any repository.
• Vercel Integration: Track deployment statuses for your Vercel projects.
• History Sparkline: Visual history of up to 40 past workflow runs rendered as color-coded blocks.
• Filtering: Quickly filter to show only projects with at least one failed status (x key).
• Manual Refresh: Reload data on demand with the r key.
• Auto-Poll: Data refreshes automatically every 60 seconds.
• Minimal View: A compact, denser layout showing one row per workflow run (--minimal flag).
• Debug Console: Toggle an embedded debug console (Ctrl+L).
• Extensible: A Service interface makes it straightforward to add new provider integrations.

Prerequisites

• GitHub CLI (gh) — must be installed and authenticated (gh auth login)
• Vercel CLI (vercel) — required only for Vercel monitoring; must be authenticated

Installation

npm install -g ci-workdlow

Configuration

Authentication is handled via the gh and vercel CLIs. There is no config file; all options are passed as CLI arguments.

GitHub

Authenticate with the GitHub CLI before running:

gh auth login

The application checks for GitHub authentication at startup and will exit with an error if gh is not authenticated.

Vercel

Authenticate with the Vercel CLI before running:

vercel login

You can also set the VERCEL_BEARER environment variable with a Vercel API token as an alternative.

Usage

ci-workflow --git owner/repo1 --git owner/repo2 --vercel project1 --vercel project2

CLI Arguments

| Argument | Description | |---|---| | --git <owner/repo> | GitHub repository to monitor, in owner/repo format. Can be repeated. | | --vercel <project> | Vercel project name to monitor. Can be repeated. | | --minimal | Start in the compact/minimal layout (one row per workflow run). |

Examples

# Monitor multiple GitHub repos and a Vercel project
ci-workflow --git facebook/react --git vercel/next.js --vercel my-app

# Monitor only Vercel projects in minimal mode
ci-workflow --vercel my-app --vercel my-other-app --minimal

# Monitor a single GitHub repo
ci-workflow --git owner/repo

Keyboard Shortcuts

| Key | Action | |---|---| | x | Toggle "show only failed" filter | | r | Manually refresh all data | | Ctrl+L | Toggle the debug console | | Ctrl+C | Exit the application |

Development

Prerequisites

• Bun runtime
• Node.js 23.2.0 (see .nvmrc)

Setup

bun install

Run in development mode (with file watching)

bun run dev

Build a compiled binary

bun run build

This compiles the project into a self-contained executable at ./dist/cli.

Built with OpenTUI.