agentreadme

Report ยท marked 25 Aug 2026

sxyazi/yazi

Solid foundations, held back in a few specific places.

Rust ยท 41,675 stars ยท 1,408 files ยท branch main

Fix these first

01
Tests exist
Coverage is thin enough that an agent can break real behavior and still see green.
02
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
03
Static type checking
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

The full marking

Every deduction below names the file or setting it came from.

Instructions 26/27 A+

Whether the repo tells an agent how to behave before it starts guessing.

โœ“Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md
โœ“Instruction quality 12/12
Specific enough that an agent can act on it.
6,009 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
โœ—README as an entry point 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 12/14 A

Whether an agent can install the project and get it running without a human.

โœ“Deterministic install 6/6
cargo.lock pins the dependency tree.
Found cargo.lock
โœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
scripts/ directory
โ€“Environment config n/a
Not applicable โ€” this reads as a library, with no environment to configure.
โœ—Pinned runtime version 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
โ€“Reproducible environment n/a
Not applicable โ€” a library doesn't need a container to be worked on.
Verification loop 15/25 B-

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

โœ—Tests exist 4/8
6 test files against 1294 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. yazi-shared/src/spec/encode.rs, yazi-shared/src/spec/inventory.rs, yazi-shared/src/spec/lua.rs
โœ“Test command is discoverable 7/7
An agent can find and run `cargo test`.
โœ“Continuous integration 4/4
10 GitHub Actions workflows define what "passing" means.
โœ—Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
โœ—Static type checking 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 20/20 A+

Whether the repo fits in a context window, or fights it.

โœ“No committed build output 6/6
No generated directories committed.
โœ“.gitignore hygiene 3/3
.gitignore covers 11 patterns.
โœ“File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
โœ“Repository weight 5/5
About 9.1MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md โ€” drafted for sxyazi/yazi
# 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.

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/sxyazi/yazi.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 84 out of 100

[![agent ready](https://agentreadme.com/badge/sxyazi/yazi.svg)](https://agentreadme.com/sxyazi/yazi)

Other Rust repositories, marked

ultraworkers/claw-code 69 B farion1231/cc-switch 64 B rustdesk/rustdesk 68 B openai/codex 82 A- rust-lang/rust 63 B tauri-apps/tauri 62 B

All Rust repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in