Home
Softono

Yazi

Open source MIT Rust
39.2K
Stars
891
Forks
71
Issues
94
Watchers
2 months
Last Commit

 About Yazi

πŸ’₯ Blazing fast terminal file manager written in Rust, based on async I/O.

Platforms

Web Self-hosted Linux Windows macOS Android

Languages

Rust

Need Help Installing Yazi?

We provide expert installation service for this software. Our team will install, configure, and secure Yazi on your server. plans start at just $30.

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

Discussion

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 (>= 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

RustRover logo

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.