agentreadme

Report · marked 25 Aug 2026

FuelLabs/fuels-ts

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

TypeScript · 43,013 stars · 2,188 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 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 18/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 (dev, build, build:packages, ci:test, pretest, depcheck…)
scripts/ directory
Environment config 4/4
.env.example documents what the app needs to run.
Pinned runtime version 2/2
The language runtime version is pinned.
Found .nvmrc
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 24/25 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
651 test files against 1224 source files.
e.g. apps/create-fuels-counter-guide/test/ui/test-ui.sh, apps/create-fuels-counter-guide/test/ui/ui.test.ts, apps/demo-bun-fuels/src/bun.test.ts
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
14 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
.eslintrc.js 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 83 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.
packages/fuel-gauge/test/fixtures/chain-config/state_transition_bytecode.ts — 4885KB
Repository weight 4/5
About 115.6MB 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 FuelLabs/fuels-ts
# AGENTS.md

Fuel Network Typescript SDK

## Setup

```
pnpm install
```

## Commands

```
pnpm dev              # run locally
pnpm build            # produce a build
pnpm test             # run the test suite, must pass before any commit
pnpm lint             # lint
pnpm build:packages
pnpm ci:test
pnpm pretest
pnpm depcheck
```

## Layout

- `packages/`         839 source files
- `apps/`             291 source files
- `templates/`        52 source files
- `scripts/`          18 source files
- `internal/`         17 source files
- `playwright-tests/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `apps/create-fuels-counter-guide/test/ui/test-ui.sh`.
- 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/audit.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/fuel-gauge/test/fixtures/chain-config/state_transition_bytecode.ts` is 4885KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/FuelLabs/fuels-ts.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 66 out of 100

[![agent ready](https://agentreadme.com/badge/FuelLabs/fuels-ts.svg)](https://agentreadme.com/FuelLabs/fuels-ts)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 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