Report · marked 10 Oct 2026

lyswhut/lx-music-desktop

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

TypeScript · 54,333 stars · 817 files · branch master

58 /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/14Whether an agent can install the project and get it running without a human. Full marks.Verification loop 13/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and test command is discoverable.Context economy 19/20Whether the repo fits in a context window, or fights it. Losing marks on repository weight.Navigability 8/10How quickly anything new can orient itself. Losing marks on written documentation.

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

Fix these first

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Test command is discoverable

Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.

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/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 (pack, pack:win, pack:win:setup:x86_64, pack:win:setup:x64, pack:win:setup:x86, pack:win:setup:arm64…)

–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

–Reproducible environment n/a

Not applicable — a library doesn't need a container to be worked on.

Verification loop 13/25 C+

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

✗Tests exist 4/8

7 test files against 677 source files.

Coverage is thin enough that an agent can break real behavior and still see green.

e.g. .github/workflows/build-test.yml, src/renderer/utils/musicSdk/bd/api-test.js, src/renderer/utils/musicSdk/kg/api-test.js

✗Test command is discoverable 0/7

There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.

✓Continuous integration 4/4

4 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

.eslintrc.cjs 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 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 32 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 92.5MB 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 lyswhut/lx-music-desktop

# AGENTS.md

一个基于 Electron 的音乐软件

## Setup

```
npm ci
```

## Commands

```
npm run dev                     # run locally
npm run build                   # produce a build
npm run lint                    # lint
npm run pack
npm run pack:win
npm run pack:win:setup:x86_64
npm run pack:win:setup:x64
npm run pack:win:setup:x86
```

## Layout

- `src/`          636 source files
- `build-config/` 26 source files
- `publish/`      11 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/build-test.yml`.
- 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/beta-pack.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/lyswhut/lx-music-desktop.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](https://agentreadme.com/badge/lyswhut/lx-music-desktop.svg)](https://agentreadme.com/lyswhut/lx-music-desktop)

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