647bda93aa
Note that the rust version is still stable in flake.nix which is used to build the provide the app via flake. The rustfmt.toml rules are only supported by rust nightly. With the current stable rust tool chain in flake.nix, `cargo fmt` gives me warnings like ``` Warning: can't set `wrap_comments = true`, unstable features are only available in nightly channel. Warning: can't set `format_code_in_doc_comments = false`, unstable features are only available in n ``` The format result with those warnings is different from the current code base for almost all files. I guess the main contributors of the repo use nightly rust. If so, we should make it consistent in shell.nix to help other contributors onboard with the same env. |
||
|---|---|---|
| .github | ||
| nix | ||
| scripts | ||
| yazi-adaptor | ||
| yazi-config | ||
| yazi-core | ||
| yazi-fm | ||
| yazi-plugin | ||
| yazi-shared | ||
| .envrc | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| cspell.json | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| README.md | ||
| rustfmt.toml | ||
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
- Discord Server (English mainly): https://discord.gg/qfADduSdJu
- Telegram Group (Chinese mainly): https://t.me/yazi_rs
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.