Report · marked 10 Oct 2026

codewhale-hq/Codewhale

Ready for an agent to work in without hand-holding.

Rust · 41,077 stars · 4,031 files · branch main

85 /100 A

Instructions 27/27Whether the repo tells an agent how to behave before it starts guessing. Full marks.Setup 20/20Whether an agent can install the project and get it running without a human. Full marks.Verification loop 19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy 8/20Whether the repo fits in a context window, or fights it. Losing marks on no committed build output and 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

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.

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.

No committed build output

Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.

The full marking

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

Instructions 27/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 12/12

Specific enough that an agent can act on it.

13,954 characters, a workable length

names the actual commands to run

uses headings, so an agent can skim it

includes copyable code blocks

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 20/20 A+

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

✓Deterministic install 6/6

package-lock.json pins the dependency tree.

Found package-lock.json

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (test, check:web)

scripts/ directory

✓Environment config 4/4

.env.example documents what the app needs to run.

✓Pinned runtime version 2/2

The language runtime version is pinned.

Found rust-toolchain.toml

✓Reproducible environment 2/2

.devcontainer/devcontainer.json 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

777 test files against 2535 source files.

e.g. .github/scripts/agent-task-metadata.test.sh, .github/scripts/d8-executable.test.js, .github/scripts/release-workflows.test.js

✓Test command is discoverable 7/7

An agent can find and run `npm run test`.

✓Continuous integration 4/4

31 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 Rust compiler type checks every build.

Context economy 8/20 C

Whether the repo fits in a context window, or fights it.

✗No committed build output 3/6

Generated output is committed: node_modules/.

Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.

✓.gitignore hygiene 3/3

.gitignore covers 113 patterns.

✗File sizes fit in context 0/6

109 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.

patches/unicode-width-0.2.2/src/tables.rs — 1527KB

crates/tui/src/tui/ui/tests.rs — 1226KB

crates/tui/src/tools/subagent/tests.rs — 1007KB

✗Repository weight 2/5

About 279MB checked out. Large enough that cloning and searching are both slow.

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 codewhale-hq/Codewhale

# AGENTS.md

Open-source Rust agent engine and terminal client for Codewhale, with provider choice, tools, approvals and receipts.

## Setup

```
npm ci
```

## Commands

```
npm run test        # run the test suite, must pass before any commit
npm run check:web
```

## Layout

- `crates/`  1592 source files
- `web/`     440 source files
- `scripts/` 142 source files
- `vendor/`  118 source files
- `pet/`     77 source files
- `patches/` 62 source files

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/agent-task-metadata.test.sh`.
- CI defines what passing means. See `.github/workflows/agent-task-labels.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `patches/unicode-width-0.2.2/src/tables.rs` is 1527KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/codewhale-hq/Codewhale.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Rust 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](https://agentreadme.com/badge/codewhale-hq/Codewhale.svg)](https://agentreadme.com/codewhale-hq/Codewhale)

Other Rust repositories, marked

ultraworkers/claw-code 71 B+ clash-verge-rev/clash-verge-rev 91 A farion1231/cc-switch 63 B openai/codex 61 B- rustdesk/rustdesk 72 B+ rust-lang/rust 65 B

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