> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/sxyazi/yazi/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to Yazi

> A blazing fast terminal file manager written in Rust, based on async I/O

# 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.

<Note>
  **Public Beta**: Yazi can be used as a daily driver, but is currently in heavy development. Expect breaking changes.
</Note>

## Why Yazi?

Yazi is designed from the ground up to be fast and efficient. Built with Rust and powered by async I/O, it delivers exceptional performance even when working with thousands of files.

<CardGroup cols={2}>
  <Card title="Get Started" icon="rocket" href="installation">
    Install Yazi on your platform and start managing files
  </Card>

  <Card title="Quick Tutorial" icon="circle-play" href="quickstart">
    Learn the basics in under 2 minutes
  </Card>

  <Card title="Configuration" icon="gear" href="configuration/overview">
    Customize Yazi to match your workflow
  </Card>

  <Card title="Plugin System" icon="puzzle-piece" href="plugins/overview">
    Extend functionality with Lua plugins
  </Card>
</CardGroup>

## Key Features

### Performance & Architecture

<AccordionGroup>
  <Accordion title="🚀 Full Asynchronous Support" icon="bolt">
    All I/O operations are asynchronous, CPU tasks are spread across multiple threads, making the most of available resources.
  </Accordion>

  <Accordion title="💪 Powerful Async Task Management" icon="list-check">
    Provides real-time progress updates, task cancellation, and internal task priority assignment.
  </Accordion>

  <Accordion title="🌟 Built-in Code Highlighting & Image Decoding" icon="code">
    Combined with the pre-loading mechanism, greatly accelerates image and normal file loading.
  </Accordion>
</AccordionGroup>

### Media & Preview

<CardGroup cols={2}>
  <Card title="Image Protocols" icon="image">
    Built-in support for Kitty, iTerm2, WezTerm, Sixel, and more image protocols
  </Card>

  <Card title="Universal Fallback" icon="grid">
    Integrated with Überzug++ (X11/Wayland) and Chafa (ASCII art) for maximum compatibility
  </Card>

  <Card title="Scrollable Previews" icon="file-video">
    Preview videos, PDFs, archives, code, and directories with scrolling support
  </Card>

  <Card title="Syntax Highlighting" icon="highlighter">
    Built-in code highlighting with syntect for instant file previews
  </Card>
</CardGroup>

### Extensibility

* **🔌 Concurrent Plugin System**: UI plugins (rewriting most of the UI), functional plugins, custom previewer/preloader/spotter/fetcher — just some pieces of Lua
* **☁️ Virtual Filesystem**: Remote file management, custom search engines
* **📡 Data Distribution Service**: Built on a client-server architecture (no additional server process required), integrated with a Lua-based publish-subscribe model
* **📦 Package Manager**: Install plugins and themes with one command, keep them up-to-date, or pin to specific versions

### Workflow Enhancements

<Steps>
  <Step title="Vim-like Navigation">
    Familiar keybindings: `j`/`k` for movement, `h`/`l` for directory navigation, visual mode with `v`
  </Step>

  <Step title="Multi-Tab Support">
    Work with multiple directories simultaneously, switch between tabs instantly
  </Step>

  <Step title="Cross-Directory Selection">
    Select files across different directories and perform batch operations
  </Step>

  <Step title="Integrated Tools">
    Built-in integration with ripgrep, fd, fzf, and zoxide
  </Step>
</Steps>

### Additional Features

* **🔄 Bulk Renaming**: Rename multiple files at once
* **📦 Archive Support**: Extract archives directly from the file manager
* **🏷️ Git Integration**: See git status inline with the [git plugin](https://github.com/yazi-rs/plugins/tree/main/git.yazi)
* **💾 Mount Manager**: Manage mounted filesystems with the [mount plugin](https://github.com/yazi-rs/plugins/tree/main/mount.yazi)
* **🗑️ Trash Bin Support**: Safe file deletion with trash bin integration
* **🎨 Theme System**: Fully customizable colors and UI elements
* **🖱️ Mouse Support**: Click, scroll, and interact with your mouse
* **⌨️ CSI u & OSC 52**: Enhanced keyboard protocol and clipboard support

## How Fast is Yazi?

Yazi's architecture is specifically designed for speed. Read the detailed explanation:

<Card title="Why is Yazi Fast?" icon="gauge-high" href="https://yazi-rs.github.io/blog/why-is-yazi-fast">
  Deep dive into Yazi's async I/O architecture and performance optimizations
</Card>

## Next Steps

Ready to get started? Follow our installation guide to set up Yazi on your system.

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="installation">
    Install Yazi via package manager or build from source
  </Card>

  <Card title="Quickstart Guide" icon="play" href="quickstart">
    Learn basic navigation and file operations
  </Card>
</CardGroup>

<Info>
  **Join the Community**

  * [Discord Server](https://discord.gg/qfADduSdJu) - English primarily
  * [Telegram Group](https://t.me/yazi_rs) - Chinese primarily
  * [GitHub Repository](https://github.com/sxyazi/yazi)
</Info>