Repository files navigation

^{Special thanks to:}

Warp, built for coding with multiple AI agents
^{Available for macOS, Linux and Windows}

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.
• 📡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, Virtual Filesystem, CSI u, OSC 52
• ... and more!

Public beta, can be used as a daily driver.

Yazi is currently in heavy development, expect breaking changes.

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

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

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

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).

Yazi is MIT-licensed. For more information check theLICENSE file.