agentreadme

Report · marked 26 Aug 2026

jeecgboot/JeecgBoot

An agent is close to flying blind in this repository.

Java · 47,475 stars · 4,036 files · branch main

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
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 2/20 F

Whether an agent can install the project and get it running without a human.

Deterministic install 0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
Discoverable commands 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
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 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment 2/2
docker-compose.yml gives a known-good environment.
Verification loop 6/22 F

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

Tests exist 6/8
144 test files against 2750 source files.
e.g. jeecg-boot/jeecg-boot-base-core/src/test/java/org/jeecg/test/security/Issue9672_SsrfFileTypeFilterTest.java, jeecg-boot/jeecg-boot-base-core/src/test/java/org/jeecg/test/security/Issue9677_SqlInjectionNewlineBypassTest.java, jeecg-boot/jeecg-boot-base-core/src/test/java/org/jeecg/test/security/Issue9681_SsrfRedirectBypassTest.java
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.
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.
Continuous integration 0/4
No CI config. Nothing outside a developer's laptop enforces correctness.
A CI workflow doubles as machine-readable documentation: it's the one file that states, unambiguously, the exact commands that must succeed.
Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
Static type checking n/a
Not applicable — the Java compiler type checks every build.
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 13 patterns.
File sizes fit in context 0/6
17 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.
jeecg-boot/db/jeecgboot-mysql-5.7.sql — 6677KB
jeecg-boot/jeecg-server-cloud/jeecg-visual/jeecg-cloud-xxljob/doc/db/tables_xxl_job.sql — 6347KB
jeecg-boot/jeecg-module-system/jeecg-system-start/src/main/resources/flyway/sql/mysql/V3.9.5_0__all_upgrade.sql — 1363KB
Repository weight 4/5
About 102.0MB 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 jeecgboot/JeecgBoot
# AGENTS.md

【低代码迈入v2.0时代,一句话即可生成整个系统】企业级AI低代码平台,一键生成前后端代码甚至整个系统。 AI Skills 一句话画流程、设计表单、生成报表、大屏。内置 AI应用平台涵盖:AI聊天、知识库、流程编排、MCP插件等,兼容主流大模型。引领AI低代码「Skills 生成 → 在线配置 → 代码生成 → 手工合并->AI修改」开发模式,解决 Java 项目 90% 重复工作,提高效率又不失灵活。

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `jeecgboot-vue3/` 1666 source files
- `jeecg-boot/`     1081 source files

## Conventions

- Tests live alongside the code they cover, following `jeecg-boot/jeecg-boot-base-core/src/test/java/org/jeecg/test/security/Issue9672_SsrfFileTypeFilterTest.java`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `jeecg-boot/db/jeecgboot-mysql-5.7.sql` is 6677KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/jeecgboot/JeecgBoot.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 31 out of 100

[![agent ready](https://agentreadme.com/badge/jeecgboot/JeecgBoot.svg)](https://agentreadme.com/jeecgboot/JeecgBoot)

Other Java repositories, marked

krahets/hello-algo 37 D iluwatar/java-design-patterns 59 B- Stirling-Tools/Stirling-PDF 71 B+ macrozheng/mall 29 F spring-projects/spring-boot 42 C doocs/advanced-java 54 C+

All Java 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