FROM THE PROJECT
README & features
Source excerpts from the project's README. Not an independent review, verification or security audit.
Special thanks to:
| Warp, built for coding with multiple AI agents Available for macOS, Linux and Windows |
|---|
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++ 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, Rclone
💫 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
Public beta, can be used as a daily driver.
Yazi is currently in heavy development, expect breaking changes.
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 (>= 0.28.0) | Kitty unicode placeholders | ✅ Built-in |
| iTerm2 | Inline images protocol | ✅ Built-in |
| WezTerm | Inline images protocol | ✅ Built-in |
| Konsole | Kitty old protocol | ✅ Built-in |
| foot | Sixel graphics format | ✅ Built-in |
| Ghostty | Kitty unicode placeholders | ✅ Built-in |
| Windows Terminal (>= v1.22.10352.0) | Sixel graphics format | ✅ Built-in |
| st-graphics | Kitty unicode placeholders | ✅ Built-in |
| Warp (macOS/Linux only) | Inline images protocol | ✅ Built-in |
| Tabby | Inline images protocol | ✅ Built-in |
| VSCode | Inline images protocol | ✅ Built-in |
| Rio (>= 0.3.9) | Kitty unicode placeholders | ✅ Built-in |
| Black Box | Sixel graphics format | ✅ Built-in |
| Bobcat | Inline images protocol | ✅ Built-in |
| X11 / Wayland | Window system protocol | ☑️ Überzug++ required |
| Fallback | ASCII art (Unicode block) | ☑️ Chafa required (>= 1.16.0) |
See https://yazi-rs.github.io/docs/image-preview for details.
Special Thanks
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
Yazi is MIT-licensed. For more information check the LICENSE file.
Read the original README
