🎲 A Neovim Plugin for yazi

Yazi is a blazing fast file manager for the terminal. This plugin allows you to open yazi in a floating window in Neovim.

demo.mp4

✨ Features

Press <f1> to display all keymaps!

Open yazi in a floating window. All visible splits are opened as yazi tabs for easy and fast navigation.

Files that are hovered in yazi are highlighted in Neovim to intuitively show where you are in relation to your Neovim session. Currently this works for splits that you have open.

Files selected in yazi can be opened in various ways: as the current buffer, a vertical split, a horizontal split, a new tab, as quickfix items...

• if you have selected a file path in visual mode, yazi will open that file instead of current file

Integrations to other plugins and tools, if they are installed:

• For telescope.nvim, fzf-lua.nvim and snacks.picker: you can grep/search in the directory yazi is in. Select some files to limit the search to those files only.
• Using a bundled version of snacks.bufdelete to have yazi close buffers and preserve the window layout. This happens when files that are open are deleted in yazi.
• For grug-far.nvim: you can search and replace in the directory yazi is in
• Copy the relative path from the start file to the currently hovered file. Requires realpath (1) on linux and windows, or grealpath on osx

If multiple files are selected, they can be sent to the quickfix list

(optionally) open yazi instead of netrw for directories

Files that are renamed, moved, or deleted in yazi are kept in sync with open buffers in Neovim

• The files are also kept in sync with currently running LSP servers. A technical explanation is available here.

Customizable keybindings

Plugin management for Yazi plugins and flavors (documentation)

🆕 Send custom commands to yazi (documentation)

For previewing images with yazi, see Yazi’s documentation related to Neovim here.

📦 Installation

First, make sure you have the requirements:

• Neovim stable or nightly

• a recent version of yazi

• Opting into new features might require a recent version of yazi (see installing-yazi-from-source.md)

• if on Windows, the minimum supported version is Windows 11

Tip

You can run :checkhealth yazi to see if compatible versions are installed and working.

⚙️ Configuration

Using lazy.nvim

This is the preferred installation method.

Notice that yazi.nvim adds and lazy loads some minimal dependencies for you automatically when using a plugin manager like lazy.nvim. To see which dependencies are installed, see lazy.lua. If you are not using lazy.nvim (or rocks.nvim), you need to install the dependencies yourself. Also see the discussion in issue 306 and examples of other Neovim plugins using this feature.

---@type LazySpec
{
"mikavilpas/yazi.nvim",
version = "*", -- use the latest stable version
event = "VeryLazy",
dependencies = {
{ "nvim-lua/plenary.nvim", lazy = true },
},
keys = {
-- 👇 in this section, choose your own keymappings!
{
"<leader>-",
mode = { "n", "v" },
"<cmd>Yazi<cr>",
desc = "Open yazi at the current file",
},
{
-- Open in the current working directory
"<leader>cw",
"<cmd>Yazi cwd<cr>",
desc = "Open the file manager in nvim's working directory",
},
{
"<c-up>",
"<cmd>Yazi toggle<cr>",
desc = "Resume the last yazi session",
},
},
---@type YaziConfig | {}
opts = {
-- if you want to open yazi instead of netrw, see below for more info
open_for_directories = false,
keymaps = {
show_help = "<f1>",
},
},
-- 👇 if you use `open_for_directories=true`, this is recommended
init = function()
-- mark netrw as loaded so it's not loaded at all.
--
-- More details: https://github.com/mikavilpas/yazi.nvim/issues/802
vim.g.loaded_netrwPlugin = 1
end,
}

Without a package manager

Instructions

If you are not using lazy.nvim, see lazy.lua for what dependencies are required.

-- (Obtain yazi.nvim and its dependencies using your preferred method first)
--
-- Next, map a key to open yazi.nvim
vim.keymap.set("n", "<leader>-", function()
require("yazi").yazi()
end)

-- 👇 if you use `open_for_directories=true`, this is recommended.
--
-- mark netrw as loaded so it's not loaded at all.
-- More details: https://github.com/mikavilpas/yazi.nvim/issues/802
vim.g.loaded_netrwPlugin = 1
vim.api.nvim_create_autocmd("UIEnter", {
callback = function()
require("yazi").setup({
open_for_directories = true,
})
end,
})

⌨️ Keybindings

These are the default keybindings that are available when yazi is open:

