Awesome

A simple terminal UI for git commands <br/>

Sponsors

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
  • 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
  • Homebrew
  • MacPorts
  • Void Linux
  • Scoop (Windows)
  • Arch Linux
  • Fedora and RHEL
  • Solus Linux
  • Ubuntu
  • Funtoo Linux
  • Gentoo Linux
  • 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 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+i) or move down (ctrl+j) any of TODO commits, before continuing the rebase by bringing up the rebase options menu with m and then selecting continue.

You can also perform any 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 ctrl+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

Commit graph

When viewing the commit graph in an enlarged window (use + and _ to cycle window sizes), 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>.

Tutorials

<img src="https://i.imgur.com/sVEktDn.png">

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

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/download/v${LAZYGIT_VERSION}/lazygit_${LAZYGIT_VERSION}_Linux_x86_64.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

On NixOs lazygit is packaged with nix and distributed via nixpkgs. You can try the lazygit without installing it with:

nix-shell -p lazygit
# or with flakes enabled
nix run nixpkgs#lazygit

Or you can add lazygit to you configuration.nix in the environment.systemPackages section. More details can be found via NixOs search page.

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

Git flow support

Lazygit supports Gitflow 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

<a href="https://discord.gg/ehwFt2t4wt"><img src='../assets/discord.png' width='75'></a>

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:

• GitUI
• tig