agentreadme

Report · marked 25 Aug 2026

schollz/croc

Solid foundations, held back in a few specific places.

Go · 40,095 stars · 281 files · branch main

Fix these first

01
Instruction quality
Worth fixing: it never states a build, test, or run command.
02
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.
03
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 23/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.
Instruction quality 8/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command.
3,166 characters, a workable length
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 18/20 A

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

Deterministic install 6/6
go.sum pins the dependency tree.
Found go.sum
Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
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.
go.mod declares a Go version
Reproducible environment 2/2
dockerfile gives a known-good environment.
Verification loop 19/25 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
67 test files against 183 source files.
e.g. internal/cli/help_test.go, src/cli/cli_test.go, src/cli/store_test.go
Test command is discoverable 7/7
An agent can find and run `go test ./...`.
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 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 18/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 21 patterns.
File sizes fit in context 4/6
2 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.
src/croc/croc.go — 125KB
web/src/blog-posts.ts — 107KB
Repository weight 5/5
About 11.5MB 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 schollz/croc
# AGENTS.md

Easily and securely send things from one computer to another :crocodile: :package:

## Setup

```
go mod download
```

## Commands

```
make build        # produce a build
make web-assets
make build-web
make serve
```

## Layout

- `src/`        94 source files
- `web/`        61 source files
- `internal/`   20 source files
- `benchmarks/` 4 source files
- `cmd/`        1 source file
- `scripts/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `internal/cli/help_test.go`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/croc/croc.go` is 125KB. 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/schollz/croc.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 84 out of 100

[![agent ready](https://agentreadme.com/badge/schollz/croc.svg)](https://agentreadme.com/schollz/croc)

Other Go repositories, marked

avelino/awesome-go 75 B+ ollama/ollama 85 A golang/go 30 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 80 A- fatedier/frp 93 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