yazi.nvim

# 🎲 A Neovim Plugin for [yazi](https://github.com/sxyazi/yazi.git)

<a href="https://dotfyle.com/plugins/mikavilpas/yazi.nvim">
  <img src="https://dotfyle.com/plugins/mikavilpas/yazi.nvim/shield?style=flat-square" alt="shield image for plugin usage" /> </a>

[![LuaRocks](https://img.shields.io/luarocks/v/mikavilpas/yazi.nvim?logo=lua)](https://luarocks.org/modules/mikavilpas/yazi.nvim)
[![Type checked codebase](https://github.com/mikavilpas/yazi.nvim/actions/workflows/typecheck.yml/badge.svg)](https://github.com/mikavilpas/yazi.nvim/actions/workflows/typecheck.yml)

[Yazi](https://github.com/sxyazi/yazi.git) is a blazing fast file manager for the terminal. This plugin allows you to
open yazi in a floating window in Neovim.

<https://github.com/mikavilpas/yazi.nvim/assets/300791/c7ff98ee-54d6-4ad0-9318-903e4b674f84>

## ✨ 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](https://github.com/nvim-telescope/telescope.nvim),
    [fzf-lua.nvim](https://github.com/ibhagwan/fzf-lua) and
    [snacks.picker](https://github.com/folke/snacks.nvim/blob/main/docs/picker.md): 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](https://github.com/folke/snacks.nvim/blob/main/docs/bufdelete.md) 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](https://github.com/MagicDuck/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)](https://www.man7.org/linux/man-pages/man1/realpath.1.html) on linux and windows, or
    [grealpath](https://formulae.brew.sh/formula/coreutils) 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 in
    [documentation/for-developers/lsp-renaming.md](documentation/for-developers/lsp-renaming.md).
- Customizable keybindings
- Plugin management for Yazi plugins and flavors ([documentation](./documentation/plugin-