agentreadme

Report · marked 25 Aug 2026

juanfont/headscale

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

Go · 43,171 stars · 1,464 files · branch main

95 /100 A+
Instructions 27/27Whether the repo tells an agent how to behave before it starts guessing. Full marks.Setup 14/14Whether 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

01
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.

The full marking

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

Instructions 27/27 A+

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

✓Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md
✓Instruction quality 12/12
Specific enough that an agent can act on it.
12,148 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 14/14 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 n/a
Not applicable — this reads as a library, with no environment to configure.
✓Pinned runtime version 2/2
The language runtime version is pinned.
go.mod declares a Go version
–Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
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
202 test files against 392 source files.
e.g. .github/workflows/docs-test.yml, .github/workflows/nix-module-test.yml, cmd/headscale/cli/root_test.go
✓Test command is discoverable 7/7
An agent can find and run `make test`.
✓Continuous integration 4/4
18 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
.golangci.yaml 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 38 patterns.
✗File sizes fit in context 2/6
9 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.
integration/route_test.go — 164KB
hscontrol/auth_test.go — 161KB
gen/client/v1/client.gen.go — 143KB
✗Repository weight 4/5
About 56.4MB 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 juanfont/headscale 
# AGENTS.md

An open source, self-hosted implementation of the Tailscale control server

## Setup

```
go mod download
```

## Commands

```
make check-deps
make build          # produce a build
make test           # run the test suite, must pass before any commit
make fmt
make fmt-go
make fmt-mdformat
```

## Layout

- `hscontrol/`   303 source files
- `integration/` 50 source files
- `cmd/`         35 source files
- `gen/`         2 source files
- `tools/`       1 source file

## Conventions

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

## Gotchas

- `integration/route_test.go` is 164KB. 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/juanfont/headscale.md

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 95 out of 100

[![agent ready](https://agentreadme.com/badge/juanfont/headscale.svg)](https://agentreadme.com/juanfont/headscale)

Other Go repositories, marked

avelino/awesome-go 75 B+ ollama/ollama 85 A golang/go 30 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 80 A- fatedier/frp 93 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