# AGENTS.md

🌈 React for interactive command-line apps

## Setup

```
npm install
```

## Commands

```
npm run dev         # run locally
npm run build       # produce a build
npm run test        # run the test suite, must pass before any commit
npm run typecheck   # type check without emitting
npm run lint        # lint
npm run format      # format
npm run prepare
npm run example
```

## Layout

- `test/`      112 source files
- `src/`       63 source files
- `examples/`  57 source files
- `benchmark/` 4 source files
- `media/`     1 source file

## Conventions

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

## Gotchas

- No lockfile is committed, so an install here may not match what CI produced.

---

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.