Report · marked 25 Aug 2026

louislam/uptime-kuma

Solid foundations, held back in a few specific places.

JavaScript · 90,600 stars · 785 files · branch master

84 /100 A-

Instructions 21/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality.Setup 16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 23/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist.Context economy 18/20Whether the repo fits in a context window, or fights it. Losing marks on 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

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.

Instruction quality

Worth fixing: it never states a build, test, or run command; has no code blocks.

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 21/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, Copilot instructions

✗Instruction quality 6/12

Real instructions, with gaps.

Worth fixing: it never states a build, test, or run command; has no code blocks.

2,308 characters, a workable length

uses headings, so an agent can skim it

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 16/20 A-

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 (lint:js, lint:js-prod, lint-fix:js, lint:style, lint-fix:style, lint…)

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

The language runtime version is pinned.

package.json engines.node >= 20.4.0

✓Reproducible environment 2/2

compose.yaml gives a known-good environment.

Verification loop 23/25 A

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

✗Tests exist 6/8

55 test files against 614 source files.

e.g. .github/workflows/auto-test.yml, .github/workflows/build-docker-pr-test.yml, test/backend-test/README.md

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

21 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

.eslintrc.js encodes the house style.

✓Static type checking 3/3

Strict type checking is on, which catches a whole class of agent mistakes before they run.

Context economy 18/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 22 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/pages/EditMonitor.vue — 233KB

✓Repository weight 5/5

About 38.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 louislam/uptime-kuma

# AGENTS.md

A fancy self-hosted monitoring tool

## Setup

```
npm ci
```

## Commands

```
npm run dev            # run locally
npm run start          # run the app
npm run build          # produce a build
npm run test           # run the test suite, must pass before any commit
npm run lint           # lint
npm run lint:js
npm run lint:js-prod
npm run lint-fix:js
```

## Layout

- `server/` 208 source files
- `src/`    196 source files
- `db/`     111 source files
- `extra/`  47 source files
- `test/`   46 source files
- `config/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/auto-test.yml`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/ai-slop.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/pages/EditMonitor.vue` is 233KB. 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/louislam/uptime-kuma.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](https://agentreadme.com/badge/louislam/uptime-kuma.svg)](https://agentreadme.com/louislam/uptime-kuma)

Other JavaScript repositories, marked

react/react 71 B+ affaan-m/ECC 90 A trekhleb/javascript-algorithms 69 B Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+ vercel/next.js 77 B+

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