# AGENTS.md

A terminal built on web technologies

## Setup

```
pnpm install
```

## Commands

```
pnpm dev               # run locally
pnpm start             # run the app
pnpm build             # produce a build
pnpm test              # run the test suite, must pass before any commit
pnpm lint              # lint
pnpm app
pnpm test:unit
pnpm test:unit:watch
```

## Layout

- `lib/`     48 source files
- `app/`     36 source files
- `typings/` 13 source files
- `bin/`     5 source files
- `test/`    5 source files
- `cli/`     2 source files

## Conventions

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

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `bin/yarn-standalone.js` is 4975KB. 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.