# AGENTS.md

Open-source Rust agent engine and terminal client for Codewhale, with provider choice, tools, approvals and receipts.

## Setup

```
npm ci
```

## Commands

```
npm run test        # run the test suite, must pass before any commit
npm run check:web
```

## Layout

- `crates/`  1592 source files
- `web/`     440 source files
- `scripts/` 142 source files
- `vendor/`  118 source files
- `pet/`     77 source files
- `patches/` 62 source files

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/agent-task-metadata.test.sh`.
- CI defines what passing means. See `.github/workflows/agent-task-labels.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `patches/unicode-width-0.2.2/src/tables.rs` is 1527KB. 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.