Report · marked 25 Aug 2026
halo-dev/halo
An agent can work here, but it will waste turns finding its footing.
Java · 39,604 stars · 3,218 files · branch main
68
/100
B
Instructions
24/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality and readme as an entry point.Setup
2/20Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and discoverable commands.Verification loop
12/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on test command is discoverable and lint and format rules.Context economy
19/20Whether the repo fits in a context window, or fights it. Losing marks on 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
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.
02
Deterministic install
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.
03
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
The full marking
Every deduction below names the file or setting it came from.
Instructions 24/27 A
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
10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
2,056 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✗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
dockerfile gives a known-good environment.
Verification loop 12/22 B-
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
587 test files against 2612 source files.
e.g. api/src/test/java/run/halo/app/core/extension/MenuItemTest.java, api/src/test/java/run/halo/app/core/extension/MenuTest.java, api/src/test/java/run/halo/app/core/extension/ThemeTest.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
4/4
5 GitHub Actions workflows define what "passing" means.
✗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 19/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 66 patterns.
✓File sizes fit in context
6/6
No source file is large enough to crowd out a context window.
✗Repository weight
4/5
About 88.9MB 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 Halo 是一款强大易用的开源建站工具，从个人博客、知识库，到企业官网、在线商城，Halo 都能助您轻松实现，一站式满足您的多样化建站需求。 ## 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 - `ui/` 1249 source files - `application/` 1071 source files - `api/` 290 source files - `buildSrc/` 1 source file - `hack/` 1 source file ## Conventions - Tests live alongside the code they cover, following `api/src/test/java/run/halo/app/core/extension/MenuItemTest.java`. - CI defines what passing means. See `.github/workflows/halo.yaml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - 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/halo-dev/halo.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/halo-dev/halo)Other Java 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.