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)

Searching Database…

42.9K ·GitHub
这是什么?Yazi(意思是'鸭子')是一个用 Rust 编写的、速度极快的终端文件管理器,基于非阻塞异步 I/O 构建,提供高效、易用且可高度自定义的文件管理体验。
那它是一个独立的终端应用,还是需要接入我的 shell 或编辑器的插件?它是一个独立的 TUI 应用,自带主题系统、鼠标支持和拖放功能——不是 shell 或编辑器的插件。它改为对接 ripgrep、fd、fzf、zoxide 等外部工具。
我怎么把它跑起来?为你的操作系统安装一个软件包或预编译二进制文件——macOS、Linux 和 Windows 都有覆盖——然后在终端里运行 'yazi';安装文档里列出了各平台的安装方式。
图片预览需要额外装工具吗?大多数终端什么都不用装:kitty、iTerm2、WezTerm、Ghostty、Windows Terminal、Konsole、foot 等都开箱即用。X11/Wayland 下需要 Überzug++,其他情况则通过 Chafa(>= 1.16.0)回退为 ASCII 字符画。
它稳定到能当我日常用的文件管理器吗?可以——作者说这个公开测试版已经能当日常工具用了,不过它仍在密集开发中,版本之间可能会有破坏性变更。
我用惯了 vim,上手会有熟悉感吗?会有——它内置了类似 vim 的 input/pick/confirm/which/notify 组件,cd 路径支持自动补全,还有 Visual Mode,vim 的使用习惯可以直接沿用。
Yazi 为什么比其他终端文件管理器快?所有 I/O 都是异步的,CPU 任务会分配到多个线程上,任务调度还能提供实时的进度更新、取消和优先级功能。内置的代码高亮和图片解码再加上预加载,让图片和文件加载更快。
能用插件或自定义主题来扩展它吗?可以——它有一个用 Lua 写的并发插件系统,涵盖能重写大部分界面的 UI 插件、功能型插件,以及自定义 previewer/preloader/spotter/fetcher 钩子。内置的包管理器一条命令就能安装插件和主题,还能锁定特定版本。
除了基本的文件浏览,它开箱还支持哪些功能?多标签页浏览和跨目录选择,视频、PDF、压缩包和代码的可滚动预览,批量重命名/新建,解压压缩包,文件选择器,git 集成,挂载管理器,回收站,以及主题系统。
我可以用它管理远程服务器上的文件吗?可以——它的虚拟文件系统支持通过自定义 VFS provider 和搜索引擎来管理远程文件。它还内置了一个数据分发服务,不需要单独的服务端进程就能在多个实例之间同步状态。
What are similar projects?nnn, lazy.nvim, vimrc, ranger, helix, gitui, nerdtree, neovim
Creator
sxyazi
Size
9.4 MB
Stars
42.9K
Age
3y
Commits · 90 Days