agentreadme

Report Β· marked 26 Aug 2026

pear-devs/pear-desktop

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

TypeScript Β· 33,186 stars Β· 414 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 16/20 A-

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 (postinstall, test, test:debug, build, vite:inspect, start…)
βœ—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 2/2
The language runtime version is pinned.
package.json engines.node >=22
βœ“Reproducible environment 2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 18/25 B+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

βœ—Tests exist 4/8
4 test files against 256 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. src/plugins/sponsorblock/tests/segments.test.js, src/plugins/synced-lyrics/parsers/lrc.test.ts, tests/index.test.js
βœ“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 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
βœ“Static type checking 3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 20/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 5/5
About 23.8MB 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 pear-devs/pear-desktop
# AGENTS.md

Pear 🍐 is extension for music player

## 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 typecheck   # type check without emitting
pnpm lint        # lint
pnpm format      # format
pnpm check       # lint and type check
```

## Layout

- `src/`   254 source files
- `tests/` 1 source file
- `tools/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `src/plugins/sponsorblock/tests/segments.test.js`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/build.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/pear-devs/pear-desktop.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 62 out of 100

[![agent ready](https://agentreadme.com/badge/pear-devs/pear-desktop.svg)](https://agentreadme.com/pear-devs/pear-desktop)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 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