Appendix B. Neovim Flake Configuration Options

Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath.

This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument name which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute.

Some arguments are already passed by default, of which the following cannot be changed with this option:

For NixOS, the default value for this option includes at least this argument:

Type: lazy attribute set of raw value

Declared by:

Follow editorconfig rules in current directory

Type: boolean

Default: true

Declared by:

the experimental Lua module loader to speed up the start up process

If true, this will enable the experimental Lua module loader which:

Type: boolean

Default: false

Example: true

Declared by:

The neovim package to use for the wrapper. This corresponds to the package that will be wrapped with your plugins and settings.

Type: package

Default: <derivation neovim-unwrapped-0.10.2>

Declared by:

Additional runtime paths that will be appended to the active runtimepath of the Neovim. This can be used to add additional lookup paths for configs, plugins, spell languages and other things you would generally place in your $HOME/.config/nvim.

This is meant as a declarative alternative to throwing files into ~/.config/nvim and having the Neovim wrapper pick them up. For more details on vim.o.runtimepath, and what paths to use; please see the official documentation

Type: list of (path or string)

Default: [ ]

Example:

[
  # absolute path, as a string - impure
  "$HOME/.config/nvim-extra"

  # relative path, as a path - pure
  ./nvim

  # source type path - pure and reproducible
  (builtins.source {
    path = ./runtime;
    name = "nvim-runtime";
  })
]

Declared by:

Whether to enable ChatGPT AI assistant. Requires the environment variable OPENAI_API_KEY to be set.

Type: boolean

Default: false

Example: true

Declared by:

[ChatGPT] Add tests

Type: null or string

Default: "<leader>aa"

Declared by:

ChatGPT

Type: null or string

Default: "<leader>ac"

Declared by:

[ChatGPT] Docstring

Type: null or string

Default: "<leader>ad"

Declared by:

[ChatGPT] Edit with instructions

Type: null or string

Default: "<leader>ae"

Declared by:

[ChatGPT] Explain code

Type: null or string

Default: "<leader>ax"

Declared by:

[ChatGPT] Fix bugs

Type: null or string

Default: "<leader>af"

Declared by:

[ChatGPT] Grammar correction

Type: null or string

Default: "<leader>ag"

Declared by:

[ChatGPT] Keywords

Type: null or string

Default: "<leader>ak"

Declared by:

[ChatGPT] Optimize code

Type: null or string

Default: "<leader>ao"

Declared by:

[ChatGPT] Code reability analysis

Type: null or string

Default: "<leader>al"

Declared by:

[ChatGPT] Roxygen edit

Type: null or string

Default: "<leader>ar"

Declared by:

[ChatGPT] Summarize

Type: null or string

Default: "<leader>as"

Declared by:

[ChatGPT] Translate

Type: null or string

Default: "<leader>at"

Declared by:

Option table to pass into the setup function of chatgpt

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Whether to enable GitHub Copilot AI assistant.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable nvim-cmp integration for GitHub Copilot.

Type: boolean

Default: false

Example: true

Declared by:

Accept suggestion

Type: null or string

Default: "<CR>"

Declared by:

Jump to next suggestion

Type: null or string

Default: "]]"

Declared by:

Jump to previous suggestion

Type: null or string

Default: "[["

Declared by:

Open suggestions

Type: null or string

Default: "<M-CR>"

Declared by:

Refresh suggestions

Type: null or string

Default: "gr"

Declared by:

Accept suggetion

Type: null or string

Default: "<M-l>"

Declared by:

Accept next line

Type: null or string

Default: null

Declared by:

Accept next word

Type: null or string

Default: null

Declared by:

Dismiss suggestion

Type: null or string

Default: "<C-]>"

Declared by:

Next suggestion

Type: null or string

Default: "<M-]>"

Declared by:

Previous suggestion

Type: null or string

Default: "<M-[>"

Declared by:

Option table to pass into the setup function of Copilot

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

The command that will be executed to initiate nodejs for GitHub Copilot. Recommended to leave as default.

Type: string

Default: "\${pkgs.nodejs-slim.out}/bin/node"

Declared by:

Whether to enable Completion Panel.

Type: boolean

Default: true

Example: true

Declared by:

Panel position

Type: one of “bottom”, “top”, “left”, “right”

Default: "bottom"

Declared by:

Panel size

Type: floating point number

Default: 0.4

Declared by:

Whether to enable Suggestions.

Type: boolean

Default: true

Example: true

Declared by:

Whether to enable nvim-cmp.

Type: boolean

Default: false

Example: true

Declared by:

The function used to customize the completion menu entries. This is outside of setupOpts to allow for an easier integration with lspkind.nvim.

See :help cmp-config.formatting.format.

Type: null or (luaInline)

Default:

function(entry, vim_item)
  vim_item.menu = (${toLuaObject config.vim.autocomplete.nvim-cmp.sources})[entry.source.name]
  return vim_item
