Skip to main content

Built-in Plugins

Yazi ships with several built-in plugins. The most notable are fzf and zoxide, which integrate external tools through the plugin system.

fzf.lua​

Integration with fzf for fuzzy file finding. Requires fzf >= 0.53.0.

Usage​

Triggered by default with the F key in the manager layer.

[manager]
prepend_keymap = [
  { on = "F", run = "plugin fzf", desc = "Find files with fzf" },
]

Configuration​

fzf options can be configured in keymap.toml:

[manager]
prepend_keymap = [
  {
    on   = "F",
    run  = "plugin fzf --args='--multi --preview=\"cat {}\"'",
    desc = "Find files with fzf (multi-select)"
  },
]

Features​

  • Fuzzy search across all files in subtree
  • Multi-select with --multi flag
  • Preview panel with custom --preview command
  • Returns selected files to Yazi for further action

Source​

Check the official fzf.lua source for updates.

zoxide.lua​

Integration with zoxide for quick directory navigation based on history and frecency.

Usage​

Triggered by default with the z key in the manager layer.

[manager]
prepend_keymap = [
  { on = "z", run = "plugin zoxide", desc = "Jump to directory with zoxide" },
]

How It Works​

  1. Press z to open the zoxide input prompt
  2. Type a partial directory name or pattern
  3. zoxide queries its database and returns the best match
  4. Yazi navigates to the matched directory

Configuration​

Pass query options through the plugin args:

[manager]
prepend_keymap = [
  {
    on   = "z",
    run  = "plugin zoxide --args='--interactive'",
    desc = "Jump directory (interactive zoxide)"
  },
]

Source​

Check the official zoxide.lua source for updates.

Other Built-in Plugins​

Additional plugins are bundled with Yazi and can be inspected in the plugins/ directory of the Yazi source or the plugins repository:

PluginPurpose
diffShow file diff in preview
mimeDetect and display MIME type
no-imageFallback when no image preview is available
max-previewToggle preview to maximum size
tip

You can override any built-in plugin by placing a plugin with the same name in ~/.config/yazi/plugins/. User plugins take precedence.