Skip to main content

Builtins

Yazi comes with useful built-in plugins to help enhance your workflow without extra setup. This page introduces these built-in plugins and their available configuration options.

fzf.lua​

Integrate the power of fzf into Yazi, allowing you to swiftly search and navigate through files and directories with fuzzy matching.

Source code: https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins/fzf.lua

Usage​

How to invoke fzf:

  • Press z for quick file subtree navigation within CWD.
  • Or, press z for quick navigation among selected items, if you are in selection mode.

If you exit fzf with a single-selected file:

  • reveal the file.
  • Or, cd to it if it's a directory.

If you exit fzf with multiple-selected files:

  • Select the files chosen by fzf in Yazi.
  • Or, deselect the files chosen by fzf in Yazi, if you are in selection mode.

zoxide.lua​

Enhance your experience of historical directories navigation with external shell, through zoxide, a smarter cd.

Source code: https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins/zoxide.lua

Usage​

Click Z to launch the interactive zoxide UI. Please ensure that:

  1. You have installed the latest version of zoxide.
  2. You have installed the latest version of fzf, which is a dependency of zoxide.
  3. You have correctly configured zoxide for your shell according to its documentation.

Options​

OptionDescription
update_db (bool)Add the path to zoxide database whenever you switches CWD.

You can optionally change certain options in your init.lua like this:

-- ~/.config/yazi/init.lua
require("zoxide"):setup {
	update_db = true,
}