Report · marked 26 Aug 2026

siddharthvaddem/openscreen

Solid foundations, held back in a few specific places.

TypeScript · 39,887 stars · 471 files · branch main

73 /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 18/18Whether an agent can install the project and get it running without a human. Full marks.Verification loop 25/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Full marks.Context economy 17/20Whether the repo fits in a context window, or fights it. Losing marks on 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

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.

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 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 18/18 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 (dev, build, lint, lint:fix, format, i18n:check…)

scripts/ directory

✓Environment config 4/4

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

✓Pinned runtime version 2/2

The language runtime version is pinned.

Found .nvmrc

–Reproducible environment n/a

Not applicable — a library doesn't need a container to be worked on.

Verification loop 25/25 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

38 test files against 233 source files.

e.g. docs/tests/writing-tests.md, electron/ipc/recordingStream.test.ts, src/components/launch/SourceSelector.test.tsx

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

6 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 17/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 44 patterns.

✓File sizes fit in context 6/6

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

✗Repository weight 2/5

About 170MB 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 siddharthvaddem/openscreen

# AGENTS.md

Create stunning demos for free. Open-source, no subscriptions, no watermarks, and free for commercial use. An alternative to Screen Studio.

## 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 lint         # lint
npm run format       # format
npm run lint:fix
npm run i18n:check
npm run preview
```

## Layout

- `src/`      173 source files
- `electron/` 42 source files
- `scripts/`  10 source files
- `tests/`    2 source files

## Conventions

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

## Gotchas

- Copy `.env.example` 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/siddharthvaddem/openscreen.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/siddharthvaddem/openscreen.svg)](https://agentreadme.com/siddharthvaddem/openscreen)

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