agentreadme

Report · marked 25 Aug 2026

TabbyML/tabby

An agent will struggle here, mostly for fixable reasons.

Rust · 33,836 stars · 2,098 files · branch main

Fix these first

01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
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 3/27 F

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

Agent instruction file 0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
Instruction quality 0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
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
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (build, vscode:dev, lint, lint:fix, test)
Makefile
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.
package.json engines.node >=18
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 15/22 B

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

Tests exist 4/8
38 test files against 1281 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. MODEL_SPEC.md, clients/tabby-agent/src/codeCompletion/postprocess/dropDuplicated.test.ts, clients/tabby-agent/src/codeCompletion/postprocess/dropMinimum.test.ts
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
16 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 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 10 patterns.
File sizes fit in context 0/6
19 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.
ee/tabby-webserver/ui/_next/static/chunks/7051-7a80262a5dbfe971.js — 1724KB
ee/tabby-webserver/ui/_next/static/chunks/2928-98ebfedf06caf8e1.js — 771KB
ee/tabby-webserver/ui/_next/static/chunks/54180a3d-2885e2285ca2b331.js — 760KB
Repository weight 4/5
About 109.3MB 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 TabbyML/tabby
# AGENTS.md

Self-hosted AI coding assistant

## Setup

```
pnpm install
```

## Commands

```
pnpm build        # produce a build
pnpm test         # run the test suite, must pass before any commit
pnpm lint         # lint
pnpm vscode:dev
pnpm lint:fix
```

## Layout

- `ee/`           681 source files
- `clients/`      379 source files
- `crates/`       132 source files
- `experimental/` 40 source files
- `python/`       34 source files
- `website/`      13 source files

## Conventions

- Tests live alongside the code they cover, following `MODEL_SPEC.md`.
- CI defines what passing means. See `.github/workflows/ast-grep-lint.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `ee/tabby-webserver/ui/_next/static/chunks/7051-7a80262a5dbfe971.js` is 1724KB. 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/TabbyML/tabby.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 52 out of 100

[![agent ready](https://agentreadme.com/badge/TabbyML/tabby.svg)](https://agentreadme.com/TabbyML/tabby)

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 65 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