You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Since these are displayed in a fenced code block on github, they aren't
auto-wrapped on display, so users have to scroll horizontally to read longer
paragraphs.
I decided on a wrap width of 80, but didn't stick to it slavishly.
# Map of filenames to icon properties (icon and color)
50
50
filenames: {}
51
51
52
-
# Map of file extensions (including the dot) to icon properties (icon and color)
52
+
# Map of file extensions (including the dot) to icon properties
53
+
# (icon and color)
53
54
extensions: {}
54
55
55
56
# The number of lines you scroll by when scrolling the main window
@@ -64,12 +65,15 @@ gui:
64
65
# One of: 'margin' (default) | 'jump'
65
66
scrollOffBehavior: margin
66
67
67
-
# The number of spaces per tab; used for everything that's shown in the main view, but probably mostly relevant for diffs.
68
-
# Note that when using a pager, the pager has its own tab width setting, so you need to pass it separately in the pager command.
68
+
# The number of spaces per tab; used for everything that's shown in the
69
+
# main view, but probably mostly relevant for diffs.
70
+
# Note that when using a pager, the pager has its own tab width setting,
71
+
# so you need to pass it separately in the pager command.
69
72
tabWidth: 4
70
73
71
74
# If true, capture mouse events.
72
-
# When mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.
75
+
# When mouse events are captured, it's a little harder to select text: e.g.
76
+
# requiring you to hold the option key when on macOS.
73
77
mouseEvents: true
74
78
75
79
# If true, do not show a warning when amending a commit.
@@ -81,33 +85,43 @@ gui:
81
85
# If true, do not show warning when applying/popping the stash
82
86
skipStashWarning: false
83
87
84
-
# If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.
88
+
# If true, do not show a warning when attempting to commit without any staged
89
+
# files; instead stage all unstaged files.
85
90
skipNoStagedFilesWarning: false
86
91
87
92
# If true, do not show a warning when rewording a commit via an external editor
88
93
skipRewordInEditorWarning: false
89
94
90
-
# Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.
95
+
# Fraction of the total screen width to use for the left side section.
96
+
# You may want to pick a small number (e.g. 0.2) if you're using a narrow
97
+
# screen, so that you can see more of the main section.
91
98
# Number from 0 to 1.0.
92
99
sidePanelWidth: 0.3333
93
100
94
-
# If true, increase the height of the focused side window; creating an accordion effect.
101
+
# If true, increase the height of the focused side window; creating an
102
+
# accordion effect.
95
103
expandFocusedSidePanel: false
96
104
97
-
# The weight of the expanded side panel, relative to the other panels. 2 means
98
-
# twice as tall as the other panels. Only relevant if `expandFocusedSidePanel` is true.
105
+
# The weight of the expanded side panel, relative to the other panels.
106
+
# 2 means twice as tall as the other panels. Only relevant if
107
+
# `expandFocusedSidePanel` is true.
99
108
expandedSidePanelWeight: 2
100
109
101
-
# Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.
110
+
# Sometimes the main window is split in two (e.g. when the selected file
111
+
# has both staged and unstaged changes). This setting controls how the
112
+
# two sections are split.
102
113
# Options are:
103
114
# - 'horizontal': split the window horizontally
104
115
# - 'vertical': split the window vertically
105
-
# - 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically
116
+
# - 'flexible': (default) split the window horizontally if the window is
117
+
# wide enough, otherwise split vertically
106
118
mainPanelSplitMode: flexible
107
119
108
-
# How the window is split when in half screen mode (i.e. after hitting '+' once).
120
+
# How the window is split when in half screen mode (i.e. after hitting
121
+
# '+' once).
109
122
# Possible values:
110
-
# - 'left': split the window horizontally (side panel on the left, main view on the right)
123
+
# - 'left': split the window horizontally (side panel on the left, main
124
+
# view on the right)
111
125
# - 'top': split the window vertically (side panel on top, main view below)
112
126
enlargedSideViewLocation: left
113
127
@@ -116,10 +130,11 @@ gui:
116
130
# paragraphs of markdown text.
117
131
wrapLinesInStagingView: true
118
132
119
-
# If true, hunk selection mode will be enabled by default when entering the staging view.
133
+
# If true, hunk selection mode will be enabled by default when entering
# Format used when displaying time e.g. commit time.
@@ -192,11 +207,15 @@ gui:
192
207
# If true, show the '5 of 20' footer at the bottom of list views
193
208
showListFooter: true
194
209
195
-
# If true, display the files in the file views as a tree. If false, display the files as a flat list.
196
-
# This can be toggled from within Lazygit with the '`' key, but that will not change the default.
210
+
# If true, display the files in the file views as a tree. If false,
211
+
# display the files as a flat list.
212
+
# This can be toggled from within Lazygit with the '`' key, but that will
213
+
# not change the default.
197
214
showFileTree: true
198
215
199
-
# If true, add a "/" root item in the file tree representing the root of the repository. It is only added when necessary, i.e. when there is more than one item at top level.
216
+
# If true, add a "/" root item in the file tree representing the root of
217
+
# the repository. It is only added when necessary, i.e. when there is more
218
+
# than one item at top level.
200
219
showRootItemInFileTree: true
201
220
202
221
# If true, show the number of lines changed per file in the Files view
@@ -208,7 +227,9 @@ gui:
208
227
# If true, show the command log
209
228
showCommandLog: true
210
229
211
-
# If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.
230
+
# If true, show the bottom line that contains keybinding info and useful
231
+
# buttons. If false, this line will be hidden except to display a loader
232
+
# for an in-progress action.
212
233
showBottomLine: true
213
234
214
235
# If true, show jump-to-window keybindings in window titles.
@@ -219,13 +240,16 @@ gui:
219
240
# If empty, do not show icons.
220
241
nerdFontsVersion: ""
221
242
222
-
# If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.
243
+
# If true (default), file icons are shown in the file views. Only relevant
244
+
# if NerdFontsVersion is not empty.
223
245
showFileIcons: true
224
246
225
-
# Length of author name in (non-expanded) commits view. 2 means show initials only.
247
+
# Length of author name in (non-expanded) commits view. 2 means show
248
+
# initials only.
226
249
commitAuthorShortLength: 2
227
250
228
-
# Length of author name in expanded commits view. 2 means show initials only.
251
+
# Length of author name in expanded commits view. 2 means show
252
+
# initials only.
229
253
commitAuthorLongLength: 17
230
254
231
255
# Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.
@@ -243,18 +267,21 @@ gui:
243
267
244
268
# Whether to split the main window when viewing file changes.
245
269
# One of: 'auto' | 'always'
246
-
# If 'auto', only split the main window when a file has both staged and unstaged changes
270
+
# If 'auto', only split the main window when a file has both staged and
271
+
# unstaged changes
247
272
splitDiff: auto
248
273
249
-
# Default size for focused window. Can be changed from within Lazygit with '+' and '_' (but this won't change the default).
274
+
# Default size for focused window. Can be changed from within Lazygit
275
+
# with '+' and '_' (but this won't change the default).
250
276
# One of: 'normal' (default) | 'half' | 'full'
251
277
screenMode: normal
252
278
253
279
# Window border style.
254
280
# One of 'rounded' (default) | 'single' | 'double' | 'hidden' | 'bold'
255
281
border: rounded
256
282
257
-
# If true, show a seriously epic explosion animation when nuking the working tree.
283
+
# If true, show a seriously epic explosion animation when nuking the
284
+
# working tree.
258
285
animateExplosion: true
259
286
260
287
# Whether to stack UI components on top of each other.
@@ -287,14 +314,16 @@ gui:
287
314
# If true, jump to the Files panel after applying a stash
288
315
switchToFilesAfterStashApply: true
289
316
290
-
# If true, when using the panel jump keys (default 1 through 5) and target panel is already active, go to next tab instead
317
+
# If true, when using the panel jump keys (default 1 through 5) and target
318
+
# panel is already active, go to next tab instead
291
319
switchTabsWithPanelJumpKeys: false
292
320
293
321
# Config relating to git
294
322
git:
295
323
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md
296
324
paging:
297
-
# Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'
325
+
# Value of the --color arg in the git diff command. Some pagers want this
326
+
# to be set to 'always' and some want it set to 'never'
298
327
colorArg: always
299
328
300
329
# e.g.
@@ -306,7 +335,10 @@ git:
306
335
# e.g. 'difft --color=always'
307
336
externalDiffCommand: ""
308
337
309
-
# If true, Lazygit will use git's `diff.external` config for paging. The advantage over `externalDiffCommand` is that this can be configured per file type in .gitattributes; see https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
338
+
# If true, Lazygit will use git's `diff.external` config for paging. The
339
+
# advantage over `externalDiffCommand` is that this can be configured per
# If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang
357
+
# If true, run merges in a subprocess so that if a commit message is
358
+
# required, Lazygit will not hang.
326
359
# Only applicable to unix users.
327
360
manualCommit: false
328
361
329
362
# Extra args passed to `git merge`, e.g. --no-ff
330
363
args: ""
331
364
332
-
# The commit message to use for a squash merge commit. Can contain "{{selectedRef}}" and "{{currentBranch}}" placeholders.
365
+
# The commit message to use for a squash merge commit. Can contain
366
+
# "{{selectedRef}}" and "{{currentBranch}}" placeholders.
333
367
squashMergeMessage: Squash merge {{selectedRef}} into {{currentBranch}}
334
368
335
-
# list of branches that are considered 'main' branches, used when displaying commits
369
+
# list of branches that are considered 'main' branches, used when
370
+
# displaying commits
336
371
mainBranches:
337
372
- master
338
373
- main
339
374
340
-
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'
375
+
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit
376
+
# hooks will be skipped when the commit message starts with 'WIP'
341
377
skipHookPrefix: WIP
342
378
343
379
# If true, periodically fetch from remote
@@ -346,7 +382,10 @@ git:
346
382
# If true, periodically refresh files and submodules
347
383
autoRefresh: true
348
384
349
-
# If not "none", lazygit will automatically fast-forward local branches to match their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
385
+
# If not "none", lazygit will automatically fast-forward local branches
386
+
# to match their upstream after fetching. Applies to branches that are not
387
+
# the currently checked out branch, and only to those that are strictly
388
+
# behind their upstream (as opposed to diverged).
350
389
# Possible values: 'none' | 'onlyMainBranches' | 'allBranches'
351
390
autoForwardBranches: onlyMainBranches
352
391
@@ -362,17 +401,22 @@ git:
362
401
# Command used when displaying the current branch git log in the main window
# If true, git diffs are rendered with the `--ignore-all-space` flag, which ignores whitespace changes. Can be toggled from within Lazygit with `<c-w>`.
409
+
# If true, git diffs are rendered with the `--ignore-all-space` flag,
410
+
# which ignores whitespace changes. Can be toggled from within Lazygit
411
+
# with `<c-w>`.
370
412
ignoreWhitespaceInDiffView: false
371
413
372
-
# The number of lines of context to show around each diff hunk. Can be changed from within Lazygit with the `{` and `}` keys.
414
+
# The number of lines of context to show around each diff hunk. Can be
415
+
# changed from within Lazygit with the `{` and `}` keys.
373
416
diffContextSize: 3
374
417
375
-
# The threshold for considering a file to be renamed, in percent. Can be changed from within Lazygit with the `(` and `)` keys.
418
+
# The threshold for considering a file to be renamed, in percent. Can be
419
+
# changed from within Lazygit with the `(` and `)` keys.
376
420
renameSimilarityThreshold: 50
377
421
378
422
# If true, do not spawn a separate process when using GPG
@@ -397,29 +441,34 @@ git:
397
441
# Config for showing the log in the commits view
398
442
log:
399
443
# One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'
400
-
# 'topo-order' makes it easier to read the git log graph, but commits may not
401
-
# appear chronologically. See https://git-scm.com/docs/
444
+
# 'topo-order' makes it easier to read the git log graph, but commits may
445
+
#not appear chronologically. See https://git-scm.com/docs/
402
446
#
403
-
# Can be changed from within Lazygit with `Log menu -> Commit sort order` (`<c-l>` in the commits window by default).
447
+
# Can be changed from within Lazygit with `Log menu -> Commit sort order`
448
+
# (`<c-l>` in the commits window by default).
404
449
order: topo-order
405
450
406
451
# This determines whether the git graph is rendered in the commits panel
407
452
# One of 'always' | 'never' | 'when-maximised'
408
453
#
409
-
# Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>` in the commits window by default).
454
+
# Can be toggled from within lazygit with `Log menu -> Show git graph`
455
+
# (`<c-l>` in the commits window by default).
410
456
showGraph: always
411
457
412
-
# displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
458
+
# displays the whole git graph by default in the commits view (equivalent
459
+
# to passing the `--all` argument to `git log`)
413
460
showWholeGraph: false
414
461
415
462
# How branches are sorted in the local branches view.
416
463
# One of: 'date' (default) | 'recency' | 'alphabetical'
417
-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the branches panel.
464
+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in
465
+
# the branches panel.
418
466
localBranchSortOrder: date
419
467
420
468
# How branches are sorted in the remote branches view.
421
469
# One of: 'date' (default) | 'alphabetical'
422
-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the remote branches panel.
470
+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in
471
+
# the remote branches panel.
423
472
remoteBranchSortOrder: date
424
473
425
474
# When copying commit hashes to the clipboard, truncate them to this
@@ -447,10 +496,12 @@ refresher:
447
496
# If true, show a confirmation popup before quitting Lazygit
448
497
confirmOnQuit: false
449
498
450
-
# If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close
499
+
# If true, exit Lazygit when the user presses escape in a context where
500
+
# there is nothing to cancel/close
451
501
quitOnTopLevelReturn: false
452
502
453
-
# Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc
503
+
# Config relating to things outside of Lazygit like how files are opened,
504
+
# copying to clipboard, etc
454
505
os:
455
506
# Command for editing a file. Should contain "{{filename}}".
456
507
edit: ""
@@ -488,7 +539,10 @@ os:
488
539
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-and-pasting-from-clipboard
489
540
readFromClipboardCmd: ""
490
541
491
-
# A shell startup file containing shell aliases or shell functions. This will be sourced before running any shell commands, so that shell functions are available in the `:` command prompt or even in custom commands.
542
+
# A shell startup file containing shell aliases or shell functions. This
543
+
# will be sourced before running any shell commands, so that shell
544
+
# functions are available in the `:` command prompt or even in custom
545
+
# commands.
492
546
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#using-aliases-or-functions-in-shell-commands
493
547
shellFunctionsFile: ""
494
548
@@ -503,13 +557,15 @@ customCommands: []
503
557
services: {}
504
558
505
559
# What to do when opening Lazygit outside of a git repo.
506
-
# - 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo
560
+
# - 'prompt': (default) ask whether to initialize a new repo or open in
561
+
# the most recent repo
507
562
# - 'create': initialize a new repo
508
563
# - 'skip': open most recent repo
509
564
# - 'quit': exit Lazygit
510
565
notARepository: prompt
511
566
512
-
# If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.
567
+
# If true, display a confirmation when subprocess terminates. This allows
568
+
# you to view the output of the subprocess before returning to Lazygit.
0 commit comments