plugins.lazygit.settings

The configuration options for lazygit without the lazygit_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal lazygit_foo_bar=1
  • hello = "world" -> :setglobal lazygit_hello="world"
  • some_toggle = true -> :setglobal lazygit_some_toggle
  • other_toggle = false -> :setglobal nolazygit_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  config_file_path = [ ];
  floating_window_border_chars = [
    "╭"
    "─"
    "╮"
    "│"
    "╯"
    "─"
    "╰"
    "│"
  ];
  floating_window_scaling_factor = 0.9;
  floating_window_use_plenary = 0;
  floating_window_winblend = 0;
  use_custom_config_file_path = 0;
  use_neovim_remote = 1;
}

Declared by:

plugins.lazygit.settings.config_file_path

Custom config file path or list of custom config file paths.

Type: null or string or list of string

Default: null

Plugin default: [ ]

Declared by:

plugins.lazygit.settings.floating_window_border_chars

Customize lazygit popup window border characters.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "╭"
  "─"
  "╮"
  "│"
  "╯"
  "─"
  "╰"
  "│"
]

Declared by:

plugins.lazygit.settings.floating_window_scaling_factor

Set the scaling factor for floating window.

Type: null or (nonnegative integer or floating point number, meaning >=0)

Default: null

Plugin default: 0.9

Declared by:

plugins.lazygit.settings.floating_window_use_plenary

Whether to use plenary.nvim to manage floating window if available.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.lazygit.settings.floating_window_winblend

Set the transparency of the floating window.

Type: null or integer between 0 and 100 (both inclusive)

Default: null

Plugin default: 0

Declared by:

plugins.lazygit.settings.use_custom_config_file_path

Config file path is evaluated if this value is 1.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.lazygit.settings.use_neovim_remote

Whether to use neovim remote. Will fallback to 0 if neovim-remote is not installed.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 1

Declared by: