yazi Documentation

File: README.md Copy Chapter

Yazi - ⚡️ Blazing Fast Terminal File Manager Copy Chapter

Yazi (means "duck") is a terminal file manager written in Rust, based on non-blocking async I/O. It aims to provide an efficient, user-friendly, and customizable file management experience.

💡 A new article explaining its internal workings: Why is Yazi Fast?

• 🚀 Full Asynchronous Support: All I/O operations are asynchronous, CPU tasks are spread across multiple threads, making the most of available resources.
• 💪 Powerful Async Task Scheduling and Management: Provides real-time progress updates, task cancellation, and internal task priority assignment.
• 🖼️ Built-in Support for Multiple Image Protocols: Also integrated with Überzug++ and Chafa, covering almost all terminals.
• 🌟 Built-in Code Highlighting and Image Decoding: Combined with the pre-loading mechanism, greatly accelerates image and normal file loading.
• 🔌 Concurrent Plugin System: UI plugins (rewriting most of the UI), functional plugins, custom previewer/preloader/spotter/fetcher; Just some pieces of Lua.
• ☁️ Virtual Filesystem: Remote file management, custom VFS provider, custom search engines.
• 📡 Data Distribution Service: Built on a client-server architecture (no additional server process required), integrated with a Lua-based publish-subscribe model, achieving cross-instance communication and state persistence.
• 📦 Package Manager: Install plugins and themes with one command, keeping them up-to-date, or pin them to a specific version.
• 🧰 Integration with ripgrep, fd, fzf, zoxide
• 💫 Vim-like input/pick/confirm/which/notify component, auto-completion for cd paths
• 🏷️ Multi-Tab Support, Cross-directory selection, Scrollable Preview (for videos, PDFs, archives, code, directories, etc.)
• 🔄 Bulk Rename/Create, Archive Extraction, Visual Mode, File Chooser, Git Integration, Mount Manager
• 🎨 Theme System, Mouse Support, Drag and Drop, Trash Bin, Custom Layouts, CSI u, OSC 52, CSI 2031
• ... and more!

https://github.com/sxyazi/yazi/assets/17523360/92ff23fa-0cd5-4f04-b387-894c12265cc7

Project status Copy Chapter

Public beta, can be used as a daily driver.

Yazi is currently in heavy development, expect breaking changes.

Documentation Copy Chapter

• Usage: https://yazi-rs.github.io/docs/installation
• Features: https://yazi-rs.github.io/features

Discussion Copy Chapter

• Discord Server (English mainly): https://discord.gg/qfADduSdJu
• Telegram Group (Chinese mainly): https://t.me/yazi_rs

Image Preview Copy Chapter

See https://yazi-rs.github.io/docs/image-preview for details.

Special Thanks Copy Chapter

Thanks to RustRover team for providing open-source licenses to support the maintenance of Yazi.

Active code contributors can contact @sxyazi to get a license (if any are still available).

License Copy Chapter

Yazi is MIT-licensed. For more information check the LICENSE file.

File: yazi-config/preset/README.md Copy Chapter

Default Configuration

[!IMPORTANT]
If you're using a stable release of Yazi instead of the newest nightly build, make sure you're checking these files out from the shipped tag, not the newest main branch.

This directory contains the default configuration files for Yazi:

• yazi-default.toml: General configuration
• keymap-default.toml: Keybindings configuration
• theme-dark.toml: Dark color scheme (loaded when your terminal is in dark mode)
• theme-light.toml: Light color scheme (loaded when your terminal is in light mode)

These files are already included with Yazi when you install the release, so you don't need to manually download or copy them to your Yazi configuration directory.

However, if you want to customize certain configurations:

• Create a yazi.toml in your config directory to override certain settings in yazi-default.toml, so either:
  • ~/.config/yazi/yazi.toml on Unix-like systems
  • %AppData%\yazi\config\yazi.toml on Windows
• Create a keymap.toml in your config directory to override certain settings in keymap-default.toml, so either:
  • ~/.config/yazi/keymap.toml on Unix-like systems
  • %AppData%\yazi\config\keymap.toml on Windows
• Create a theme.toml in your config directory to override certain settings in theme-light.toml and theme-dark.toml, so either:
  • ~/.config/yazi/theme.toml on Unix-like systems
  • %AppData%\yazi\config\theme.toml on Windows

For the user's theme.toml file, you can only apply the same color scheme to both the light and dark themes.

If you want more granular control over colors, specify two different flavors for light and dark modes under the [flavor] section of your theme.toml, and override them in your respective flavor instead.

Learn more Copy Chapter

• Configuration documentation
• Flavors documentation