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

65 lines
1.6 KiB
Markdown
Raw Normal View History

2020-03-03 14:07:12 +02:00
# Custom Pagers
Lazygit supports custom pagers, [configured](/docs/Config.md) in the config.yml file (which can be opened by pressing `o` in the Status panel).
2020-03-03 14:07:12 +02:00
Support does not extend to Windows users, because we're making use of a package which doesn't have Windows support.
2020-03-03 14:07:12 +02:00
## Default:
```yaml
git:
paging:
colorArg: always
useConfig: false
```
the `colorArg` key is for whether you want the `--color=always` arg in your `git diff` command. Some pagers want it set to `always`, others want it set to `never`.
2020-03-03 14:07:12 +02:00
## Delta:
```yaml
git:
paging:
colorArg: always
pager: delta --dark --paging=never
2020-03-03 14:07:12 +02:00
```
2020-03-03 15:06:49 +02:00
![](https://i.imgur.com/QJpQkF3.png)
2020-03-03 14:07:12 +02:00
## Diff-so-fancy
```yaml
git:
paging:
colorArg: always
pager: diff-so-fancy
```
![](https://i.imgur.com/rjH1TpT.png)
2020-03-03 15:06:49 +02:00
## ydiff
```yaml
gui:
sidePanelWidth: 0.2 # gives you more space to show things side-by-side
git:
paging:
colorArg: never
pager: ydiff -p cat -s --wrap --width={{columnWidth}}
```
![](https://i.imgur.com/vaa8z0H.png)
Be careful with this one, I think the homebrew and pip versions are behind master. I needed to directly download the ydiff script to get the no-pager functionality working.
2020-03-03 14:07:12 +02:00
## Using git config
```yaml
git:
paging:
colorArg: always
useConfig: true
```
If you set `useConfig: true`, lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).