OhMyCode AGENTS.md

A set of project instructions for OhMyCode, a small Python program modeled on a coding-assistant command line. It covers the project layout, supported libraries, development references, and commands for starting and testing it.

In plain words
What is it for?
Use it to work on the assistant’s command line, tool execution, streaming responses, permissions, context compression, memory, skills, setup script, and automated tests.
Why use it?
It helps coding agents find the right architecture documents and use the project’s required command-line workflow instead of guessing how the repository is organized.

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/alphalab-ustc/ohmycode/agents-md
Clone the repo
git clone --depth 1 https://github.com/AlphaLab-USTC/OhMyCode

Made for: Codex, OpenCode.

Per session 686 This file is loaded in full into every session.
When invoked 686 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.00686 $0.00686
Opus 5 $0.00343 $0.00343
Sonnet 5 $0.00137 $0.00137
Haiku 4.5 $0.00069 $0.00069

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

Security

Grade A, and why

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

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

AGENTS.md · 76 lines

How it starts

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

OhMyCode — AI Agent Development Guide

OhMyCode is a minimal Claude Code–style clone in roughly 3,000 lines of Python. It supports a REPL, streaming output, tool execution, a permissions pipeline, context compression, a memory system, and skills.

Quick orientation

  1. Architecture and module relationships → read agent_docs/ARCHITECTURE.md
  2. Core interfaces → read agent_docs/KEY-MODULES.md
  3. Gotchas → read agent_docs/GOTCHAS.md
  4. Development conventions → read docs/DEVELOPMENT_GUIDE.md
  5. Design docs → read project design docs committed in this repository

References

  • Project architecture and module docs under agent_docs/
  • Development workflow and conventions in docs/DEVELOPMENT_GUIDE.md

Tech stack

Python 3.9+, asyncio, openai SDK, anthropic SDK, rich, prompt_toolkit, tiktoken, httpx, pydantic

Run and test

./scripts/setup-cli.sh            # install + register CLI
ohmycode                         # start REPL
ohmycode -p "hello"              # single-shot prompt
python3 -m pytest tests/ -v      # run tests (currently 72)

CLI policy: always run via ohmycode command.

Project knowledge (agent_docs/)

Persistent, project-level knowledge lives under agent_docs/ for all tasks:

  • ARCHITECTURE.md — overall architecture, modules, data flow
  • KEY-MODULES.md — responsibilities and interfaces of core modules
  • GOTCHAS.md — pitfalls, counterintuitive design, common mistakes

After changing core project logic, update the relevant docs in agent_docs/.

Skills (.claude/skills/)

The project ships seven built-in skills to guide AI agents extending OhMyCode:

  • add-tool — add a custom tool
  • add-provider — integrate a new LLM provider
  • add-feature — add any new feature (points to docs/DEVELOPMENT_GUIDE.md)
  • customize-system-prompt — customize AI behavior
  • customize-response-style — customize terminal output style
  • commit-conventions — commit message conventions
  • debug-ohmycode — troubleshoot issues

Read the full file on GitHub · 76 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. 2d ago First seen · 76 lines · 686 tokens per session scan A 249dff1738a8

Subscribe to this mod's changes

OhMyCode AGENTS.md is an instructions file published in the GitHub repository AlphaLab-USTC/OhMyCode (131 stars, last pushed 5mo ago), licensed MIT. It adds 686 tokens to every session, about $0.0034 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-30.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

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 · 6,785 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 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,345 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js 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,296 tokens