Repository files navigation

Automatic updates

File type icons

Git integration

Diagnostics integration: LSP and COC

(Live) filtering

Cut, copy, paste, rename, delete, create

Highly customisable

Take a look at thewiki for Showcases, Tips, Recipes and more.

Join us on matrix

Existing*_on_setup* mechanisms have been removed in favour ofOpen At Startup

neovim >=0.8.0

nvim-web-devicons is optional and used to display file icons. It requires apatched font. Your terminal emulator must be configured to use that font, usually "Hack Nerd Font"

Install withvim-plug:

Plug'nvim-tree/nvim-web-devicons'" optional, for file iconsPlug'nvim-tree/nvim-tree.lua'

or withpacker:

use {'nvim-tree/nvim-tree.lua',requires= {'nvim-tree/nvim-web-devicons',-- optional, for file icons  },tag='nightly'-- optional, updated every week. (see issue #1193)}

Setup should be run in a lua file or in a lua heredoc:help lua-heredoc if using in a vim file.

-- examples for your init.lua-- disable netrw at the very start of your init.lua (strongly advised)vim.g.loaded_netrw=1vim.g.loaded_netrwPlugin=1-- set termguicolors to enable highlight groupsvim.opt.termguicolors=true-- empty setup using defaultsrequire("nvim-tree").setup()-- OR setup with some optionsrequire("nvim-tree").setup({sort_by="case_sensitive",view= {width=30,mappings= {list= {        {key="u",action="dir_up"},      },    },  },renderer= {group_empty=true,  },filters= {dotfiles=true,  },})

For complete list of available configuration options see:help nvim-tree-setup

Each option is documented in:help nvim-tree.OPTION_NAME. Nested options can be accessed by appending., for example:help nvim-tree.view.mappings

See:help nvim-tree-commands

Basic commands:

:NvimTreeToggle Open or close the tree. Takes an optional path argument.

:NvimTreeFocus Open the tree if it is closed, and then focus on the tree.

:NvimTreeFindFile Move the cursor in the tree for the current buffer, opening folders if needed.

:NvimTreeCollapse Collapses the nvim-tree recursively.

nvim-tree comes with number of mappings; for default mappings please see:help nvim-tree-default-mappings, for way of configuring mappings see:help nvim-tree-mappings

g? toggles help, showing all the mappings and their actions.

nvim-tree is stable and new major features will not be added. The focus is on existing user experience.

Users are encouraged to add their own custom features via the publicAPI.

Development is focused on:

• Bug fixes
• Performance
• Quality of Life improvements
• API / Events
• Enhancements to existing features

nvim-tree exposes a public API. This is non breaking, with additions made as necessary.

See wikiRecipes andTips for ideas and insipration.

Please raise afeature request if the API is insufficent for your needs.Contributions are always welcome.

:help nvim-tree-api

Users may subscribe to events that nvim-tree will dispatch in a variety of situations.

:help nvim-tree-events

Custom actions may be mapped which can invoke API or perform your own actions.

:help nvim-tree-mappings

PRs are always welcome. Seewiki to get started.

Seebug andPR Please issues if you are looking for some work to get you started.

Developers with the following environments:

• Apple macOS
• Windows
  • WSL
  • msys
  • powershell

Help triaging, diagnosing and fixing issues specific to those environments is needed, as the nvim-tree developers do not have access to or expertise in these environments.

Let us know you're interested by commenting on issues and raising PRs.

SeeShowcases wiki page for examples of user's configurations with sources.

Please add your own!