Stefan HallerandGitHub
bf5829af3f
Lazygit assumes a repo can be found again from its working directory: it chdirs there and lets git rediscover the git dir from `<worktree>/.git`. That holds for an ordinary repo and breaks for every setup where the git dir lives somewhere else, which is where these bugs come from. Opening such a repo worked at all only when `--git-dir` happened to leave `GIT_DIR` in the environment for every command to inherit — which is also why entering a submodule, which has to clear it, broke the way back out. Three reported problems: - **`core.worktree` (#5895).** A repo whose work tree is elsewhere panicked on startup with `fatal: not a git repository`: we chdir'd into a work tree with no `.git` in it and every command after that was lost. We now work out at startup whether git can find the repo from its work tree, and when it can't we put `GIT_DIR`/`GIT_WORK_TREE` on every command the repo's command builder produces — as well as in the process environment, for subprocesses that don't come through the builder. Nothing is set for the repos git can find on its own, which is nearly all of them. - **Escaping a submodule of a dotfile repo (#1118).** The repo-path stack we push the superproject onto only held its path, and for a repo opened with `--git-dir`/`--work-tree` the path leads nowhere. Escaping failed with `not a git repository`, or, if some unrelated repo happened to lie above the work tree, quietly switched to that one instead. The stack now carries the environment as well, taken from the repo paths rather than from the process env, so it also covers a repo whose location lazygit worked out itself. - **Opening a directory that holds a bare repo (#5469, #5681).** `git rev-parse --show-toplevel` is fatal when there's no work tree, so we never got an answer at all for a bare repo: `IsBareRepo()` could never come out true, and lazygit either died with a stack trace or decided we weren't in a repository. We now ask again without `--show-toplevel` when the first query fails, and the existing "open most recent repo?" prompt does its job. Some related things that turned up on the way: - **A submodule no longer looks like a linked worktree.** `git worktree list` reports the main worktree as the common git dir with a trailing `/.git` removed, which is not the working tree when the git dir doesn't live inside it. Comparing that against the working tree path matched nothing, so inside a submodule the status bar claimed we were in a linked worktree named after the submodule, the worktrees panel listed it as not current, and its branch got a "checked out elsewhere" marker. Worktrees are now identified by their git dir, which names them unambiguously. - **Commands aimed at another repo no longer resolve against ours.** With `GIT_DIR` set, `git -C mysub log -1` reports the *superproject's* commit, silently. So opening lazygit with `--git-dir`/`--work-tree` quietly broke resolving submodule conflicts, stashing and resetting a submodule, and detaching another worktree. - **Starting lazygit in a repo's `.git` dir opens the repo.** It used to tell you that you were in a bare repo, which you weren't — the work tree was one directory up. git's own convention is that a git dir called `.git` belongs to the directory holding it, so we look there. (A linked worktree's or a submodule's git dir isn't called `.git`, and nothing we look at says where their work tree is, so those still get the prompt.) - **`RepoPath()`** is documented to be the work tree when we're in the main worktree, but was derived from the git dir's location, which is only the same thing when the git dir is inside the work tree. This fixes the repo name shown in the status panel for split setups. Fixes #1118 Fixes #5469 Fixes #5681 Fixes #5736 Fixes #5895
Available for macOS and Linux
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
- Sponsors
- Elevator Pitch
- Table of contents
- Features
- Tutorials
- Installation
- Binary Releases
- Dev container
- Homebrew
- MacPorts
- Void Linux
- Scoop (Windows)
- gah (Linux and Mac OS)
- Arch Linux
- Fedora / Amazon Linux 2023 / CentOS Stream
- Solus Linux
- Debian and Ubuntu
- Funtoo Linux
- Gentoo Linux
- openSUSE
- NixOS
- Flox
- FreeBSD
- Termux
- Conda
- Go
- Chocolatey (Windows)
- Winget (Windows 10 1709 or later)
- Manual
- Usage
- Configuration
- Contributing
- Donate
- FAQ
- Shameless Plug
- Alternatives
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
Features
Stage individual lines
Press space on the selected line to stage it, or press v to start selecting a range of lines. You can also press a to select the entirety of the current hunk.
Interactive Rebase
Press i to start an interactive rebase. Then squash (s), fixup (f), drop (d), edit (e), move up (ctrl+k) or move down (ctrl+j) any of the TODO commits, before continuing the rebase by bringing up the rebase options menu with m and then selecting continue.
You can also perform any of these actions as a once-off (e.g. pressing s on a commit to squash it) without explicitly starting a rebase.
This demo also uses shift+down to select a range of commits to move and fixup.
Cherry-pick
Press shift+c on a commit to copy it and press shift+v to paste (cherry-pick) it.
Bisect
Press b in the commits view to mark a commit as good/bad in order to begin a git bisect.
Nuke 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, press shift+d to bring up the reset options menu and then select the 'nuke' option.
Amend an old commit
Pressing shift+a on any commit will amend that commit with the currently staged changes (running an interactive rebase in the background).
Filter
You can filter a view with /. Here we filter down our branches view and then hit enter to view its commits.
Invoke a custom command
Lazygit has a very flexible custom command system. In this example a custom command is defined which emulates the built-in branch checkout action.
Worktrees
You can create worktrees to have multiple branches going at once without the need for stashing or creating WIP commits when switching between them. Press w in the branches view to create a worktree from the selected branch and switch to it.
Rebase magic (custom patches)
You can build a custom patch from an old commit and then remove the patch from the commit, split out a new commit, apply the patch in reverse to the index, and more.
In this example we have a redundant comment that we want to remove from an old commit. We hit <enter> on the commit to view its files, then <enter> on a file to focus the patch, then <space> to add the comment line to our custom patch, and then ctrl+p to view the custom patch options; selecting to remove the patch from the current commit.
Learn more in the Rebase magic Youtube tutorial.
Rebase from marked base commit
Say you're on a feature branch that was itself branched off of the develop branch, and you've decided you'd rather be branching off the master branch. You need a way to rebase only the commits from your feature branch. In this demo we check to see which was the last commit on the develop branch, then press shift+b to mark that commit as our base commit, then press r on the master branch to rebase onto it, only bringing across the commits from our feature branch. Then we push our changes with shift+p.
Undo
You can undo the last action by pressing z and redo with shift+z. Here we drop a couple of commits and then undo the actions.
Undo uses the reflog which is specific to commits and branches so we can't undo changes to the working tree or stash.
Commit graph
When viewing the commit graph in an enlarged window (use + and _ to cycle screen modes), the commit graph is shown. Colours correspond to the commit authors, and as you navigate down the graph, the parent commits of the selected commit are highlighted.
Compare two commits
If you press shift+w on a commit (or branch/ref) a menu will open that allows you to mark that commit so that any other commit you select will be diffed against it. Once you've selected the second commit, you'll see the diff in the main view and if you press <enter> you'll see the files of the diff. You can press shift+w to view the diff menu again to see options like reversing the diff direction or exiting diff mode. You can also exit diff mode by pressing <escape>.
Show GitHub pull requests
In the branches panel, lazygit can show which of your branches have an associated GitHub pull request by showing a GitHub icon next to the branch name; its color shows the state of the PR (open, merged, etc.). For those that have one, you can press shift-G to open the PR in the browser. There is no configuration needed to enable this for github.com, but it requires the gh tool to be installed, and you need to do gh auth login once to allow lazygit to access GitHub. For GitHub Enterprise, also run gh auth login --hostname <webDomain> and add a services entry for the host with the github provider.
Tutorials
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.
Dev container feature
If you want to use lazygit in e.g. one of your GitHub Codespaces, there is a third-party dev container feature based on the binary releases mentioned above.
Homebrew
It works with Linux, too.
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
gah (Linux and Mac OS)
You can install lazygit using gah:
gah 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 / Amazon Linux 2023 / CentOS Stream
Packages for Fedora, Amazon Linux 2023 and CentOS Stream are available via Copr (Cool Other Package Repo).
sudo dnf copr enable dejan/lazygit
sudo dnf install lazygit
These packages are built using the RPM spec file located here: https://codeberg.org/dejan/rpm-lazygit
You should be able to build RPMs for Fedora 41 or older, and other Fedora derivatives using the SRPM (Source RPM) file that you can grab from the latest COPR build.
Fedora / RHEL Derivatives (Terra)
Packages for Fedora and RHEL derivatives are also available from the Terra Repository.
sudo dnf install --nogpgcheck --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' terra-release
sudo dnf install lazygit
(Install guide for Atomic/EL can be found on their README)
Terra also has lazygit-doc, which contains the contents of the docs folder.
Solus Linux
sudo eopkg install lazygit
Debian and Ubuntu
For Debian 13 "Trixie", Sid, and later, or Ubuntu 25.10 "Questing Quokka" and later:
sudo apt install lazygit
For Debian 12 "Bookworm", Ubuntu 25.04 "Plucky Puffin" and earlier:
LAZYGIT_VERSION=$(curl -s "https://api.github.com/repos/jesseduffield/lazygit/releases/latest" | \grep -Po '"tag_name": *"v\K[^"]*')
LAZYGIT_ARCH=$(uname -m | sed -e 's/aarch64/arm64/')
curl -Lo lazygit.tar.gz "https://github.com/jesseduffield/lazygit/releases/download/v${LAZYGIT_VERSION}/lazygit_${LAZYGIT_VERSION}_Linux_${LAZYGIT_ARCH}.tar.gz"
tar xf lazygit.tar.gz lazygit
sudo install lazygit -D -t /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 GURU overlay
You can either add the overlay to your system and install lazygit as usual:
sudo eselect repository enable guru
sudo emaint sync -r guru
sudo emerge dev-vcs/lazygit
openSUSE
The lazygit package is currently built in devel:languages:go/lazygit.
To install lazygit on openSUSE Tumbleweed run:
sudo zypper ar https://download.opensuse.org/repositories/devel:/languages:/go/openSUSE_Factory/devel:languages:go.repo
sudo zypper ref && sudo zypper in lazygit
To install lazygit on openSUSE Leap run:
source /etc/os-release
sudo zypper ar https://download.opensuse.org/repositories/devel:/languages:/go/$VERSION_ID/devel:languages:go.repo
sudo zypper ref && sudo zypper in lazygit
NixOS
Using lazygit from nixpkgs
On NixOS, lazygit is packaged with nix and distributed via nixpkgs. You can try lazygit without installing it with:
nix-shell -p lazygit
# or with flakes enabled
nix run nixpkgs#lazygit
Or you can add lazygit to your configuration.nix using the environment.systemPackages option.
More details can be found via NixOS search page.
Using the official lazygit flake
This repository includes a nix flake that provides the latest development version and additional development tools:
Run lazygit directly from the repository:
nix run github:jesseduffield/lazygit
# or from a local clone
nix run .
Build lazygit from source:
nix build github:jesseduffield/lazygit
# or from a local clone
nix build .
Development environment: For contributors, the flake provides a development shell with Go toolchain, development tools, and dependencies:
nix develop github:jesseduffield/lazygit
# or from a local clone
nix develop
The development shell includes:
- Go toolchain
- git and make
- Proper environment variables for development
Using in other flakes: The flake also provides an overlay for easy integration into other flake-based projects:
{
inputs.lazygit.url = "github:jesseduffield/lazygit";
outputs = { self, nixpkgs, lazygit }: {
# Use the overlay
nixpkgs.overlays = [ lazygit.overlays.default ];
};
}
Flox
Lazygit can be installed into a Flox environment as follows.
flox install lazygit
More details about Flox can be found on their website.
FreeBSD
pkg install lazygit
Termux
apt 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
Winget (Windows 10 1709 or later)
You can install lazygit using the winget command in the Windows Terminal with the following command:
winget install -e --id=JesseDuffield.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 Diff Renderers
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
Git flow support
Lazygit supports Gitflow (or git-flow-next) if you have it installed. To understand how the Gitflow model works check out Vincent Driessen's original post explaining it. To view Gitflow options from within Lazygit, press i from within the branches view.
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: