Yazi

<div align="center"> ^{Special thanks to:}<br>

|<a href="https://go.warp.dev/yazi" target="_blank"><img alt="Warp sponsorship" width=350 src="https://github.com/warpdotdev/brand-assets/blob/main/Github/Sponsor/Warp-Github-LG-02.png"><br><b>Warp, built for coding with multiple AI agents</b><br>^{Available for macOS, Linux and Windows}</a>|<a href="https://git-tower.com/?utm_source=yazi&utm_medium=referral" target="_blank"><img alt="Tower sponsorship" width=350 src="https://github.com/user-attachments/assets/c561a30f-2c5e-4f33-bbec-2bf9df26431a"><br><b>The most powerful Git client for Mac and Windows</b></a>| |-|-|

</div>

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 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 Renaming, Archive Extraction, Visual Mode, File Chooser, Git Integration, Mount Manager
• 🎨 Theme System, Mouse Support, Trash Bin, Custom Layouts, CSI u, OSC 52
• ... 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 with Sixel patch | Sixel graphics format | ✅ Built-in | | Warp (macOS/Linux only) | Inline images protocol | ✅ Built-in | | Tabby | Inline images protocol | ✅ Built-in | | VSCode | Inline images protocol | ✅ Built-in | | Rio | Inline images protocol | ❌ Rio renders images at incorrect sizes | | 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.

<!-- Protocols --> <!-- Dependencies -->

Special Thanks

<img alt="RustRover logo" align="right" width="200" src="https://resources.jetbrains.com/storage/products/company/brand/logos/RustRover.svg">

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.