# AGENTS.md

A modern GUI client based on Tauri, designed to run in Windows, macOS and Linux for tailored proxy experience

## Setup

```
pnpm install
```

## Commands

```
pnpm dev           # run locally
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 prepare
pnpm dev:service
```

## Layout

- `src/`              228 source files
- `src-tauri/`        116 source files
- `crates/`           25 source files
- `scripts/`          20 source files
- `scripts-workflow/` 2 source files
- `tests/`            1 source file

## Conventions

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

---

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.