# AGENTS.md

Fast and extensible multi-platform HTTP/1-2-3 web server with automatic HTTPS

## Setup

```
go mod download
```

## Commands

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

## Layout

- `modules/`     227 source files
- `caddyconfig/` 34 source files
- `caddytest/`   21 source files
- `cmd/`         15 source files
- `internal/`    10 source files
- `notify/`      3 source files

## Conventions

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

## Gotchas

- `modules/caddyhttp/encode/testdata/caddy_asciinema_player.js` is 154KB. 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.