# AGENTS.md

Orca is the ADE for working with a fleet of parallel agents. Run any coding agent with your own subscription. Available on desktop, mobile and VPS.

## 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 typecheck            # type check without emitting
pnpm lint                 # lint
pnpm format               # format
pnpm audit:code-quality
```

## Layout

- `src/`       15902 source files
- `mobile/`    1264 source files
- `tests/`     585 source files
- `config/`    365 source files
- `native/`    33 source files
- `resources/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `config/scripts/adhoc-build-version.test.mjs`.
- 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/adhoc-mac-build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/main/runtime/orca-runtime.test.ts` is 1758KB. 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.