neo-tree.nvim

# 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](https://github.com/nvim-neo-tree/resources/blob/main/images/Neo-tree-with-right-aligned-symbols.png)

<details>
  <summary>
    Neo-tree filesystem screenshot, Netrw Style
  </summary>

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](https://github.com/nvim-neo-tree/resources/blob/main/images/Neo-tree-with-file-details-and-sort.png)

</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?](#what-is-a-breaking-change) for details.

See [Changelog 3.0](https://github.com/nvim-neo-tree/neo-tree.nvim/wiki/Changelog#30)
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](https://github.com/MunifTanji