# AGENTS.md

一款轻量级、高性能、功能强大的内网穿透代理服务器。支持tcp、udp、socks5、http等几乎所有流量转发，可用来访问内网网站、本地支付接口调试、ssh访问、远程桌面，内网dns解析、内网socks5代理等等……，并带有功能强大的web管理端。a lightweight, high-performance, powerful intranet penetration proxy server, with a powerful web management terminal.

## Setup

```
go mod download
```

## Commands

```
make build   # produce a build
make setup
make test    # run the test suite, must pass before any commit
make cover
make fmt
make lint    # lint
```

## Layout

- `lib/`    33 source files
- `server/` 13 source files
- `web/`    8 source files
- `client/` 5 source files
- `cmd/`    3 source files
- `bridge/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `lib/config/config_test.go`.
- CI defines what passing means. See `.github/workflows/release.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.