Report · marked 10 Oct 2026

LizardByte/Sunshine

Solid foundations, held back in a few specific places.

C++ · 42,052 stars · 573 files · branch master

83 /100 A-

Instructions 26/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on readme as an entry point.Setup 12/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.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 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

Environment config

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.

Lint and format rules

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

Repository weight

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

The full marking

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

Instructions 26/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.

✓Instruction quality 12/12

Specific enough that an agent can act on it.

4,032 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 2/3

README exists but never explains how to get the thing running.

Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.

Setup 12/20 B-

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

✓Deterministic install 6/6

package-lock.json pins the dependency tree.

Found package-lock.json

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (build, build-clean, dev, serve, test)

scripts/ directory

✗Environment config 0/4

Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.

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

No pinned runtime version.

Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.

✗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

61 test files against 262 source files.

e.g. tests/CMakeLists.txt, tests/certificate_test_utils.h, tests/fixtures/http/hello-redirect.txt

✓Test command is discoverable 7/7

An agent can find and run `npm run test`.

✓Continuous integration 4/4

28 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 C++ 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 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.

src/video.cpp — 131KB

✗Repository weight 2/5

About 460MB checked out. Large enough that cloning and searching are both slow.

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 LizardByte/Sunshine

# AGENTS.md

Self-hosted game stream host for Moonlight.

## Setup

```
npm ci
```

## Commands

```
npm run dev           # run locally
npm run build         # produce a build
npm run test          # run the test suite, must pass before any commit
npm run build-clean
npm run serve
```

## Layout

- `src/`        143 source files
- `tests/`      57 source files
- `src_assets/` 46 source files
- `packaging/`  4 source files
- `docs/`       3 source files
- `tools/`      3 source files

## Conventions

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

## Gotchas

- `src/video.cpp` is 131KB. 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/LizardByte/Sunshine.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good C++ 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/LizardByte/Sunshine.svg)](https://agentreadme.com/LizardByte/Sunshine)

Other C++ repositories, marked

tensorflow/tensorflow 34 D ggml-org/llama.cpp 74 B+ react/react-native 73 B+ electron/electron 85 A godotengine/godot 39 D microsoft/terminal 56 B-

All C++ 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