• <f1>: show the help menu

• <c-v>: open the selected file(s) in vertical splits

• <c-x>: open the selected file(s) in horizontal splits

• <c-t>: open the selected file(s) in new tabs

• <c-q>: send the selected file(s) to the quickfix list

• There are also integrations to other plugins, which you need to install separately:

• <c-s>: search in the current yazi directory using telescope’s live_grep, if available. Optionally you can use fzf-lua.nvim, snacks.picker or provide your own implementation - see the instructions in the configuration section for more info.

• if multiple files/directories are selected in yazi, the search and replace will only be done in the selected files/directories

• <c-g>: search and replace in the current yazi directory using grug-far, if available

• if multiple files/directories are selected in yazi, the operation is limited to those only

• <c-y>: copy the relative path of the selected file(s) to the clipboard. Requires GNU realpath or grealpath on OSX

• also available for the snacks.nvim picker, see documentation/copy-relative-path-to-files.md for more information

• <tab>: make yazi jump to the open buffers in Neovim. See #232 for more information

⚙️⚙️ Advanced configuration

Important

You don’t have to set any of these options. The defaults are fine for most users.

For advanced configuration, it’s recommended to have your Lua language server set up so that you can type check your configuration and avoid errors.

For help on how to do this, there is a section for Neovim development tools in the documentation.

You can optionally configure yazi.nvim by setting any of the options below.

