# yazi
**Repository Path**: lowkey110/yazi
## Basic Information
- **Project Name**: yazi
- **Description**: π₯ Blazing fast terminal file manager written in Rust, based on async I/O.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://yazi-rs.github.io
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-03-20
- **Last Updated**: 2026-03-20
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## 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?](https://yazi-rs.github.io/blog/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 Renaming, Archive Extraction, Visual Mode, File Chooser, [Git Integration](https://github.com/yazi-rs/plugins/tree/main/git.yazi), [Mount Manager](https://github.com/yazi-rs/plugins/tree/main/mount.yazi)
- π¨ Theme System, Mouse Support, 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
- Usage: https://yazi-rs.github.io/docs/installation
- Features: https://yazi-rs.github.io/features
## Discussion
- Discord Server (English mainly): https://discord.gg/qfADduSdJu
- Telegram Group (Chinese mainly): https://t.me/yazi_rs
## Image Preview
| Platform | Protocol | Support |
| ---------------------------------------------------------------------------- | -------------------------------------- | ---------------------------------------- |
| [kitty](https://github.com/kovidgoyal/kitty) (>= 0.28.0) | [Kitty unicode placeholders][kgp] | β
Built-in |
| [iTerm2](https://iterm2.com) | [Inline images protocol][iip] | β
Built-in |
| [WezTerm](https://github.com/wez/wezterm) | [Inline images protocol][iip] | β
Built-in |
| [Konsole](https://invent.kde.org/utilities/konsole) | [Kitty old protocol][kgp-old] | β
Built-in |
| [foot](https://codeberg.org/dnkl/foot) | [Sixel graphics format][sixel] | β
Built-in |
| [Ghostty](https://github.com/ghostty-org/ghostty) | [Kitty unicode placeholders][kgp] | β
Built-in |
| [Windows Terminal](https://github.com/microsoft/terminal) (>= v1.22.10352.0) | [Sixel graphics format][sixel] | β
Built-in |
| [st with Sixel patch](https://github.com/bakkeby/st-flexipatch) | [Sixel graphics format][sixel] | β
Built-in |
| [Warp](https://www.warp.dev) (macOS/Linux only) | [Inline images protocol][iip] | β
Built-in |
| [Tabby](https://github.com/Eugeny/tabby) | [Inline images protocol][iip] | β
Built-in |
| [VSCode](https://github.com/microsoft/vscode) | [Inline images protocol][iip] | β
Built-in |
| [Rio](https://github.com/raphamorim/rio) | [Inline images protocol][iip] | β Rio renders images at incorrect sizes |
| [Black Box](https://gitlab.gnome.org/raggesilver/blackbox) | [Sixel graphics format][sixel] | β
Built-in |
| [Bobcat](https://github.com/ismail-yilmaz/Bobcat) | [Inline images protocol][iip] | β
Built-in |
| X11 / Wayland | Window system protocol | βοΈ [Γberzug++][ueberzug] required |
| Fallback | [ASCII art (Unicode block)][ascii-art] | βοΈ [Chafa][chafa] required (>= 1.16.0) |
See https://yazi-rs.github.io/docs/image-preview for details.
[kgp]: https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders
[kgp-old]: https://github.com/sxyazi/yazi/blob/main/yazi-adapter/src/drivers/kgp_old.rs
[iip]: https://iterm2.com/documentation-images.html
[sixel]: https://www.vt100.net/docs/vt3xx-gp/chapter14.html
[ascii-art]: https://en.wikipedia.org/wiki/ASCII_art
[ueberzug]: https://github.com/jstkdng/ueberzugpp
[chafa]: https://hpjansson.org/chafa/
## Special Thanks
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](LICENSE) file.