lazygit

README

lazygit

A simple terminal UI for git commands, written in Go with the gocui library.

Are YOU tired of typing every git command directly into the terminal, but you're too stubborn to use Sourcetree because you'll never forgive Atlassian for making Jira? This is the app for you!

• Installation
• Usage, Keybindings
• Cool Features
• Contributing
• Video Tutorial
• Twitch Stream

Installation

Homebrew

brew tap jesseduffield/lazygit
brew install lazygit

Ubuntu

Packages for Ubuntu 16.04, 18.04 and 18.10 are available via Launchpad PPA.

Release builds

Built from git tags. Supposed to be more stable.

sudo add-apt-repository ppa:lazygit-team/release
sudo apt-get update
sudo apt-get install lazygit

Daily builds

Built from master branch once in 24 hours (or more sometimes).

sudo add-apt-repository ppa:lazygit-team/daily
sudo apt-get update
sudo apt-get install lazygit

Void Linux

Packages for Void Linux are available in the distro repo

They follow upstream latest releases

sudo xbps-install -S lazygit

Arch Linux

Packages for Arch Linux are available via 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: https://aur.archlinux.org/packages/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

Binary Release (Windows/Linux/OSX)

You can download a binary release here.

Go

go get github.com/jesseduffield/lazygit

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 mistaked for C:\Go\bin (which is for Go's own binaries, not apps like Lazygit).

Usage

Call lazygit in your terminal inside a git repository. If you want, you can also add an alias for this with echo "alias lg='lazygit'" >> ~/.zshrc (or whichever rc file you're using).

• Basic video tutorial here.
• List of keybindings here.

Cool features

• Adding files easily
• Resolving merge conflicts
• Easily check out recent branches
• Scroll through logs/diffs of branches/commits/stash
• Quick pushing/pulling
• Squash down and rename commits

Resolving merge conflicts

Viewing commit diffs

Milestones

• Easy Installation (homebrew, release binaries)
• Configurable Keybindings
• Configurable Color Themes
• Spawning Subprocesses (help needed - have a look at https://github.com/jesseduffield/lazygit/pull/18)
• Maintainability
• Performance
• i18n

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

Work in progress

This is still a work in progress so there's still bugs to iron out and as this is my first project in Go the code could no doubt use an increase in quality, but I'll be improving on it whenever I find the time. If you have any feedback feel free to raise an issue/submit a PR.

Social

If you want to see what I (Jesse) am up to in terms of development, follow me on twitter or watch me program on twitch.