return {
-- ... other lazy.nvim configuration from above

---@type YaziConfig | {}
opts = {
-- Below is the default configuration. It is optional to set these values.
-- You can customize the configuration for each yazi call by passing it to
-- yazi() explicitly

-- enable this if you want to open yazi instead of netrw.
-- Note that if you enable this, you need to call yazi.setup() to
-- initialize the plugin. lazy.nvim does this for you in certain cases.
--
-- If you are also using neotree, you may prefer not to bring it up when
-- opening a directory:
-- {
--   "nvim-neo-tree/neo-tree.nvim",
--   opts = {
--     filesystem = {
--       hijack_netrw_behavior = "disabled",
--     },
--   },
-- }
open_for_directories = false,

-- open visible splits and quickfix items as yazi tabs for easy navigation
-- https://github.com/mikavilpas/yazi.nvim/pull/359
open_multiple_tabs = false,

-- when yazi is closed with no file chosen, change the Neovim working
-- directory to the directory that yazi was in before it was closed. Defaults
-- to being off (`false`)
change_neovim_cwd_on_close = false,

highlight_groups = {
-- See https://github.com/mikavilpas/yazi.nvim/pull/180
hovered_buffer = nil,
-- See https://github.com/mikavilpas/yazi.nvim/pull/351
hovered_buffer_in_same_directory = nil,
},

-- the floating window scaling factor. 1 means 100%, 0.9 means 90%, etc.
floating_window_scaling_factor = 0.9,

-- the transparency of the yazi floating window (0-100). See :h winblend
yazi_floating_window_winblend = 0,

-- the type of border to use for the floating window. Can be many values,
-- including 'none', 'rounded', 'single', 'double', 'shadow', etc. For
-- more information, see :h nvim_open_win
yazi_floating_window_border = "rounded",

-- the zindex of the yazi floating window. Can be used to make the yazi
-- window fullscreen. See `:h nvim_open_win()` for more information.
yazi_floating_window_zindex = nil,

-- the log level to use. Off by default, but can be used to diagnose
-- issues. You can find the location of the log file by running
-- `:checkhealth yazi` in Neovim. Also check out the "reproducing issues"
-- section below
log_level = vim.log.levels.OFF,

-- what Neovim should do a when a file was opened (selected) in yazi.
-- Defaults to simply opening the file.
open_file_function = function(chosen_file, config, state) end,

-- customize the keymaps that are active when yazi is open and focused. The
-- defaults are listed below. Note that the keymaps simply hijack input and
-- they are never sent to yazi, so only try to map keys that are never
-- needed by yazi.
--
-- Also:
-- - use e.g. `open_file_in_tab = false` to disable a keymap
-- - you can customize only some of the keymaps (not all of them)
-- - you can opt out of all keymaps by setting `keymaps = false`
keymaps = {
show_help = "<f1>",
open_file_in_vertical_split = "<c-v>",
open_file_in_horizontal_split = "<c-x>",
open_file_in_tab = "<c-t>",
grep_in_directory = "<c-s>",
replace_in_directory = "<c-g>",
cycle_open_buffers = "<tab>",
copy_relative_path_to_selected_files = "<c-y>",
send_to_quickfix_list = "<c-q>",
change_working_directory = "<c-\\>",
open_and_pick_window = "<c-o>",
},

-- completely override the keymappings for yazi. This function will be
-- called in the context of the yazi terminal buffer.
set_keymappings_function = function(yazi_buffer_id, config, context) end,

-- some yazi.nvim commands copy text to the clipboard. This is the register
-- yazi.nvim should use for copying. Defaults to "*", the system clipboard
clipboard_register = "*",

hooks = {
-- if you want to execute a custom action when yazi has been opened,
-- you can define it here.
yazi_opened = function(preselected_path, yazi_buffer_id, config)
-- you can optionally modify the config for this specific yazi
-- invocation if you want to customize the behaviour
end,

-- when yazi was successfully closed
yazi_closed_successfully = function(chosen_file, config, state) end,

-- when yazi opened multiple files. The default is to send them to the
-- quickfix list, but if you want to change that, you can define it here
yazi_opened_multiple_files = function(chosen_files, config, state) end,

-- This function is called when yazi is ready to process events.
on_yazi_ready = function(buffer, config, process_api) end,

before_opening_window = function(window_options) end,
},

-- highlight buffers in the same directory as the hovered buffer
highlight_hovered_buffers_in_same_directory = true,

integrations = {
--- What should be done when the user wants to grep in a directory
grep_in_directory = function(directory)
-- the default implementation uses telescope if available, otherwise nothing
end,

grep_in_selected_files = function(selected_files)
-- similar to grep_in_directory, but for selected files
end,

--- Similarly, search and replace in the files in the directory
replace_in_directory = function(directory)
-- default: grug-far.nvim
end,

replace_in_selected_files = function(selected_files)
-- default: grug-far.nvim
end,

-- `grealpath` on OSX, (GNU) `realpath` otherwise
resolve_relative_path_application = "",

-- the way to resolve relative paths. The default_implementation can be
-- customized with a function. See
-- documentation/copy-relative-path-to-files.md for more information.
resolve_relative_path_implementation = function(args, get_relative_path)
end,

-- how to delete (close) a buffer. Defaults to a bundled version of
-- `snacks.bufdelete`, copied from https://github.com/folke/snacks.nvim,
-- which maintains the window layout. See the `types.lua` file for more
-- information for the available options.
bufdelete_implementation = "bundled-snacks",

-- add an action to a file picker to copy the relative path to the
-- selected file(s). The implementation is the same as for the
-- `copy_relative_path_to_selected_files` yazi.nvim keymap. Currently
-- only snacks.nvim is supported. Documentation can be found in the
-- keybindings section of the readme.
--
-- available options:
-- - nil (default, no action added)
-- - "snacks.picker" (snacks.nvim)
picker_add_copy_relative_path_action = nil,
},

future_features = {
-- use a file to store the last directory that yazi was in before it was
-- closed. Defaults to `true`.
use_cwd_file = true,

-- use a new shell escaping implementation that is more robust and works
-- on more platforms. Defaults to `true`. If set to `false`, the old
-- shell escaping implementation will be used, which is less robust and
-- may not work on all platforms.
new_shell_escaping = true,
},
},
}

Tip

If you are adding custom bindings for special use cases, you can use the lua api. It allows customizing the configuration on a per call basis. For example, you can open yazi with a different configuration by calling require('yazi').yazi({open_for_directories = true}) to override some of your default settings for this specific call.

🪛 Customizing yazi

Yazi is highly customizable. It features its own plugin and event system, themes, and keybindings. This section lists some of the plugins and themes that I like.

• https://github.com/mikavilpas/easyjump.yazi allows jumping to a line by typing a hint character, much like hop.nvim.
• https://github.com/Rolv-Apneseth/starship.yazi is a port of the starship prompt to yazi. It allows reusing the starship prompt you are using in your shell in yazi.
• https://github.com/yazi-rs/flavors houses many of the most popular themes as yazi flavors, check it out! They typically also include matching code highlighting.

Contributing

Please see COMMUNITY.md for more information on the project!

In case there are issues

See reproducing-issues.md.

Powershell users: see here for Powershell specific configuration.