Skip to content
/ yazi Public
forked from sxyazi/yazi

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

License

Notifications You must be signed in to change notification settings

bxb100/yazi

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation


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, Archive Extraction, Visual Mode, File Chooser, Git Integration, Mount Manager
  • ๐ŸŽจ Theme System, Mouse Support, Trash Bin, Custom Layouts, Virtual Filesystem, CSI u, OSC 52
  • ... and more!
example.mp4

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 Inline images protocol โŒ Rio renders images at incorrect sizes
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

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.

About

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

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 94.3%
  • Lua 4.7%
  • Other 1.0%