Skip to content

douglance/lazygit

 
 

Repository files navigation

A simple terminal UI for git commands

GitHub Releases Go Report Card Codacy Badge Codacy Badge GolangCI GitHub tag homebrew

commit_and_push

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

Mark LussierDean HerbertPeter BjorklundReilly WoodOliver GüntherPawan DhananjayBartłomiej DachCarsten GehlingCEUKHolden LucasChau TranmatejciktheAverageDev (Luca Tumedei)Nicholas CloudAliaksandr StelmachonakBurgy BenjaminJoe KlemmerTobias LütkeBen BeaumontHollyCasey BoettcherJeff ForcierMaciej T. NowakAndreas KurthBraden SteffaniakJordan GillardSebastianGeorge SpanosAndy SlezakMartin KockJesse AlamaDaniel KokottJan HeijmansKevin NowaldOmar LuqEthan LiMaxiJan ZenknerVictor AremuFrederick MorlockMaximilian LangenfeldDavis BulsNeil LambertDavid Heinemeier HanssonEthan FischerTerry TaiAdam RoesnerTim MorganMax ShypulniakKovács ÁdámSviatoslav AbakumovPatricio SerranoKiriBob ParsonsJohn Even BjørnevikMichael OberstStian HegglundKenth FagerlundJulien TardotAaron ArredondoEllord TayagEdgar Post-Buijssbc64Pierre SpringZac ClayThomas MüllerCarl AssmannSergey OgnevMoody LiuAlex GMichael HowardLasse Bloch LauritsenLarry MarburgerDavid BrockmanjrgnAlexander SlavschikAidan GaulandMaksym BieńkowskiJoshua WootonnGurbinder SinghSimon Sandvik LeeThomas GilbertSzymon MuchaTim ShilovUnnawut LeepaisalsuwannaIngo SchommerBret WortmanHaoyu (Daniel) YANG 杨浩宇Manuel

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

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.

stage_lines

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

interactive_rebase

Cherry-pick

Press shift+c on a commit to copy it and press shift+v to paste (cherry-pick) it.

cherry_pick

Bisect

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

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.

Nuke working tree

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

amend_old_commit

Filter

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

filter

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.

custom_command

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.

worktree_create_from_branches

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.

custom_patch

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.

rebase_onto

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