neo-tree.nvim
A Neovim plugin for browsing the file system and other tree-like structures with multiple layout styles and a focus on stability.
What is neo-tree.nvim?
Neo-tree is a versatile file explorer and tree viewer plugin for Neovim designed to replace traditional file browsers with a smooth, customizable experience. It provides multiple layout options including sidebars, floating windows, and netrw-style splits, while prioritizing user experience and stability. The plugin supports browsing filesystems, open buffers, git status, document symbols, and external sources.
Neovim users seeking a stable, glitch-free file explorer with extensive customization options, particularly developers who work across multiple projects and need flexible tree views for files, buffers, and git status.
Developers choose Neo-tree for its commitment to avoiding breaking changes within major versions, ensuring a reliable workflow, and its focus on eliminating glitchy sidebar behavior common in other plugins. Its highly configurable UI with replaceable components and event hooks allows deep customization beyond typical file explorers.
Overview
Neovim plugin to manage the file system and other tree like structures.
Use Cases
Best For
- Replacing netrw or other file explorers in Neovim with a more stable and customizable alternative.
- Managing multiple data sources like filesystems, open buffers, and git status in a unified tree interface.
- Customizing Neovim's sidebar or tree viewer with configurable components and layout options (sidebars, floats, splits).
- Syncing clipboard operations globally or universally across multiple Neovim instances for seamless file operations.
- Following the current file automatically in the tree view to maintain context during navigation.
- Previewing files (including images with optional plugins) without switching focus from the tree window.
Not Ideal For
- Vim users seeking a file explorer plugin (exclusive to Neovim due to Lua dependencies)
- Developers who prefer minimal, keyboard-driven workflows without visual tree interfaces
- Teams requiring instant file browsing with zero configuration overhead
- Projects where dependency bloat is a critical concern (relies on multiple external plugins)
Pros & Cons
Pros
Explicitly avoids breaking changes within major versions, ensuring reliable updates without workflow interruptions, as stated in the 'Breaking Changes BAD' section.
Designed to eliminate common sidebar issues like window takeovers and incorrect scrolling, prioritizing smooth operation as emphasized in the 'User Experience GOOD' notes.
Supports multiple views including filesystems, buffers, git status, and document symbols in a unified tree, reducing the need for separate plugins.
Offers replaceable components and event hooks for deep extensibility, allowing users to tailor the UI beyond default settings, as shown in configuration examples.
Cons
Setup involves multiple dependencies (e.g., nui.nvim, plenary.nvim) and a lengthy configuration table, which can be daunting for quick adoption.
Relies on optional plugins like nvim-web-devicons for icons and snacks.nvim for image previews, adding installation and maintenance overhead.
Features like libuv file watchers and multiple simultaneous sources may introduce latency, especially in large projects with many files.
Open Source Alternative To
neo-tree.nvim is an open-source alternative to the following products:
netrw is the built-in file explorer and network-oriented reading/writing/editing/browsing plugin for the Vim text editor, providing file system navigation.
NERDTree is a file system explorer plugin for Vim and Neovim that provides a tree view of directories and files for easy navigation.
nvim-tree.lua is the same as nvim-tree, a file explorer plugin for Neovim written in Lua with a tree-style interface for file management.
Frequently Asked Questions
Related Projects
nvim-tree.luaA file explorer tree for neovim written in lua
oil.nvimNeovim file explorer: edit your filesystem like a buffer
yazi.nvimA Neovim Plugin for the yazi terminal file manager
chadtreeFile manager for Neovim. Better than NERDTree.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.