# AGENTS.md

A platform for building proxies to bypass network restrictions.

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `transport/` 269 source files
- `common/`    224 source files
- `app/`       175 source files
- `proxy/`     113 source files
- `infra/`     108 source files
- `main/`      63 source files

## Conventions

- Tests live alongside the code they cover, following `app/dispatcher/stats_test.go`.
- CI defines what passing means. See `.github/workflows/codeql-analysis.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `release/extra/browserforwarder/index.js` is 1513KB. 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.