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.
Addresses
#800 (comment).
# 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.
67
+
# The number of spaces per tab; used for everything that's shown in the main
68
+
# view, but probably mostly relevant for diffs.
69
+
# Note that when using a pager, the pager has its own tab width setting, so you
70
+
# need to pass it separately in the pager command.
69
71
tabWidth: 4
70
72
71
73
# 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.
74
+
# When mouse events are captured, it's a little harder to select text: e.g.
75
+
# requiring you to hold the option key when on macOS.
73
76
mouseEvents: true
74
77
75
78
# If true, do not show a warning when amending a commit.
@@ -81,45 +84,57 @@ gui:
81
84
# If true, do not show warning when applying/popping the stash
82
85
skipStashWarning: false
83
86
84
-
# If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.
87
+
# If true, do not show a warning when attempting to commit without any staged
88
+
# files; instead stage all unstaged files.
85
89
skipNoStagedFilesWarning: false
86
90
87
91
# If true, do not show a warning when rewording a commit via an external editor
88
92
skipRewordInEditorWarning: false
89
93
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.
94
+
# Fraction of the total screen width to use for the left side section. You may
95
+
# want to pick a small number (e.g. 0.2) if you're using a narrow screen, so
96
+
# that you can see more of the main section.
91
97
# Number from 0 to 1.0.
92
98
sidePanelWidth: 0.3333
93
99
94
-
# If true, increase the height of the focused side window; creating an accordion effect.
100
+
# If true, increase the height of the focused side window; creating an accordion
101
+
# effect.
95
102
expandFocusedSidePanel: false
96
103
97
104
# 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
+
# twice as tall as the other panels. Only relevant if `expandFocusedSidePanel`
106
+
# is true.
99
107
expandedSidePanelWeight: 2
100
108
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.
109
+
# Sometimes the main window is split in two (e.g. when the selected file has
110
+
# both staged and unstaged changes). This setting controls how the two sections
111
+
# are split.
102
112
# Options are:
103
113
# - 'horizontal': split the window horizontally
104
114
# - 'vertical': split the window vertically
105
-
# - 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically
115
+
# - 'flexible': (default) split the window horizontally if the window is wide
116
+
# enough, otherwise split vertically
106
117
mainPanelSplitMode: flexible
107
118
108
-
# How the window is split when in half screen mode (i.e. after hitting '+' once).
119
+
# How the window is split when in half screen mode (i.e. after hitting '+'
120
+
# once).
109
121
# Possible values:
110
-
# - 'left': split the window horizontally (side panel on the left, main view on the right)
122
+
# - 'left': split the window horizontally (side panel on the left, main view on
123
+
# the right)
111
124
# - 'top': split the window vertically (side panel on top, main view below)
112
125
enlargedSideViewLocation: left
113
126
114
-
# If true, wrap lines in the staging view to the width of the view. This
115
-
#makes it much easier to work with diffs that have long lines, e.g.
116
-
#paragraphs of markdown text.
127
+
# If true, wrap lines in the staging view to the width of the view. This makes
128
+
# it much easier to work with diffs that have long lines, e.g. paragraphs of
129
+
# markdown text.
117
130
wrapLinesInStagingView: true
118
131
119
-
# If true, hunk selection mode will be enabled by default when entering the staging view.
132
+
# If true, hunk selection mode will be enabled by default when entering the
# One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko'
137
+
# | 'ru' | 'pt'
123
138
language: auto
124
139
125
140
# 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, display the
211
+
# files as a flat list.
212
+
# This can be toggled from within Lazygit with the '`' key, but that will not
213
+
# 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 the
217
+
# repository. It is only added when necessary, i.e. when there is more than one
218
+
# 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 for an
232
+
# in-progress action.
212
233
showBottomLine: true
213
234
214
235
# If true, show jump-to-window keybindings in window titles.
@@ -219,10 +240,12 @@ 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 if
244
+
# 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 initials
248
+
# only.
226
249
commitAuthorShortLength: 2
227
250
228
251
# Length of author name in expanded commits view. 2 means show initials only.
@@ -243,18 +266,21 @@ gui:
243
266
244
267
# Whether to split the main window when viewing file changes.
245
268
# One of: 'auto' | 'always'
246
-
# If 'auto', only split the main window when a file has both staged and unstaged changes
269
+
# If 'auto', only split the main window when a file has both staged and unstaged
270
+
# changes
247
271
splitDiff: auto
248
272
249
-
# Default size for focused window. Can be changed from within Lazygit with '+' and '_' (but this won't change the default).
273
+
# Default size for focused window. Can be changed from within Lazygit with '+'
274
+
# and '_' (but this won't change the default).
250
275
# One of: 'normal' (default) | 'half' | 'full'
251
276
screenMode: normal
252
277
253
278
# Window border style.
254
279
# One of 'rounded' (default) | 'single' | 'double' | 'hidden' | 'bold'
255
280
border: rounded
256
281
257
-
# If true, show a seriously epic explosion animation when nuking the working tree.
282
+
# If true, show a seriously epic explosion animation when nuking the working
283
+
# tree.
258
284
animateExplosion: true
259
285
260
286
# Whether to stack UI components on top of each other.
@@ -287,14 +313,16 @@ gui:
287
313
# If true, jump to the Files panel after applying a stash
288
314
switchToFilesAfterStashApply: true
289
315
290
-
# If true, when using the panel jump keys (default 1 through 5) and target panel is already active, go to next tab instead
316
+
# If true, when using the panel jump keys (default 1 through 5) and target panel
317
+
# is already active, go to next tab instead
291
318
switchTabsWithPanelJumpKeys: false
292
319
293
320
# Config relating to git
294
321
git:
295
322
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md
296
323
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'
324
+
# Value of the --color arg in the git diff command. Some pagers want this to be
325
+
# set to 'always' and some want it set to 'never'
298
326
colorArg: always
299
327
300
328
# e.g.
@@ -306,7 +334,10 @@ git:
306
334
# e.g. 'difft --color=always'
307
335
externalDiffCommand: ""
308
336
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.
337
+
# If true, Lazygit will use git's `diff.external` config for paging. The
338
+
# advantage over `externalDiffCommand` is that this can be configured per file
# If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang
356
+
# If true, run merges in a subprocess so that if a commit message is required,
357
+
# Lazygit will not hang
326
358
# Only applicable to unix users.
327
359
manualCommit: false
328
360
329
361
# Extra args passed to `git merge`, e.g. --no-ff
330
362
args: ""
331
363
332
-
# The commit message to use for a squash merge commit. Can contain "{{selectedRef}}" and "{{currentBranch}}" placeholders.
364
+
# The commit message to use for a squash merge commit. Can contain
365
+
# "{{selectedRef}}" and "{{currentBranch}}" placeholders.
333
366
squashMergeMessage: Squash merge {{selectedRef}} into {{currentBranch}}
334
367
335
-
# list of branches that are considered 'main' branches, used when displaying commits
368
+
# list of branches that are considered 'main' branches, used when displaying
369
+
# commits
336
370
mainBranches:
337
371
- master
338
372
- main
339
373
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'
374
+
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks
375
+
# will be skipped when the commit message starts with 'WIP'
341
376
skipHookPrefix: WIP
342
377
343
378
# If true, periodically fetch from remote
@@ -346,33 +381,40 @@ git:
346
381
# If true, periodically refresh files and submodules
347
382
autoRefresh: true
348
383
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).
384
+
# If not "none", lazygit will automatically fast-forward local branches to match
385
+
# their upstream after fetching. Applies to branches that are not the currently
386
+
# checked out branch, and only to those that are strictly behind their upstream
387
+
# (as opposed to diverged).
350
388
# Possible values: 'none' | 'onlyMainBranches' | 'allBranches'
351
389
autoForwardBranches: onlyMainBranches
352
390
353
391
# If true, pass the --all arg to git fetch
354
392
fetchAll: true
355
393
356
394
# If true, lazygit will automatically stage files that used to have merge
357
-
# conflicts but no longer do; and it will also ask you if you want to
358
-
#continue a merge or rebase if you've resolved all conflicts. If false, it
359
-
#won't do either of these things.
395
+
# conflicts but no longer do; and it will also ask you if you want to continue a
396
+
# merge or rebase if you've resolved all conflicts. If false, it won't do either
397
+
# of these things.
360
398
autoStageResolvedConflicts: true
361
399
362
400
# 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>`.
408
+
# If true, git diffs are rendered with the `--ignore-all-space` flag, which
409
+
# ignores whitespace changes. Can be toggled from within Lazygit with `<c-w>`.
370
410
ignoreWhitespaceInDiffView: false
371
411
372
-
# The number of lines of context to show around each diff hunk. Can be changed from within Lazygit with the `{` and `}` keys.
412
+
# The number of lines of context to show around each diff hunk. Can be changed
413
+
# from within Lazygit with the `{` and `}` keys.
373
414
diffContextSize: 3
374
415
375
-
# The threshold for considering a file to be renamed, in percent. Can be changed from within Lazygit with the `(` and `)` keys.
416
+
# The threshold for considering a file to be renamed, in percent. Can be changed
417
+
# from within Lazygit with the `(` and `)` keys.
376
418
renameSimilarityThreshold: 50
377
419
378
420
# If true, do not spawn a separate process when using GPG
@@ -400,30 +442,35 @@ git:
400
442
# 'topo-order' makes it easier to read the git log graph, but commits may not
401
443
# appear chronologically. See https://git-scm.com/docs/
402
444
#
403
-
# Can be changed from within Lazygit with `Log menu -> Commit sort order` (`<c-l>` in the commits window by default).
445
+
# Can be changed from within Lazygit with `Log menu -> Commit sort order`
446
+
# (`<c-l>` in the commits window by default).
404
447
order: topo-order
405
448
406
449
# This determines whether the git graph is rendered in the commits panel
407
450
# One of 'always' | 'never' | 'when-maximised'
408
451
#
409
-
# Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>` in the commits window by default).
452
+
# Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>`
453
+
# in the commits window by default).
410
454
showGraph: always
411
455
412
-
# displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
456
+
# displays the whole git graph by default in the commits view (equivalent to
457
+
# passing the `--all` argument to `git log`)
413
458
showWholeGraph: false
414
459
415
460
# How branches are sorted in the local branches view.
416
461
# One of: 'date' (default) | 'recency' | 'alphabetical'
417
-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the branches panel.
462
+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the
463
+
# branches panel.
418
464
localBranchSortOrder: date
419
465
420
466
# How branches are sorted in the remote branches view.
421
467
# One of: 'date' (default) | 'alphabetical'
422
-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the remote branches panel.
468
+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the
469
+
# remote branches panel.
423
470
remoteBranchSortOrder: date
424
471
425
-
# When copying commit hashes to the clipboard, truncate them to this
426
-
#length. Set to 40 to disable truncation.
472
+
# When copying commit hashes to the clipboard, truncate them to this length. Set
473
+
# to 40 to disable truncation.
427
474
truncateCopiedCommitHashesTo: 12
428
475
429
476
# Periodic update checks
@@ -447,10 +494,12 @@ refresher:
447
494
# If true, show a confirmation popup before quitting Lazygit
448
495
confirmOnQuit: false
449
496
450
-
# If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close
497
+
# If true, exit Lazygit when the user presses escape in a context where there is
498
+
# nothing to cancel/close
451
499
quitOnTopLevelReturn: false
452
500
453
-
# Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc
501
+
# Config relating to things outside of Lazygit like how files are opened,
502
+
# copying to clipboard, etc
454
503
os:
455
504
# Command for editing a file. Should contain "{{filename}}".
456
505
edit: ""
@@ -459,8 +508,8 @@ os:
459
508
# "{{filename}}", and may optionally contain "{{line}}".
460
509
editAtLine: ""
461
510
462
-
# Same as EditAtLine, except that the command needs to wait until the
463
-
#window is closed.
511
+
# Same as EditAtLine, except that the command needs to wait until the window is
512
+
# closed.
464
513
editAtLineAndWait: ""
465
514
466
515
# Whether lazygit suspends until an edit process returns
@@ -469,12 +518,12 @@ os:
469
518
# For opening a directory in an editor
470
519
openDirInEditor: ""
471
520
472
-
# A built-in preset that sets all of the above settings. Supported presets
473
-
#are defined in the getPreset function in editor_presets.go.
521
+
# A built-in preset that sets all of the above settings. Supported presets are
522
+
# defined in the getPreset function in editor_presets.go.
474
523
editPreset: ""
475
524
476
-
# Command for opening a file, as if the file is double-clicked. Should
477
-
#contain "{{filename}}", but doesn't support "{{line}}".
525
+
# Command for opening a file, as if the file is double-clicked. Should contain
526
+
# "{{filename}}", but doesn't support "{{line}}".
478
527
open: ""
479
528
480
529
# Command for opening a link. Should contain "{{link}}".
@@ -488,7 +537,9 @@ os:
488
537
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-and-pasting-from-clipboard
489
538
readFromClipboardCmd: ""
490
539
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.
540
+
# A shell startup file containing shell aliases or shell functions. This will be
541
+
# sourced before running any shell commands, so that shell functions are
542
+
# available in the `:` command prompt or even in custom commands.
492
543
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#using-aliases-or-functions-in-shell-commands
493
544
shellFunctionsFile: ""
494
545
@@ -503,13 +554,15 @@ customCommands: []
503
554
services: {}
504
555
505
556
# 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
557
+
# - 'prompt': (default) ask whether to initialize a new repo or open in the most
558
+
# recent repo
507
559
# - 'create': initialize a new repo
508
560
# - 'skip': open most recent repo
509
561
# - 'quit': exit Lazygit
510
562
notARepository: prompt
511
563
512
-
# If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.
564
+
# If true, display a confirmation when subprocess terminates. This allows you to
565
+
# view the output of the subprocess before returning to Lazygit.
0 commit comments