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.
34 Commits 2 Branches 20 Tags 44 MiB
Rust 92.8%
Lua 6.3%
Nix 0.7%
Shell 0.2%
ba13009321
Go to file
Pig Fang ba13009321
docs: update installation guide
2023-07-20 14:12:37 +08:00
config feat: enable arrow keys by default 2023-07-20 06:44:26 +08:00
docs docs: full keymap commands 2023-07-20 00:23:55 +08:00
src feat: enable arrow keys by default 2023-07-20 06:44:26 +08:00
.gitignore first commit 2023-07-08 19:46:43 +08:00
build.sh fix: build error on linux 2023-07-19 09:08:36 +08:00
Cargo.lock fix: build error on linux 2023-07-19 09:08:36 +08:00
Cargo.toml feat: unbounded channel used as ui event 2023-07-19 19:02:30 +08:00
LICENCE first commit 2023-07-08 19:46:43 +08:00
README.md docs: update installation guide 2023-07-20 14:12:37 +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.

https://github.com/sxyazi/yazi/assets/17523360/740a41f4-3d24-4287-952c-3aec51520a32

⚠️ Note: Yazi is currently in active development and may be unstable. The API is subject to change without prior notice.

Installation

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

  • nerd-fonts (required, for icons)
  • jq (optional, for JSON preview)
  • unar (optional, for archive 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)

Arch Linux

Install with paru or your favorite AUR helper:

paru -S yazi jq unarchiver ffmpegthumbnailer fd ripgrep fzf zoxide

macOS

brew install jq unar ffmpegthumbnailer fd ripgrep fzf zoxide
brew tap homebrew/cask-fonts && brew install --cask font-symbols-only-nerd-font

Cargo

cargo install --git https://github.com/sxyazi/yazi.git

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 --release

Then, you can run:

./target/release/yazi

Usage

yazi

If you want to use your own config, copy the config folder to ~/.config/yazi, and modify it as you like.

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
  • Documentation of commands and options
  • Support for Überzug++ for image previews with X11/wayland environment
  • Batch renaming support

License

Yazi is MIT licensed.