# 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.