ptywright: Instructions file for Codex

AGENTS.md

ptywright AGENTS.md is an instructions file for Codex, OpenCode from kingsword09/ptywright. It costs 1,254 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for an AI coding assistant working on ptywright, a tool for observing and testing terminal and text-based interfaces. They describe the project goal, design principles, quick-start commands, and documentation map.

In plain words
What is it for?
Use them when developing or reviewing ptywright, running its Bun-based setup and tests, or deciding where terminal, session, rendering, and agent logic belongs.
Why use it?
They give the assistant shared context for working across terminal sessions, regression tests, scripts, and agent-facing tools. The instructions emphasize repeatable tests and portable generated files.

Instructions file for CodexOpenCode

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

This is kingsword09/ptywright's own configuration. It tells Codex and OpenCode how to work on ptywright 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 ptywright configures →

Reuse

Borrowing it

Nothing to install: this file belongs to kingsword09/ptywright. 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/kingsword09/ptywright/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/kingsword09/ptywright

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 ptywright AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/kingsword09/ptywright/agents-md/github.svg)](https://agentmods.dev/instructions/kingsword09/ptywright/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/kingsword09/ptywright/agents-md"><img src="https://agentmods.dev/badge/instructions/kingsword09/ptywright/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 ptywright AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/kingsword09/ptywright/agents-md"><img src="https://agentmods.dev/badge/instructions/kingsword09/ptywright/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,254 This file is loaded in full into every session.
When invoked 1,254 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.01254 $0.01254
Opus 5.5 $0.00502 $0.00502
Sonnet 5.5 $0.00251 $0.00251
Haiku 4.5 $0.00125 $0.00125

Measured 2mo ago against content hash 2aee1986c80e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

ptywright 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 2mo 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 · 120 lines

How it starts

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

ptywright - Agent Notes

Project Goal

Build and maintain a universal terminal/TUI observability and regression driver: launch commands through a PTY, feed ANSI/VT output into @xterm/headless, rebuild terminal state, and expose that state through MCP tools, scripts, cassettes, and browser-terminal regression workflows.

Priorities:

  • Deterministic regression first: stable snapshots, masks, explicit waits, goldens, and replayable artifacts.
  • Agent visibility second: let agents inspect terminal semantics before relying on visual screenshots.
  • Portable artifacts: generated summaries/manifests must remain useful after copied or moved.

Design Principles

  • KISS: keep the smallest reliable loop for each workflow.
  • YAGNI: avoid pixel diff, terminal component-tree inference, or app-specific contracts unless a milestone needs them.
  • DRY: snapshot/wait/normalize logic belongs in src/terminal/, src/session/, src/script/, and src/agent/, not scattered across tests.
  • SOLID: keep PTY adapters, session lifecycle, rendering, MCP tools, script runner, and browser-agent runner separated by clear contracts.

Quick Start

  • Install dependencies: bun install
  • Local CLI help: bun run src/cli.ts help
  • Start MCP server: bun run src/cli.ts mcp
  • Run unit/regression tests: bun run test
  • Run committed agent cassette check: bun run agent:check
  • Full gate: bun run check
  • Lint: bun run lint
  • Format: bun run format / bun run format:check

Documentation Map

  • README.md / README_ZH.md: concise product entry points.
  • docs/mcp.md: live terminal MCP usage.
  • docs/script-runner.md: JSON/TS script runner and goldens.
  • docs/pty-cassette.md: raw PTY record/replay and wrapper APIs.
  • docs/agent-regression.md: browser terminal flows, replay, promote, check.
  • docs/browser-terminal-harness.md: downstream browser renderer harness pattern for raw PTY cassette replay.
  • docs/artifacts-and-ci.md: failure triage, manifests, reusable commands, CI.
  • docs/documentation-maintenance.md: docs/schema/CLI/example sync checklist.
  • plan.md: roadmap, milestones, decision log.
  • DEEPRESEARCH.md: historical research status and current implementation decision, not active architecture instructions.

Read the full file on GitHub · 120 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. 2mo ago First seen · 120 lines · 1,254 tokens per session scan A 2aee1986c80e

Subscribe to this mod's changes

ptywright AGENTS.md is an instructions file published in the GitHub repository kingsword09/ptywright (1 stars, last pushed 5mo ago), licensed Apache-2.0. It adds 1,254 tokens to every session, about $0.0050 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-31.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens