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 и построенный на неблокирующем асинхронном вводе-выводе: работа с файлами получается эффективной, удобной и настраиваемой.
Так это отдельное приложение для терминала или что-то, что встраивается в мой шелл или редактор?Это самостоятельное TUI-приложение со своей системой тем, поддержкой мыши и drag-and-drop — не плагин к вашему шеллу или редактору. Зато оно подхватывает сторонние инструменты вроде ripgrep, fd, fzf и zoxide.
Как мне его запустить?Установите пакет или готовый бинарник для вашей ОС — macOS, Linux и Windows все поддерживаются — затем выполните 'yazi' в терминале; в документации по установке перечислены варианты для каждой платформы.
Нужны ли дополнительные инструменты для предпросмотра картинок?В большинстве терминалов ничего не нужно: kitty, iTerm2, WezTerm, Ghostty, Windows Terminal, Konsole, foot и другие работают сразу. Для X11/Wayland потребуется Überzug++, а во всех остальных случаях картинка показывается как ASCII-арт через Chafa (>= 1.16.0).
Он достаточно стабилен, чтобы использовать его как основной файловый менеджер на каждый день?Да — это публичная бета, и автор говорит, что её можно использовать каждый день, но проект активно разрабатывается, так что между релизами возможны изменения, ломающие совместимость.
Будет ли мне привычно, если я прихожу из vim?Да — в комплекте идут vim-подобные компоненты ввода/выбора/подтверждения/which/notify с автодополнением путей для cd, плюс Visual Mode, так что привычки из vim перенесутся.
Почему Yazi быстрее других файловых менеджеров для терминала?Весь ввод-вывод асинхронный, а задачи процессора распределяются по нескольким потокам, причём планировщик задач показывает прогресс в реальном времени и поддерживает отмену и приоритеты. Встроенная подсветка кода и декодирование изображений вместе с предзагрузкой ускоряют открытие картинок и файлов.
Могу ли я расширять его плагинами или своими темами?Да — параллельная система плагинов на Lua покрывает UI-плагины, переписывающие почти весь интерфейс, функциональные плагины и кастомные хуки previewer/preloader/spotter/fetcher. Встроенный пакетный менеджер ставит плагины и темы одной командой и умеет закреплять конкретные версии.
Что он умеет из коробки, кроме простой навигации?Несколько вкладок с выделением файлов в разных папках, прокручиваемый предпросмотр видео, PDF, архивов и кода, массовое переименование и создание файлов, распаковку архивов, выбор файла (file chooser), интеграцию с git, менеджер монтирования, корзину и систему тем.
Могу ли я управлять файлами на удалённых серверах?Да — его виртуальная файловая система поддерживает удалённую работу с файлами через кастомные VFS-провайдеры и поисковые движки. А встроенный сервис распределения данных синхронизирует состояние между экземплярами без отдельного серверного процесса.
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