Report · marked 26 Aug 2026

lissy93/web-check

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

TypeScript · 34,597 stars · 296 files · branch master

56 /100 B-

Instructions 0/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 20/20Whether an agent can install the project and get it running without a human. Full marks.Verification loop 11/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 and test command is discoverable.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 6/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.

Test command is discoverable

Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.

The full marking

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

Instructions 0/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 0/3

No README. This is the first file anything reads, human or machine.

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

Setup 20/20 A+

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

✓Deterministic install 6/6

yarn.lock pins the dependency tree.

Found yarn.lock

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (start, build, dev:vercel, dev:netlify, dev:api, dev:astro…)

✓Environment config 4/4

.env.sample documents what the app needs to run.

✓Pinned runtime version 2/2

The language runtime version is pinned.

package.json engines.node >=22.12.0

✓Reproducible environment 2/2

dockerfile gives a known-good environment.

Verification loop 11/25 C

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

✗Tests exist 4/8

1 test file against 180 source files.

Coverage is thin enough that an agent can break real behavior and still see green.

e.g. public/resources/openapi-spec.yml

✗Test command is discoverable 0/7

There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.

✓Continuous integration 4/4

5 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 3/3

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

Context economy 20/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 31 patterns.

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✓Repository weight 5/5

About 28.0MB 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 lissy93/web-check

# AGENTS.md

🕵️‍♂️ All-in-one OSINT tool for analysing any website

## Setup

```
yarn install
```

## Commands

```
yarn dev           # run locally
yarn start         # run the app
yarn build         # produce a build
yarn typecheck     # type check without emitting
yarn lint          # lint
yarn dev:vercel
yarn dev:netlify
yarn dev:api
```

## Layout

- `src/` 132 source files
- `api/` 42 source files

## Conventions

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

## Gotchas

- Copy `.env.sample` before running anything that needs configuration.

---

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/lissy93/web-check.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/lissy93/web-check.svg)](https://agentreadme.com/lissy93/web-check)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 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