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

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, and custom preloader; 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, Custom Layouts, Trash Bin, 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 Chafa โ˜‘๏ธ รœberzug++ 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 94.5%Language:Lua 4.5%Language:Nix 0.7%Language:Shell 0.3%