Report · marked 10 Oct 2026

XTLS/Xray-core

An agent can work here, but it will waste turns finding its footing.

Go · 42,039 stars · 1,151 files · branch main

56 /100 B-

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 10/20Whether an agent can install the project and get it running without a human. Losing marks on discoverable commands and environment config.Verification loop 19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy 15/20Whether the repo fits in a context window, or fights it. Losing marks on no committed build output and file sizes fit in context.Navigability 8/10How quickly anything new can orient itself. Losing marks on written documentation.

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

Fix these first

Agent instruction file

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Discoverable commands

Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.

The full marking

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

Instructions 3/27 F

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

✗Agent instruction file 0/12

None found. Every agent that opens this repo starts from zero.

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules

✗Instruction quality 0/12

Nothing to judge, since there are no instructions.

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 10/20 C+

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 0/6

No declared commands. An agent has to infer how to build and run this from the file tree.

Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.

✗Environment config 2/4

Env vars are mentioned in the README but there's no example file to copy.

Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.

✓Pinned runtime version 2/2

The language runtime version is pinned.

go.mod declares a Go version

✗Reproducible environment 0/2

No container or devcontainer definition.

A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.

Verification loop 19/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

262 test files against 950 source files.

e.g. app/dispatcher/stats_test.go, app/dns/dns_internal_test.go, app/dns/dns_test.go

✓Test command is discoverable 7/7

An agent can find and run `go test ./...`.

✓Continuous integration 4/4

5 GitHub Actions workflows define what "passing" means.

✗Lint and format rules 0/3

No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.

A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

–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 3/6

Generated output is committed: coverage/.

Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.

✓.gitignore hygiene 3/3

.gitignore covers 36 patterns.

✗File sizes fit in context 4/6

1 source file is 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.

common/protocol/quic/sniff_test.go — 119KB

✓Repository weight 5/5

About 31.8MB 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 XTLS/Xray-core

# AGENTS.md

Xray, Penetrates Everything. Also the best v2ray-core. Where the magic happens. An open platform for various uses.

## Setup

```
go mod download
```

## Commands

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

## Layout

- `transport/` 283 source files
- `common/`    228 source files
- `proxy/`     138 source files
- `app/`       110 source files
- `infra/`     72 source files
- `main/`      57 source files

## Conventions

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

## Gotchas

- `common/protocol/quic/sniff_test.go` is 119KB. 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.

Open the raw markdown or curl -o AGENTS.md agentreadme.com/draft/XTLS/Xray-core.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/XTLS/Xray-core.svg)](https://agentreadme.com/XTLS/Xray-core)

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