agentreadme

Report · marked 10 Oct 2026

earendil-works/pi

Ready for an agent to work in without hand-holding.

TypeScript · 113,992 stars · 1,988 files · branch main

89 /100 A
Instructions 25/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality.Setup 14/14Whether an agent can install the project and get it running without a human. Full marks.Verification loop 24/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 15/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability 7/10How quickly anything new can orient itself. Losing marks on written documentation and repository description.

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

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
Instruction quality
Worth fixing: has no code blocks.
03
Written documentation
Prose that explains why the architecture is the way it is saves an agent from re-deriving it wrong.

The full marking

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

Instructions 25/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.
✗Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
8,480 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 14/14 A+

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

✓Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (clean, build, build:offline, build:native:darwin, build:native:linux, build:native:win32…)
scripts/ directory
–Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
✓Pinned runtime version 2/2
The language runtime version is pinned.
package.json engines.node >=22.19.0
–Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
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
782 test files against 1713 source files.
e.g. packages/agent/test/agent-loop.test.ts, packages/agent/test/agent.test.ts, packages/agent/test/e2e.test.ts
✓Test command is discoverable 7/7
An agent can find and run `npm run check`.
✓Continuous integration 4/4
13 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
biome.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 15/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 40 patterns.
✗File sizes fit in context 2/6
5 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.
packages/coding-agent/src/modes/interactive/interactive-mode.ts — 245KB
packages/coding-agent/src/core/agent-session.ts — 157KB
packages/tui/test/editor.test.ts — 154KB
✗Repository weight 4/5
About 82.3MB 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 earendil-works/pi 
# AGENTS.md

AI agent toolkit: unified LLM API, agent loop, TUI, coding agent CLI

## Setup

```
npm ci
```

## Commands

```
npm run build                 # produce a build
npm run test                  # run the test suite, must pass before any commit
npm run check                 # lint and type check
npm run clean
npm run build:offline
npm run build:native:darwin
npm run build:native:linux
npm run build:native:win32
```

## Layout

- `packages/` 1644 source files
- `scripts/`  62 source files

## Conventions

- Tests live alongside the code they cover, following `packages/agent/test/agent-loop.test.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/approve-contributor.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/coding-agent/src/modes/interactive/interactive-mode.ts` is 245KB. 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/earendil-works/pi.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good TypeScript AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

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 89 out of 100

[![agent ready](https://agentreadme.com/badge/earendil-works/pi.svg)](https://agentreadme.com/earendil-works/pi)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 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