# AGENTS.md

Xray panel supporting multi-protocol multi-user expire day & traffic & IP limit (Vmess, Vless, Trojan, ShadowSocks, Wireguard, Hysteria, Tunnel, Mixed, HTTP, Tun, MTProto) 

## Setup

```
go mod download
```

## Commands

```
make help
make dist-stub
make gen
make gen-check
make lint-go
make lint-fe
```

## Layout

- `internal/` 604 source files
- `frontend/` 532 source files
- `docs/`     78 source files
- `tools/`    8 source files
- `deploy/`   1 source file

## Conventions

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

## Gotchas

- `x-ui.sh` is 132KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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.