agentreadme

Report · marked 25 Aug 2026

rtk-ai/rtk

Solid foundations, held back in a few specific places.

Rust · 77,389 stars · 412 files · branch develop

Fix these first

01
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.
02
Agent instruction file
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
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 24/27 A

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 9/12
CLAUDE.md is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
Also found: Copilot instructions
Instruction quality 12/12
Specific enough that an agent can act on it.
7,704 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 14/18 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.
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 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
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
62 test files against 169 source files.
e.g. hooks/hermes/tests/__init__.py, hooks/hermes/tests/test_rtk_rewrite_plugin.py, tests/copilot_selfheal_test.rs
Test command is discoverable 7/7
An agent can find and run `cargo 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 16/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 32 patterns.
File sizes fit in context 2/6
5 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/hooks/init.rs — 286KB
src/discover/registry.rs — 170KB
src/cmds/git/git.rs — 126KB
Repository weight 5/5
About 6.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 rtk-ai/rtk
# AGENTS.md

CLI proxy that reduces LLM token consumption by 60-90% on common dev commands. Single Rust binary, zero dependencies

## Setup

```
cargo build
```

## Commands

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

## Layout

- `src/`      121 source files
- `scripts/`  19 source files
- `tests/`    13 source files
- `hooks/`    9 source files
- `Formula/`  1 source file
- `openclaw/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `hooks/hermes/tests/__init__.py`.
- CI defines what passing means. See `.github/workflows/cd.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/hooks/init.rs` is 286KB. 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/rtk-ai/rtk.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 83 out of 100

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

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