nvim-neo-tree /neo-tree.nvim
Neovim plugin to manage the file system and other tree like structures.
★ 5,653⑂ 315👁 9⑃ 710● 1,069▤ 175
+1
日增长
5,653
stars
315
forks
9
watchers
710
prs
1,069
issues
175
releases
README
Neo-tree.nvim
Neo-tree is a Neovim plugin to browse the file system and other tree like
structures in whatever style suits you, including sidebars, floating windows,
netrw split style, or all of them at once!
This screenshot shows Neo-tree opened in the traditional sidebar layout:
!Neo-tree file system
sidebar
Neo-tree filesystem screenshot, Netrw Style
The below screenshot shows Neo-tree opened "netrw style" (:Neotree
position=current). When opened in this way, there is more room so the extra
detail columns can be shown. This screenshot also shows how the contents can be
sorted on any column. In this example, we are sorted on "Size" descending:
!Neo-tree file system
details
Breaking Changes BAD :bomb: :imp:
The biggest and most important feature of Neo-tree is that we will never
knowingly push a breaking change and interrupt your day. Bugs happen, but
breaking changes can always be avoided. When breaking changes are needed, there
will be a new branch that you can opt into, when it is a good time for you.
See What is a Breaking Change? for details.
See Changelog 3.0
for breaking changes and deprecations in 3.0.
User Experience GOOD :slightly_smiling_face: :thumbsup:
Aside from being polite about breaking changes, Neo-tree is also focused on the
little details of user experience. Everything should work exactly as you would
expect a sidebar to work without all of the glitchy behavior that is normally
accepted in (neo)vim sidebars. I can't stand glitchy behavior, and neither
should you!
- Neo-tree won't let other buffers take over its window.
- Neo-tree won't leave its window scrolled to the last line when there is plenty
of room to display the whole tree.
- Neo-tree does not need to be manually refreshed
(set use_libuv_file_watcher = true)
- Neo-tree can intelligently follow the current file
(set follow_current_file.enabled = true)
- Neo-tree can sync its clipboard across multiple trees, either globally
(within the same Neovim instance) or universally (across all Neovim
instances). Try clipboard.sync = "global" | "universal".
- Neo-tree is thoughtful about maintaining or setting focus on the right node
- Neo-tree windows in different tabs are completely separate
- respect_gitignore actually works!
[!NOTE]
Neo-tree is meant to be smooth, efficient, stable, and intuitive. If you find
anything janky, slow, broken, or unintuitive, please open an issue so we can
fix it.
Installation
Neo-tree currently supports Neovim 0.8 and onwards.
This plugin relies upon these two excellent library plugins:
- MunifTanjim/nui.nvim for all UI
components, including the tree!
- nvim-lua/plenary.nvim for backend
utilities, such as scanning the filesystem.
There are also some optional plugins that work with Neo-tree:
- nvim-tree/nvim-web-devicons
for file icons.
- Crysthamus/nvim-file-operations
or
antosha417/nvim-lsp-file-operations
for LSP-enhanced renames/etc.
- folke/snacks.nvim for image previews,
see PreviewTop issues
#879Tracking issue for Document Symbol source20 comments · 2023-04-17#1504FEATURE: preserve window layout when the last non-neotree-sidebar window is closed18 comments · 2024-06-22#914`file_event_callback: EPERM` error notification after some background filesystem actions16 comments · 2023-05-05#128Restore tree state in session restore16 comments · 2022-02-06#1365BUG: Buffer with this name already exists 13 comments · 2024-02-27#758[Bug] Failed to open NeoTree when currently focused buffer path does not exist13 comments · 2023-02-17#1235FEATURE: Shared neo-tree window across tabs12 comments · 2023-11-17#633[Cross-Plugins] Does neo-tree.nvim move the cursor to the first line after the first file is open?12 comments · 2022-11-30
Discussions
#2118Separate file and folder icons from the selected icon1 comments · 2026-11-09#2098FYI: NuiTree - Massive Internal Restructure for Perf Improment1 comments · 2026-09-17#2055How do I remap the n/N keys?2 comments · 2026-07-04#2029how to make neo-tree evalueate standard tilde ~ as $HOME when copy when move when anything?1 comments · 2026-05-13#2019How to configure ignored and untracked_files options for git status?1 comments · 2026-04-21#2018Why is the NeoTree background not transparent when configured?2 comments · 2026-04-20#1976How can I disable recentering the NeoTree on focus through mouseclick1 comments · 2026-02-05#1968Better "Open file but keep neo-tree focused"0 comments · 2026-01-15
Latest release
3.42.0 3.42.0 2026-09-01Hi, sorry for delays on this release, been a bit busy lately. Highlights feat(commands): trash command w/ undo and restore by @pynappo in https://github.com/nvim-neo-tree/neo-tree.nvim/pull/1914 By default, trash is currently bound to T, undo is bound to u. and restore_from_trash is bound to U. restore_from_trash is for restoring items directly from the trash bin. feat(commands): quick jump by @stupidbullet in https://github.com/nvim-neo-tree/neo-tree.nvim/pull/2004 Bound to by default. Allows quick jumping to visible lines. feat(commands): select command by @pynappo in