Notice

Install

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

use {'kyazdani42/nvim-tree.lua',requires= {'kyazdani42/nvim-web-devicons',-- optional, for file icon    },config=function()require'nvim-tree'.setup {}end}

Setup

" vimrcletg:nvim_tree_indent_markers=1"0 by default, this option shows indent markers when folders are openletg: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_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_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_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_create_in_closed_folder=1"0 by default, When creating files, sets the path of a file when cursor is on a closed folder to the parent folder when 0, and inside the folder when 1.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':"",\  }\}nnoremap<C-n>:NvimTreeToggle<CR>nnoremap<leader>r :NvimTreeRefresh<CR>nnoremap<leader>n :NvimTreeFindFile<CR>" More available functions:" NvimTreeOpen" NvimTreeClose" NvimTreeFocus" NvimTreeFindFileToggle" NvimTreeResize" NvimTreeCollapse" NvimTreeCollapseKeepBufferssettermguicolors" 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

-- init.lua-- empty setup using defaults: add your own optionsrequire'nvim-tree'.setup {}-- OR-- setup with all defaults-- each of these are documented in `:help nvim-tree.OPTION_NAME`require'nvim-tree'.setup {-- BEGIN_DEFAULT_OPTSauto_reload_on_write=true,disable_netrw=false,hide_root_folder=false,hijack_cursor=false,hijack_netrw=true,hijack_unnamed_buffer_when_opening=false,ignore_buffer_on_setup=false,open_on_setup=false,open_on_tab=false,sort_by="name",update_cwd=false,view= {width=30,height=30,side="left",preserve_window_proportions=false,number=false,relativenumber=false,signcolumn="yes",mappings= {custom_only=false,list= {-- user mappings go here      },    },  },hijack_directories= {enable=true,auto_open=true,  },update_focused_file= {enable=false,update_cwd=false,ignore_list= {},  },ignore_ft_on_setup= {},system_open= {cmd=nil,args= {},  },diagnostics= {enable=false,show_on_dirs=false,icons= {hint="",info="",warning="",error="",    },  },filters= {dotfiles=false,custom= {},exclude= {},  },git= {enable=true,ignore=true,timeout=400,  },actions= {change_dir= {enable=true,global=false,    },open_file= {quit_on_open=false,resize_window=false,window_picker= {enable=true,chars="ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",exclude= {filetype= {"notify","packer","qf","diff","fugitive","fugitiveblame"},buftype= {"nofile","terminal","help"},        },      },    },  },trash= {cmd="trash",require_confirm=true,  },log= {enable=false,truncate=false,types= {all=false,config=false,copy_paste=false,git=false,profile=false,    },  },}-- END_DEFAULT_OPTS

KeyBindings

Default actions

Settings

-- key can be either a string or a table of string (lhs)-- action is the name of the action, set to `""` to remove default action-- action_cb is the function that will be called, it receives the node as a parameter. Optional for default actions-- mode is normal by defaultlocaltree_cb=require'nvim-tree.config'.nvim_tree_callbacklocalfunctionprint_node_path(node) {print(node.absolute_path)}locallist= {  {key= {"<CR>","o"},action="edit",mode="n"},  {key="p",action="print_path",action_cb=print_node_path },  {key="s",cb=tree_cb("vsplit") },--tree_cb and the cb property are deprecated  {key="<2-RightMouse>",action=""},-- will remove default cd action}

-- default mappingslocallist= {  {key= {"<CR>","o","<2-LeftMouse>"},action="edit"},  {key="<C-e>",action="edit_in_place"},  {key= {"O"},action="edit_no_picker"},  {key= {"<2-RightMouse>","<C-]>"},action="cd"},  {key="<C-v>",action="vsplit"},  {key="<C-x>",action="split"},  {key="<C-t>",action="tabnew"},  {key="<",action="prev_sibling"},  {key=">",action="next_sibling"},  {key="P",action="parent_node"},  {key="<BS>",action="close_node"},  {key="<Tab>",action="preview"},  {key="K",action="first_sibling"},  {key="J",action="last_sibling"},  {key="I",action="toggle_git_ignored"},  {key="H",action="toggle_dotfiles"},  {key="R",action="refresh"},  {key="a",action="create"},  {key="d",action="remove"},  {key="D",action="trash"},  {key="r",action="rename"},  {key="<C-r>",action="full_rename"},  {key="x",action="cut"},  {key="c",action="copy"},  {key="p",action="paste"},  {key="y",action="copy_name"},  {key="Y",action="copy_path"},  {key="gy",action="copy_absolute_path"},  {key="[c",action="prev_git_item"},  {key="]c",action="next_git_item"},  {key="-",action="dir_up"},  {key="s",action="system_open"},  {key="q",action="close"},  {key="g?",action="toggle_help"},  {key="W",action="collapse_all"},  {key="S",action="search_node"},  {key="<C-k>",action="toggle_file_info"},  {key=".",action="run_file_command"}}

Tips & reminders

autocmdBufEnter*++nestedifwinnr('$')==1&&bufname()=='NvimTree_' .tabpagenr() |quit |endif

Diagnostic Logging

Performance Issues

log= {enable=true,truncate=true,types= {git=true,profile=true,  },},

Screenshots