# AGENTS.md

AI agent toolkit: unified LLM API, agent loop, TUI, coding agent CLI

## Setup

```
npm ci
```

## Commands

```
npm run build                 # produce a build
npm run test                  # run the test suite, must pass before any commit
npm run check                 # lint and type check
npm run clean
npm run build:offline
npm run check:browser-smoke
npm run check:pinned-deps
npm run check:shrinkwrap
```

## Layout

- `packages/` 1167 source files
- `scripts/`  35 source files

## Conventions

- Tests live alongside the code they cover, following `packages/agent/test/agent-loop.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/approve-contributor.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/coding-agent/src/modes/interactive/interactive-mode.ts` is 222KB. 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.