agentreadme

Report · marked 10 Oct 2026

Eugeny/tabby

An agent can work here, but it will waste turns finding its footing.

TypeScript · 74,882 stars · 892 files · branch master

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 2/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 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 12/20 B-

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

✓Deterministic install 6/6
yarn.lock pins the dependency tree.
Found yarn.lock
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (build, build:typings, watch, start, start:prod, prod…)
✗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 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✗Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 20/25 A-

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

✗Tests exist 4/8
6 test files against 340 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. tabby-ssh/test/authMethodSelection.test.ts, tabby-ssh/test/shellChannel.test.ts, tabby-ssh/test/terminalType.test.ts
✓Test command is discoverable 7/7
An agent can find and run `npm run test:unit`.
✓Continuous integration 4/4
4 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
.eslintrc.yml encodes the house style.
✗Static type checking 2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
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 30 patterns.
✗File sizes fit in context 0/6
1 source file is 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.
tabby-web-demo/data/v86_all.js — 375KB
✗Repository weight 4/5
About 100.1MB 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 Eugeny/tabby
# AGENTS.md

A terminal for a more modern age

## Setup

```
yarn install
```

## Commands

```
yarn start           # run the app
yarn build           # produce a build
yarn lint            # lint
yarn build:typings
yarn watch
yarn start:prod
yarn prod
yarn docs
```

## Layout

- `tabby-core/`     75 source files
- `tabby-terminal/` 45 source files
- `tabby-ssh/`      38 source files
- `tabby-electron/` 36 source files
- `tabby-settings/` 22 source files
- `app/`            21 source files

## Conventions

- Tests live alongside the code they cover, following `tabby-ssh/test/authMethodSelection.test.ts`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `tabby-web-demo/data/v86_all.js` is 375KB. 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/Eugeny/tabby.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good TypeScript 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 56 out of 100

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

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 A-

All TypeScript 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