# AGENTS.md

🤱🏻 Turn any webpage into a desktop app with one command.

## 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 format        # format
pnpm build:debug
pnpm build:mac
pnpm analyze
```

## Layout

- `tests/`     44 source files
- `bin/`       32 source files
- `src-tauri/` 20 source files
- `dist/`      1 source file
- `scripts/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/quality-and-test.yml`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/npm-publish.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `dist/cli.js` is 136KB. 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.