agentreadme

Report · marked 27 Aug 2026

sharkdp/fd

An agent can work here, but it will waste turns finding its footing.

Rust · 44,213 stars · 59 files · branch master

Fix these first

01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
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.

The full marking

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

Instructions 3/27 F

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

Agent instruction file 0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
Instruction quality 0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
README as an entry point 3/3
README has a clear getting-started section.
Setup 14/18 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.
Makefile
scripts/ directory
Environment config 2/4
Env vars are mentioned in the README but there's no example file to copy.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
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 17/22 B+

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

Tests exist 6/8
2 test files against 28 source files.
e.g. tests/testenv/mod.rs, tests/tests.rs
Test command is discoverable 7/7
An agent can find and run `cargo test`.
Continuous integration 4/4
1 GitHub Actions workflow 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 n/a
Not applicable — the Rust compiler type checks every build.
Context economy 19/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 2/3
.gitignore has only 3 rules.
Start from a standard template for your stack. It prevents the previous problem before it happens.
File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
Repository weight 5/5
About 2.4MB 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 sharkdp/fd
# AGENTS.md

A simple, fast and user-friendly alternative to 'find'

## Setup

```
cargo build
```

## Commands

```
make completions
make install
```

## Layout

- `src/`     22 source files
- `scripts/` 2 source files
- `tests/`   2 source files
- `contrib/` 1 source file
- `doc/`     1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/testenv/mod.rs`.
- CI defines what passing means. See `.github/workflows/CICD.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/sharkdp/fd.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 65 out of 100

[![agent ready](https://agentreadme.com/badge/sharkdp/fd.svg)](https://agentreadme.com/sharkdp/fd)

Other Rust repositories, marked

ultraworkers/claw-code 71 B+ farion1231/cc-switch 63 B rustdesk/rustdesk 70 B+ openai/codex 82 A- rust-lang/rust 65 B tauri-apps/tauri 64 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