Report · marked 25 Aug 2026
refinedev/refine
An agent can work here, but it will waste turns finding its footing.
TypeScript · 35,574 stars · 11,521 files · branch main
57
/100
B-
Instructions
1/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
14/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and reproducible environment.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 tests exist and static type checking.Context economy
11/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
10/10How quickly anything new can orient itself. Full marks.
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
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 1/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
1/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/20 B+
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 (attw, attw:all, biome, build, build:all, changeset…)
scripts/ directory
✗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 >=18
✗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 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
6/8
837 test files against 6779 source files.
e.g. documentation/k8s/refine-documentation/templates/tests/test-connection.yaml, documentation/test/jest.setup.ts, documentation/test/svgTransform.ts
✓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
biome.json 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 30 patterns.
✗File sizes fit in context
2/6
6 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.
documentation/src/refine-theme/icons/landing-app-crm.tsx — 287KB
documentation/src/refine-theme/icons/landing-hero-mobile.tsx — 200KB
packages/nestjsx-crud/test/getList/index.mock.ts — 170KB
✗Repository weight
0/5
About 8285MB 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 A React Framework for building internal tools, admin panels, dashboards & B2B apps with unmatched flexibility. ## 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 lint # lint pnpm attw pnpm attw:all pnpm biome ``` ## Layout - `examples/` 3731 source files - `packages/` 2081 source files - `documentation/` 862 source files - `cypress/` 99 source files - `scripts/` 1 source file ## Conventions - Tests live alongside the code they cover, following `documentation/k8s/refine-documentation/templates/tests/test-connection.yaml`. - 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/build-examples.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `documentation/src/refine-theme/icons/landing-app-crm.tsx` is 287KB. It will not fit comfortably in context, so read it in parts. --- 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/refinedev/refine.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/refinedev/refine)Other TypeScript repositories, marked
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.