end

Declared by:

Close [nvim-cmp]

Type: null or string

Default: "<C-e>"

Declared by:

Complete [nvim-cmp]

Type: null or string

Default: "<C-Space>"

Declared by:

Confirm [nvim-cmp]

Type: null or string

Default: "<CR>"

Declared by:

Next item [nvim-cmp]

Type: null or string

Default: "<Tab>"

Declared by:

Previous item [nvim-cmp]

Type: null or string

Default: "<S-Tab>"

Declared by:

Scroll docs down [nvim-cmp]

Type: null or string

Default: "<C-f>"

Declared by:

Scroll docs up [nvim-cmp]

Type: null or string

Default: "<C-d>"

Declared by:

Option table to pass into the setup function of the autocomplete plugin

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

A comma-separated list of options for completion.

See :help completeopt for the complete list.

Type: string

Default: "menu,menuone,noinsert"

Declared by:

The comparator functions used for sorting completions.

You can either pass a valid inline lua function (see :help cmp-config.sorting.comparators), or a string, in which case the builtin comparator with that name will be used.

A deprio function and a kinds (require("cmp.types").lsp.CompletionItemKind) variable is provided above setupOpts. By passing a type to the function, the returned function will be a comparator that always ranks the specified kind the lowest.

Type: mergeless list of (string or (luaInline))

Default:

[
  {
    _type = "lua-inline";
    expr = "deprio(kinds.Text)";
  }
  {
    _type = "lua-inline";
    expr = "deprio(kinds.Snippet)";
  }
  "offset"
  "exact"
  "score"
  "kind"
  "length"
  "sort_text"
]

Declared by:

List of source plugins used by nvim-cmp.

Type: list of (null or package or one of “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “registers”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)

Default: [ ]

Declared by:

The list of sources used by nvim-cmp

Type: attribute set of (null or string)

Default: { }

Example:

{
  nvim-cmp = null;
  buffer = "[Buffer]";
}

Declared by:

Whether to enable autopairs.

Type: boolean

Default: false

Example: true

Declared by:

Option table to pass into the setup function of nvim-autopairs

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Set how bells are handled. Options: on, visual or none

Type: one of “none”, “visual”, “on”

Default: "none"

Declared by:

Whether to enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable which-key keybind helper menu.

Type: boolean

Default: false

Example: true

Declared by:

Register label for which-key keybind helper menu

Type: attribute set of (null or string)

Default: { }

Declared by:

Option table to pass into the setup function of which-key

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Show a warning when issues were detected with mappings

Type: boolean

Default: true

Declared by:

The default preset for the which-key window

Type: one of “classic”, “modern”, “helix”

Default: "modern"

Declared by:

Functions/Lua Patterns for formatting the labels

Type: attribute set

Default:

{
  "<cr>" = "RETURN";
  "<leader>" = "SPACE";
  "<space>" = "SPACE";
  "<tab>" = "TAB";
}

Declared by:

Which-key window border style

Type: string

Default: "rounded"

Declared by:

Whether to enable smart and powerful comment plugin for neovim comment-nvim.

Type: boolean

Default: false

Example: true

Declared by:

Toggle current block comment

Type: null or string

Default: "gbc"

Declared by:

Toggle current line comment

Type: null or string

Default: "gcc"

Declared by:

Toggle block comment

Type: null or string

Default: "gb"

Declared by:

Toggle line comment

Type: null or string

Default: "gc"

Declared by:

Toggle selected block

Type: null or string

Default: "gb"

Declared by:

Toggle selected comment

Type: null or string

Default: "gc"

Declared by:

Option table to pass into the setup function of Comment-nvim

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Whether to enable basic mappings.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable extra mappings.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable fast and fully programmable greeter for neovim [alpha.mvim].

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Fancy and Blazing Fast start screen plugin of neovim [dashboard.nvim].

Type: boolean

Default: false

Example: true

Declared by:

Option table to pass into the setup function of dashboard.nvim

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Whether to enable dashboard via vim-startify.

Type: boolean

Default: false

Example: true

Declared by:

List of book marks to disaply on start page

Type: list of (attribute set)

Default: [ ]

Example:

{
  c = "~/.vimrc";
}

Declared by:

Command to change the current window with. Can be cd, lcd or tcd

Type: one of “cd”, “lcd”, “tcd”

Default: "lcd"

Declared by:

Should vim change to the directory of the file you open

Type: boolean

Default: true

Declared by:

Should vim change to the version control root when opening a file

Type: boolean

Default: false

Declared by:

Commands that are presented to the user on startify page

Type: list of (string or (attribute set) or list of string)

Default: [ ]

Declared by:

Text to place in the footer

Type: list of string

Default: [ ]

Declared by:

Text to place in the header

Type: list of string

Default: [ ]

Declared by:

