Introduction to Neo-Tree
Neo-Tree is a modern, feature-rich file explorer plugin for Neovim, designed to streamline file navigation and management. Integrated into LunarVim by default, it replaces traditional file explorers with a sleek, sidebar-style interface that supports:
- File/directory creation, deletion, and renaming
- Copy-paste operations
- Git status indicators (modified/untracked files)
- File previews and quick navigation
For LunarVim users, Neo-Tree eliminates the need for terminal commands or manual editing of directories, making it a perfect companion for developers who value efficiency.
Why Neo-Tree in LunarVim?
LunarVim’s pre-configured setup ensures Neo-Tree works seamlessly out of the box. With your Space key as the leader, all keybindings feel intuitive and ergonomic.
Key Features & Workflow
1. Accessing Neo-Tree
- Open/Close Explorer:
Space + e
(Your leader key is Space, so no need to memorize\!)
2. Basic File Operations
Use these keybindings while focused on the Neo-Tree explorer:
| Action | Keybinding |
|---|---|
| Create File | a → Type filename |
| Create Directory | a → Type dirname/ |
| Rename | r → Edit name |
| Delete | d → Confirm with y |
| Copy File | c |
| Paste File | p |
| Refresh Explorer | Ctrl + r |
Pro Tip: Right-click items for a context menu with all actions!
3. Advanced Features
- Git Integration: Files show symbols for modified (
), untracked (), or staged changes. - Tabs: Open multiple explorers with
Space + te(LunarVim’s tab management). - Search: Filter files by name with
/. - File Preview: Hover over files to preview content without opening them.
Customizing Neo-Tree for Your Workflow
LunarVim allows easy customization. For example, to change keybindings, add this to your config.lua:
vim.keymap.set("n", "<Leader>nf", function()
require("neo-tree.command").execute({ toggle = true, dir = vim.loop.cwd() })
end) (This remaps Neo-Tree to Space + nf if desired.)
Best Practices
- Double-Check Deletions: Neo-Tree deletes files permanently (no trash bin).
- Use Git: Track changes to avoid accidental file losses.
- Refresh Often: Hit
Ctrl + rif external changes occur (e.g., git pull).
Conclusion
With Neo-Tree in LunarVim, file management becomes a frictionless part of your coding workflow. By leveraging your Space leader key and the intuitive keybindings, you’ll spend less time organizing files and more time building projects.
For more shortcuts, type :help neo-tree or press Space + s k (which-key) to see LunarVim’s keybinding guide.