# AGENTS.md

💥 Blazing fast terminal file manager written in Rust, based on async I/O.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `yazi-actor/`  159 source files
- `yazi-shared/` 118 source files
- `yazi-plugin/` 101 source files
- `yazi-parser/` 98 source files
- `yazi-config/` 92 source files
- `yazi-fs/`     80 source files

## Conventions

- Tests live alongside the code they cover, following `yazi-shared/src/spec/encode.rs`.
- CI defines what passing means. See `.github/workflows/cachix.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.