Report · marked 25 Aug 2026
vercel/hyper
An agent can work here, but it will waste turns finding its footing.
TypeScript · 44,703 stars · 170 files · branch canary
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
14/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.Verification loop
20/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and static type checking.Context economy
14/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
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
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.
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/20 B+
Whether an agent can install the project and get it running without a human.
✓Deterministic install
6/6
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
package.json scripts (start, app, dev, build, lint, test…)
✗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
0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 20/25 A-
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
4/8
5 test files against 113 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. test/index.ts, test/testUtils/is-hex-color.ts, test/unit/cli-api.test.ts
✓Test command is discoverable
7/7
An agent can find and run `npm run test`.
✓Continuous integration
4/4
2 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
.eslintrc.json encodes the house style.
✗Static type checking
2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
Context economy 14/20 B+
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 15 patterns.
✗File sizes fit in context
0/6
1 source file is 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.
bin/yarn-standalone.js — 4975KB
✓Repository weight
5/5
About 23.5MB 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 A terminal built on web technologies ## Setup ``` pnpm install ``` ## Commands ``` pnpm dev # run locally pnpm start # run the app pnpm build # produce a build pnpm test # run the test suite, must pass before any commit pnpm lint # lint pnpm app pnpm test:unit pnpm test:unit:watch ``` ## Layout - `lib/` 48 source files - `app/` 36 source files - `typings/` 13 source files - `bin/` 5 source files - `test/` 5 source files - `cli/` 2 source files ## Conventions - Tests live alongside the code they cover, following `test/index.ts`. - TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run. - CI defines what passing means. See `.github/workflows/codeql-analysis.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that. - `bin/yarn-standalone.js` is 4975KB. 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/vercel/hyper.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/vercel/hyper)Other TypeScript repositories, marked
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.