Report · marked 25 Aug 2026

BurntSushi/ripgrep

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

Rust · 67,593 stars · 237 files · branch master

58 /100 B-

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 6/14Whether an agent can install the project and get it running without a human. Losing marks on discoverable commands and pinned runtime version.Verification loop 19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy 18/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability 8/10How quickly anything new can orient itself. Losing marks on written documentation.

Higher is better. Accent marks what is costing you most.

Fix these first

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Discoverable commands

Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.

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 6/14 C

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 0/6

No declared commands. An agent has to infer how to build and run this from the file tree.

Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.

–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 19/22 A

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

✓Tests exist 8/8

29 test files against 114 source files.

e.g. crates/ignore/tests/gitignore_matched_path_or_any_parents_tests.gitignore, crates/ignore/tests/gitignore_matched_path_or_any_parents_tests.rs, crates/ignore/tests/gitignore_skip_bom.gitignore

✓Test command is discoverable 7/7

An agent can find and run `cargo test`.

✓Continuous integration 4/4

2 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 n/a

Not applicable — the Rust compiler type checks every build.

Context economy 18/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 19 patterns.

✗File sizes fit in context 4/6

2 source files are over 100KB.

A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.

crates/core/flags/defs.rs — 241KB

crates/printer/src/standard.rs — 133KB

✓Repository weight 5/5

About 5.7MB 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 BurntSushi/ripgrep

# AGENTS.md

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

## Setup

```
cargo build
```

## Commands

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

## Layout

- `crates/` 96 source files
- `tests/`  13 source files
- `ci/`     1 source file
- `fuzz/`   1 source file
- `pkg/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `crates/ignore/tests/gitignore_matched_path_or_any_parents_tests.gitignore`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/core/flags/defs.rs` is 241KB. It will not fit comfortably in context, so read it in parts.

---

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/BurntSushi/ripgrep.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](https://agentreadme.com/badge/BurntSushi/ripgrep.svg)](https://agentreadme.com/BurntSushi/ripgrep)

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