Specify a list of default characters to use instead of numbers

Type: list of string

Default: [ ]

Declared by:

Prevent startify from opening on startup but can be called with :Startify

Type: boolean

Default: false

Declared by:

How many files to list

Type: signed integer

Default: 10

Declared by:

Specify the lists and in what order they are displayed on startify.

Type: list of (attribute set)

Default:

[
  {
    header = [
      "MRU"
    ];
    type = "files";
  }
  {
    header = [
      "MRU Current Directory"
    ];
    type = "dir";
  }
  {
    header = [
      "Sessions"
    ];
    type = "sessions";
  }
  {
    header = [
      "Bookmarks"
    ];
    type = "bookmarks";
  }
  {
    header = [
      "Commands"
    ];
    type = "commands";
  }
]

Declared by:

Number of spaces used for left padding.

Type: signed integer

Default: 3

Declared by:

Make startify auto load Session.vim files from the current directory

Type: boolean

Default: false

Declared by:

Commands to run before saving a session

Type: list of string

Default: [ ]

Declared by:

Delete all buffers when loading or closing a session

Type: boolean

Default: true

Declared by:

Directory to save and load sessions from

Type: string

Default: "~/.vim/session"

Declared by:

Persist session before leaving vim or switching session

Type: boolean

Default: false

Declared by:

Patterns to remove from session files

Type: list of string

Default: [ ]

Declared by:

List of commands to run when loading a session.

Type: list of string

Default: [ ]

Declared by:

List of variables to save into a session file.

Type: list of string

Default: [ ]

Declared by:

Set if you want items sorted by date rather than alphabetically

Type: boolean

Default: false

Declared by:

List of regex patterns to exclude from MRU lists

Type: list of string

Default: [ ]

Declared by:

List of vim servers to not load startify for

Type: list of string

Default: [ ]

Declared by:

Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list

Type: boolean

Default: false

Declared by:

Set if you want startify to always update and not just when neovim closes

Type: boolean

Default: false

Declared by:

Show environment variables in path if name is shorter than value

Type: boolean

Default: false

Declared by:

Whether to enable debug mode.

Type: boolean

Default: false

Example: true

Declared by:

Set verbosity level of Neovim while debug mode is enabled.

Value must be be one of the levels expected by Neovim’s verbose option

Type: one of 2, 3, 4, 5, 8, 9, 11, 12, 13, 14, 15, 16

Default: 16

Declared by:

Set the log file that will be used to store verbose messages set by the verbose option.

Type: null or path

Default: null

Declared by:

Whether to enable debugging via nvim-dap.

Type: boolean

Default: false

Example: true

Declared by:

Continue

Type: null or string

Default: "<leader>dc"

Declared by:

Go down stacktrace

Type: null or string

Default: "<leader>dvi"

Declared by:

Go up stacktrace

Type: null or string

Default: "<leader>dvo"

Declared by:

Hover

Type: null or string

Default: "<leader>dh"

Declared by:

Restart

Type: null or string

Default: "<leader>dR"

Declared by:

Re-run Last Debug Session

Type: null or string

Default: "<leader>d."

Declared by:

Continue to the current cursor

Type: null or string

Default: "<leader>dgc"

Declared by:

Step back

Type: null or string

Default: "<leader>dgk"

Declared by:

Step into function

Type: null or string

Default: "<leader>dgi"

Declared by:

Step out of function

Type: null or string

Default: "<leader>dgo"

Declared by:

Next step

Type: null or string

Default: "<leader>dgj"

Declared by:

Terminate

Type: null or string

Default: "<leader>dq"

Declared by:

Toggle breakpoint

Type: null or string

Default: "<leader>db"

Declared by:

Toggle DAP-UI

Type: null or string

Default: "<leader>du"

Declared by:

Toggle Repl

Type: null or string

Default: "<leader>dr"

Declared by:

List of debuggers to install

Type: attribute set of string

Default: { }

Declared by:

Whether to enable UI extension for nvim-dap.

Type: boolean

Default: false

Example: true

Declared by:

Automatically Opens and Closes DAP-UI upon starting/closing a debugging session

Type: boolean

Default: true

Declared by:

Option table to pass into the setup function of nvim-dap-ui

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Set to prevent arrow keys from moving cursor

Type: boolean

Default: false

Declared by:

Additional lua files that will be sourced by Neovim. Takes both absolute and relative paths, all of which will be called via the luafile command in Neovim.

See lua-commands on the Neovim documentation for more details.

Type: list of (path or string)

Default: [ ]

Example:

[
  # absolute path, as a string - impure
  "$HOME/.config/nvim/my-lua-file.lua"

  # relative path, as a path - pure
  ./nvim/my-lua-file.lua

  # source type path - pure and reproducible
  (builtins.source {
    path = ./nvim/my-lua-file.lua;
    name = "my-lua-file";
  })
]

