agentreadme

Report ยท marked 25 Aug 2026

Homebrew/brew

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

Ruby ยท 49,269 stars ยท 3,188 files ยท branch main

Fix these first

01
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface โ€” an agent tries `npm test` and `make test` before it tries reading your CI config.
02
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
03
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 24/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 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
6,514 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
โœ—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 2/20 F

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

โœ—Deterministic install 0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
โœ—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 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
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 2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 12/25 C+

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

โœ“Tests exist 8/8
1056 test files against 1934 source files.
e.g. Library/Homebrew/dev-cmd/update-test.rb, Library/Homebrew/extend/os/dev-cmd/update-test.rb, Library/Homebrew/extend/os/linux/dev-cmd/update-test.rb
โœ—Test command is discoverable 0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface โ€” an agent tries `npm test` and `make test` before it tries reading your CI config.
โœ“Continuous integration 4/4
25 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 17/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 183 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.
Library/Homebrew/formula.rb โ€” 170KB
Library/Homebrew/test/formula_spec.rb โ€” 102KB
โœ—Repository weight 4/5
About 123.8MB 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 Homebrew/brew
# AGENTS.md

๐Ÿบ The Package Manager for Everywhere

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `Library/` 1926 source files
- `docs/`    3 source files

## Conventions

- Tests live alongside the code they cover, following `Library/Homebrew/dev-cmd/update-test.rb`.
- CI defines what passing means. See `.github/workflows/actionlint.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `Library/Homebrew/formula.rb` is 170KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/Homebrew/brew.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 64 out of 100

[![agent ready](https://agentreadme.com/badge/Homebrew/brew.svg)](https://agentreadme.com/Homebrew/brew)

Other Ruby repositories, marked

rails/rails 66 B maybe-finance/maybe 85 A jekyll/jekyll 50 C+ mastodon/mastodon 67 B huginn/huginn 60 B- discourse/discourse 62 B

All Ruby 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