Notice

Install

" requiresPlug'kyazdani42/nvim-web-devicons'" for file iconsPlug'kyazdani42/nvim-tree.lua'

use {'kyazdani42/nvim-tree.lua',requires='kyazdani42/nvim-web-devicons'}

Setup

letg:nvim_tree_side='right'"left by defaultletg:nvim_tree_width=40"30 by default, can be width_in_columns or 'width_in_percent%'letg:nvim_tree_ignore= ['.git','node_modules','.cache' ]"empty by defaultletg:nvim_tree_gitignore=1"0 by defaultletg:nvim_tree_auto_open=1"0 by default, opens the tree when typing `vim $DIR` or `vim`letg:nvim_tree_auto_close=1"0 by default, closes the tree when it's the last windowletg:nvim_tree_auto_ignore_ft= ['startify','dashboard' ]"empty by default, don't auto open tree on specific filetypes.letg:nvim_tree_quit_on_open=1"0 by default, closes the tree when you open a fileletg:nvim_tree_follow=1"0 by default, this option allows the cursor to be updated when entering a bufferletg:nvim_tree_follow_update_path=1"0 by default, will update the path of the current dir if the file is not inside the tree.Defaultis0letg:nvim_tree_indent_markers=1"0 by default, this option shows indent markers when folders are openletg:nvim_tree_hide_dotfiles=1"0 by default, this option hides files and folders starting with a dot `.`letg:nvim_tree_git_hl=1"0 by default, will enable file highlight for git attributes (can be used without the icons).letg:nvim_tree_highlight_opened_files=1"0 by default, will enable folder and file icon highlight for opened files/directories.letg:nvim_tree_root_folder_modifier=':~'"This is the default. See :help filename-modifiers for more optionsletg:nvim_tree_tab_open=1"0 by default, will open the tree when entering a new tab and the tree was previously openletg:nvim_tree_auto_resize=0"1 by default, will resize the tree to its saved width when opening a fileletg:nvim_tree_disable_netrw=0"1 by default, disables netrwletg:nvim_tree_hijack_netrw=0"1 by default, prevents netrw from automatically opening when opening directories (but lets you keep its other utilities)letg:nvim_tree_add_trailing=1"0 by default, append a trailing slash to folder namesletg:nvim_tree_group_empty=1" 0 by default, compact folders that only contain a single folder into one node in the file treeletg:nvim_tree_lsp_diagnostics=1"0 by default, will show lsp diagnostics in the signcolumn. See :help nvim_tree_lsp_diagnosticsletg:nvim_tree_disable_window_picker=1"0 by default, will disable the window picker.letg:nvim_tree_hijack_cursor=0"1 by default, when moving cursor in the tree, will position the cursor at the start of the file on the current lineletg:nvim_tree_icon_padding=''"one space by default, used for rendering the space between the icon and the filename. Use with caution, it could break rendering if you set an empty string depending on your font.letg:nvim_tree_symlink_arrow=' >>'" defaults to ' ➛ '. used as a separator between symlinks' source and target.letg:nvim_tree_update_cwd=1"0 by default, will update the tree cwd when changing nvim's directory (DirChanged event). Behaves strangely with autochdir set.letg:nvim_tree_respect_buf_cwd=1"0 by default, will change cwd of nvim-tree to that of new buffer's when opening nvim-tree.letg:nvim_tree_refresh_wait=500"1000 by default, control how often the tree can be refreshed, 1000 means the tree can be refresh once per 1000ms.letg:nvim_tree_window_picker_exclude= {\'filetype': [\'notify',\'packer',\'qf'\  ],\'buftype': [\'terminal'\  ]\}" Dictionary of buffer option names mapped to a list of option values that" indicates to the window picker that the buffer's window should not be" selectable.letg:nvim_tree_special_files= {'README.md':1,'Makefile':1,'MAKEFILE':1 }" List of filenames that gets highlighted with NvimTreeSpecialFileletg:nvim_tree_show_icons= {\'git':1,\'folders':0,\'files':0,\'folder_arrows':0,\}"If 0, do not show the icons for one of 'git' 'folder' and 'files'"1 by default, notice that if 'files' is 1, it will only display"if nvim-web-devicons is installed and on your runtimepath."if folder is 1, you can also tell folder_arrows 1 to show small arrows next to the folder icons."but this will not work when you set indent_markers (because of UI conflict)" default will show icon by default if no icon is provided" default shows no icon by defaultletg:nvim_tree_icons= {\'default':'',\'symlink':'',\'git': {\'unstaged':"✗",\'staged':"✓",\'unmerged':"",\'renamed':"➜",\'untracked':"★",\'deleted':"",\'ignored':"◌"\  },\'folder': {\'arrow_open':"",\'arrow_closed':"",\'default':"",\'open':"",\'empty':"",\'empty_open':"",\'symlink':"",\'symlink_open':"",\  },\'lsp': {\'hint':"",\'info':"",\'warning':"",\'error':"",\  }\}nnoremap<C-n>:NvimTreeToggle<CR>nnoremap<leader>r :NvimTreeRefresh<CR>nnoremap<leader>n :NvimTreeFindFile<CR>" NvimTreeOpen, NvimTreeClose and NvimTreeFocus are also available if you need themsettermguicolors" this variable must be enabled for colors to be applied properly" a list of groups can be found at `:help nvim_tree_highlight`highlight NvimTreeFolderIcon guibg=blue

