agentreadme

Report · marked 10 Oct 2026

JuliusBrussee/caveman

Solid foundations, held back in a few specific places.

Go · 110,867 stars · 1,651 files · branch main

Fix these first

01
Instruction quality
Worth fixing: it never states a build, test, or run command; has no headings to structure it; has no code blocks.
02
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.
03
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

The full marking

Every deduction below names the file or setting it came from.

Instructions 19/27 B+

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 4/12
Present but too thin to change an agent's behavior.
Worth fixing: it never states a build, test, or run command; has no headings to structure it; has no code blocks.
733 characters, a workable length
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 18/20 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 (test, test:windows)
scripts/ directory
✗Environment config 2/4
Env vars are mentioned in the README but there's no example file to copy.
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 2/2
dockerfile gives a known-good environment.
Verification loop 19/22 A

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

✓Tests exist 8/8
636 test files against 1064 source files.
e.g. agents/delegate/portable-process.test.mjs, browse/bin/launcher.test.mjs, browse/cdp_integration_test.go
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
16 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 Go compiler type checks every build.
Context economy 14/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 37 patterns.
✗File sizes fit in context 0/6
4 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.
packages/cli/src/index.ts — 922KB
installer/install.js — 119KB
packages/sdk/python/caveman_cloud/core.py — 107KB
✓Repository weight 5/5
About 23.6MB 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 JuliusBrussee/caveman
# AGENTS.md

🪨 why use many token when few token do trick. Viral skill + proxy for coding agents that cuts 65% of tokens by talking like a caveman.

## Setup

```
pnpm install
```

## Commands

```
pnpm test           # run the test suite, must pass before any commit
pnpm test:windows
```

## Layout

- `proxy/`     320 source files
- `packages/`  300 source files
- `engine/`    170 source files
- `tests/`     91 source files
- `shared/`    43 source files
- `extension/` 17 source files

## Conventions

- Tests live alongside the code they cover, following `agents/delegate/portable-process.test.mjs`.
- CI defines what passing means. See `.github/workflows/agent-conformance.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `packages/cli/src/index.ts` is 922KB. 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/JuliusBrussee/caveman.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Go AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

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 81 out of 100

[![agent ready](https://agentreadme.com/badge/JuliusBrussee/caveman.svg)](https://agentreadme.com/JuliusBrussee/caveman)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 88 A golang/go 31 D kubernetes/kubernetes 74 B+ microsoft/TypeScript 82 A- fatedier/frp 96 A+

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