Declared by:

List of additional packages to make available to the Neovim wrapper.

Type: list of package

Default: [ ]

Example: "[pkgs.fzf pkgs.ripgrep]"

Declared by:

A list of plugins and their configurations that will be set up after builtin plugins.

This option takes a special type that allows you to order your custom plugins using nvf’s modified DAG library.

Type: attribute set of (submodule)

Default: { }

Example:

with pkgs.vimPlugins; {
  aerial = {
    package = aerial-nvim;
    setup = "require('aerial').setup {}";
  };

  harpoon = {
    package = harpoon;
    setup = "require('harpoon').setup {}";
    after = ["aerial"]; # place harpoon configuration after aerial
  };
}

Declared by:

Plugin Package.

Type: null or package or one of “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “registers”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”

Declared by:

Setup this plugin after the following ones.

Type: list of string

Default: [ ]

Declared by:

Lua code to run during setup.

Type: strings concatenated with “\n”

Default: ""

Example: "require('aerial').setup {}"

Declared by:

Whether to enable filetree via neo-tree.nvim.

Type: boolean

Default: false

Example: true

Declared by:

Option table to pass into the setup function of neo-tree

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Whether to enable cursor hijacking.

If enabled neotree will keep the cursor on the first letter of the filename when moving in the tree .

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable diagnostics.

Type: boolean

Default: true

Example: true

Declared by:

Whether to enable git status.

Type: boolean

Default: true

Example: true

Declared by:

Whether to enable markers for files with unsaved changes…

Type: boolean

Default: true

Example: true

Declared by:

Whether to enable tracking of opened files.

Required for components.name.highlight_opened_files .

Type: boolean

Default: true

Example: true

Declared by:

Whether to enable Refresh the tree when a file is written.

Only used if use_libuv_file_watcher is false. .

Type: boolean

Default: true

Example: true

Declared by:

Whether to add a blank line at the top of the tree

Type: boolean

Default: false

Declared by:

Whether to automatically clean up broken neo-tree buffers saved in sessions

Type: boolean

Default: false

Declared by:

You can choose a specific source.

last here which indicates the last used source

Type: string

Default: "filesystem"

Declared by:

Hijack Netrw behavior

Type: one of “disabled”, “open_default”, “open_current”

Default: "open_default"

Declared by:

Whether to enable async git status.

This will make the git status check async and will not block the UI. .

Type: boolean

Default: false

Example: true

Declared by:

Whether to hide the root node of the tree

Type: boolean

Default: false

Declared by:

Log level for the plugin.

Type: one of “trace”, “debug”, “info”, “warn”, “error”, “fatal”

Default: "info"

Declared by:

Must be either a boolean or a path to your log file.

Use :NeoTreeLogs to show the file

Type: boolean or string

Default: false

Example: /tmp/neo-tree.log

Declared by:

A list of filetypes that should not be replaced when opening a file

Type: list of string

Default:

[
  "terminal"
  "Trouble"
  "qf"
  "edgy"
]

Declared by:

Whether to open files in the last window

If disabled, neo-tree will open files in top left window

Type: boolean

Default: true

Declared by:

Whether to retain the indent of the hidden root node

IF the root node is hidden, keep the indentation anyhow. This is needed if you use expanders because they render in the indent.

Type: boolean

Default: false

Declared by:

Whether to enable filetree via nvim-tree.lua.

Type: boolean

Default: false

Example: true

Declared by:

Find file in NvimTree

Type: null or string

Default: "<leader>tg"

Declared by:

Focus NvimTree

Type: null or string

Default: "<leader>tf"

Declared by:

Refresh NvimTree

Type: null or string

Default: "<leader>tr"

Declared by:

Toggle NvimTree

Type: null or string

Default: "<leader>t"

Declared by:

Open when vim is started on a directory

Type: boolean

Default: true

Declared by:

Option table to pass into the setup function of Nvim Tree

You can pass in any additional options even if they’re not listed in the docs

Type: anything

Default: { }

Declared by:

Configuration for various actions.

Type: submodule

Default: { }

Declared by:

vim change-directory behaviour

Type: submodule

Default: { }

Declared by:

Change the working directory when changing directories in the tree.

Type: boolean

Default: true

Declared by:

Use :cd instead of :lcd when changing directories. Consider that this might cause issues with the nvimTree.syncRootWithCwd option.

Type: boolean

Default: false

Declared by:

Restrict changing to a directory above the global current working directory.

Type: boolean

Default: false

Declared by:

Configuration for expand_all behaviour.

Type: submodule

Default: { }

Declared by:

A list of directories that should not be expanded automatically.

Type: list of string

Default:

[
  ".git"
  "target"
  "build"
  "result"
]

Declared by:

Limit the number of folders being explored when expanding every folders. Avoids hanging neovim when running this action on very large folders.

Type: signed integer

Default: 300

