openscreen: Instructions file for Codex

AGENTS.md

openscreen AGENTS.md is an instructions file for Codex, OpenCode from getopenscreen/openscreen. It costs 7,116 tokens per session, scanned A, original, MIT.

A project guide for coding agents working on OpenScreen, an open-source screen recorder and video editor built with Electron, React, TypeScript, and Pixi.js.

In plain words
What is it for?
Use it when developing OpenScreen to install dependencies, run the app, build, type-check, test, lint, format, and validate translations.
Why use it?
It gives agents the project's setup commands, coding rules, checks, and testing requirements so changes follow the repository's expectations.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is getopenscreen/openscreen's own configuration. It tells Codex and OpenCode how to work on openscreen itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything openscreen configures →

About the project

OpenScreen is a desktop screen-recording application that turns captured windows or screens, along with audio and optional webcam footage, into product demos and walkthroughs. It is for people creating demonstrations for social networks, video platforms, documentation, or landing pages.

getopenscreen/openscreen · 6,339 stars · on GitHub · getopenscreen.com

Reuse

Borrowing it

Nothing to install: this file belongs to getopenscreen/openscreen. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/getopenscreen/openscreen/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/getopenscreen/openscreen

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for openscreen AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/getopenscreen/openscreen/agents-md/github.svg)](https://agentmods.dev/instructions/getopenscreen/openscreen/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/getopenscreen/openscreen/agents-md"><img src="https://agentmods.dev/badge/instructions/getopenscreen/openscreen/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for openscreen AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/getopenscreen/openscreen/agents-md"><img src="https://agentmods.dev/badge/instructions/getopenscreen/openscreen/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 7,116 This file is loaded in full into every session.
When invoked 7,116 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.07116 $0.07116
Opus 5.5 $0.02846 $0.02846
Sonnet 5.5 $0.01423 $0.01423
Haiku 4.5 $0.00712 $0.00712

Measured 8d ago against content hash 90bc90edb0a6, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

openscreen AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 187 lines

How it starts

The opening of the file, as written. The whole thing — 187 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

OpenScreen is a free, open-source screen recorder and video editor (Electron + React + TypeScript, with a native Rust compositor) maintained as a continuation of the original v1.5.0 release. This file is the canonical guide for any AI coding agent working in this repo.

Setup commands

  • Install deps: npm install (Node 22.22.1, npm 10.9.4 — see package.json#engines)
  • Start dev: npm run dev (Vite dev server; Electron window opens via vite-plugin-electron)
  • Build: npm run build (TypeScript check + Vite build + electron-builder)
  • Typecheck: npx tsc --noEmit — app code only. CI also runs npx tsc -p tsconfig.test.json --noEmit in a separate job ("Typecheck (tests)"), so run both: test files are invisible to the root config, and a type error in a *.test.ts fails CI while the root check stays green.
  • Test (unit): npx vitest --run <path> while you work, npm run test once at the end — see Testing instructions
  • Test (e2e): npm run test:e2e (Playwright)
  • Lint: npm run lint (Biome 2.4)
  • Format: npm run format (Biome, tabs, double quotes, 100-col)
  • i18n check: npm run i18n:check (validates the 15 locale folders)

Use npm, not bun/pnpm/yarn/Deno. Not a style preference. Node native modules are rebuilt against Electron's ABI by electron-builder + @electron/rebuild, which resolve the tree through package-lock.json. Another package manager writes a different lockfile, so that rebuild breaks. packageManager + engines in package.json pin the versions; CI installs with npm ci. Note what this does not cover: the standalone Swift (macOS) and C++ (Windows) capture helpers are separate executables, built by npm run build:native:<platform> and only copied into the package as extraResources — build:win even passes --config.npmRebuild=false. Nothing in a normal build compiles them.

Development principles

  • Prefer the simplest solution that stays readable — no abstraction for hypothetical needs (YAGNI).
  • No mandated app-stack choice yet. Contributors pick their own state/data library. Don't impose one across the codebase and don't refactor existing code onto a different one — keep each addition self-contained and consistent within its own module. A single choice may be enforced later.
  • Don't optimize for line count. A dense one-liner that hides control flow is worse than the explicit version.
  • Match the surrounding code's idiom rather than introducing a new pattern next to it.

Read the full file on GitHub · 187 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago Changed · +7 lines · +269 tokens per session 90bc90edb0a6
  2. 14d ago Changed · +61 tokens per session 44897d1c003e
  3. 22d ago Changed · +43 tokens per session 658da266fb2e
  4. 25d ago Changed · +1 lines · +100 tokens per session 0c11bc65758e
  5. 27d ago Changed · +1 lines · +164 tokens per session 9a7f9ffd6b59
  6. 1mo ago Changed · +6 lines · +721 tokens per session 015666f45b14
  7. 1mo ago Changed · +57 tokens per session 0b8df1c84ad4
  8. 1mo ago Changed · +1 lines · +76 tokens per session 069f550a885f
  9. 1mo ago Changed · -2 tokens per session e3dc2f032e8f
  10. 2mo ago First seen · 171 lines · 5,627 tokens per session scan A 92f6add04279

Subscribe to this mod's changes

openscreen AGENTS.md is an instructions file published in the GitHub repository getopenscreen/openscreen (6,339 stars, last pushed yesterday), licensed MIT. It adds 7,116 tokens to every session, about $0.0285 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

openscreen AGENTS.md compared with instructions from other repositories

openscreen AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
openscreen AGENTS.mdgetopenscreen/openscreenInstructions file6.3kyesterdayMITA7,116Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode