yazi README

The project's README from github.com/sxyazi/yazi. As one markdown file: README.md.

Special thanks to:
Warp sponsorship
Warp, built for coding with multiple AI agents
Available for macOS, Linux and Windows

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?

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

Project status

Public beta, can be used as a daily driver.

Yazi is currently in heavy development, expect breaking changes.

Documentation

Discussion

Image Preview

Platform Protocol Support
kitty (>= 0.28.0) Kitty unicode placeholders ✅ Built-in
iTerm2 Inline images protocol ✅ Built-in
WezTerm Inline images protocol ✅ Built-in
Konsole Kitty old protocol ✅ Built-in
foot Sixel graphics format ✅ Built-in
Ghostty Kitty unicode placeholders ✅ Built-in
Windows Terminal (>= v1.22.10352.0) Sixel graphics format ✅ Built-in
st with Sixel patch Sixel graphics format ✅ Built-in
Warp (macOS/Linux only) Inline images protocol ✅ Built-in
Tabby Inline images protocol ✅ Built-in
VSCode Inline images protocol ✅ Built-in
Rio (>= 0.3.9) Kitty unicode placeholders ✅ Built-in
Black Box Sixel graphics format ✅ Built-in
Bobcat Inline images protocol ✅ Built-in
X11 / Wayland Window system protocol ☑️ Überzug++ required
Fallback ASCII art (Unicode block) ☑️ Chafa required (>= 1.16.0)

See https://yazi-rs.github.io/docs/image-preview for details.

Special Thanks

RustRover logo

Thanks to RustRover team for providing open-source licenses to support the maintenance of Yazi.

Active code contributors can contact @sxyazi to get a license (if any are still available).

License

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

yazi (sxyazi/yazi)

image
Searching Database…

42.9K ·GitHub
What is this?Yazi (means 'duck') is a blazing fast terminal file manager written in Rust, built on non-blocking async I/O for an efficient, user-friendly and customizable file management experience.
So is this a standalone terminal app, or something that plugs into my shell or editor?It is a standalone TUI application with its own theme system, mouse support and drag-and-drop — not a plugin for your shell or editor. It hooks into external tools like ripgrep, fd, fzf and zoxide instead.
How do I get it running?Install a package or prebuilt binary for your OS — macOS, Linux and Windows are all covered — then run 'yazi' in your terminal; the installation docs list the options per platform.
Do I need extra tools for image previews?Most terminals need nothing: kitty, iTerm2, WezTerm, Ghostty, Windows Terminal, Konsole, foot and others work built-in. X11/Wayland requires Überzug++, and anything else falls back to ASCII art via Chafa (>= 1.16.0).
Is it stable enough to use as my everyday file manager?Yes — it is a public beta the author says can be used as a daily driver, but it is in heavy development, so expect breaking changes between releases.
Will it feel familiar if I am coming from vim?Yes — it ships vim-like input/pick/confirm/which/notify components with auto-completion for cd paths, plus a Visual Mode, so vim habits carry over.
What makes Yazi faster than other terminal file managers?All I/O is asynchronous and CPU tasks are spread across multiple threads, with task scheduling providing real-time progress updates, cancellation and priorities. Built-in code highlighting and image decoding combined with preloading make images and files load faster.
Can I extend it with plugins or custom themes?Yes — a concurrent plugin system in Lua covers UI plugins that rewrite most of the UI, functional plugins, and custom previewer/preloader/spotter/fetcher hooks. A built-in package manager installs plugins and themes with one command and can pin specific versions.
What does it handle out of the box besides basic navigation?Multi-tab browsing with cross-directory selection, scrollable previews for videos, PDFs, archives and code, bulk rename/create, archive extraction, a file chooser, git integration, a mount manager, a trash bin and a theme system.
Can I use it to manage files on remote servers?Yes — its virtual filesystem supports remote file management with custom VFS providers and search engines. A built-in data distribution service also syncs state across instances without a separate server process.
What are similar projects?nnn, lazy.nvim, vimrc, ranger, helix, gitui, nerdtree, neovim
Creator
sxyazi
Size
9.5 MB
Stars
42.9K
Age
3y
Commits · 90 Days