Declared by:

Configuration for file_popup behaviour.

Type: submodule

Default: { }

Declared by:

Floating window config for file_popup. See |nvim_open_win| for more details.

Type: attribute set

Default:

{
  border = "rounded";
  col = 1;
  relative = "cursor";
  row = 1;
  style = "minimal";
}

Declared by:

Configuration options for opening a file from nvim-tree.

Type: submodule

Default: { }

Declared by:

Prevent new opened file from opening in the same window as the tree.

Type: boolean

Default: false

Declared by:

Closes the explorer when opening a file.

Type: boolean

Default: false

Declared by:

Resizes the tree when opening a file. Previously view.auto_resize

Type: boolean

Default: false

Declared by:

window_picker

Type: submodule

Default: { }

Declared by:

Enable the window picker. If this feature is not enabled, files will open in window from which you last opened the tree.

Type: boolean

Default: false

Declared by:

A string of chars used as identifiers by the window picker.

Type: string

Default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

Declared by:

A list of buftypes to exclude from the window picker.

Type: list of string

Default:

[
  "nofile"
  "terminal"
  "help"
]

Declared by:

A list of filetypes to exclude from the window picker.

Type: list of string

Default:

[
  "notify"
  "packer"
  "qf"
  "diff"
  "fugitive"
  "fugitiveblame"
]

Declared by:

Change the default window picker, can be a string "default" or a function. The function should return the window id that will open the node, or nil if an invalid window is picked or user cancelled the action.

The picker may create a new window.

Type: string

Default: "default"

Example:

-- with s1n7ax/nvim-window-picker plugin
require('window-picker').pick_window,

Declared by:

Close any window displaying a file when removing the file from the tree

Type: boolean

Default: true

Declared by:

A boolean value that toggle the use of system clipboard when copy/paste function are invoked. When enabled, copied text will be stored in registers ‘+’ (system), otherwise, it will be stored in ‘1’ and ‘"’.

Type: boolean

Default: true

Declared by:

Auto reload tree on write

Type: boolean

Default: true

Declared by:

Show LSP and COC diagnostics in the signcolumn Note that the modified sign will take precedence over the diagnostics signs.

Type: submodule

Default: { }

Declared by:

Whether to enable diagnostics view in the signcolumn…

Type: boolean

Default: false

Example: true

Declared by:

Idle milliseconds between diagnostic event and update.

Type: signed integer

Default: 50

Declared by:

Icons for diagnostic severity.

Type: submodule

Default: { }

Declared by:

Icon used for error diagnostic.

Type: string

Default: ""

Declared by:

Icon used for hint diagnostic.

Type: string

Default: ""

Declared by:

Icon used for info diagnostic.

Type: string

Default: ""

Declared by:

Icon used for warning diagnostic.

Type: string

Default: ""

Declared by:

Severity for which the diagnostics will be displayed. See :help diagnostic-severity

Type: submodule

Default: { }

Declared by:

Maximum severity.

Type: one of “HINT”, “INFO”, “WARNING”, “ERROR”

Default: "ERROR"

Declared by:

Minimum severity.

Type: one of “HINT”, “INFO”, “WARNING”, “ERROR”

Default: "HINT"

Declared by:

Show diagnostic icons on parent directories.

Type: unspecified value

Default: false

Declared by:

Show diagnostics icons on directories that are open. Only relevant when diagnostics.show_on_dirs is true.

Type: boolean

Default: true

Declared by:

Disables netrw and replaces it with tree

Type: boolean

Default: false

Declared by:

Will use file system watcher (libuv fs_event) to watch the filesystem for changes. Using this will disable BufEnter / BufWritePost events in nvim-tree which were used to update the whole tree. With this feature, the tree will be updated only for the appropriate folder change, resulting in better performance.

Type: submodule

Default: { }

Declared by:

Enable filesystem watchers.

Type: boolean

Default: true

Declared by:

Idle milliseconds between filesystem change and action.

Type: signed integer

Default: 50

Declared by:

List of vim regex for absolute directory paths that will not be watched. Backslashes must be escaped e.g. "my-project/\\.build$". Useful when path is not in .gitignore or git integration is disabled.

Type: list of string

Default: [ ]

Declared by:

Filtering options.

Type: submodule

Default:

{
  dotfiles = false;
  exclude = [ ];
  git_clean = false;
  git_ignored = false;
  no_buffer = false;
}

Declared by:

Do not show dotfiles: files starting with a .

Type: boolean

Default: false

Declared by:

List of directories or files to exclude from filtering: always show them.

Type: list of string

Default: [ ]

Declared by:

Do not show files with no git status. This will show ignored files when nvimTree.filters.gitIgnored is set, as they are effectively dirty.

Type: boolean

Default: false

Declared by:

