sxyazi/yazi
1
1
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2024-12-18 22:31:35 +03:00
Code Issues Packages Projects Releases Wiki Activity
💥 Blazing fast terminal file manager written in Rust, based on async I/O.
10 Commits 2 Branches 20 Tags 44 MiB
Rust 92.8%
Lua 6.3%
Nix 0.7%
Shell 0.2%
4a5154c03e
Go to file
sxyazi 4a5154c03e
feat: jump around with fzf and zoxide
2023-07-12 19:33:23 +08:00
src feat: jump around with fzf and zoxide 2023-07-12 19:33:23 +08:00
.gitignore first commit 2023-07-08 19:46:43 +08:00
Cargo.lock feat: jump around with fzf and zoxide 2023-07-12 19:33:23 +08:00
Cargo.toml chore: use new project name 2023-07-11 00:25:57 +08:00
LICENCE first commit 2023-07-08 19:46:43 +08:00
README.md feat: jump around with fzf and zoxide 2023-07-12 19:33:23 +08:00

README.md

Yazi - ⚡️ Blazing Fast Terminal File Manager

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 configurable file management experience.

⚠️ Note: Yazi is currently in active development and may be unstable. The API is subject to change without prior notice. Please use it with caution in a non-production environment.

Installation

Before getting started, ensure that the following dependencies are installed on your system:

  • jq (optional, for JSON preview)
  • ffmpegthumbnailer (optional, for video thumbnails)
  • fd (optional, for file searching)
  • rg (optional, for file content searching)
  • fzf (optional, for directory jumping)
  • zoxide (optional, for directory jumping)

Execute the following commands to clone the project and build Yazi:

git clone https://github.com/sxyazi/yazi.git
cd yazi
cargo build --release

Usage

./target/release/yazi

TODO

  • Add example config for general usage, currently please see my another repo instead
  • Integration with fzf, zoxide for fast directory navigation
  • Integration with fd, rg for fuzzy file searching
  • Support for Überzug++ for image previews with X11/wayland environment
  • Batch renaming support

License

Yazi is MIT licensed.