# AGENTS.md

The swiss army knife of lossless video/audio editing

## Setup

```
yarn install
```

## Commands

```
yarn dev                          # run locally
yarn start                        # run the app
yarn build                        # produce a build
yarn test                         # run the test suite, must pass before any commit
yarn lint                         # lint
yarn check                        # lint and type check
yarn clean
yarn download-ffmpeg-darwin-x64
```

## Layout

- `src/`         159 source files
- `script/`      9 source files
- `test-manual/` 1 source file

## Conventions

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

## Gotchas

- `.yarn/releases/yarn-4.11.0.cjs` is 2921KB. 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.