sxyazi/yazi
1
1
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2024-12-25 01:31:36 +03:00
Code Issues Packages Projects Releases Wiki Activity
💥 Blazing fast terminal file manager written in Rust, based on async I/O.
288 Commits 2 Branches 21 Tags 44 MiB
Rust 92.8%
Lua 6.3%
Nix 0.7%
Shell 0.2%
2b731748e4
Go to file
XOR-op 2b731748e4
chore: ignore configuration of editor (#322)
2023-10-26 23:02:37 +08:00
.github feat: add lock and no-response workflow 2023-10-26 11:35:45 +08:00
nix fix: change the rust tool chain in shell.nix from stable to nightly (#314) 2023-10-24 16:16:24 +08:00
scripts refactor: publish to crates.io (#298) 2023-10-22 16:34:20 +08:00
yazi-adaptor fix: use WAYLAND_DISPLAY and DISPLAY to detect Wayland/X11 when XDG_SESSION_TYPE is not set (#312) 2023-10-24 23:16:19 +08:00
yazi-config feat: add config support for coordinate and size adjustment for ueberzugpp image preview (#304) 2023-10-23 14:46:03 +08:00
yazi-core fix: jq previews empty when the user sets tab_size=8 (#320) 2023-10-26 01:33:07 +08:00
yazi-fm refactor: format and adjust log levels 2023-10-23 16:07:08 +08:00
yazi-plugin refactor: format and adjust log levels 2023-10-23 16:07:08 +08:00
yazi-shared refactor: remove the warning of unused variable, fix #300 2023-10-23 15:58:22 +08:00
.envrc refactor(nix): add shell completion and avoid impure (#293) 2023-10-22 08:10:53 +08:00
.gitignore chore: ignore configuration of editor (#322) 2023-10-26 23:02:37 +08:00
Cargo.lock refactor: publish to crates.io (#298) 2023-10-22 16:34:20 +08:00
Cargo.toml refactor: publish to crates.io (#298) 2023-10-22 16:34:20 +08:00
cspell.json refactor: publish to crates.io (#298) 2023-10-22 16:34:20 +08:00
flake.lock refactor(nix): add shell completion and avoid impure (#293) 2023-10-22 08:10:53 +08:00
flake.nix fix: change the rust tool chain in shell.nix from stable to nightly (#314) 2023-10-24 16:16:24 +08:00
LICENSE fix: typo of LICENSE file (#201) 2023-09-21 23:11:51 +08:00
README.md docs: new doc url 2023-10-19 08:54:51 +08:00
rustfmt.toml chore: add rustfmt.toml 2023-08-08 21:02:56 +08:00

README.md

Yazi - ⚡️ Blazing Fast Terminal File Manager

Yazi ("duck" in Chinese) 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 Encoding: Combined with the pre-caching mechanism, greatly accelerates image and normal file loading.
  • 🧰 Integration with fd, rg, fzf, zoxide
  • 💫 Vim-like Input component, and Select component
  • 🏷️ Multi-Tab Support, Scrollable Preview (for videos, PDFs, archives, directories, code, etc.)
  • 🔄 Batch Renaming, Visual Mode, File Chooser
  • 🎨 Theme System, Custom Layouts, Trash Bin, CSI u
  • ... and more!

https://github.com/sxyazi/yazi/assets/17523360/92ff23fa-0cd5-4f04-b387-894c12265cc7

⚠️ Note: Yazi is currently in active development and may be unstable. The API is subject to change without prior notice.

Documentation

Discussion

Image Preview

Platform Protocol Support
Kitty Terminal graphics protocol ✅ Built-in
WezTerm Terminal graphics protocol ✅ Built-in
Konsole Terminal graphics protocol ✅ Built-in
iTerm2 Inline images protocol ✅ Built-in
Mintty (Git Bash) Inline images protocol ✅ Built-in
Hyper Sixel graphics format ✅ Built-in
foot Sixel graphics format ✅ Built-in
Black Box Sixel graphics format ✅ Built-in
X11 / Wayland Window system protocol ☑️ Überzug++ required
Fallback Chafa ☑️ Überzug++ required

Yazi automatically selects the appropriate preview method for you, based on the priority from top to bottom. That's relying on the $TERM, $TERM_PROGRAM, and $XDG_SESSION_TYPE variables, make sure you don't overwrite them by mistake!

For instance, if your terminal is Alacritty, which doesn't support displaying images itself, but you are running on an X11/Wayland environment, it will automatically use the "Window system protocol" to display images -- this requires you to have Überzug++ installed.

Here is a guide for tmux users: Image preview within tmux

TODO

See Feature requests for more details.

License

Yazi is MIT licensed. For more information check the LICENSE file.