liucheng023 / yazi

💥 Blazing fast terminal file manager written in Rust, based on async I/O.

Yazi - ⚡️ Blazing Fast Terminal File Manager

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++, 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 (coming soon), custom previewer, and custom preloader; Just some pieces of Lua.
• 🧰 Integration with fd, rg, fzf, zoxide
• 💫 Vim-like input/select component, auto-completion for cd paths
• 🏷️ Multi-Tab Support, Scrollable Preview (for videos, PDFs, archives, directories, code, etc.)
• 🔄 Batch Renaming, Visual Mode, File Chooser
• 🎨 Theme System, Custom Layouts, Trash Bin, CSI u
• ... and more!

example.mp4

⚠️ Note: Yazi is currently in heavy development and may be unstable. The API is subject to change without prior notice.

Documentation

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

Discussion

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

Image Preview

Platform	Protocol	Support
kitty	Kitty unicode placeholders	✅ Built-in
Konsole	Kitty old protocol	✅ Built-in
iTerm2	Inline images protocol	✅ Built-in
WezTerm	Inline images protocol	✅ Built-in
Mintty (Git Bash)	Inline images protocol	✅ Built-in
foot	Sixel graphics format	✅ Built-in
Ghostty	Kitty old protocol	✅ Built-in
Black Box	Sixel graphics format	✅ Built-in
Hyper	Sixel graphics format	✅ Built-in
X11 / Wayland	Window system protocol	☑️ Überzug++ required
Fallback	Chafa	☑️ Überzug++ required

Yazi automatically selects the appropriate preview method for you, based on the priority from top to bottom. That's relying on the $TERM, $TERM_PROGRAM, and $XDG_SESSION_TYPE variables, make sure you don't overwrite them by mistake!

For instance, if your terminal is Alacritty, which doesn't support displaying images itself, but you are running on an X11/Wayland environment, it will automatically use the "Window system protocol" to display images -- this requires you to have Überzug++ installed.

Here is a guide for tmux users: Image preview within tmux

TODO

See Feature requests for more details.

License

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