sxyazi/yazi
1
1
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2025-01-02 13:50:15 +03:00
Code Issues Packages Projects Releases Wiki Activity
💥 Blazing fast terminal file manager written in Rust, based on async I/O.
732 Commits 2 Branches 21 Tags 45 MiB
Rust 92.8%
Lua 6.3%
Nix 0.7%
Shell 0.2%
e940d81d2a
Go to file
e82eric e940d81d2a
feat: support image preview in Windows Terminal (#1588) 
Co-authored-by: sxyazi <sxyazi@gmail.com>
2024-09-02 11:47:30 +08:00
.github feat: switch to kitty unicode placeholders for Ghostty image previewing (#1427) 2024-08-07 19:13:32 +08:00
assets feat: add desktop entry and logo (#534) 2024-01-18 00:46:04 +08:00
nix chore: bump version to 0.3.1 (#1492) 2024-08-15 22:39:36 +08:00
scripts chore: set MACOSX_DEPLOYMENT_TARGE to 10.11 to make the binary compatible with old macOS (#1532) 2024-08-22 23:41:02 +08:00
snap chore: update snap to core24 (#1415) 2024-08-05 17:17:10 +08:00
yazi-adapter feat: support image preview in Windows Terminal (#1588) 2024-09-02 11:47:30 +08:00
yazi-boot fix: fallback to PollWatcher on WSL (#1574) 2024-08-31 01:33:28 +08:00
yazi-cli chore: bump version to 0.3.2 2024-08-28 12:37:54 +08:00
yazi-config perf: truncate long lists in confirm dialogs (#1590) 2024-09-02 07:19:22 +08:00
yazi-core perf: truncate long lists in confirm dialogs (#1590) 2024-09-02 07:19:22 +08:00
yazi-dds chore: bump version to 0.3.2 2024-08-28 12:37:54 +08:00
yazi-fm feat: size linemode supports showing the file count for directories (#1591) 2024-09-02 09:11:30 +08:00
yazi-fs fix: squeeze offset of the file list after resizing window (#1500) 2024-08-30 10:11:41 +08:00
yazi-plugin feat: size linemode supports showing the file count for directories (#1591) 2024-09-02 09:11:30 +08:00
yazi-proxy chore: bump version to 0.3.2 2024-08-28 12:37:54 +08:00
yazi-scheduler fix: continuous fetcher was not scheduled consecutively (#1575) 2024-08-31 11:57:39 +08:00
yazi-shared perf: truncate long lists in confirm dialogs (#1590) 2024-09-02 07:19: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
.styluaignore ci: consistently enforce Lua coding style (#1029) 2024-05-15 10:54:20 +08:00
Cargo.lock fix: continuous fetcher was not scheduled consecutively (#1575) 2024-08-31 11:57:39 +08:00
Cargo.toml fix: continuous fetcher was not scheduled consecutively (#1575) 2024-08-31 11:57:39 +08:00
CONTRIBUTING.md refactor: rename crate yazi-adaptor to yazi-adapter 2024-06-08 19:28:46 +08:00
cspell.json fix: check compositor support status before using ueberzug wayland output (#1566) 2024-08-30 02:00:59 +08:00
flake.lock fix(nix): pin rust-overlay to workaround cargo-c (#1442) 2024-08-08 23:07:28 +08:00
flake.nix fix(nix): pin rust-overlay to workaround cargo-c (#1442) 2024-08-08 23:07:28 +08:00
LICENSE fix: typo of LICENSE file (#201) 2023-09-21 23:11:51 +08:00
LICENSE-ICONS feat!: redesign icons (#1086) 2024-05-25 22:56:08 +08:00
README.md feat: support image preview in Windows Terminal (#1588) 2024-09-02 11:47:30 +08:00
rustfmt.toml chore: add rustfmt.toml 2023-08-08 21:02:56 +08:00
stylua.toml ci: consistently enforce Lua coding style (#1029) 2024-05-15 10:54:20 +08:00

README.md

Yazi logo

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/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/select/confirm/which/notify component, auto-completion for cd paths
  • 🏷️ Multi-Tab Support, Cross-directory selection, Scrollable Preview (for videos, PDFs, archives, directories, code, etc.)
  • 🔄 Bulk Renaming, Visual Mode, File Chooser
  • 🎨 Theme System, Mouse Support, Trash Bin, Custom Layouts, CSI u
  • ... and more!

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

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

Documentation

Discussion

Image Preview

Platform Protocol Support
kitty Kitty unicode placeholders ✅ Built-in
Konsole Kitty old protocol ✅ Built-in
iTerm2 Inline images protocol ✅ Built-in
WezTerm Inline images protocol ✅ Built-in
Mintty (Git Bash) Inline images protocol ✅ Built-in
foot Sixel graphics format ✅ Built-in
Ghostty Kitty unicode placeholders ✅ Built-in
Windows Terminal (>= v1.22.2362.0) Sixel graphics format ✅ Built-in
Black Box Sixel graphics format ✅ Built-in
VSCode Inline images protocol ✅ Built-in
Tabby Inline images protocol ✅ Built-in
Hyper 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.

License

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