KeyBindings

Default actions

Setup

" let g:nvim_tree_disable_keybindings=1

letg:nvim_tree_disable_default_keybindings=1

lua <<EOFvim.g.nvim_tree_bindings= {      {key= {"<CR>","o" },cb=":lua some_func()<cr>"}      {key="<Tab>",mode="v",cb=":lua some_func()<cr>"}    }EOF

lua <<EOF    local tree_cb= require'nvim-tree.config'.nvim_tree_callback-- default mappingsvim.g.nvim_tree_bindings= {      {key= {"<CR>","o","<2-LeftMouse>"},cb=tree_cb("edit") },      {key= {"<2-RightMouse>","<C-]>"},cb=tree_cb("cd") },      {key="<C-v>",cb=tree_cb("vsplit") },      {key="<C-x>",cb=tree_cb("split") },      {key="<C-t>",cb=tree_cb("tabnew") },      {key="<",cb=tree_cb("prev_sibling") },      {key=">",cb=tree_cb("next_sibling") },      {key="P",cb=tree_cb("parent_node") },      {key="<BS>",cb=tree_cb("close_node") },      {key="<S-CR>",cb=tree_cb("close_node") },      {key="<Tab>",cb=tree_cb("preview") },      {key="K",cb=tree_cb("first_sibling") },      {key="J",cb=tree_cb("last_sibling") },      {key="I",cb=tree_cb("toggle_ignored") },      {key="H",cb=tree_cb("toggle_dotfiles") },      {key="R",cb=tree_cb("refresh") },      {key="a",cb=tree_cb("create") },      {key="d",cb=tree_cb("remove") },      {key="r",cb=tree_cb("rename") },      {key="<C-r>",cb=tree_cb("full_rename") },      {key="x",cb=tree_cb("cut") },      {key="c",cb=tree_cb("copy") },      {key="p",cb=tree_cb("paste") },      {key="y",cb=tree_cb("copy_name") },      {key="Y",cb=tree_cb("copy_path") },      {key="gy",cb=tree_cb("copy_absolute_path") },      {key="[c",cb=tree_cb("prev_git_item") },      {key="]c",cb=tree_cb("next_git_item") },      {key="-",cb=tree_cb("dir_up") },      {key="s",cb=tree_cb("system_open") },      {key="q",cb=tree_cb("close") },      {key="g?",cb=tree_cb("toggle_help") },    }EOF

Note

Features

Tips

Screenshots