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