Report · marked 26 Aug 2026
shadcn-ui/ui
An agent can work here, but it will waste turns finding its footing.
TypeScript · 122,125 stars · 5,781 files · branch main
59
/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/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and reproducible environment.Verification loop
23/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.Context economy
13/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and 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
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
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.
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/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 (build, build:packages, registry:build, registry:capture, registry:health, registry:health:prepare…)
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.
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 23/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
517 test files against 3922 source files.
e.g. apps/v4/app/(app)/(create)/init/route.test.ts, apps/v4/app/(app)/(create)/lib/parse-config.test.ts, apps/v4/app/(app)/(create)/lib/parse-preset-input.test.ts
✓Test command is discoverable
7/7
An agent can find and run `npm run check`.
✓Continuous integration
4/4
10 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
.eslintrc.json encodes the house style.
✓Static type checking
3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 13/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 36 patterns.
✗File sizes fit in context
0/6
7 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.
apps/v4/registry/__index__.tsx — 1051KB
apps/v4/registry/bases/__index__.tsx — 291KB
apps/v4/examples/__index__.tsx — 177KB
✗Repository weight
4/5
About 70.3MB 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 A set of beautifully-designed, accessible components and a code distribution platform. Works with your favorite frameworks. Open Source. Open Code. ## Setup ``` pnpm install ``` ## Commands ``` pnpm dev # run locally 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 check # lint and type check pnpm build:packages pnpm registry:build ``` ## Layout - `apps/` 3409 source files - `packages/` 441 source files - `templates/` 65 source files - `scripts/` 1 source file ## Conventions - Tests live alongside the code they cover, following `apps/v4/app/(app)/(create)/init/route.test.ts`. - 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/browser-tests.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `apps/v4/registry/__index__.tsx` is 1051KB. 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/shadcn-ui/ui.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/shadcn-ui/ui)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.