Report · marked 10 Oct 2026

umami-software/umami

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

TypeScript · 39,283 stars · 2,026 files · branch master

60 /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 16/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 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 11/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.

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 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 16/20 A-

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

✓Deterministic install 6/6

pnpm-lock.yaml pins the dependency tree.

Found pnpm-lock.yaml

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (dev, build, start, build:docker, start:docker, start:env…)

scripts/ directory

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

No pinned runtime version.

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

✓Reproducible environment 2/2

dockerfile 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

187 test files against 1289 source files.

e.g. docker-compose.test.yml, packages/api-client/src/client.test.ts, packages/api-client/src/http.test.ts

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

5 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

biome.json 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 11/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 41 patterns.

✗File sizes fit in context 0/6

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

packages/api-client/src/generated/types.ts — 687KB

packages/api-client/src/generated/operations.ts — 128KB

✓Repository weight 5/5

About 30.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 umami-software/umami

# AGENTS.md

Umami is a privacy-first analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place — no cookies, no surveillance, self-hosted or in the cloud.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev            # run locally
pnpm start          # run the app
pnpm build          # produce a build
pnpm test           # run the test suite, must pass before any commit
pnpm lint           # lint
pnpm format         # format
pnpm check          # lint and type check
pnpm build:docker
```

## Layout

- `src/`      1144 source files
- `tests/`    56 source files
- `packages/` 46 source files
- `scripts/`  30 source files
- `db/`       3 source files
- `docker/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `docker-compose.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/cd-cloud.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/api-client/src/generated/types.ts` is 687KB. 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/umami-software/umami.md

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

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 A-

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