# AGENTS.md

The open source coding agent.

## Setup

```
bun install
```

## Commands

```
bun dev           # run locally
bun test          # run the test suite, must pass before any commit
bun typecheck     # type check without emitting
bun lint          # lint
bun dev:desktop
bun dev:web
bun dev:console
bun dev:stats
```

## Layout

- `packages/`  3277 source files
- `script/`    14 source files
- `artifacts/` 9 source files
- `infra/`     8 source files
- `sdks/`      5 source files
- `github/`    2 source files

## Conventions

- Tests live alongside the code they cover, following `packages/app/create-effect-simplification-spec.md`.
- 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/close-issues.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/web/src/components/icons/index.tsx` is 257KB. 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.