# AGENTS.md

The universal proxy platform

## Setup

```
go mod download
```

## Commands

```
make build                  # produce a build
make race
make ci_build
make generate_completions
make schema
make install
```

## Layout

- `common/`       241 source files
- `experimental/` 163 source files
- `cmd/`          113 source files
- `protocol/`     107 source files
- `route/`        83 source files
- `option/`       67 source files

## Conventions

- Tests live alongside the code they cover, following `adapter/inbound_test.go`.
- 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

- `common/certificate/mozilla.go` is 239KB. 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.