agentreadme

Report · marked 10 Oct 2026

tldr-pages/tldr

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

Markdown · 63,873 stars · 40,047 files · branch main

63 /100 B
Instructions 2/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.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
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
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.

The full marking

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

Instructions 2/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 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
81 test files against 17 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 15 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 65.6MB 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/` 17 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

A draft gets the commands right and stops at the things only a maintainer knows. 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 63 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