agentreadme

Report · marked 26 Aug 2026

exelban/stats

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

Swift · 41,437 stars · 302 files · branch master

Fix these first

01
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.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

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 6/14 C

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

Deterministic install 0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
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 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 18/22 A-

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

Tests exist 4/8
3 test files against 147 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. Tests/Info.plist, Tests/Kit.swift, Tests/RAM.swift
Test command is discoverable 7/7
An agent can find and run `make test`.
Continuous integration 4/4
3 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
.swiftlint.yml encodes the house style.
Static type checking n/a
Not applicable — the Swift compiler type checks every build.
Context economy 19/20 A+

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 13 patterns.
File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
Repository weight 4/5
About 60.2MB 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 exelban/stats
# AGENTS.md

macOS system monitor in your menu bar

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make build         # produce a build
make archive
make notarize
make sign
make verify
make prepare-dmg
```

## Layout

- `Modules/` 72 source files
- `Kit/`     57 source files
- `Stats/`   9 source files
- `SMC/`     4 source files
- `Tests/`   2 source files
- `Widgets/` 2 source files

## Conventions

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

## Gotchas

- No lockfile is committed, so an install here may not match what CI produced.

---

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/exelban/stats.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 56 out of 100

[![agent ready](https://agentreadme.com/badge/exelban/stats.svg)](https://agentreadme.com/exelban/stats)

Other Swift repositories, marked

jaywcjlove/awesome-mac 40 C swiftlang/swift 31 D apple/container 61 B- iina/iina 28 F Alamofire/Alamofire 55 B- permissionlesstech/bitchat 52 C+

All Swift 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