sxyazi/yazi
1
1
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2024-11-28 02:46:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
💥 Blazing fast terminal file manager written in Rust, based on async I/O.
204 Commits 2 Branches 18 Tags 43 MiB
Rust 92.6%
Lua 6.4%
Nix 0.8%
Shell 0.2%
5a7b84a8fc
Go to file
三咲雅 · Misaki Masa 5a7b84a8fc
docs: use new documentation
2023-09-21 09:15:31 +08:00
adaptor fix: image preview not working on Zellij (#181) 2023-09-19 01:21:00 +08:00
app feat: new sort_sensitive option, and sort case-insensitively by default (#155) 2023-09-14 09:58:32 +08:00
config fix: inconsistent Shift key behavior on Unix and Windows (#174) 2023-09-21 00:29:25 +08:00
core feat: make trash optional (#178) 2023-09-19 08:54:31 +08:00
shared feat: make trash optional (#178) 2023-09-19 08:54:31 +08:00
.gitignore refactor: use workspace to speed up builds (#13) 2023-08-02 10:29:49 +08:00
build.sh chore: bump version to v0.1.4 2023-09-01 14:38:16 +08:00
Cargo.lock fix: SIGTSTP does not exist on Windows 2023-09-12 02:13:11 +08:00
Cargo.toml refactor: use workspace to speed up builds (#13) 2023-08-02 10:29:49 +08:00
cspell.json feat: suspend process (Ctrl-Z) (#120) 2023-09-07 16:08:51 +08:00
LICENCE first commit 2023-07-08 19:46:43 +08:00
README.md docs: use new documentation 2023-09-21 09:15:31 +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/0ba95b83-4784-44cd-9735-5e63d1153538

⚠️ 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.