sxyazi / yazi

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

Home Page:https://yazi-rs.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The main branch is the upcoming v0.4 development version. Please see the shipped tag for the stable version of Yazi.

For breaking changes, see Migrating to Yazi v0.4.0.



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++ 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, 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
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.2702.0) Sixel graphics format βœ… Built-in
st with Sixel patch Sixel graphics format βœ… Built-in
Tabby Inline images protocol βœ… Built-in
VSCode Inline images protocol βœ… Built-in
Rio Inline images protocol ❌ Rio doesn't correctly clear images (#1786)
Black Box Sixel graphics format βœ… 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.

https://yazi-rs.github.io

License:MIT License


Languages

Language:Rust 92.7%Language:Lua 6.3%Language:Nix 0.8%Language:Shell 0.2%