agentreadme

Report Β· marked 26 Aug 2026

naptha/tesseract.js

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

JavaScript Β· 38,668 stars Β· 118 files Β· branch master

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
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.

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 12/20 B-

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 (start, build, profile:tesseract, profile:worker, prepublishOnly, wait…)
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 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 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
25 test files against 59 source files.
e.g. tests/.eslintrc, tests/FS.test.mjs, tests/assets/images/bill.png
βœ“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 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 19/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 13 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 109.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 naptha/tesseract.js
# AGENTS.md

Pure Javascript OCR for more than 100 Languages πŸ“–πŸŽ‰πŸ–₯

## Setup

```
npm ci
```

## Commands

```
npm run start               # run the app
npm run build               # produce a build
npm run test                # run the test suite, must pass before any commit
npm run lint                # lint
npm run profile:tesseract
npm run profile:worker
npm run prepublishOnly
npm run wait
```

## Layout

- `src/`        42 source files
- `scripts/`    5 source files
- `tests/`      5 source files
- `examples/`   4 source files
- `benchmarks/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `tests/.eslintrc`.
- 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.

---

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/naptha/tesseract.js.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 65 out of 100

[![agent ready](https://agentreadme.com/badge/naptha/tesseract.js.svg)](https://agentreadme.com/naptha/tesseract.js)

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 78 A-

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