Ignore files based on .gitignore. Requires git.enableto betrue`

Type: boolean

Default: false

Declared by:

Do not show files that have no buflisted() buffer.

Type: boolean

Default: false

Declared by:

Whether to enable Git integration with icons and colors…

Type: boolean

Default: false

Example: true

Declared by:

Disable git integration when git top-level matches these paths. May be relative, evaluated via ":p"

Type: list of string

Default: [ ]

Declared by:

Show git icons on parent directories.

Type: boolean

Default: true

Declared by:

Show git icons on directories that are open.

Type: boolean

Default: true

Declared by:

Kills the git process after some time if it takes too long. Git integration will be disabled after 10 git jobs exceed this timeout.

Type: signed integer

Default: 400

Declared by:

Hijack the cursor in the tree to put it at the start of the filename

Type: boolean

Default: false

Declared by:

Enable the hijack_directories feature. Disable this option if you use vim-dirvish or dirbuf.nvim. If hijack_netrw and disable_netrw are false, this feature will be disabled.

Type: boolean

Default: true

Declared by:

Opens the tree if the tree was previously closed.

Type: boolean

Default: false

Declared by:

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

Open nvimtree in place of the unnamed buffer if it’s empty.

Type: boolean

Default: false

Declared by:

Configurations for the live_filtering feature. The live filter allows you to filter the tree nodes dynamically, based on regex matching (see vim.regex). This feature is bound to the f key by default. The filter can be cleared with the F key by default.

Type: submodule

Default: { }

Declared by:

Whether to filter folders or not.

Type: boolean

Default: true

Declared by:

Prefix of the filter displayed in the buffer.

Type: string

Default: "[FILTER]: "

Declared by:

Indicate which file have unsaved modification.

Type: submodule

Default: { }

Declared by:

Whether to enable Modified files with icons and color highlight…

Type: boolean

Default: false

Example: true

Declared by:

Show modified icons on parent directories.

Type: boolean

Default: true

Declared by:

Show modified icons on directories that are open.

Type: boolean

Default: true

Declared by:

Configuration for notifications.

Type: submodule

Default: { }

Declared by:

Whether to use absolute paths or item names in fs action notifications.

Type: boolean

Default: true

Declared by:

Specify minimum notification level, uses the values from vim.log.levels

Type: one of “ERROR”, “WARNING”, “INFO”, “DEBUG”

Default: "INFO"

Declared by:

Prefer startup root directory when updating root directory of the tree. Only relevant when update_focused_file.update_root is true

Type: boolean

Default: false

Declared by:

Automatically reloads the tree on BufEnter nvim-tree.

Type: boolean

Default: false

Declared by:

Appends a trailing slash to folder names.

Type: boolean

Default: false

Declared by:

Display node whose name length is wider than the width of nvim-tree window in floating window.

Type: boolean

Default: false

Declared by:

Compact folders that only contain a single folder into one node in the file tree.

Type: boolean

Default: false

Declared by:

Enable file highlight for git attributes using NvimTreeGit highlight groups. Requires nvimTree.git.enable This can be used with or without the icons.

Type: boolean

Default: false

Declared by:

Highlight modified files in the tree using NvimTreeNormal highlight group. Requires nvimTree.view.highlightOpenedFiles

Type: one of “none”, “icon”, “name”, “all”

Default: "none"

Declared by:

Highlight icons and/or names for bufloaded() files using the NvimTreeOpenedFile highlight group.

Type: one of “none”, “icon”, “name”, “all”

Default: "none"

Declared by:

Configuration options for icons.

Type: submodule

Default: { }

Declared by:

Place where the git icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Type: one of “before”, “after”, “signcolumn”

Default: "before"

Declared by:

Configuration options for icon glyphs. NOTE: Do not set any glyphs to more than two characters if it’s going to appear in the signcolumn.

Type: submodule

Default: { }

Declared by:

Glyph for files. Will be overridden by nvim-web-devicons if available.

Type: string

Default: ""

Declared by:

Glyphs for directories. Recommended to use the defaults unless you know what you are doing.

Type: attribute set

Default:

{
  arrow_closed = "";
  arrow_open = "";
  default = "";
  empty = "";
  empty_open = "";
  open = "";
  symlink = "";
  symlink_open = "";
}

Declared by:

Glyphs for git status.

Type: attribute set

Default:

{
  deleted = "";
  ignored = "◌";
  renamed = "➜";
  staged = "✓";
  unmerged = "";
  unstaged = "✗";
  untracked = "★";
}

Declared by:

Icon to display for modified files.

Type: string

Default: ""

Declared by:

Glyph for symlinks.

Type: string

Default: ""

Declared by:

Place where the modified icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Type: one of “before”, “after”, “signcolumn”

Default: "after"

Declared by:

Inserted between icon and filename

Type: string

Default: " "

Declared by:

Show an icon before the file name. nvim-web-devicons will be used if available.

Type: boolean

Default: true

Declared by:

Show an icon before the folder name.

Type: boolean

Default: true

Declared by:

Show a small arrow before the folder node. Arrow will be a part of the node when using renderer.indent_markers.

Type: boolean

Default: true

Declared by:

Show a git status icon, see renderer.icons.gitPlacement Requires git.enable to be true.

Type: boolean

Default: false

Declared by:

Show a modified icon, see renderer.icons.modifiedPlacement Requires modified.enable to be true.

Type: boolean

Default: true

Declared by:

Used as a separator between symlinks’ source and target.

Type: string

Default: " ➛ "

Declared by:

Use the webdev icon colors, otherwise NvimTreeFileIcon

Type: boolean

Default: true

Declared by:

Configuration options for tree indent markers.

Type: submodule

Default: { }

Declared by:

Whether to enable Display indent markers when folders are open…

Type: boolean

Default: false

Example: true

Declared by:

Individual elements of the indent markers

Type: attribute set

Default:

{
  bottom = "─";
  corner = "└";
  edge = "│";
  item = "│";
  none = "";
}

Declared by:

Display folder arrows in the same column as indent marker when using renderer.icons.show.folder_arrow

Type: boolean

Default: true

Declared by:

Number of spaces for an each tree nesting level. Minimum 1.

Type: signed integer

Default: 2

Declared by:

In what format to show root folder. See :help filename-modifiers for available string options. Set to false to hide the root folder.

Function is passed the absolute path of the root folder and should return a string. e.g. my_root_folder_label = function(path) return “…/” … vim.fn.fnamemodify(path, “:t”) end

Type: string or boolean

Default: false

Example: "\"\":~:s?$?/..?\""

Declared by:

A list of filenames that gets highlighted with `NvimTreeSpecialFile

