Froggit: A Modern, Minimalist Git TUI for Streamlined Workflow
Summary
Froggit is a modern, minimalist Git Terminal User Interface (TUI) designed to simplify your Git workflow. It offers visual feedback, keyboard-driven controls, and seamless integration with your terminal, enhancing clarity and speed for common Git operations. Built with Go, Froggit provides a fast and efficient way to manage your repositories across Windows, Linux, and macOS.
Repository Info
Introduction
Froggit is an innovative Terminal User Interface (TUI) for Git, crafted to provide a modern, minimalist, and highly efficient way to interact with your Git repositories. It aims to simplify complex Git operations by offering clear visual feedback and intuitive, keyboard-driven controls. Developed in Go, Froggit ensures high performance and cross-platform compatibility, running smoothly on Windows, Linux, and macOS. Whether you're staging changes, managing branches, or committing, Froggit streamlines your development process.
Installation
Getting started with Froggit is straightforward. You can use the quick install scripts or build it from source.
Quick Install
Linux / macOS:
curl -s https://raw.githubusercontent.com/thewizardshell/froggit/master/scripts/install.sh | bash
Windows (PowerShell):
iwr https://raw.githubusercontent.com/thewizardshell/froggit/master/scripts/install.ps1 -UseBasicParsing | iex
Build from Source
If you prefer to build Froggit yourself, ensure you have Go 1.20+ installed.
git clone https://github.com/thewizardshell/froggit.git
cd froggit
go mod tidy
go build
./froggit
Examples
Froggit is highly customizable and integrates with popular tools to enhance your Git experience.
Configuration
You can customize Froggit's behavior using a froggit.yml file. Here's a minimal example:
git:
defaultbranch: "master"
GitHub CLI Integration
Froggit seamlessly integrates with GitHub CLI to offer features like cloning repositories directly from GitHub. After authenticating with gh auth login, Froggit will automatically detect the CLI and enable these functionalities.
GitHub Copilot Integration
Leverage AI-powered commit messages with Froggit's GitHub Copilot integration. If you have an active Copilot subscription authenticated via VS Code, Neovim, or other supported editors, Froggit can generate commit messages for your staged changes. Simply stage your changes, enter the commit view, and press Tab to generate a message.
Key Shortcuts
Froggit is designed for keyboard efficiency. Here are a few essential shortcuts:
? / ?: Navigate filesSpace: Stage/unstage filesa: Stage all changesc: Commit changesb: View branchesq,Ctrl+C: QuitEsc: Go back
Why Use Froggit?
Froggit stands out as a powerful tool for several reasons:
- Streamlined Workflow: Its intuitive TUI design simplifies common Git tasks, reducing the need for complex command-line arguments.
- Visual Feedback: Get immediate visual cues on your repository's status, staged changes, and branch information.
- Keyboard-Driven Efficiency: Navigate and execute operations quickly with a comprehensive set of keyboard shortcuts, designed for speed.
- Modern and Minimalist: Enjoy a clean, uncluttered interface that focuses on essential information, enhancing clarity.
- Powerful Integrations: Benefit from seamless integration with GitHub CLI for repository management and GitHub Copilot for AI-assisted commit messages.
Links
- GitHub Repository: thewizardshell/froggit
- Installation Guide: Froggit Installation Guide
- Keyboard Shortcuts: Froggit Keyboard Shortcuts Documentation
- Official Documentation: Froggit Docs