💥 Blazing fast terminal file manager written in Rust, based on async I/O.
Go to file
karimElmougi d2ebadb631
chore: move common dependencies to workspace Cargo.toml (#1388)
Co-authored-by: sxyazi <sxyazi@gmail.com>
2024-08-03 10:45:46 +08:00
.github chore: update issue templates 2024-08-02 17:43:41 +08:00
assets feat: add desktop entry and logo (#534) 2024-01-18 00:46:04 +08:00
nix refactor(nix): cleanup and switch to nixfmt-rfc-style (#1376) 2024-08-01 11:01:07 +08:00
scripts feat: add filtering tip in help component (#1361) 2024-08-02 15:20:14 +08:00
snap feat: add support for snap packages (#531) 2024-01-18 00:20:45 +08:00
yazi-adapter chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-boot chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-cli chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-config chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-core chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-dds chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-fm chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-fs chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-plugin chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-proxy chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-scheduler chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
yazi-shared chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +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 chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
Cargo.toml chore: move common dependencies to workspace Cargo.toml (#1388) 2024-08-03 10:45:46 +08:00
CONTRIBUTING.md refactor: rename crate yazi-adaptor to yazi-adapter 2024-06-08 19:28:46 +08:00
cspell.json fix: adapt to a wider range of terminal cursor management through DECSET and DECRQM requests (#1346) 2024-07-25 22:25:26 +08:00
flake.lock feat: new extract builtin plugin for archive extracting (#1321) 2024-07-31 08:27:22 +08:00
flake.nix refactor(nix): cleanup and switch to nixfmt-rfc-style (#1376) 2024-08-01 11:01:07 +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 fix: adapt to a wider range of terminal cursor management through DECSET and DECRQM requests (#1346) 2024-07-25 22:25:26 +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

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/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 old protocol 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.