Report · marked 10 Oct 2026

MHSanaei/3x-ui

Ready for an agent to work in without hand-holding.

Go · 47,717 stars · 2,065 files · branch main

90 /100 A

Instructions 22/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 20/20Whether an agent can install the project and get it running without a human. Full marks.Verification loop 22/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Full marks.Context economy 15/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability 10/10How quickly anything new can orient itself. Full marks.

Higher is better. Accent marks what is costing you most.

Fix these first

File sizes fit in context

A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.

Agent instruction file

Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.

Instruction quality

Worth fixing: has no code blocks.

The full marking

Every deduction below names the file or setting it came from.

Instructions 22/27 A-

Whether the repo tells an agent how to behave before it starts guessing.

✗Agent instruction file 9/12

CLAUDE.md is present, but not the vendor-neutral AGENTS.md.

Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.

✗Instruction quality 10/12

Specific enough that an agent can act on it.

Worth fixing: has no code blocks.

13,470 characters, a workable length

names the actual commands to run

uses headings, so an agent can skim it

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 20/20 A+

Whether an agent can install the project and get it running without a human.

✓Deterministic install 6/6

go.sum pins the dependency tree.

Found go.sum

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

Makefile

✓Environment config 4/4

.env.example documents what the app needs to run.

✓Pinned runtime version 2/2

The language runtime version is pinned.

Found .nvmrc

✓Reproducible environment 2/2

dockerfile gives a known-good environment.

Verification loop 22/22 A+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

✓Tests exist 8/8

805 test files against 1573 source files.

e.g. api_token_cli_test.go, bot_context_test.go, deploy/test/smoke-noninteractive.sh

✓Test command is discoverable 7/7

An agent can find and run `make test`.

✓Continuous integration 4/4

10 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

.golangci.yml encodes the house style.

–Static type checking n/a

Not applicable — the Go compiler type checks every build.

Context economy 15/20 B+

Whether the repo fits in a context window, or fights it.

✓No committed build output 6/6

No generated directories committed.

✓.gitignore hygiene 3/3

.gitignore covers 28 patterns.

✗File sizes fit in context 2/6

4 source files are over 100KB.

A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.

x-ui.sh — 137KB

frontend/src/pages/api-docs/endpoints.ts — 128KB

frontend/src/generated/schemas.ts — 106KB

✗Repository weight 4/5

About 71.3MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for MHSanaei/3x-ui

# AGENTS.md

Supporting multi-protocol multi-user(Vmess, Vless, Trojan, ShadowSocks, Wireguard, Hysteria, Tunnel, Mixed, HTTP, Tun, MTProto، AmneziaWG) 

## Setup

```
go mod download
```

## Commands

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

## Layout

- `internal/` 851 source files
- `frontend/` 626 source files
- `docs/`     78 source files
- `tools/`    9 source files
- `deploy/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `api_token_cli_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 137KB. 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.

Open the raw markdown or curl -o AGENTS.md agentreadme.com/draft/MHSanaei/3x-ui.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Go AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

[![agent ready](https://agentreadme.com/badge/MHSanaei/3x-ui.svg)](https://agentreadme.com/MHSanaei/3x-ui)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 88 A golang/go 31 D kubernetes/kubernetes 74 B+ microsoft/TypeScript 82 A- JuliusBrussee/caveman 81 A-

All Go repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in