trducng commited on
Commit
1e4f4d1
·
1 Parent(s): 9857687

Add markdown

Browse files
Files changed (1) hide show
  1. lz.md +418 -0
lz.md ADDED
@@ -0,0 +1,418 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <p align="center">
2
+ <img width="536" src="https://user-images.githubusercontent.com/8456633/174470852-339b5011-5800-4bb9-a628-ff230aa8cd4e.png">
3
+ </p>
4
+
5
+ <div align="center">
6
+
7
+ A simple terminal UI for git commands
8
+ <br/>
9
+
10
+ [![GitHub Releases](https://img.shields.io/github/downloads/jesseduffield/lazygit/total)](https://github.com/jesseduffield/lazygit/releases) [![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) [![GitHub tag](https://img.shields.io/github/tag/jesseduffield/lazygit.svg)](https://github.com/jesseduffield/lazygit/releases/latest) [![homebrew](https://img.shields.io/homebrew/v/lazygit)](https://github.com/Homebrew/homebrew-core/blob/master/Formula/lazygit.rb)
11
+
12
+ ![commit_and_push](../assets/demo/commit_and_push-compressed.gif)
13
+
14
+ </div>
15
+
16
+ | Month | Savings |
17
+ | -------- | ------- |
18
+ | January | $250 |
19
+ | February | $80 |
20
+ | March | $420 |
21
+
22
+ Sponsors
23
+ --------
24
+
25
+ <p align="center">
26
+ Maintenance of this project is made possible by all the <a href="https://github.com/jesseduffield/lazygit/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/jesseduffield">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/jesseduffield">click here</a>. 💙
27
+ </p>
28
+
29
+ <p align="center">
30
+ <!-- sponsors --><a href="https://github.com/intabulas"><img src="https://github.com/intabulas.png" width="60px" alt="" /></a><a href="https://github.com/piot"><img src="https://github.com/piot.png" width="60px" alt="" /></a><a href="https://github.com/rgwood"><img src="https://github.com/rgwood.png" width="60px" alt="" /></a><a href="https://github.com/oliverguenther"><img src="https://github.com/oliverguenther.png" width="60px" alt="" /></a><a href="https://github.com/pawanjay176"><img src="https://github.com/pawanjay176.png" width="60px" alt="" /></a><a href="https://github.com/bdach"><img src="https://github.com/bdach.png" width="60px" alt="" /></a><a href="https://github.com/davidklsn"><img src="https://github.com/davidklsn.png" width="60px" alt="" /></a><a href="https://github.com/naoey"><img src="https://github.com/naoey.png" width="60px" alt="" /></a><a href="https://github.com/jryom"><img src="https://github.com/jryom.png" width="60px" alt="" /></a><a href="https://github.com/carstengehling"><img src="https://github.com/carstengehling.png" width="60px" alt="" /></a><a href="https://github.com/ceuk"><img src="https://github.com/ceuk.png" width="60px" alt="" /></a><a href="https://github.com/akospwc"><img src="https://github.com/akospwc.png" width="60px" alt="" /></a><a href="https://github.com/Xetera"><img src="https://github.com/Xetera.png" width="60px" alt="" /></a><a href="https://github.com/HoldenLucas"><img src="https://github.com/HoldenLucas.png" width="60px" alt="" /></a><a href="https://github.com/barbados-clemens"><img src="https://github.com/barbados-clemens.png" width="60px" alt="" /></a><a href="https://github.com/nartc"><img src="https://github.com/nartc.png" width="60px" alt="" /></a><a href="https://github.com/matejcik"><img src="https://github.com/matejcik.png" width="60px" alt="" /></a><a href="https://github.com/lucatume"><img src="https://github.com/lucatume.png" width="60px" alt="" /></a><a href="https://github.com/zach-fuller"><img src="https://github.com/zach-fuller.png" width="60px" alt="" /></a><a href="https://github.com/KowalskiPiotr98"><img src="https://github.com/KowalskiPiotr98.png" width="60px" alt="" /></a><a href="https://github.com/nicholascloud"><img src="https://github.com/nicholascloud.png" width="60px" alt="" /></a><a href="https://github.com/PhotonQuantum"><img src="https://github.com/PhotonQuantum.png" width="60px" alt="" /></a><a href="https://github.com/GitSquared"><img src="https://github.com/GitSquared.png" width="60px" alt="" /></a><a href="https://github.com/ava1ar"><img src="https://github.com/ava1ar.png" width="60px" alt="" /></a><a href="https://github.com/pedropombeiro"><img src="https://github.com/pedropombeiro.png" width="60px" alt="" /></a><a href="https://github.com/minidfx"><img src="https://github.com/minidfx.png" width="60px" alt="" /></a><a href="https://github.com/JoeKlemmer"><img src="https://github.com/JoeKlemmer.png" width="60px" alt="" /></a><a href="https://github.com/ColonelBucket8"><img src="https://github.com/ColonelBucket8.png" width="60px" alt="" /></a><a href="https://github.com/tobi"><img src="https://github.com/tobi.png" width="60px" alt="" /></a><a href="https://github.com/benbfortis"><img src="https://github.com/benbfortis.png" width="60px" alt="" /></a><a href="https://github.com/jakewarren"><img src="https://github.com/jakewarren.png" width="60px" alt="" /></a><a href="https://github.com/tgpholly"><img src="https://github.com/tgpholly.png" width="60px" alt="" /></a><a href="https://github.com/jisantuc"><img src="https://github.com/jisantuc.png" width="60px" alt="" /></a><a href="https://github.com/bitprophet"><img src="https://github.com/bitprophet.png" width="60px" alt="" /></a><a href="https://github.com/tayleighr"><img src="https://github.com/tayleighr.png" width="60px" alt="" /></a><a href="https://github.com/Novakov"><img src="https://github.com/Novakov.png" width="60px" alt="" /></a><a href="https://github.com/mthuggett"><img src="https://github.com/mthuggett.png" width="60px" alt="" /></a><a href="https://github.com/portothree"><img src="https://github.com/portothree.png" width="60px" alt="" /></a><a href="https://github.com/farzadmf"><img src="https://github.com/farzadmf.png" width="60px" alt="" /></a><a href="https://github.com/nekhaevskiy"><img src="https://github.com/nekhaevskiy.png" width="60px" alt="" /></a><a href="https://github.com/reivilibre"><img src="https://github.com/reivilibre.png" width="60px" alt="" /></a><a href="https://github.com/andreaskurth"><img src="https://github.com/andreaskurth.png" width="60px" alt="" /></a><a href="https://github.com/BSteffaniak"><img src="https://github.com/BSteffaniak.png" width="60px" alt="" /></a><a href="https://github.com/jordan-gillard"><img src="https://github.com/jordan-gillard.png" width="60px" alt="" /></a><a href="https://github.com/smangels"><img src="https://github.com/smangels.png" width="60px" alt="" /></a><a href="https://github.com/George-Spanos"><img src="https://github.com/George-Spanos.png" width="60px" alt="" /></a><a href="https://github.com/BenGH28"><img src="https://github.com/BenGH28.png" width="60px" alt="" /></a><a href="https://github.com/abradner"><img src="https://github.com/abradner.png" width="60px" alt="" /></a><a href="https://github.com/Thalys"><img src="https://github.com/Thalys.png" width="60px" alt="" /></a><a href="https://github.com/wakywayne"><img src="https://github.com/wakywayne.png" width="60px" alt="" /></a><a href="https://github.com/frantisekstanko"><img src="https://github.com/frantisekstanko.png" width="60px" alt="" /></a><a href="https://github.com/vlad-psh"><img src="https://github.com/vlad-psh.png" width="60px" alt="" /></a><a href="https://github.com/atlj"><img src="https://github.com/atlj.png" width="60px" alt="" /></a><a href="https://github.com/robclancy"><img src="https://github.com/robclancy.png" width="60px" alt="" /></a><a href="https://github.com/Jaxwood"><img src="https://github.com/Jaxwood.png" width="60px" alt="" /></a><a href="https://github.com/orthodoX"><img src="https://github.com/orthodoX.png" width="60px" alt="" /></a><a href="https://github.com/Broderick-Westrope"><img src="https://github.com/Broderick-Westrope.png" width="60px" alt="" /></a><a href="https://github.com/tmontaigu"><img src="https://github.com/tmontaigu.png" width="60px" alt="" /></a><a href="https://github.com/camina-apps"><img src="https://github.com/camina-apps.png" width="60px" alt="" /></a><a href="https://github.com/tkuraku"><img src="https://github.com/tkuraku.png" width="60px" alt="" /></a><!-- sponsors -->
31
+ </p>
32
+
33
+ ## Elevator Pitch
34
+
35
+ 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!_
36
+
37
+ 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.
38
+
39
+ ## Table of contents
40
+
41
+ - [Features](#features)
42
+ - [Tutorials](#tutorials)
43
+ - [Installation](#installation)
44
+ - [Binary releases](#binary-releases)
45
+ - [Homebrew](#homebrew)
46
+ - [MacPorts](#macports)
47
+ - [Void Linux](#void-linux)
48
+ - [Scoop (Windows)](#scoop-windows)
49
+ - [Arch Linux](#arch-linux)
50
+ - [Fedora and RHEL](#fedora-and-rhel)
51
+ - [Solus Linux](#solus-linux)
52
+ - [Ubuntu](#ubuntu)
53
+ - [Funtoo Linux](#funtoo-linux)
54
+ - [Gentoo Linux](#gentoo-linux)
55
+ - [FreeBSD](#freebsd)
56
+ - [Conda](#conda)
57
+ - [Go](#go)
58
+ - [Chocolatey (Windows)](#chocolatey-windows)
59
+ - [Manual](#manual)
60
+ - [Usage](#usage)
61
+ - [Keybindings](#keybindings)
62
+ - [Changing directory on exit](#changing-directory-on-exit)
63
+ - [Undo/Redo](#undoredo)
64
+ - [Configuration](#configuration)
65
+ - [Custom pagers](#configuration)
66
+ - [Custom commands](#configuration)
67
+ - [Contributing](#contributing)
68
+ - [Donate](#donate)
69
+ - [Alternatives](#alternatives)
70
+
71
+ 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](https://github.com/sponsors/jesseduffield)
72
+
73
+ ## Features
74
+
75
+ ### Stage individual lines
76
+
77
+ 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.
78
+
79
+ ![stage_lines](../assets/demo/stage_lines-compressed.gif)
80
+
81
+ ### Interactive Rebase
82
+
83
+ Press `e` on a commit to start an interactive rebase on it: causing all above commits to become part of the TODO file. 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.
84
+
85
+ ![interactive_rebase](../assets/demo/interactive_rebase-compressed.gif)
86
+
87
+ ### Cherry-pick
88
+
89
+ Press `c` on a commit to copy it and press `v` to paste (cherry-pick) it.
90
+
91
+ ![cherry_pick](../assets/demo/cherry_pick-compressed.gif)
92
+
93
+ ### Bisect
94
+
95
+ Press `b` in the commits view to mark a commit as good/bad in order to begin a git bisect.
96
+
97
+ ![bisect](../assets/demo/bisect-compressed.gif)
98
+
99
+ ### Nuke the working tree
100
+
101
+ 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](https://www.youtube.com/watch?v=Ur7_A4JusMU), press `shift+d` to bring up the reset options menu and then select the 'nuke' option.
102
+
103
+ ![Nuke working tree](../assets/demo/nuke_working_tree-compressed.gif)
104
+
105
+ ### Amend an old commit
106
+
107
+ Pressing `shift+a` on any commit will amend that commit with the currently staged changes (running an interactive rebase in the background).
108
+
109
+ ![amend_old_commit](../assets/demo/amend_old_commit-compressed.gif)
110
+
111
+ ### Filter
112
+
113
+ You can filter a view with `/`. Here we filter down our branches view and then hit `enter` to view its commits.
114
+
115
+ ![filter](../assets/demo/filter-compressed.gif)
116
+
117
+ ### Invoke a custom command
118
+
119
+ Lazygit has a very flexible [custom command system](docs/Custom_Command_Keybindings.md). In this example a custom command is defined which emulates the built-in branch checkout action.
120
+
121
+ ![custom_command](../assets/demo/custom_command-compressed.gif)
122
+
123
+ ### Worktrees
124
+
125
+ 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.
126
+
127
+ ![worktree_create_from_branches](../assets/demo/worktree_create_from_branches-compressed.gif)
128
+
129
+ ### Rebase magic (custom patches)
130
+
131
+ 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.
132
+
133
+ 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.
134
+
135
+ Learn more in the [Rebase magic Youtube tutorial](https://youtu.be/4XaToVut_hs).
136
+
137
+ ![custom_patch](../assets/demo/custom_patch-compressed.gif)
138
+
139
+ ## Tutorials
140
+
141
+ [<img src="https://i.imgur.com/sVEktDn.png">](https://youtu.be/CPLdltN7wgE)
142
+
143
+ - [15 Lazygit Features in 15 Minutes](https://youtu.be/CPLdltN7wgE)
144
+ - [Basics Tutorial](https://youtu.be/VDXvbHZYeKY)
145
+ - [Rebase Magic Tutorial](https://youtu.be/4XaToVut_hs)
146
+
147
+ ## Installation
148
+
149
+ [![Packaging status](https://repology.org/badge/vertical-allrepos/lazygit.svg)](https://repology.org/project/lazygit/versions)
150
+
151
+ _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_
152
+
153
+ ### Binary Releases
154
+
155
+ For Windows, Mac OS(10.12+) or Linux, you can download a binary release [here](../../releases).
156
+
157
+ ### Homebrew
158
+
159
+ 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.
160
+
161
+ Tap:
162
+
163
+ ```
164
+ brew install jesseduffield/lazygit/lazygit
165
+ ```
166
+
167
+ Core:
168
+
169
+ ```
170
+ brew install lazygit
171
+ ```
172
+
173
+ ### MacPorts
174
+
175
+ Latest version built from github releases.
176
+ Tap:
177
+
178
+ ```
179
+ sudo port install lazygit
180
+ ```
181
+
182
+ ### Void Linux
183
+
184
+ Packages for Void Linux are available in the distro repo
185
+
186
+ They follow upstream latest releases
187
+
188
+ ```sh
189
+ sudo xbps-install -S lazygit
190
+ ```
191
+
192
+ ### Scoop (Windows)
193
+
194
+ You can install `lazygit` using [scoop](https://scoop.sh/). It's in the `extras` bucket:
195
+
196
+ ```sh
197
+ # Add the extras bucket
198
+ scoop bucket add extras
199
+
200
+ # Install lazygit
201
+ scoop install lazygit
202
+ ```
203
+
204
+ ### Arch Linux
205
+
206
+ Packages for Arch Linux are available via pacman and AUR (Arch User Repository).
207
+
208
+ There are two packages. The stable one which is built with the latest release
209
+ and the git version which builds from the most recent commit.
210
+
211
+ - Stable: `sudo pacman -S lazygit`
212
+ - Development: <https://aur.archlinux.org/packages/lazygit-git/>
213
+
214
+ Instruction of how to install AUR content can be found here:
215
+ <https://wiki.archlinux.org/index.php/Arch_User_Repository>
216
+
217
+ ### Fedora and RHEL
218
+
219
+ Packages for Fedora/RHEL and CentOS Stream are available via [Copr](https://copr.fedorainfracloud.org/coprs/atim/lazygit/) (Cool Other Package Repo).
220
+
221
+ ```sh
222
+ sudo dnf copr enable atim/lazygit -y
223
+ sudo dnf install lazygit
224
+ ```
225
+
226
+ ### Solus Linux
227
+
228
+ ```sh
229
+ sudo eopkg install lazygit
230
+ ```
231
+
232
+ ### Ubuntu
233
+
234
+ ```sh
235
+ LAZYGIT_VERSION=$(curl -s "https://api.github.com/repos/jesseduffield/lazygit/releases/latest" | grep -Po '"tag_name": "v\K[^"]*')
236
+ curl -Lo lazygit.tar.gz "https://github.com/jesseduffield/lazygit/releases/latest/download/lazygit_${LAZYGIT_VERSION}_Linux_x86_64.tar.gz"
237
+ tar xf lazygit.tar.gz lazygit
238
+ sudo install lazygit /usr/local/bin
239
+ ```
240
+
241
+ Verify the correct installation of lazygit:
242
+
243
+ ```sh
244
+ lazygit --version
245
+ ```
246
+
247
+ ### Funtoo Linux
248
+
249
+ Funtoo Linux has an autogenerated lazygit package in [dev-kit](https://github.com/funtoo/dev-kit/tree/1.4-release/dev-vcs/lazygit):
250
+
251
+ ```sh
252
+ sudo emerge dev-vcs/lazygit
253
+ ```
254
+ ### Gentoo Linux
255
+
256
+ Lazygit is not (yet) in main Gentoo portage, however an ebuild is available in [cova overlay](https://github.com/cova-fe/cova-overlay/tree/main/dev-vcs/lazygit)
257
+
258
+ You can either add the overlay to your system and install lazygit as usual:
259
+
260
+ ```sh
261
+ sudo eselect repository enable cova
262
+ sudo emaint sync -r cova
263
+ sudo emerge dev-vcs/lazygit
264
+ ```
265
+
266
+ Or you can download the ebuild and install it manually; please consider the example below just as a suggestion to be adapted to your system.
267
+
268
+ ```sh
269
+ su
270
+ LAZYGIT_VERSION="0.39.3" # Replace with the version you want from cova-overlay
271
+ cd /usr/overlay/dev-vcs/ # Replace your overlay path
272
+ mkdir lazygit
273
+ cd lazygit
274
+ curl -O https://raw.githubusercontent.com/cova-fe/cova-overlay/main/dev-vcs/lazygit/lazygit-${LAZYGIT_VERSION}.ebuild
275
+ ebuild lazygit-${LAZYGIT_VERSION}.ebuild manifest
276
+ emerge lazygit
277
+ ```
278
+
279
+ ### FreeBSD
280
+
281
+ ```sh
282
+ pkg install lazygit
283
+ ```
284
+
285
+ ### Conda
286
+
287
+ Released versions are available for different platforms, see <https://anaconda.org/conda-forge/lazygit>
288
+
289
+ ```sh
290
+ conda install -c conda-forge lazygit
291
+ ```
292
+
293
+ ### Go
294
+
295
+ ```sh
296
+ go install github.com/jesseduffield/lazygit@latest
297
+ ```
298
+
299
+ Please note:
300
+ If you get an error claiming that lazygit cannot be found or is not defined, you
301
+ may need to add `~/go/bin` to your $PATH (MacOS/Linux), or `%HOME%\go\bin`
302
+ (Windows). Not to be mistaken for `C:\Go\bin` (which is for Go's own binaries,
303
+ not apps like lazygit).
304
+
305
+ ### Chocolatey (Windows)
306
+
307
+ You can install `lazygit` using [Chocolatey](https://chocolatey.org/):
308
+
309
+ ```sh
310
+ choco install lazygit
311
+ ```
312
+
313
+ ### Manual
314
+
315
+ You'll need to [install Go](https://golang.org/doc/install)
316
+
317
+ ```
318
+ git clone https://github.com/jesseduffield/lazygit.git
319
+ cd lazygit
320
+ go install
321
+ ```
322
+
323
+ You can also use `go run main.go` to compile and run in one go (pun definitely intended)
324
+
325
+ ## Usage
326
+
327
+ Call `lazygit` in your terminal inside a git repository.
328
+
329
+ ```sh
330
+ $ lazygit
331
+ ```
332
+
333
+ If you want, you can
334
+ also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or
335
+ whichever rc file you're using).
336
+
337
+ ### Keybindings
338
+
339
+ You can check out the list of keybindings [here](/docs/keybindings).
340
+
341
+ ### Changing Directory On Exit
342
+
343
+ 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):
344
+
345
+ ```
346
+ lg()
347
+ {
348
+ export LAZYGIT_NEW_DIR_FILE=~/.lazygit/newdir
349
+
350
+ lazygit "$@"
351
+
352
+ if [ -f $LAZYGIT_NEW_DIR_FILE ]; then
353
+ cd "$(cat $LAZYGIT_NEW_DIR_FILE)"
354
+ rm -f $LAZYGIT_NEW_DIR_FILE > /dev/null
355
+ fi
356
+ }
357
+ ```
358
+
359
+ 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`.
360
+
361
+ ### Undo/Redo
362
+
363
+ See the [docs](/docs/Undoing.md)
364
+
365
+ ## Configuration
366
+
367
+ Check out the [configuration docs](docs/Config.md).
368
+
369
+ ### Custom Pagers
370
+
371
+ See the [docs](docs/Custom_Pagers.md)
372
+
373
+ ### Custom Commands
374
+
375
+ If lazygit is missing a feature, there's a good chance you can implement it yourself with a custom command!
376
+
377
+ See the [docs](docs/Custom_Command_Keybindings.md)
378
+
379
+ ## Contributing
380
+
381
+ We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
382
+ For contributor discussion about things not better discussed here in the repo, join the [discord channel](https://discord.gg/ehwFt2t4wt)
383
+
384
+ <a href="https://discord.gg/ehwFt2t4wt"><img src='../assets/discord.png' width='75'></a>
385
+
386
+ Check out this [video](https://www.youtube.com/watch?v=kNavnhzZHtk) walking through the creation of a small feature in lazygit if you want an idea of where to get started.
387
+
388
+ ### Debugging Locally
389
+
390
+ Run `lazygit --debug` in one terminal tab and `lazygit --logs` in another to view the program and its log output side by side
391
+
392
+ ## Donate
393
+
394
+ 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)
395
+
396
+ ## FAQ
397
+
398
+ ### What do the commit colors represent?
399
+
400
+ - Green: the commit is included in the master branch
401
+ - Yellow: the commit is not included in the master branch
402
+ - Red: the commit has not been pushed to the upstream branch
403
+
404
+ ## Shameless Plug
405
+
406
+ If you want to see what I (Jesse) am up to in terms of development, follow me on
407
+ [twitter](https://twitter.com/DuffieldJesse) or check out my [blog](https://jesseduffield.com/)
408
+
409
+ ```
410
+ ``` asdfas
411
+
412
+ ## Alternatives
413
+
414
+ ```
415
+ If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit:
416
+
417
+ - [GitUI](https://github.com/Extrawurst/gitui)
418
+ - [tig](https://github.com/jonas/tig)