oil.nvim
A Neovim file explorer that lets you edit your filesystem like a normal buffer, inspired by vim-vinegar.
What is oil.nvim?
oil.nvim is a file explorer plugin for Neovim that treats the filesystem as an editable text buffer. It provides a vim-vinegar-like interface for browsing directories while enabling powerful cross-directory file operations directly within Neovim. The plugin solves the problem of cumbersome file management by allowing users to rename, delete, or move files using familiar Neovim editing commands.
Neovim users who prefer a netrw-like, single-pane directory browser and want to perform complex file operations without leaving the editor. It is particularly suited for developers who manage files across local directories, remote servers via SSH, or cloud storage like AWS S3.
Developers choose oil.nvim for its unique ability to perform cross-directory file operations, including copying or moving files between different directories and even across different adapters like local and remote systems, in a single operation. Its extensible adapter architecture and deep integration with Neovim's native buffer and window system provide a more direct and powerful editing model compared to traditional tree-based file explorers.
Overview
Neovim file explorer: edit your filesystem like a buffer
Use Cases
Best For
- Performing cross-directory file operations like copying or moving files between different folders within Neovim.
- Browsing and editing files on remote servers via SSH directly from Neovim.
- Managing files stored in AWS S3 buckets through a Neovim interface.
- Using familiar Neovim keybindings and commands to rename, delete, or move files as if editing a text buffer.
- Customizing file explorer columns, keymaps, sorting, and preview windows to match specific workflows.
- Replacing netrw with a more performant and bug-free alternative for single-directory browsing.
Not Ideal For
- Projects requiring hierarchical tree navigation for file exploration
- Teams needing out-of-the-box, seamless git integration without additional plugins
- Environments where external command dependencies (like aws CLI or specific Unix tools) are unavailable
- Users who prefer minimal configuration and default tree-based interfaces
Pros & Cons
Pros
Enables copying and moving files between directories and across adapters like SSH and S3 in a single operation, as highlighted in the key features.
Supports browsing and editing files on remote servers via SSH and cloud storage like AWS S3, allowing unified management of diverse filesystems.
Treats directory listings as editable text buffers, allowing users to use familiar Neovim commands for renaming, deleting, or moving files, akin to editing normal text.
Offers extensive configuration options for columns, keymaps, sorting, and preview windows, detailed in the setup options section.
Designed to avoid netrw bugs and performance issues, providing a more stable alternative for single-directory browsing, as noted in the FAQ.
Cons
Explicitly does not support tree-based navigation, which may be a limitation for users accustomed to hierarchical file explorers like nvim-tree.
Adapters like SSH require specific Unix commands and do not support Windows servers, adding setup overhead and limiting cross-platform use.
Git integration is experimental and requires custom functions, lacking seamless out-of-the-box git status or operations without third-party extensions.
Relies on external tools for adapters (e.g., aws CLI for S3, standard Unix commands for SSH), which may not be available in all environments.
Frequently Asked Questions
Related Projects
nvim-tree.luaA file explorer tree for neovim written in lua
neo-tree.nvimNeovim plugin to manage the file system and other tree like structures.
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.