2024-02-18 10:36:11 +03:00
< div align = "center" >
< img src = "assets/logo.png" alt = "Yazi logo" width = "20%" >
< / div >
2023-07-08 14:46:43 +03:00
## Yazi - ⚡️ Blazing Fast Terminal File Manager
2023-12-26 14:48:33 +03:00
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.
2023-07-08 14:46:43 +03:00
2023-11-02 14:19:45 +03:00
💡 A new article explaining its internal workings: [Why is Yazi Fast? ](https://yazi-rs.github.io/blog/why-is-yazi-fast )
2023-09-13 14:49:45 +03:00
2023-09-02 17:13:37 +03:00
- 🚀 **Full Asynchronous Support** : All I/O operations are asynchronous, CPU tasks are spread across multiple threads, making the most of available resources.
2023-09-12 17:05:28 +03:00
- 💪 **Powerful Async Task Scheduling and Management** : Provides real-time progress updates, task cancellation, and internal task priority assignment.
2023-09-03 07:06:45 +03:00
- 🖼️ **Built-in Support for Multiple Image Protocols** : Also integrated with Überzug++, covering almost all terminals.
2023-12-26 14:48:33 +03:00
- 🌟 **Built-in Code Highlighting and Image Decoding** : Combined with the pre-loading mechanism, greatly accelerates image and normal file loading.
2024-03-01 05:22:12 +03:00
- 🔌 **Concurrent Plugin System** : UI plugins (rewriting most of the UI), functional plugins, custom previewer, and custom preloader; Just some pieces of Lua.
2024-03-29 18:30:30 +03:00
- 📡 **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.
2024-05-07 08:42:45 +03:00
- 📦 **Package Manager** : Install plugins and themes with one command, keeping them always up to date, or pin them to a specific version.
2023-09-02 17:13:37 +03:00
- 🧰 Integration with fd, rg, fzf, zoxide
2024-03-29 18:30:30 +03:00
- 💫 Vim-like input/select/which/notify component, auto-completion for cd paths
2024-03-01 05:22:12 +03:00
- 🏷️ Multi-Tab Support, Cross-directory selection, Scrollable Preview (for videos, PDFs, archives, directories, code, etc.)
2024-01-30 20:22:55 +03:00
- 🔄 Bulk Renaming, Visual Mode, File Chooser
2023-09-03 07:06:45 +03:00
- 🎨 Theme System, Custom Layouts, Trash Bin, CSI u
- ... and more!
2023-09-02 17:13:37 +03:00
2023-09-21 04:52:26 +03:00
https://github.com/sxyazi/yazi/assets/17523360/92ff23fa-0cd5-4f04-b387-894c12265cc7
2023-07-18 20:11:04 +03:00
2023-11-29 11:07:58 +03:00
⚠️ Note: Yazi is currently in heavy development and may be unstable. The API is subject to change without prior notice.
2023-07-08 14:46:43 +03:00
2023-09-21 04:15:31 +03:00
## Documentation
2023-07-08 14:46:43 +03:00
2023-11-02 14:19:45 +03:00
- Usage: https://yazi-rs.github.io/docs/installation
2023-11-29 11:07:58 +03:00
- Features: https://yazi-rs.github.io/features
2023-08-28 11:57:52 +03:00
2023-08-09 14:12:15 +03:00
## Discussion
- Discord Server (English mainly): https://discord.gg/qfADduSdJu
- Telegram Group (Chinese mainly): https://t.me/yazi_rs
2023-07-30 06:53:40 +03:00
## Image Preview
2023-11-24 01:21:13 +03:00
| Platform | Protocol | Support |
| ----------------- | ----------------------------------------------------------------------------------------------------- | --------------------- |
| kitty | [Kitty unicode placeholders ](https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders ) | ✅ Built-in |
| Konsole | [Kitty old protocol ](https://github.com/sxyazi/yazi/blob/main/yazi-adaptor/src/kitty_old.rs ) | ✅ Built-in |
| iTerm2 | [Inline images protocol ](https://iterm2.com/documentation-images.html ) | ✅ Built-in |
| WezTerm | [Inline images protocol ](https://iterm2.com/documentation-images.html ) | ✅ Built-in |
| Mintty (Git Bash) | [Inline images protocol ](https://iterm2.com/documentation-images.html ) | ✅ Built-in |
| foot | [Sixel graphics format ](https://www.vt100.net/docs/vt3xx-gp/chapter14.html ) | ✅ Built-in |
2024-01-06 06:11:08 +03:00
| Ghostty | [Kitty old protocol ](https://github.com/sxyazi/yazi/blob/main/yazi-adaptor/src/kitty_old.rs ) | ✅ Built-in |
2023-11-24 01:21:13 +03:00
| Black Box | [Sixel graphics format ](https://www.vt100.net/docs/vt3xx-gp/chapter14.html ) | ✅ Built-in |
2024-03-01 05:22:12 +03:00
| VSCode | [Inline images protocol ](https://iterm2.com/documentation-images.html ) | ✅ Built-in |
| Tabby | [Inline images protocol ](https://iterm2.com/documentation-images.html ) | ✅ Built-in |
| Hyper | [Inline images protocol ](https://iterm2.com/documentation-images.html ) | ✅ Built-in |
2023-11-24 01:21:13 +03:00
| X11 / Wayland | Window system protocol | ☑️ Überzug++ required |
| Fallback | [Chafa ](https://hpjansson.org/chafa/ ) | ☑️ Überzug++ required |
2023-07-30 06:53:40 +03:00
2024-02-19 19:15:40 +03:00
See https://yazi-rs.github.io/docs/image-preview for details.
2023-07-08 14:46:43 +03:00
## License
2024-02-19 19:15:40 +03:00
Yazi is MIT-licensed. For more information check the [LICENSE ](LICENSE ) file.