AI-Powered GitHub Workflow TUI Assistant
A fast, keyboard-driven Terminal User Interface (TUI) tool written in Go to automate your Git and GitHub workflows with integrated offline and cloud AI generation.
|
Seamless navigation with arrow keys and shortcut keys. No complex command syntax to memorize. |
Generate highly descriptive conventional commits, PR titles, and descriptions dynamically from actual diff statistics. |
|
Supports both local/offline providers (Ollama, LM Studio, MLX) and cloud providers (OpenAI, Claude). |
Resolve and toggle PR target repositories (e.g., origin fork vs upstream parent) and configure missing remotes right in the TUI. |
- GitHub CLI (gh) installed and authenticated
curl -sSfL https://raw.githubusercontent.com/KDM-cli/ghx/main/install.sh | shbrew tap KDM-cli/tap
brew install ghxcurl -sSfL https://raw.githubusercontent.com/KDM-cli/ghx/main/install.sh | shbrew tap KDM-cli/tap
brew install ghxRun the following command in PowerShell:
irm https://raw.githubusercontent.com/KDM-cli/ghx/main/install.ps1 | iexRun the following command in your terminal:
curl -sSfL https://raw.githubusercontent.com/KDM-cli/ghx/main/install.sh | shIf you have Go 1.21 or higher installed:
go install github.com/KDM-cli/ghx@latest# Clone the repository
git clone https://github.com/KDM-cli/ghx.git
cd ghx
# Build the binary
go build -o ghx .(Alternatively, you can manually download the correct archive for your platform from the GitHub Releases page).
We recommend running Ollama locally for a private, zero-latency offline workflow.
# Install and start Ollama, then pull llama3
ollama pull llama3- Launch
./ghx. - Navigate to Settings and select your preferred active AI provider.
- Configure API Keys (for cloud providers) or choose custom models inline by pressing m.
Navigation & General controls
| Key | Description |
|---|---|
| ↑ / ↓ or k / j | Navigate options / scroll lists |
| Tab / Shift+Tab | Focus next / previous section or step |
| Enter | Select menu option or confirm step |
| Esc or b | Go back to previous screen or step |
| q | Quit application (from Home Screen) |
| ? | Toggle Help view |
Contextual Actions
| Key | Context | Description |
|---|---|---|
| Space | Commit Stage list | Toggle staged state of selected file |
| a / n | Commit Stage list | Stage all files / unstage all files |
| g | Commit / PR screens | Generate suggestions using the configured AI model |
| t | PR review | Toggle target repository (e.g. upstream <-> origin) |
| u | PR review | Set/add a new upstream remote repository |
| d | PR review | Toggle Draft state of the pull request |
| 1 - 3 | Commit AI suggestions | Select the corresponding AI suggestion |
| r | Commit AI suggestions | Regenerate AI suggestions |
Distributed under the MIT License. See LICENSE for more information.