Report · marked 25 Aug 2026

Hmbown/CodeWhale

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

Rust · 40,846 stars · 1,754 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 17/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 lint and format rules.Context economy 13/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and 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

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.

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.

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.

5,828 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.

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 17/25 B

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

✗Tests exist 6/8

169 test files against 1321 source files.

e.g. .github/scripts/agent-task-metadata.test.sh, .github/scripts/release-workflows.test.js, .github/scripts/update-homebrew-tap.test.sh

✓Test command is discoverable 7/7

An agent can find and run `cargo test`.

✓Continuous integration 4/4

25 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 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 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 97 patterns.

✗File sizes fit in context 0/6

69 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 — 826KB

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

✗Repository weight 4/5

About 134.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 — drafted for Hmbown/CodeWhale

# AGENTS.md

Open-source coding agent for your terminal, built in Rust and on a journey of continuous community improvement. Issues and PRs welcome.

## Setup

```
npm ci
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `crates/`           932 source files
- `web/`              229 source files
- `scripts/`          83 source files
- `integrations/`     22 source files
- `npm/`              17 source files
- `telemetry-ingest/` 13 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/Hmbown/CodeWhale.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](https://agentreadme.com/badge/Hmbown/CodeWhale.svg)](https://agentreadme.com/Hmbown/CodeWhale)

Other Rust repositories, marked

ultraworkers/claw-code 69 B farion1231/cc-switch 64 B rustdesk/rustdesk 68 B openai/codex 82 A- rust-lang/rust 63 B tauri-apps/tauri 62 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