Report · marked 26 Aug 2026
vbenjs/vue-vben-admin
An agent can work here, but it will waste turns finding its footing.
Vue · 33,230 stars · 1,883 files · branch main
63
/100
B
Instructions
3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
14/18Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop
18/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
18/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.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 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 14/18 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 (bootstrap, build, build:analyze, build:antd, build:docker, build:docs…)
✗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 .node-version
–Reproducible environment
n/a
Not applicable — a library doesn't need a container to be worked on.
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
72 test files against 1442 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. internal/node-utils/src/__tests__/hash.test.ts, internal/node-utils/src/__tests__/path.test.ts, internal/vite-config/src/plugins/css-layer.test.ts
✓Test command is discoverable
7/7
An agent can find and run `npm run check`.
✓Continuous integration
4/4
13 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
eslint.config.mjs encodes the house style.
✗Static type checking
0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 18/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 56 patterns.
✗File sizes fit in context
4/6
1 source file is 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/effects/layouts/src/authentication/icons/slogan.vue — 162KB
✓Repository weight
5/5
About 48.2MB 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 modern vue admin panel built with Vue3, Shadcn UI, Vite, TypeScript, and Monorepo. It's fast! ## Setup ``` pnpm install ``` ## Commands ``` pnpm dev # run locally pnpm build # produce a build pnpm lint # lint pnpm format # format pnpm check # lint and type check pnpm bootstrap pnpm build:analyze pnpm build:antd ``` ## Layout - `packages/` 770 source files - `apps/` 302 source files - `playground/` 195 source files - `docs/` 78 source files - `internal/` 76 source files - `scripts/` 15 source files ## Conventions - Tests live alongside the code they cover, following `internal/node-utils/src/__tests__/hash.test.ts`. - 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. ## Gotchas - `packages/effects/layouts/src/authentication/icons/slogan.vue` is 162KB. 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/vbenjs/vue-vben-admin.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/vbenjs/vue-vben-admin)Other Vue 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.