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.
example.mp4
Before getting started, ensure that the following dependencies are installed on your system:
- nerd-fonts (required, for icons)
- ffmpegthumbnailer (optional, for video thumbnails)
- unar (optional, for archive preview)
- jq (optional, for JSON preview)
- poppler (optional, for PDF preview)
- fd (optional, for file searching)
- rg (optional, for file content searching)
- fzf (optional, for directory jumping)
- zoxide (optional, for directory jumping)
Arch Linux
Install with paru or your favorite AUR helper:
paru -S yazi ffmpegthumbnailer unarchiver jq poppler fd ripgrep fzf zoxideOr, you can replace yazi with yazi-bin package if you want pre-built binary instead of compiling by yourself.
macOS
Install the dependencies with Homebrew:
brew install ffmpegthumbnailer unar jq poppler fd ripgrep fzf zoxide
brew tap homebrew/cask-fonts && brew install --cask font-symbols-only-nerd-fontAnd download the latest release from here. Or you can install Yazi via cargo:
cargo install --git https://github.com/sxyazi/yazi.gitNix
Nix users can install Yazi from the NUR:
nix-env -iA nur.repos.xyenon.yaziOr add the following to your configuration:
# configuration.nix
environment.systemPackages = with pkgs; [
nur.repos.xyenon.yazi
];If you prefer to use the most recent code, use nur.repos.xyenon.yazi-unstable instead.
Build from source
Execute the following commands to clone the project and build Yazi:
git clone https://github.com/sxyazi/yazi.git
cd yazi
cargo build --releaseThen, you can run:
./target/release/yaziyaziIf you want to use your own config, copy the config folder to ~/.config/yazi, and modify it as you like.
There is a wrapper of yazi, that provides the ability to change the current working directory when yazi exiting, feel free to use it:
function ya() {
tmp="$(mktemp -t "yazi-cwd.XXXXX")"
yazi --cwd-file="$tmp"
if cwd="$(cat -- "$tmp")" && [ -n "$cwd" ] && [ "$cwd" != "$PWD" ]; then
cd -- "$cwd"
fi
rm -f -- "$tmp"
}- Discord Server (English mainly): https://discord.gg/qfADduSdJu
- Telegram Group (Chinese mainly): https://t.me/yazi_rs
| 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 |
| Hyper | Sixel graphics format | ✅ Built-in |
| foot | 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.
See Feature requests for more details.
Yazi is MIT licensed.