agentreadme

Report · marked 26 Aug 2026

tldr-pages/tldr

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

Markdown · 63,484 stars · 38,518 files · branch main

88 /100 A
Instructions 26/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on readme as an entry point.Setup 14/16Whether an agent can install the project and get it running without a human. Losing marks on pinned runtime version.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 19/20Whether the repo fits in a context window, or fights it. Losing marks on 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
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.
02
License
Without a license nobody can safely reuse this, and some tools will refuse to work with it at all.
03
Pinned runtime version
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.

The full marking

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

Instructions 26/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 12/12
Specific enough that an agent can act on it.
10,333 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 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 14/16 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 (lint-markdown, lint-tldr-pages, test, build-index, prepare)
scripts/ directory
–Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
✗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 2/2
.devcontainer/devcontainer.json gives a known-good environment.
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
78 test files against 16 source files.
e.g. pages.ar/common/npm-test.md, pages.bg/common/npm-test.md, pages.bn/common/npm-install-test.md
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
7 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
.flake8 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 14 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 62.0MB 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 tldr-pages/tldr 
# AGENTS.md

Collaborative cheatsheets for console commands 📚.

## Setup

```
npm ci
```

## Commands

```
npm run test              # run the test suite, must pass before any commit
npm run lint-markdown
npm run lint-tldr-pages
npm run build-index
npm run prepare
```

## Layout

- `scripts/` 16 source files

## Conventions

- Tests live alongside the code they cover, following `pages.ar/common/npm-test.md`.
- CI defines what passing means. See `.github/workflows/bot-prevention.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/tldr-pages/tldr.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 88 out of 100

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

Other Markdown repositories, marked

jaywcjlove/linux-command 38 D

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