1
0
mirror of https://github.com/jesseduffield/lazygit.git synced 2024-12-12 11:15:00 +02:00
lazygit/README.md

300 lines
8.6 KiB
Markdown
Raw Normal View History

2020-08-22 12:46:00 +02:00
<p align="center">
<img src="https://i.imgur.com/oYB7Cj8.png">
</p>
2018-08-06 07:42:41 +02:00
2020-03-26 03:41:37 +02:00
![CI](https://github.com/jesseduffield/lazygit/workflows/Continuous%20Integration/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/jesseduffield/lazygit)](https://goreportcard.com/report/github.com/jesseduffield/lazygit) [![GolangCI](https://golangci.com/badges/github.com/jesseduffield/lazygit.svg)](https://golangci.com) [![GoDoc](https://godoc.org/github.com/jesseduffield/lazygit?status.svg)](http://godoc.org/github.com/jesseduffield/lazygit) [![GitHub tag](https://img.shields.io/github/tag/jesseduffield/lazygit.svg)]() [![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/jesseduffield/lazygit)](https://www.tickgit.com/browse?repo=github.com/jesseduffield/lazygit)
2018-06-10 04:49:12 +02:00
2020-08-22 12:46:00 +02:00
2020-03-26 03:41:37 +02:00
A simple terminal UI for git commands, written in Go with the [gocui](https://github.com/jroimartin/gocui "gocui") library.
2020-03-26 03:45:41 +02:00
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!*
2019-11-10 01:02:04 +02:00
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.
2018-06-09 11:30:59 +02:00
2020-09-27 02:31:53 +02:00
![Gif](../assets/staging.gif)
2018-06-09 11:30:59 +02:00
2020-03-26 03:41:37 +02:00
## Table of contents
- [Installation](#installation)
2020-03-26 03:45:41 +02:00
- [Binary releases](#binary-releases)
2020-03-26 03:41:37 +02:00
- [Homebrew](#homebrew)
- [MacPorts](#macports)
- [Void Linux](#void-linux)
2020-03-26 21:59:55 +02:00
- [Scoop (Windows)](#scoop-windows)
2020-03-26 03:41:37 +02:00
- [Arch Linux](#arch-linux)
- [Fedora and CentOS 7](#fedora-and-centos-7)
2020-07-17 10:39:53 +02:00
- [Solus Linux](#solus-linux)
- [FreeBSD](#freebsd)
2020-03-26 03:41:37 +02:00
- [Conda](#conda)
- [Go](#go)
- [Chocolatey (Windows)](#chocolatey-windows)
2020-10-01 22:46:51 +02:00
- [Manual](#manual)
2020-03-26 03:41:37 +02:00
- [Usage](#usage)
- [Keybindings](#keybindings)
- [Changing directory on exit](#changing-directory-on-exit)
2020-03-26 21:59:55 +02:00
- [Undo/Redo](#undoredo)
2020-03-26 03:41:37 +02:00
- [Configuration](#configuration)
- [Custom pagers](#configuration)
2020-09-27 02:36:18 +02:00
- [Custom commands](#configuration)
2020-03-26 03:41:37 +02:00
- [Tutorials](#tutorials)
- [Cool Features](#cool-features)
- [Contributing](#contributing)
- [Donate](#donate)
- [Alternatives](#alternatives)
2019-11-10 00:02:00 +02:00
2019-11-10 01:07:43 +02:00
Github Sponsors is matching all donations dollar-for-dollar for 12 months so if you're feeling generous consider [sponsoring me](https://github.com/sponsors/jesseduffield)
2020-03-26 03:45:41 +02:00
[<img src="https://i.imgur.com/sVEktDn.png">](https://youtu.be/CPLdltN7wgE)
2018-06-10 04:49:12 +02:00
## Installation
2018-08-08 00:49:37 +02:00
2020-03-26 03:45:41 +02:00
### Binary Releases
For Windows, Mac OS(10.10+) or Linux, you can download a binary release [here](../../releases).
2020-03-26 03:45:41 +02:00
2018-08-09 02:46:27 +02:00
### Homebrew
2019-11-10 14:31:19 +02:00
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.
2019-11-10 14:31:19 +02:00
Tap:
2019-11-10 14:31:19 +02:00
```
brew install jesseduffield/lazygit/lazygit
```
Core:
```
2018-08-09 02:46:27 +02:00
brew install lazygit
2018-08-09 02:46:57 +02:00
```
2018-08-09 02:46:27 +02:00
2019-11-17 08:47:30 +02:00
### MacPorts
2019-11-17 08:47:30 +02:00
Latest version built from github releases.
Tap:
2019-11-17 08:47:30 +02:00
```
sudo port install lazygit
```
### Ubuntu
2021-05-07 00:06:38 +02:00
**Deprecated**: will no longer receive updates.
2020-01-03 15:49:51 +02:00
Packages for Ubuntu are available via [Launchpad PPA](https://launchpad.net/~lazygit-team).
2018-08-16 19:26:43 +02:00
```sh
sudo add-apt-repository ppa:lazygit-team/release
sudo apt-get update
sudo apt-get install lazygit
```
2018-08-09 23:17:38 +02:00
### Void Linux
2018-08-09 23:17:38 +02:00
Packages for Void Linux are available in the distro repo
They follow upstream latest releases
```sh
sudo xbps-install -S lazygit
```
2020-03-26 03:41:37 +02:00
### Scoop (Windows)
You can install `lazygit` using [scoop](https://scoop.sh/). It's in the `extras` bucket:
```sh
# Add the extras bucket
scoop bucket add extras
# Install lazygit
scoop install lazygit
2018-08-09 23:17:38 +02:00
```
### Arch Linux
2021-04-06 17:30:02 +02:00
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.
2021-04-06 17:30:02 +02:00
- 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>
2019-12-07 08:26:07 +02:00
### Fedora and CentOS 7
Packages for Fedora and CentOS 7 are available via [Copr](https://copr.fedorainfracloud.org/coprs/atim/lazygit/) (Cool Other Package Repo).
```sh
sudo dnf copr enable atim/lazygit -y
sudo dnf install lazygit
```
2020-07-17 10:39:53 +02:00
### Solus Linux
```sh
sudo eopkg install lazygit
```
2020-04-22 11:49:56 +02:00
### FreeBSD
```sh
pkg install lazygit
```
### Conda
Released versions are available for different platforms, see <https://anaconda.org/conda-forge/lazygit>
```sh
conda install -c conda-forge lazygit
```
2018-08-09 02:48:57 +02:00
### Go
2018-08-09 03:07:41 +02:00
```sh
go get github.com/jesseduffield/lazygit
```
2018-08-09 02:48:57 +02:00
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).
2018-08-08 00:49:37 +02:00
### Chocolatey (Windows)
You can install `lazygit` using [Chocolatey](https://chocolatey.org/):
```sh
choco install lazygit
```
2020-10-01 22:46:51 +02:00
### Manual
You'll need to [install Go](https://golang.org/doc/install)
```
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)
2020-03-26 03:41:37 +02:00
2018-08-08 00:49:37 +02:00
## Usage
2020-03-26 03:41:37 +02:00
Call `lazygit` in your terminal inside a git repository.
```sh
$ 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).
2018-08-09 02:21:45 +02:00
2020-03-26 03:41:37 +02:00
### Keybindings
2020-03-26 03:41:37 +02:00
You can check out the list of keybindings [here](/docs/keybindings).
### Changing Directory On Exit
2019-11-11 12:45:37 +02:00
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):
2019-11-11 12:45:37 +02:00
```
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
}
```
2019-11-11 12:45:37 +02:00
Then `source ~/.zshrc` and from now on when you call `lg` and exit you'll switch directories to whatever you were in inside lazyigt. To override this behaviour you can exit using `shift+Q` rather than just `q`.
2018-08-08 00:49:37 +02:00
2020-03-26 03:45:41 +02:00
### Undo/Redo
2020-03-25 11:32:44 +02:00
See the [docs](/docs/Undoing.md)
## Configuration
2020-03-26 03:41:37 +02:00
Check out the [configuration docs](docs/Config.md).
2020-03-26 03:41:37 +02:00
### Custom Pagers
2020-03-03 15:11:32 +02:00
See the [docs](docs/Custom_Pagers.md)
2020-09-27 01:58:49 +02:00
### 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](docs/Custom_Command_Keybindings.md)
2020-03-03 15:11:32 +02:00
2020-03-26 03:41:37 +02:00
## Tutorials
- [Video Tutorial](https://youtu.be/VDXvbHZYeKY)
- [Rebase Magic Video Tutorial](https://youtu.be/4XaToVut_hs)
- [Twitch Stream](https://www.twitch.tv/jesseduffield)
2018-06-10 04:49:12 +02:00
## 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
2018-06-10 04:49:12 +02:00
### Resolving merge conflicts
2020-09-27 02:31:53 +02:00
![Gif](../assets/resolving-merge-conflicts.gif)
2018-06-10 04:49:12 +02:00
2019-03-04 11:39:00 +02:00
### Interactive Rebasing
2020-09-27 02:31:53 +02:00
![Interactive Rebasing](../assets/rebase.gif)
2018-06-10 04:52:55 +02:00
2018-08-06 16:07:42 +02:00
## Contributing
We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
2018-08-16 02:37:23 +02:00
For contributor discussion about things not better discussed here in the repo, join the slack channel
2020-09-27 02:31:53 +02:00
[![Slack](../assets/slack_rgb.png)](https://join.slack.com/t/lazygit/shared_invite/zt-5bo2clzo-hB8ZTVN5dWUCqj5QFiQVLA)
2018-08-06 16:07:42 +02:00
2020-09-26 02:57:04 +02:00
### Debugging Locally
2020-09-26 02:56:22 +02:00
Run `lazygit --debug` in one terminal tab and `lazygit --logs` in another to view the program and its log output side by side
2018-09-23 05:09:54 +02:00
## Donate
2019-11-10 01:17:35 +02:00
If you would like to support the development of lazygit, consider [sponsoring me](https://github.com/sponsors/jesseduffield) (github is matching all donations dollar-for-dollar for 12 months)
2018-09-23 05:09:54 +02:00
2021-04-01 11:56:04 +02:00
## FAQ
2021-04-01 11:56:04 +02:00
### I'm struggling to see the selected line
see [here](https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#struggling-to-see-selected-line)
2018-08-11 01:43:22 +02:00
## Social
If you want to see what I (Jesse) am up to in terms of development, follow me on
[twitter](https://twitter.com/DuffieldJesse) or watch me program on
[twitch](https://www.twitch.tv/jesseduffield).
2018-09-05 10:44:24 +02:00
## Alternatives
2018-09-05 10:44:24 +02:00
If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit:
2020-08-22 22:34:41 +02:00
- [GitUI](https://github.com/Extrawurst/gitui)
2018-09-05 10:44:24 +02:00
- [tig](https://github.com/jonas/tig)