codex-client AGENTS.md

Repository instructions for a project that wraps the Codex command-line tool so programs can automate it. They define where protocol schemas, design rules, and Python and TypeScript implementations fit together.

In plain words
What is it for?
Updating protocol-facing code, regenerating TypeScript files, keeping Python and TypeScript behavior aligned, and testing the client’s communication layers.
Why use it?
They reduce compatibility mistakes when changing messages, generated types, transports, or client behavior.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/cheolwanpark/codex-client/agents-md
Clone the repo
git clone --depth 1 https://github.com/cheolwanpark/codex-client

Made for: Codex, OpenCode.

Per session 354 This file is loaded in full into every session.
When invoked 354 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00354 $0.00354
Opus 5 $0.00177 $0.00177
Sonnet 5 $0.00071 $0.00071
Haiku 4.5 $0.00035 $0.00035

Measured 2d ago against content hash 1bfa83dab117, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

codex-client 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 2d 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 · 15 lines

What it actually says

Repo Agent Notes

  • Read DESIGN.md before changing protocol-facing code.
  • schema/ is the source of truth for wire shapes. DESIGN.md is the source of truth for shared layering and lifecycle rules.
  • Keep bindings parallel where practical. Treat python/ as the behavioral reference when building out typescript/.
  • Build the TypeScript binding bottom-up: messages/errors -> codec -> transport -> connection -> typed client -> runtime.
  • The TypeScript package now includes all 3 layers. Preserve the separation between generated protocol surface and handwritten client/runtime logic.
  • If protocol-facing TypeScript types or wrapper methods change, update the codegen source and regenerate the checked-in files in typescript/src/generated*.ts.
  • Keep new TypeScript helpers limited to parity-oriented payload builders and documented runtime ergonomics. Do not add higher-level workflow helpers unless the task explicitly asks for them.
  • Prefer parity tests against the Python low-level behavior before introducing TypeScript-only abstractions.
  • Keep the TypeScript package Node-focused until a task explicitly asks for additional runtimes or transports.
  • When repo docs mention available bindings or TypeScript support level, keep them accurate now that the runtime layer exists.
  • Run TypeScript examples through the checked-in pnpm example:* scripts. pnpm examples:build compiles src/ and examples/ into typescript/.examples-dist/ for local example execution.
  • If a commit is requested, follow the existing Conventional Commit pattern from git log such as feat: ..., fix: ..., docs: ..., or refactor: ....
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. 2d ago First seen · 15 lines · 354 tokens per session scan A 1bfa83dab117

Subscribe to this mod's changes

codex-client AGENTS.md is an instructions file published in the GitHub repository cheolwanpark/codex-client (7 stars, last pushed 5mo ago), licensed MIT. It adds 354 tokens to every session, about $0.0018 per session on Opus 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.