Type: list of string

Default:

[
  "Cargo.toml"
  "README.md"
  "readme.md"
  "Makefile"
  "MAKEFILE"
  "flake.nix"
]

Declared by:

Whether to show the destination of the symlink.

Type: boolean

Default: true

Declared by:

Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.

Type: boolean

Default: false

Declared by:

Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true

Type: list of string

Default: [ ]

Declared by:

Whether to enable Use vim.ui.select style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim .

Type: boolean

Default: false

Example: true

Declared by:

Sort folders before files. Has no effect when sort.sorter is a function.

Type: boolean

Default: true

Declared by:

How files within the same directory are sorted.

Type: one of “name”, “extension”, “modification_time”, “case_sensitive”, “suffix”, “filetype”

Default: "name"

Declared by:

Changes the tree root directory on DirChanged and refreshes the tree. Only relevant when updateFocusedFile.updateRoot is true

(previously update_cwd)

Type: boolean

Default: false

Declared by:

Optional argument list.

Type: list of string

Default: [ ]

Declared by:

The open command itself

Type: string

Default: "\${pkgs.xdg-utils}/bin/xdg-open"

Declared by:

Configuration for tab behaviour.

Type: submodule

Default: { }

Declared by:

Configuration for syncing nvim-tree across tabs.

Type: submodule

Default: { }

Declared by:

Closes the tree across all tabpages when the tree is closed.

Type: boolean

Default: false

Declared by:

List of filetypes or buffer names on new tab that will prevent nvimTree.tab.sync.open and nvimTree.tab.sync.close

Type: list of string

Default: [ ]

Declared by:

Opens the tree automatically when switching tabpage or opening a new tabpage if the tree was previously open.

Type: boolean

Default: false

Declared by:

Configuration options for trashing.

Type: submodule

Default:

{
  cmd = "\${pkgs.glib}/bin/gio trash";
}

Declared by:

The command used to trash items

Type: string

Declared by:

General UI configuration.

Type: submodule

Default: { }

Declared by:

Prompt before removing.

Type: boolean

Default: true

Declared by:

Prompt before trash.

Type: boolean

Default: true

Declared by:

Update the focused file on BufEnter, un-collapses the folders recursively until it finds the file.

Type: submodule

Default: { }

Declared by:

update focused file

Type: boolean

Default: false

Declared by:

List of buffer names and filetypes that will not update the root dir of the tree if the file isn’t found under the current root directory. Only relevant when update_focused_file.update_root and update_focused_file.enable are true.

Type: list of string

Default: [ ]

Declared by:

Update the root directory of the tree if the file is not under current root directory. It prefers vim’s cwd and root_dirs. Otherwise it falls back to the folder containing the file. Only relevant when update_focused_file.enable is true

Type: boolean

Default: false

Declared by:

Window / buffer setup.

Type: submodule

Default: { }

Declared by:

If true, reposition the view so that the current node is initially centralized when entering nvim-tree.

Type: boolean

Default: false

Declared by:

Enable cursorline in nvim-tree window.

Type: boolean

Default: true

Declared by:

