# AGENTS.md

A terminal for a more modern age

## Setup

```
yarn install
```

## Commands

```
yarn start           # run the app
yarn build           # produce a build
yarn lint            # lint
yarn build:typings
yarn watch
yarn start:prod
yarn prod
yarn docs
```

## Layout

- `tabby-core/`     75 source files
- `tabby-terminal/` 40 source files
- `tabby-electron/` 36 source files
- `tabby-ssh/`      33 source files
- `tabby-settings/` 22 source files
- `app/`            20 source files

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- 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/build.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.
- `tabby-web-demo/data/v86_all.js` is 375KB. 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.