agentreadme

Report · marked 25 Aug 2026

cypress-io/cypress

Solid foundations, held back in a few specific places.

TypeScript · 51,000 stars · 7,348 files · branch develop

Fix these first

01
File sizes fit in context
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.
02
Environment config
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.
03
Repository weight
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

The full marking

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

Instructions 27/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.
16,783 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 3/3
README has a clear getting-started section.
Setup 16/20 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 (binary-build, binary-deploy, binary-deploy-linux, binary-ensure, binary-package, binary-purge…)
scripts/ directory
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 2/2
The language runtime version is pinned.
Found .nvmrc
Reproducible environment 2/2
docker-compose.yml gives a known-good environment.
Verification loop 24/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
1420 test files against 4865 source files.
e.g. __snapshots__/move-binaries-spec.js, __snapshots__/packages-spec.js, __snapshots__/prepare-release-artifacts-spec.js
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
12 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
.eslintrc.js encodes the house style.
Static type checking 2/3
Type checking is configured, but not in strict mode.
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 6/20 D

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 192 patterns.
File sizes fit in context 0/6
16 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.
system-tests/projects/yarn-v3.1.1-pnp/yarn-3.1.1.cjs — 2148KB
system-tests/__snapshots__/protocol_spec.js — 362KB
system-tests/projects/e2e/static/jquery.js — 279KB
Repository weight 0/5
About 572MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 cypress-io/cypress
# AGENTS.md

Fast, easy and reliable testing for anything that runs in a browser.

## Setup

```
yarn install
```

## Commands

```
yarn dev                   # run locally
yarn start                 # run the app
yarn build                 # produce a build
yarn test                  # run the test suite, must pass before any commit
yarn lint                  # lint
yarn binary-build
yarn binary-deploy
yarn binary-deploy-linux
```

## Layout

- `packages/`     2499 source files
- `system-tests/` 1606 source files
- `npm/`          473 source files
- `cli/`          149 source files
- `scripts/`      106 source files
- `tooling/`      19 source files

## Conventions

- Tests live alongside the code they cover, following `__snapshots__/move-binaries-spec.js`.
- CI defines what passing means. See `.github/workflows/auto_approve_low_risk.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `system-tests/projects/yarn-v3.1.1-pnp/yarn-3.1.1.cjs` is 2148KB. 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/cypress-io/cypress.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 79 out of 100

[![agent ready](https://agentreadme.com/badge/cypress-io/cypress.svg)](https://agentreadme.com/cypress-io/cypress)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

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