What is okcode AGENTS.md?

Project instructions for OK Code, a minimal web interface for using coding agents such as Codex and Claude.

Use them when changing the OK Code repository, including running its formatting, linting, type-checking, and test commands or rebuilding the served app.

They define the checks required before completing work and emphasize reliability, performance, predictable failure handling, and maintainable code.

How OpenKnots/okcode configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to OpenKnots/okcode. 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/OpenKnots/okcode/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/OpenKnots/okcode

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/openknots/okcode/agents-md/github.svg)](https://agentmods.dev/instructions/openknots/okcode/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/openknots/okcode/agents-md"><img src="https://agentmods.dev/badge/instructions/openknots/okcode/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/openknots/okcode/agents-md"><img src="https://agentmods.dev/badge/instructions/openknots/okcode/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 651 This file is loaded in full into every session.

When invoked 651 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 81% copy Near-identical to another mod 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.

Model	Per session	Once invoked
Fable 5.1	$0.00651	$0.00651
Opus 5.5	$0.00260	$0.00260
Sonnet 5.5	$0.00130	$0.00130
Haiku 4.5	$0.00065	$0.00065

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

Security

Grade A, and why

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

Origin

This is a copy

81% identical to PeakCode CLAUDE.md — 180 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md · 55 lines

How it starts

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

AGENTS.md

Task Completion Requirements

All of bun fmt, bun lint, and bun typecheck must pass before considering tasks completed.
NEVER run bun test. Always use bun run test (runs Vitest).
For any change that must be visible on the served app endpoint, rebuild and restart the served app before considering the task complete. A browser hard refresh is not sufficient for the Tailscale-served production bundle.

Project Snapshot

OK Code is a minimal web GUI for using coding agents like Codex and Claude.

This repository is a VERY EARLY WIP. Proposing sweeping changes that improve long-term maintainability is encouraged.

Core Priorities

Performance first.
Reliability first.
Keep behavior predictable under load and during failures (session restarts, reconnects, partial streams).

If a tradeoff is required, choose correctness and robustness over short-term convenience.

Maintainability

Long term maintainability is a core priority. If you add new functionality, first check if there is shared logic that can be extracted to a separate module. Duplicate logic across multiple files is a code smell and should be avoided. Don't be afraid to change existing code. Don't take shortcuts by just adding local logic to solve a problem.

Package Roles

apps/server: Node.js WebSocket server. Wraps Codex app-server (JSON-RPC over stdio), serves the React web app, and manages provider sessions.
apps/web: React/Vite UI. Owns session UX, conversation/event rendering, and client-side state. Connects to the server via WebSocket.
packages/contracts: Shared effect/Schema schemas and TypeScript contracts for provider events, WebSocket protocol, and model/session types. Keep this package schema-only — no runtime logic.
packages/shared: Shared runtime utilities consumed by both server and web. Uses explicit subpath exports (e.g. @okcode/shared/git) — no barrel index.

Codex App Server (Important)

OK Code is currently Codex-first. The server starts codex app-server (JSON-RPC over stdio) per provider session, then streams structured events to the browser through WebSocket push messages.

Read the full file on GitHub · 55 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.

2mo ago First seen · 55 lines · 651 tokens per session scan A 318738b90b30

Subscribe to this mod's changes

okcode AGENTS.md is an instructions file published in the GitHub repository OpenKnots/okcode (24 stars, last pushed 5mo ago), licensed MIT. It adds 651 tokens to every session, about $0.0026 per session on Opus 5.5. A static security scan graded it A with 0 findings. It is 81% identical to PeakCode CLAUDE.md, differing in 180 lines, and is treated as a copy.

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

okcode: Instructions file for Codex