octotui 0.1.11

A blazing-fast TUI replacement for GitKraken - manage your Git repos with style!

🐙 OctoTUI

A Textual TUI For GitKraken Lovers

Installation • AI Commits • Keybindings

---

🚀 OctoTUI

We love GitKraken so much, we wanted to bring that beautiful experience to the terminal!

GitKraken is amazing - it's gorgeous, intuitive, and makes Git feel approachable. But as terminal enthusiasts, we found ourselves constantly context-switching between our editor and GitKraken. We wanted that same delightful experience without ever leaving the command line.

OctoTUI is our love letter to both GitKraken and the terminal.

💙 What We Kept from GitKraken

• ✅ Beautiful, intuitive visual diffs
• ✅ Hunk-level staging control
• ✅ Branch visualization and management
• ✅ Commit history browsing

🎯 What We Added for Terminal Lovers

• 🤖 AI-powered commit messages (via GAC)
• 🆓 100% free and open source
• 🏠 Never leave your terminal flow

---

📸 Screenshots

Status Tab

See your repository status at a glance: current branch, remote tracking, sync status (ahead/behind), and working tree changes. Manage branches and remote operations all in one place.

Files Tab

Browse your entire repository with a familiar tree view. Press e to open any file in your configured editor.

Unstaged Changes

Review your unstaged changes with beautiful syntax-highlighted diffs. Stage or discard individual hunks with a single click.

Staged Changes

See exactly what's going into your next commit. Unstage hunks if you change your mind.

Commit Tab

Write your commit message with a subject and body. Or let AI generate it for you with the Generate with GAC button!

Settings Tab

Configure your editor, theme, and AI provider for commit message generation. Supports 30+ AI providers including OpenAI, Anthropic, Ollama, and more.

---

📦 Installation

Quick Start (Recommended)

# Using uvx (isolated, recommended)
uvx octotui

From Source (For Contributors)

git clone https://github.com/never-use-gui/octotui.git
cd octotui
uv run octotui

System Requirements

• 🐍 Python 3.11+
• 🔧 Git
• 💻 Any terminal with 256+ colors

First-Time Workflow

1. Review Changes: See your diffs in beautiful color
2. Stage Hunks: Click or use s to stage individual changes
3. Generate Commit: Press g for AI-powered message (optional)
4. Commit: Press c to commit with your message
5. Push: Press p to push to remote

Pro tip: Press h anytime to see all available keybindings! 🚀

🤖 AI-Powered Commits

Setup (Optional but Awesome)

# Install GAC (Git Auto Commit)
uv pip install 'gac>=0.18.0'

Configuration

1. Press Ctrl+G in OctoTUI
2. Choose your provider (we recommend Cerebras for free tier)
3. Select your model
4. Paste your API key
5. Save & enjoy AI commit messages!

⌨️ Keybindings

📁 Navigation

Key	Action
↑/↓	Navigate files/hunks
←/→	Navigate between files
Enter	Select file
Tab	Cycle through buttons
e	Edit file in external editor

📑 View Switching (1-8)

Key	Tab
1	Status
2	Files
3	Unstaged
4	Staged
5	Commit
6	Graph
7	History
8	Settings

🔄 Git Operations

Key	Action
s	Stage selected file
u	Unstage selected file
a	Stage ALL unstaged changes
x	Unstage ALL staged changes
c	Commit staged changes

🌿 Branch & Remote

Key	Action
b	Switch branch
r	Refresh status
p	Push to remote
o	Pull from remote

🤖 AI Features

Key	Action
g	Generate AI commit message
Ctrl+G	Configure GAC settings

⚙️ Application

Key	Action
h	Show help modal
q	Quit application
Ctrl+D	Toggle dark mode

🎨 Git Status Colors

Color	Meaning
🟢 Green	Staged files (ready to commit)
🟡 Yellow	Modified files (unstaged)
🔵 Blue	Directories
🟣 Purple	Untracked files
🔴 Red	Deleted files

Code Quality Standards

• ✅ Follow the Zen of Python
• ✅ DRY (Don't Repeat Yourself)
• ✅ YAGNI (You Aren't Gonna Need It)
• ✅ SOLID principles
• ✅ Keep files under 600 lines
• ✅ Write tests for new features
• ✅ Pass ruff check with zero errors

📚 Tech Stack

• Textual: Modern TUI framework
• GitPython: Git operations
• GAC: AI commit generation
• Ruff: Lightning-fast Python linter

📜 License

MIT License - see LICENSE for details

🙏 Acknowledgments

• Built with ❤️ using Textual
• AI commits powered by GAC

💬 Community

• 🐛 Issues: GitHub Issues

---

🌟 If you like OctoTUI, give us a star! 🌟

⬆ Back to Top