AGENTS.md

1# AGENTS.md
2 
3Go 1.26+ proxy server providing OpenAI/Gemini/Claude/Codex compatible APIs with OAuth and round-robin load balancing.
4 
5## Repository
6- GitHub: https://github.com/router-for-me/CLIProxyAPI
7 
8## Commands
9```bash
10gofmt -w . # Format (required after Go changes)
11go build -o cli-proxy-api ./cmd/server # Build
12go run ./cmd/server # Run dev server
13go test ./... # Run all tests
14go test -v -run TestName ./path/to/pkg # Run single test
15go build -o test-output ./cmd/server && rm test-output # Verify compile (REQUIRED after changes)
16```
17- Common flags: `--config <path>`, `--tui`, `--standalone`, `--local-model`, `--no-browser`, `--oauth-callback-port <port>`
18 
19## Config
20- Default config: `config.yaml` (template: `config.example.yaml`)
21- `.env` is auto-loaded from the working directory
22- Auth material defaults under `auths/`
23- Storage backends: file-based default; optional Postgres/git/object store (`PGSTORE_*`, `GITSTORE_*`, `OBJECTSTORE_*`)
24 
25## Architecture
26- `cmd/server/` — Server entrypoint
27- `internal/api/` — Gin HTTP API (routes, middleware, modules)
28- `internal/api/modules/amp/` — Amp integration (Amp-style routes + reverse proxy)
29- `internal/thinking/` — Main thinking/reasoning pipeline. `ApplyThinking()` (apply.go) parses suffixes (`suffix.go`, suffix overrides body), normalizes config to canonical `ThinkingConfig` (`types.go`), normalizes and validates centrally (`validate.go`/`convert.go`), then applies provider-specific output via `ProviderApplier`. Do not break this "canonical representation → per-provider translation" architecture.
30- `internal/runtime/executor/` — Per-provider runtime executors (incl. Codex WebSocket)
31- `internal/translator/` — Provider protocol translators (and shared `common`)
32- `internal/registry/` — Model registry + remote updater (`StartModelsUpdater`); `--local-model` disables remote updates
33- `internal/store/` — Storage implementations and secret resolution
34- `internal/managementasset/` — Config snapshots and management assets
35- `internal/cache/` — Request signature caching
36- `internal/watcher/` — Config hot-reload and watchers
37- `internal/wsrelay/` — WebSocket relay sessions
38- `internal/usage/` — Usage and token accounting
39- `internal/tui/` — Bubbletea terminal UI (`--tui`, `--standalone`)
40- `sdk/cliproxy/` — Embeddable SDK entry (service/builder/watchers/pipeline)
41- `test/` — Cross-module integration tests
42 
43## Code Conventions
44- Keep changes small and simple (KISS)
45- Comments in English only
46- If editing code that already contains non-English comments, translate them to English (don’t add new non-English comments)
47- For user-visible strings, keep the existing language used in that file/area
48- New Markdown docs should be in English unless the file is explicitly language-specific (e.g. `README_CN.md`)
49- As a rule, do not make standalone changes to `internal/translator/`. You may modify it only as part of broader changes elsewhere.
50- If a task requires changing only `internal/translator/`, run `gh repo view --json viewerPermission -q .viewerPermission` to confirm you have `WRITE`, `MAINTAIN`, or `ADMIN`. If you do, you may proceed; otherwise, file a GitHub issue including the goal, rationale, and the intended implementation code, then stop further work.
51- `internal/runtime/executor/` should contain executors and their unit tests only. Place any helper/supporting files under `internal/runtime/executor/helps/`.
52- Follow `gofmt`; keep imports goimports-style; wrap errors with context where helpful
53- Do not use `log.Fatal`/`log.Fatalf` (terminates the process); prefer returning errors and logging via logrus
54- Shadowed variables: use method suffix (`errStart := server.Start()`)
55- Wrap defer errors: `defer func() { if err := f.Close(); err != nil { log.Errorf(...) } }()`
56- Use logrus structured logging; avoid leaking secrets/tokens in logs
57- Avoid panics in HTTP handlers; prefer logged errors and meaningful HTTP status codes
58- Timeouts are allowed only during credential acquisition; after an upstream connection is established, do not set timeouts for any subsequent network behavior. Intentional exceptions that must remain allowed are the Codex websocket liveness deadlines in `internal/runtime/executor/codex_websockets_executor.go`, the wsrelay session deadlines in `internal/wsrelay/session.go`, the management APICall timeout in `internal/api/handlers/management/api_tools.go`, and the `cmd/fetch_antigravity_models` utility timeouts
59