Idle milliseconds before some reload / refresh operations. Increase if you experience performance issues around screen refresh.

Type: signed integer

Default: 15

Declared by:

Configuration options for floating window.

Type: submodule

Default: { }

Declared by:

If true, tree window will be floating.

Type: boolean

Default: false

Declared by:

Floating window config. See :h nvim_open_win() for more details.

Type: attribute set

Default:

{
  border = "rounded";
  col = 1;
  height = 30;
  relative = "editor";
  row = 1;
  width = 30;
}

Declared by:

Close the floating tree window when it loses focus.

Type: boolean

Default: true

Declared by:

Print the line number in front of each line.

Type: boolean

Default: false

Declared by:

Preserves window proportions when opening a file. If false, the height and width of windows other than nvim-tree will be equalized.

Type: boolean

Default: false

Declared by:

Show the line number relative to the line with the cursor in front of each line. If the option view.number is also true, the number on the cursor line will be the line number instead of 0.

Type: boolean

Default: false

Declared by:

Side of the tree.

Type: one of “left”, “right”

Default: "left"

Declared by:

Show diagnostic sign column. Value can be "yes", "auto" or"no".

Type: one of “yes”, “auto”, “no”

Default: "yes"

Declared by:

Width of the window: can be a % string, a number representing columns, a function or a table.

A table (an attribute set in our case, see example) indicates that the view should be dynamically sized based on the longest line.

Type: signed integer or (attribute set)

Default: 30

Example:

{
  min = 30;
  max = -1;
  padding = 1;
}

Declared by:

Whether to enable gesture-nvim: mouse gestures.

Type: boolean

Default: false

Example: true

Declared by:

Start drawing [gesture.nvim]

Type: null or string

Default: "<LeftDrag>"

Declared by:

Finish drawing [gesture.nvim]

Type: null or string

Default: "<LeftRelease>"

Declared by:

Whether to enable git integration suite.

Enabling this option will enable the following plugins:

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable gitsigns.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable gitsigns codeactions through null-ls.

Type: boolean

Default: false

Example: true

Declared by:

Blame line [Gitsigns]

Type: null or string

Default: "<leader>hb"

Declared by:

Diff project [Gitsigns]

Type: null or string

Default: "<leader>hD"

Declared by:

Diff this [Gitsigns]

Type: null or string

Default: "<leader>hd"

Declared by:

Next hunk [Gitsigns]

Type: null or string

Default: "]c"

Declared by:

Preview hunk [Gitsigns]

Type: null or string

Default: "<leader>hP"

Declared by:

Previous hunk [Gitsigns]

Type: null or string

Default: "[c"

Declared by:

Reset buffer [Gitsigns]

Type: null or string

Default: "<leader>hR"

Declared by:

Reset hunk [Gitsigns]

Type: null or string

Default: "<leader>hr"

Declared by:

Stage buffer [Gitsigns]

Type: null or string

Default: "<leader>hS"

Declared by:

Stage hunk [Gitsigns]

Type: null or string

Default: "<leader>hs"

Declared by:

Toggle blame [Gitsigns]

Type: null or string

Default: "<leader>tb"

Declared by:

Toggle deleted [Gitsigns]

Type: null or string

Default: "<leader>td"

Declared by:

Undo stage hunk [Gitsigns]

Type: null or string

Default: "<leader>hu"

Declared by:

Whether to enable vim-fugitive.

Type: boolean

Default: false

Example: true

Declared by:

An attribute set containing global variable values for storing vim variables as early as possible. If populated, this option will set vim variables in the built luaConfigRC as the first item.

Type: attribute set of anything

Default: { }

Example:

{
  some_variable = 42;
}

Declared by:

The key used for <leader> mappings

Type: string

Default: " "

Declared by:

The key used for <localleader> mappings

Type: string

Default: ","

Declared by:

Hide search highlight so it doesn’t stay highlighted

Type: boolean

Default: false

Declared by:

Custom keybindings.

Type: list of (submodule)

Default: { }

Example:

''
  vim.keymaps = [
    {
      key = "<leader>m";
      mode = "n";
      silent = true;
      action = ":make<CR>";
    }
    {
      key = "<leader>l";
      mode = ["n" "x"];
      silent = true;
      action = "<cmd>cnext<CR>";
    }
  ];
''

Declared by:

The command to execute.

Type: string

Declared by:

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: null or string

Default: null

Declared by:

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: boolean

Default: false

Declared by:

The key that triggers this keybind.

Type: null or string

Declared by:

If true, action is considered to be lua code. Thus, it will not be wrapped in "".

Type: boolean

Default: false

Declared by:

The short-name of the mode to set the keymapping for. Passing an empty string is the equivalent of :map.

See :help map-modes for a list of modes.

Type: string or list of string

Example: ["n" "v" "c"] for normal, visual and command mode

Declared by:

Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.

Type: boolean

Default: true

Declared by: