Froggit

Installation

Quick Install (Recommended)

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

git clone https://github.com/thewizardshell/froggit.git
cd froggit
go mod tidy
go build
./froggit

Configuration

Froggit can be customized using a froggit.yml configuration file. The configuration file should be placed in the same directory as the Froggit executable.

Creating Configuration File

Create a froggit.yml file next to your Froggit executable with the following structure:

ui:
  branding: true          # Show Froggit branding (default: true)
  position: "center"      # UI position: "left", "center", "right" (default: "left")

git:
  autofetch: true         # Automatically fetch from remote (default: true)
  defaultbranch: "main"   # Default branch for new repositories (default: "main")

Configuration Options

UI Settings (ui)

Option	Type	Default	Description
branding	boolean	true	Display Froggit branding and visual elements
position	string	"left"	UI positioning: "left", "center", or "right"

Git Settings (git)

Option	Type	Default	Description
autofetch	boolean	true	Automatically fetch from remote repositories on startup
defaultbranch	string	"main"	Default branch name for new repositories and push operations

Example Configurations

Minimal Configuration:

git:
  defaultbranch: "master"

Full Configuration:

ui:
  branding: false
  position: "center"
git:
  autofetch: false
  defaultbranch: "develop"

Note: If no configuration file is found, Froggit will use the default values shown above.

Requirements

• Git installed and accessible in your terminal
• Go 1.20+ (only required if building from source)
• A terminal with Nerd Fonts support
• GitHub CLI (gh) – optional, for GitHub integration

Feature Support

Git Operations

Feature	Status	Description
Stage all	🟢	Stage all changes
Branches	🟢	View and manage branches
Remotes	🟢	Manage remote repositories
Push	🟢	Push changes to remote
Fetch	🟢	Fetch from remote
Pull	🟢	Pull changes (when remote changes available)
Commit	🟢	Create commits
Discard changes	🟢	Discard uncommitted changes
Refresh	🟢	Refresh repository status
Advanced mode	🟢	Access to logs, merge, stash, rebase
Logs	🟢	View commit history
Merge	🟢	Merge branches
Stash	🟡	Stash changes
Rebase	🟢	Rebase branches

GitHub CLI Integration

Feature	Status	Description
Create repository	🟢	Create new GitHub repository
Clone repository	🟢	Clone from your GitHub repositories

GitHub Copilot Integration

Feature	Status	Description
AI commit messages	🟢	Generate commit messages with Copilot

🟢 Supported    🟡 In Development    🔴 Planned

GitHub Copilot Integration

Froggit can generate AI-powered commit messages using your existing GitHub Copilot subscription.

Requirements

You need to have GitHub Copilot authenticated through one of these:

• VS Code with GitHub Copilot extension
• copilot.vim or copilot.lua for Neovim
• Any editor that stores Copilot tokens in ~/.config/github-copilot/

Usage

1. Stage your changes
2. Press c to enter commit view
3. Press Tab to generate an AI commit message

Froggit automatically detects if Copilot is available and shows the option in the commit view.

Note: No additional API keys needed - Froggit uses your existing Copilot authentication.

GitHub CLI Integration

Froggit integrates seamlessly with GitHub CLI to enhance your workflow.

gh auth login

Once authenticated, Froggit will detect gh and enable features like cloning repositories directly from GitHub.

Key Shortcuts

File Management

• ↑ / ↓: Navigate files
• Space: Stage/unstage files
• a: Stage all changes
• x: Discard changes
• c: Commit changes

Branch Operations

• b: View branches
• n: Create new branch
• d: Delete branch
• Enter: Switch branch

Advanced Mode

• A: Enter advanced mode
• M: Merge (in advanced mode)
• R: Rebase (in advanced mode)

Global

• q, Ctrl+C: Quit
• Esc: Go back
• ?: Show help

For a complete list of shortcuts, see the keyboard shortcuts documentation.

Documentation

• Installation Guide
• Architecture Overview
• Development Guide
• Contributing Guidelines
• Keyboard Shortcuts

Related Tools

• LazyGit – Git TUI for power users
• tig – Terminal Git history browser
• Magit – Git for Emacs

Learn More About Git

• Git Handbook – A practical, visual Git reference

Contributing

We welcome contributions! Please see our Contributing Guidelines for details on how to get started.

Star History

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Vicente Roa
GitHub: @thewizardshell

---