|
|
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| .vscode | ||
| cmd/integration_test | ||
| demo | ||
| docs | ||
| pkg | ||
| scripts | ||
| test | ||
| vendor | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| CODE-OF-CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| README.md | ||
A simple terminal UI for git commands
Sponsors
Maintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below click here. 💙
Elevator Pitch
Rant time: You've heard it before, git is powerful, but what good is that power when everything is so damn hard to do? Interactive rebasing requires you to edit a goddamn TODO file in your editor? Are you kidding me? To stage part of a file you need to use a command line program to step through each hunk and if a hunk can't be split down any further but contains code you don't want to stage, you have to edit an arcane patch file by hand? Are you KIDDING me?! Sometimes you get asked to stash your changes when switching branches only to realise that after you switch and unstash that there weren't even any conflicts and it would have been fine to just checkout the branch directly? YOU HAVE GOT TO BE KIDDING ME!
If you're a mere mortal like me and you're tired of hearing how powerful git is when in your daily life it's a powerful pain in your ass, lazygit might be for you.
Table of contents
Lazygit is not my fulltime job but it is a hefty part time job so if you want to support the project please consider sponsoring me
Installation
Most of the above packages are maintained by third parties so be sure to vet them yourself and confirm that the maintainer is a trustworthy looking person who attends local sports games and gives back to their communities with barbeque fundraisers etc
Binary Releases
For Windows, Mac OS(10.12+) or Linux, you can download a binary release here.
Homebrew
Normally the lazygit formula can be found in the Homebrew core but we suggest you tap our formula to get the frequently updated one. It works with Linux, too.
Tap:
brew install jesseduffield/lazygit/lazygit
Core:
brew install lazygit
MacPorts
Latest version built from github releases. Tap:
sudo port install lazygit
Void Linux
Packages for Void Linux are available in the distro repo
They follow upstream latest releases
sudo xbps-install -S lazygit
Scoop (Windows)
You can install lazygit using scoop. It's in the extras bucket:
# Add the extras bucket
scoop bucket add extras
# Install lazygit
scoop install lazygit
Arch Linux
Packages for Arch Linux are available via pacman and AUR (Arch User Repository).
There are two packages. The stable one which is built with the latest release and the git version which builds from the most recent commit.
- Stable:
sudo pacman -S lazygit - Development: https://aur.archlinux.org/packages/lazygit-git/
Instruction of how to install AUR content can be found here: https://wiki.archlinux.org/index.php/Arch_User_Repository
Fedora and RHEL
Packages for Fedora/RHEL and CentOS Stream are available via Copr (Cool Other Package Repo).
sudo dnf copr enable atim/lazygit -y
sudo dnf install lazygit
Solus Linux
sudo eopkg install lazygit
Ubuntu
LAZYGIT_VERSION=$(curl -s "https://api.github.com/repos/jesseduffield/lazygit/releases/latest" | grep -Po '"tag_name": "v\K[^"]*')
curl -Lo lazygit.tar.gz "https://github.com/jesseduffield/lazygit/releases/latest/download/lazygit_${LAZYGIT_VERSION}_Linux_x86_64.tar.gz"
tar xf lazygit.tar.gz lazygit
sudo install lazygit /usr/local/bin
Verify the correct installation of lazygit:
lazygit --version
Funtoo Linux
Funtoo Linux has an autogenerated lazygit package in dev-kit:
sudo emerge dev-vcs/lazygit
Gentoo Linux
Lazygit is not (yet) in main Gentoo portage, however an ebuild is available in cova overlay
You can either add the overlay to your system and install lazygit as usual:
sudo eselect repository enable cova
sudo emaint sync -r cova
sudo emerge dev-vcs/lazygit
Or you can download the ebuild and install it manually; please consider the example below just as a suggestion to be adapted to your system.
su
LAZYGIT_VERSION="0.39.3" # Replace with the version you want from cova-overlay
cd /usr/overlay/dev-vcs/ # Replace your overlay path
mkdir lazygit
cd lazygit
curl -O https://raw.githubusercontent.com/cova-fe/cova-overlay/main/dev-vcs/lazygit/lazygit-${LAZYGIT_VERSION}.ebuild
ebuild lazygit-${LAZYGIT_VERSION}.ebuild manifest
emerge lazygit
FreeBSD
pkg install lazygit
Conda
Released versions are available for different platforms, see https://anaconda.org/conda-forge/lazygit
conda install -c conda-forge lazygit
Go
go install github.com/jesseduffield/lazygit@latest
Please note:
If you get an error claiming that lazygit cannot be found or is not defined, you
may need to add ~/go/bin to your $PATH (MacOS/Linux), or %HOME%\go\bin
(Windows). Not to be mistaken for C:\Go\bin (which is for Go's own binaries,
not apps like lazygit).
Chocolatey (Windows)
You can install lazygit using Chocolatey:
choco install lazygit
Manual
You'll need to install Go
git clone https://github.com/jesseduffield/lazygit.git
cd lazygit
go install
You can also use go run main.go to compile and run in one go (pun definitely intended)
Usage
Call lazygit in your terminal inside a git repository.
$ lazygit
If you want, you can
also add an alias for this with echo "alias lg='lazygit'" >> ~/.zshrc (or
whichever rc file you're using).
Keybindings
You can check out the list of keybindings here.
Changing Directory On Exit
If you change repos in lazygit and want your shell to change directory into that repo on exiting lazygit, add this to your ~/.zshrc (or other rc file):
lg()
{
export LAZYGIT_NEW_DIR_FILE=~/.lazygit/newdir
lazygit "$@"
if [ -f $LAZYGIT_NEW_DIR_FILE ]; then
cd "$(cat $LAZYGIT_NEW_DIR_FILE)"
rm -f $LAZYGIT_NEW_DIR_FILE > /dev/null
fi
}
Then source ~/.zshrc and from now on when you call lg and exit you'll switch directories to whatever you were in inside lazygit. To override this behaviour you can exit using shift+Q rather than just q.
Undo/Redo
See the docs
Configuration
Check out the configuration docs.
Custom Pagers
See the docs
Custom Commands
If lazygit is missing a feature, there's a good chance you can implement it yourself with a custom command!
See the docs
Tutorials
Cool features
- Add files easily
- Resolve merge conflicts
- Fuzzy searching
- Git bisect
- Amend old commits
- Slice, dice, squash, and rearrange commits
- Submodules support
- diff branches easily
- Cherry-pick commits like it's copy+paste
Git Bisect
Cherry-pick
Interactive Rebase
Nuking the working tree
For when you really want to just get rid of anything that shows up when you run git status (and yes that includes dirty submodules) kidpix style
Amend old commit
Contributing
We love your input! Please check out the contributing guide. For contributor discussion about things not better discussed here in the repo, join the discord channel
Check out this video walking through the creation of a small feature in lazygit if you want an idea of where to get started.
Debugging Locally
Run lazygit --debug in one terminal tab and lazygit --logs in another to view the program and its log output side by side
Donate
If you would like to support the development of lazygit, consider sponsoring me (github is matching all donations dollar-for-dollar for 12 months)
FAQ
What do the commit colors represent?
- Green: the commit is included in the master branch
- Yellow: the commit is not included in the master branch
- Red: the commit has not been pushed to the upstream branch
Shameless Plug
If you want to see what I (Jesse) am up to in terms of development, follow me on twitter or check out my blog
Alternatives
If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit: