Repository files navigation

^{Special thanks to:}

Warp, the intelligent terminal
Available for MacOS and Linux

^{Visit warp.dev to learn more.}

---

Tuple, the premier screen sharing app for developers on macOS and Windows.

---

I (Jesse) co-founded Subble to save your company time and money by finding unused and over-provisioned SaaS licences. Check it out!

---

Maintenance of this project is made possible by all thecontributors andsponsors. If you'd like to sponsor this project and have your avatar or company logo appear belowclick here. 💙

Rant time: You've heard it before, git ispowerful, 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 fileby 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.

• Sponsors
• Elevator Pitch
• Table of contents
• Features
  • Stage individual lines
  • Interactive Rebase
  • Cherry-pick
  • Bisect
  • Nuke the working tree
  • Amend an old commit
  • Filter
  • Invoke a custom command
  • Worktrees
  • Rebase magic (custom patches)
  • Rebase from marked base commit
  • Undo
  • Commit graph
  • Compare two commits
• 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
  • Keybindings
  • Changing Directory On Exit
  • Undo/Redo
• Configuration
  • Custom Pagers
  • Custom Commands
  • Git flow support
• Contributing
  • Debugging Locally
• Donate
• FAQ
  • What do the commit colors represent?
• 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 considersponsoring me

Press space on the selected line to stage it, or pressv to start selecting a range of lines. You can also pressa to select the entirety of the current hunk.

Pressi 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 TODO commits, before continuing the rebase by bringing up the rebase options menu withm and then selectingcontinue.

You can also perform any these actions as a once-off (e.g. pressings 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.

Pressshift+c on a commit to copy it and pressshift+v to paste (cherry-pick) it.

Pressb in the commits view to mark a commit as good/bad in order to begin a git bisect.

For when you really want to just get rid of anything that shows up when you rungit status (and yes that includes dirty submodules)kidpix style, pressshift+d to bring up the reset options menu and then select the 'nuke' option.

Pressingshift+a on any commit will amend that commit with the currently staged changes (running an interactive rebase in the background).

You can filter a view with/. Here we filter down our branches view and then hitenter to view its commits.

Lazygit has a very flexiblecustom command system. In this example a custom command is defined which emulates the built-in branch checkout action.

You can create worktrees to have multiple branches going at once without the need for stashing or creating WIP commits when switching between them. Pressw in the branches view to create a worktree from the selected branch and switch to it.

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 thenctrl+p to view the custom patch options; selecting to remove the patch from the current commit.

Learn more in theRebase magic Youtube tutorial.

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 pressshift+b to mark that commit as our base commit, then pressr on the master branch to rebase onto it, only bringing across the commits from our feature branch. Then we push our changes withshift+p.

You can undo the last action by pressingz and redo withctrl+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.

More info

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.

If you pressshift+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 pressshift+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>.

• 15 Lazygit Features in 15 Minutes
• Basics Tutorial
• Rebase Magic Tutorial

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

For Windows, Mac OS(10.12+) or Linux, you can download a binary releasehere.

If you want to use lazygit in e.g. one of your GitHub Codespaces, there is a third-partydev container feature based on the binary releases mentioned above.

It works with Linux, too.

brew install lazygit

Latest version built from github releases.Tap:

sudo port install lazygit

Packages for Void Linux are available in the distro repo

They follow upstream latest releases

sudo xbps-install -S lazygit

You can installlazygit usingscoop. It's in theextras bucket:

# Add the extras bucketscoop bucket add extras# Install lazygitscoop install lazygit

You can installlazygit usinggah:

gah install lazygit

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 releaseand 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

Packages for Fedora, Amazon Linux 2023 and CentOS Stream are available viaCopr (Cool Other Package Repo).

sudo dnf coprenable dejan/lazygitsudo 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 theSRPM (Source RPM) file that you can grab from the latest COPR build.

sudo eopkg install lazygit

ForDebian 13 "Trixie", Sid, and later, orUbuntu 25.10 "Questing Quokka" and later:

sudo apt install lazygit

ForDebian 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[^"]*')curl -Lo lazygit.tar.gz"https://github.com/jesseduffield/lazygit/releases/download/v${LAZYGIT_VERSION}/lazygit_${LAZYGIT_VERSION}_Linux_x86_64.tar.gz"tar xf lazygit.tar.gz lazygitsudo install lazygit -D -t /usr/local/bin/

Verify the correct installation of lazygit:

lazygit --version

Funtoo Linux has an autogenerated lazygit package indev-kit:

sudo emerge dev-vcs/lazygit

Lazygit is not (yet) in main Gentoo portage, however an ebuild is available inGURU overlay

You can either add the overlay to your system and install lazygit as usual:

sudo eselect repositoryenable gurusudo emaint sync -r gurusudo emerge dev-vcs/lazygit

The lazygit package is currently built indevel: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.reposudo zypper ref&& sudo zypperin lazygit

To install lazygit on openSUSE Leap run:

source /etc/os-releasesudo zypper ar https://download.opensuse.org/repositories/devel:/languages:/go/$VERSION_ID/devel:languages:go.reposudo zypper ref&& sudo zypperin lazygit

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 enablednix run nixpkgs#lazygit

Or you can add lazygit to yourconfiguration.nix using theenvironment.systemPackages option.More details can be found via NixOS searchpage.

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 clonenix run.

Build lazygit from source:

nix build github:jesseduffield/lazygit# or from a local clonenix 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 clonenix 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 overlaynixpkgs.overlays=[lazygit.overlays.default];};}

Lazygit can be installed into a Flox environment as follows.

flox install lazygit

More details about Flox can be found ontheir website.

pkg install lazygit

apt install lazygit

Released versions are available for different platforms, seehttps://anaconda.org/conda-forge/lazygit

conda install -c conda-forge lazygit

go install github.com/jesseduffield/lazygit@latest

Please note:If you get an error claiming that lazygit cannot be found or is not defined, youmay need to add~/go/bin to your $PATH (MacOS/Linux), or%HOME%\go\bin(Windows). Not to be mistaken forC:\Go\bin (which is for Go's own binaries,not apps like lazygit).

You can installlazygit usingChocolatey:

choco install lazygit

You can installlazygit using thewinget command in the Windows Terminal with the following command:

winget install-e--id=JesseDuffield.lazygit

You'll need toinstall Go

git clone https://github.com/jesseduffield/lazygit.gitcd lazygitgo install

You can also usego run main.go to compile and run in one go (pun definitely intended)

Calllazygit in your terminal inside a git repository.

$ lazygit

If you want, you canalso add an alias for this withecho "alias lg='lazygit'" >> ~/.zshrc (orwhichever rc file you're using).

You can check out the list of keybindingshere.

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}

Thensource ~/.zshrc and from now on when you calllg and exit you'll switch directories to whatever you were in inside lazygit. To override this behaviour you can exit usingshift+Q rather than justq.

See thedocs

Check out theconfiguration docs.

See thedocs

If lazygit is missing a feature, there's a good chance you can implement it yourself with a custom command!

See thedocs

Lazygit supportsGitflow if you have it installed. To understand how the Gitflow model works check out Vincent Driessen's originalpost explaining it. To view Gitflow options from within Lazygit, pressi from within the branches view.

We love your input! Please check out thecontributing guide.For contributor discussion about things not better discussed here in the repo, join thediscord channel

Check out thisvideo walking through the creation of a small feature in lazygit if you want an idea of where to get started.

Runlazygit --debug in one terminal tab andlazygit --logs in another to view the program and its log output side by side

If you would like to support the development of lazygit, considersponsoring me (github is matching all donations dollar-for-dollar for 12 months)

• 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

If you want to see what I (Jesse) am up to in terms of development, follow me ontwitter or check out myblog

If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit:

• GitUI
• tig
• GitArbor TUI