Skip to content
/ yazi Public
forked from sxyazi/yazi

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

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE-ICONS
Notifications You must be signed in to change notification settings

AidanV/yazi

 
 

Repository files navigation

Yazi logo

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, custom previewer/preloader/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 always up to date, or pin them to a specific version.
  • 🧰 Integration with fd, rg, fzf, zoxide
  • 💫 Vim-like input/select/which/notify component, auto-completion for cd paths
  • 🏷️ Multi-Tab Support, Cross-directory selection, Scrollable Preview (for videos, PDFs, archives, directories, code, etc.)
  • 🔄 Bulk Renaming, Visual Mode, File Chooser
  • 🎨 Theme System, Mouse Support, Trash Bin, Custom Layouts, 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

Discussion

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
VSCode Inline images protocol ✅ Built-in
Tabby Inline images protocol ✅ Built-in
Hyper Inline images protocol ✅ Built-in
X11 / Wayland Window system protocol ☑️ Überzug++ required
Fallback ASCII art (Unicode block) ☑️ Chafa required

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

License

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

About

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

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE-ICONS

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 93.4%
  • Lua 5.7%
  • Other 0.9%