1
0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-06-15 00:15:32 +02:00

prettify config.md

This commit is contained in:
Jesse Duffield
2021-04-11 21:42:41 +10:00
parent 069c7c9d35
commit 764bd556f3

View File

@ -2,20 +2,20 @@
Default path for the config file:
* Linux: `~/.config/lazygit/config.yml`
* MacOS: `~/Library/Application Support/lazygit/config.yml`
* Windows: `%APPDATA%\lazygit\config.yml`
- Linux: `~/.config/lazygit/config.yml`
- MacOS: `~/Library/Application Support/lazygit/config.yml`
- Windows: `%APPDATA%\lazygit\config.yml`
For old installations (slightly embarrassing: I didn't realise at the time that you didn't need to supply a vendor name to the path so I just used my name):
* Linux: `~/.config/jesseduffield/lazygit/config.yml`
* MacOS: `~/Library/Application Support/jesseduffield/lazygit/config.yml`
* Windows: `%APPDATA%\jesseduffield\lazygit\config.yml`
- Linux: `~/.config/jesseduffield/lazygit/config.yml`
- MacOS: `~/Library/Application Support/jesseduffield/lazygit/config.yml`
- Windows: `%APPDATA%\jesseduffield\lazygit\config.yml`
## Default
```yaml
gui:
gui:
# stuff relating to the UI
scrollHeight: 2 # how many lines you scroll by
scrollPastBottom: true # enable scrolling past the bottom
@ -41,8 +41,8 @@ For old installations (slightly embarrassing: I didn't realise at the time that
skipUnstageLineWarning: false
skipStashWarning: true
showFileTree: false # for rendering changes files in a tree format
showCommandLog: false
git:
showCommandLog:
git:
paging:
colorArg: always
useConfig: false
@ -50,28 +50,28 @@ For old installations (slightly embarrassing: I didn't realise at the time that
# only applicable to unix users
manualCommit: false
# extra args passed to `git merge`, e.g. --no-ff
args: ""
args: ''
pull:
mode: 'merge' # one of 'merge' | 'rebase' | 'ff-only'
skipHookPrefix: WIP
autoFetch: true
branchLogCmd: "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --"
allBranchesLogCmd: "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium"
branchLogCmd: 'git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --'
allBranchesLogCmd: 'git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium'
overrideGpg: false # prevents lazygit from spawning a separate process when using GPG
disableForcePushing: false
refresher:
refresher:
refreshInterval: 10 # file/submodule refresh interval in seconds
fetchInterval: 60 # re-fetch interval in seconds
update:
update:
method: prompt # can be: prompt | background | never
days: 14 # how often an update is checked for
reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
confirmOnQuit: false
# determines whether hitting 'esc' will quit the application when there is nothing to cancel/close
quitOnTopLevelReturn: false
disableStartupPopups: false
notARepository: 'prompt' # one of: 'prompt' | 'create' | 'skip'
keybinding:
reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
confirmOnQuit: false
# determines whether hitting 'esc' will quit the application when there is nothing to cancel/close
quitOnTopLevelReturn: false
disableStartupPopups: false
notARepository: 'prompt' # one of: 'prompt' | 'create' | 'skip'
keybinding:
universal:
quit: 'q'
quit-alt1: '<c-c>' # alternative/alias of quit
@ -193,21 +193,21 @@ For old installations (slightly embarrassing: I didn't realise at the time that
### Windows
```yaml
os:
os:
openCommand: 'cmd /c "start "" {{filename}}"'
```
### Linux
```yaml
os:
os:
openCommand: 'sh -c "xdg-open {{filename}} >/dev/null"'
```
### OSX
```yaml
os:
os:
openCommand: 'open {{filename}}'
```
@ -216,7 +216,7 @@ For old installations (slightly embarrassing: I didn't realise at the time that
for users of VSCode
```yaml
os:
os:
openCommand: 'code -rg {{filename}}'
```
@ -243,7 +243,7 @@ The available attributes are:
If you have issues with a light terminal theme where you can't read / see the text add these settings
```yaml
gui:
gui:
theme:
lightTheme: true
activeBorderColor:
@ -260,7 +260,7 @@ If you have issues with a light terminal theme where you can't read / see the te
If you struggle to see the selected line I recommend using the reverse attribute on selected lines like so:
```yaml
gui:
gui:
theme:
selectedLineBgColor:
- reverse
@ -269,6 +269,7 @@ If you struggle to see the selected line I recommend using the reverse attribute
```
The following has also worked for a couple of people:
```yaml
gui:
theme:
@ -297,7 +298,7 @@ For all possible keybinding options, check [Custom_Keybindings.md](https://githu
### Example Keybindings For Colemak Users
```yaml
keybinding:
keybinding:
universal:
prevItem-alt: 'u'
nextItem-alt: 'e'
@ -334,7 +335,7 @@ the pull request. You can do so on your `config.yml` file using the following sy
```yaml
services:
"<gitDomain>": "<provider>:<webDomain>"
'<gitDomain>': '<provider>:<webDomain>'
```
Where:
@ -344,19 +345,21 @@ Where:
- `webDomain` is the URL where your git service exposes a web interface and APIs, e.g. `gitservice.work.com`
## Predefined commit message prefix
In situations where certain naming pattern is used for branches and commits, pattern can be used to populate
commit message with prefix that is parsed from the branch name.
Example:
* Branch name: feature/AB-123
* Commit message: [AB-123] Adding feature
- Branch name: feature/AB-123
- Commit message: [AB-123] Adding feature
```yaml
git:
git:
commitPrefixes:
my_project: # This is repository folder name
pattern: "^\\w+\\/(\\w+-\\w+).*"
replace: "[$1] "
replace: '[$1] '
```
## Custom git log command