agentreadme

Report · marked 25 Aug 2026

CherryHQ/cherry-studio

Solid foundations, held back in a few specific places.

TypeScript · 51,061 stars · 8,586 files · branch main

Fix these first

01
Instruction quality
Worth fixing: it's under 200 characters, which is closer to a placeholder than instructions; it never states a build, test, or run command; has no headings to structure it; has no code blocks.
02
File sizes fit in context
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
03
Repository weight
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

The full marking

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

Instructions 15/27 B-

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.
Also found: CLAUDE.md
Instruction quality 0/12
Present but too thin to change an agent's behavior.
Worth fixing: it's under 200 characters, which is closer to a placeholder than instructions; it never states a build, test, or run command; has no headings to structure it; has no code blocks.
README as an entry point 3/3
README has a clear getting-started section.
Setup 18/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 (start, download:binaries, rebuild:electron, rebuild:node, dev, dev:watch…)
scripts/ directory
Environment config 4/4
.env.example documents what the app needs to run.
Pinned runtime version 2/2
The language runtime version is pinned.
Found .nvmrc
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 24/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
2128 test files against 7253 source files.
e.g. packages/ai-sdk-provider/src/__tests__/openai-compatible-reranking-model.test.ts, packages/aiCore/src/core/agents/__tests__/createAgent.test.ts, packages/aiCore/src/core/context/__tests__/adapter.test.ts
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
17 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
eslint.config.mjs 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 11/20 B-

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 69 patterns.
File sizes fit in context 0/6
29 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
packages/ui/src/components/icons/providers/dangbei/light.tsx — 690KB
packages/ui/src/components/icons/models/gemini/light.tsx — 249KB
packages/ui/src/components/icons/providers/dolphin-ai/light.tsx — 230KB
Repository weight 2/5
About 411MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 CherryHQ/cherry-studio
# AGENTS.md

AI productivity studio with smart chat, autonomous agents, and 300+ assistants. Unified access to frontier LLMs

## 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 download:binaries
```

## Layout

- `src/`        5081 source files
- `packages/`   2028 source files
- `scripts/`    62 source files
- `tests/`      34 source files
- `migrations/` 18 source files
- `resources/`  16 source files

## Conventions

- Tests live alongside the code they cover, following `packages/ai-sdk-provider/src/__tests__/openai-compatible-reranking-model.test.ts`.
- 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/auto-update-catalog.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `packages/ui/src/components/icons/providers/dangbei/light.tsx` is 690KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/CherryHQ/cherry-studio.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 76 out of 100

[![agent ready](https://agentreadme.com/badge/CherryHQ/cherry-studio.svg)](https://agentreadme.com/CherryHQ/cherry-studio)

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