A modern, intuitive Terminal User Interface (TUI) for Git
Simplify your Git workflow with visual feedback and keyboard-driven controls
Installation β’ Features β’ Usage β’ Shortcuts β’ Documentation
curl -s https://raw.githubusercontent.com/thewizardshell/froggit/master/scripts/install.sh | bash
iwr https://raw.githubusercontent.com/thewizardshell/froggit/master/scripts/install.ps1 -UseBasicParsing | iex
β These scripts will:
- Detect your OS and architecture
- Move it to a folder in your system PATH (e.g.
/usr/local/bin
orC:\tools\froggit
)
Once installed, run:
froggit
git clone https://github.com/thewizardshell/froggit.git
cd froggit
go mod tidy
go build -o froggit
sudo mv froggit /usr/local/bin/
-
π Visual File Management
- Stage/unstage files with visual feedback
- Bulk actions for multiple files
- Real-time status updates
-
πΏ Branch Operations
- Create and switch branches
- Delete branches safely
- Visual branch selection
-
π Git Operations
- Commit changes with message preview
- Push/pull with progress indicators
- Remote repository management
q
orCtrl+C
- QuitEsc
- Go back/cancel?
- Show help
β/β
- Navigate filesSpace
- Stage/unstage filea
- Stage all filesc
- Commit staged filesx
- Discard changes
b
- Enter branch viewn
- Create new branchd
- Delete branchEnter
- Switch to branch
p
- Push changesf
- Fetch updatesl
- Pull changesr
- Refresh status
Detailed documentation is available in the docs/ directory:
- Architecture Overview
- Development Guide
- Contributing Guidelines
- Git Commands Reference
- Keyboard Shortcuts
- Go - Performance and cross-platform support
- Bubbletea - Terminal UI framework
- Lipgloss - Style definitions
Froggit is built for simplicity, but there are many excellent Git tools worth exploring:
- LazyGit β Feature-rich Git TUI for power users.
- GitKraken β Visual Git client with a graphical interface.
- tig β Terminal-based Git history browser.
- Magit β Powerful Git interface for Emacs.
- Git Handbook β A clear and practical guide to mastering Git concepts.
Vicente Roa
GitHub: @thewizardshell
This project is licensed under the MIT License.