agentreadme

Report · marked 10 Oct 2026

aaif-goose/goose

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

Rust · 55,126 stars · 2,519 files · branch main

Fix these first

01
Environment config
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.
02
Repository weight
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
03
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.

The full marking

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

Instructions 26/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, Copilot instructions
✓Instruction quality 12/12
Specific enough that an agent can act on it.
6,209 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 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 16/20 A-

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

✓Deterministic install 6/6
cargo.lock pins the dependency tree.
Found cargo.lock
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
justfile
scripts/ directory
✗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 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 22/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
232 test files against 1294 source files.
e.g. .github/workflows/pr-smoke-test.yml, buzz/github_manager.test.mjs, crates/goose-agent/tests/cancellation.rs
✓Test command is discoverable 7/7
An agent can find and run `cargo test`.
✓Continuous integration 4/4
43 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
clippy.toml encodes the house style.
–Static type checking n/a
Not applicable — the Rust compiler type checks every build.
Context economy 11/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 60 patterns.
✗File sizes fit in context 2/6
11 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.
crates/goose-provider-types/src/formats/openai.rs — 242KB
crates/goose/src/session/session_manager.rs — 178KB
crates/goose/src/acp/provider.rs — 175KB
✗Repository weight 0/5
About 985MB 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 aaif-goose/goose
# AGENTS.md

an open source, extensible AI agent that goes beyond code suggestions - install, execute, edit, and test with any LLM

## Setup

```
cargo build
```

## Commands

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

## Layout

- `crates/`        605 source files
- `ui/`            540 source files
- `documentation/` 89 source files
- `services/`      21 source files
- `scripts/`       19 source files
- `evals/`         4 source files

## Conventions

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

## Gotchas

- `crates/goose-provider-types/src/formats/openai.rs` is 242KB. 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/aaif-goose/goose.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 86 out of 100

[![agent ready](https://agentreadme.com/badge/aaif-goose/goose.svg)](https://agentreadme.com/aaif-goose/goose)

Other Rust repositories, marked

ultraworkers/claw-code 71 B+ clash-verge-rev/clash-verge-rev 88 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