Skip to content
rovr

plugins

there are a couple plugins to improve rovr’s functionality. enable and configure them in your config.toml file.

zoxide

Section titled “zoxide”

zoxide allows you to zip around your filesystem, and can be integrated into rovr

  • enable: plugins.zoxide.enabled = true
  • keybinding: the default keybinding to open the zoxide dialog is z.

bat

Section titled “bat”

to allow for more file previews, bat can be used for its syntax highlighting capabilities.

  • enable: plugins.bat.enabled = true
  • executable: specify the path to the bat executable if it’s not in your system’s PATH.
  • line numbers: toggle line numbers with plugins.bat.show_line_numbers.

editor

Section titled “editor”

opens files and folders in your preferred editor.

  • enable: plugins.editor.enabled = true
  • executables: set the command to open files (file_executable) and folders (folder_executable).
  • keybinding: the default keybinding is e.
  • suspending: whether to suspend rovr when opening a file in an editor (recommended for TUI editors, disable for GUI editors for seamless workflow)
    • file_suspend: suspend when opening files (default: true)
    • folder_suspend: suspend when opening folders (default: true)
  • open all in editor: set plugins.editor.open_all_in_editor = true to force all files to open in your configured editor, regardless of encoding or file type. when disabled (default), files that cannot be read due to encoding issues will open with the system’s default application instead.

fd

Section titled “fd”

uses fd to search recursively in the current directory

  • enable: plugins.fd.enabled = true
  • executable: set the executable used to call fd
  • relative_paths: whether to see paths as relative or absolute
  • follow_symlinks: search inside symlinks as well

poppler

Section titled “poppler”
rovr's poppler integration

uses poppler to preview PDF files

  • enable: plugins.poppler.enabled = true
  • poppler_folder: set the location where the poppler tools are installed (e.g., /usr/bin or C:\Program Files\poppler\bin).
  • use_pdftocairo: whether to use pdftocairo instead of pdftoppm (may help performance)
  • threads: number of threads to use for processing PDF files (default is 1)

file(1)

Section titled “file(1)”

uses the file command to detect file types by their content (MIME type) instead of relying solely on file extensions. this is useful for files without extensions or with incorrect extensions.

rovr automatically detects file in your PATH, or you can set the YAZI_FILE_ONE or ROVR_FILE_ONE (higher priority) environment variables to specify a custom path.

  • enable: plugins.file_one.enabled = true
  • mime_rules: map MIME type patterns to preview types. supports glob patterns (e.g., text/* matches text/plain, text/html, etc.)

the default mime rules are:

[plugins.file_one.mime_rules]
"text/*" = "text"
"image/*" = "image"
"application/pdf" = "pdf"
"application/zip" = "archive"
"application/x-tar" = "archive"
"application/gzip" = "archive"
"application/x-bzip2" = "archive"
"application/x-xz" = "archive"
"application/x-rar" = "archive"
"application/x-7z-compressed" = "archive"
"inode/directory" = "folder"

valid preview types are: text, image, pdf, archive, folder (for now)

when enabled, rovr will:

  1. try to detect the file’s MIME type using file
  2. match against your configured mime_rules
  3. fall back to extension-based detection if no rule matches

for binary files that can’t be previewed, the MIME type will be displayed alongside the “not UTF-8” message.

a plugin system is also under works, stay tuned!