agentreadme

Report · marked 25 Aug 2026

yarnpkg/yarn

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

JavaScript · 41,487 stars · 5,579 files · branch master

62 /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 16/18Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy 16/20Whether the repo fits in a context window, or fights it. Losing marks on no committed build output and repository weight.Navigability 5/10How quickly anything new can orient itself. Losing marks on written documentation and license.

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

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
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 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 16/18 A

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

✓Deterministic install 6/6
yarn.lock pins the dependency tree.
Found yarn.lock
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (build, build-bundle, build-chocolatey, build-deb, build-dist, build-win-installer…)
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 2/2
The language runtime version is pinned.
package.json engines.node >=4.0.0
–Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 22/25 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
5202 test files against 570 source files.
e.g. __tests__/__mocks__/inquirer.js, __tests__/__mocks__/npm-registry.js, __tests__/__mocks__/request.js
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
1 GitHub Actions workflow define what "passing" means.
✓Lint and format rules 3/3
.eslintrc.json encodes the house style.
✗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 16/20 A-

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

✗No committed build output 3/6
Generated output is committed: node_modules/.
Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.
✓.gitignore hygiene 3/3
.gitignore covers 27 patterns.
✓File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
✗Repository weight 4/5
About 119.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 yarnpkg/yarn 
# AGENTS.md

The 1.x line is frozen - features and bugfixes now happen on https://github.com/yarnpkg/berry

## Setup

```
yarn install
```

## Commands

```
yarn build                 # produce a build
yarn test                  # run the test suite, must pass before any commit
yarn lint                  # lint
yarn build-bundle
yarn build-chocolatey
yarn build-deb
yarn build-dist
yarn build-win-installer
```

## Layout

- `__tests__/`        302 source files
- `src/`              160 source files
- `packages/`         75 source files
- `scripts/`          17 source files
- `flow-typed/`       7 source files
- `end_to_end_tests/` 6 source files

## Conventions

- Tests live alongside the code they cover, following `__tests__/__mocks__/inquirer.js`.
- CI defines what passing means. See `.github/workflows/signing.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/yarnpkg/yarn.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 62 out of 100

[![agent ready](https://agentreadme.com/badge/yarnpkg/yarn.svg)](https://agentreadme.com/yarnpkg/yarn)

Other JavaScript repositories, marked

react/react 71 B+ affaan-m/ECC 90 A trekhleb/javascript-algorithms 69 B Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+ vercel/next.js 77 B+

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