# AGENTS.md

Build smaller, faster, and more secure desktop and mobile applications with a web frontend.

## Setup

```
pnpm install
```

## Commands

```
pnpm build          # produce a build
pnpm test           # run the test suite, must pass before any commit
pnpm format         # format
pnpm format:check
pnpm eslint:check
pnpm ts:check
pnpm build:debug
pnpm build:api
```

## Layout

- `crates/`   354 source files
- `examples/` 54 source files
- `packages/` 32 source files
- `bench/`    11 source files

## Conventions

- Tests live alongside the code they cover, following `bench/tests/cpu_intensive/public/index.css`.
- CI defines what passing means. See `.github/workflows/audit.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/tauri-utils/src/config.rs` is 182KB. 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.