AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Worked for most · soon

hjdspace

hjdspaceReads credentialsAGENTS.md

SpaceCode

hjdspace/SpaceCode/AGENTS.md

三栏布局: Sidebar → ChatPanel → InfoPanel, 面板宽度由 splitLayout store 管理. Engine 抽象: EngineFactory (electron/engine/engines/) 按类型创建引擎实例 (ClaudeCodeEngine, PiEngine). engineGateway 是统一调用入口 — 三个 adapter (claudeCodeIPC.ts / h5Server.ts / imServer.ts) 的引擎派发全部委托到此. 详见 docs/adr/0004-engine-gateway-deep-module.md. Chat Session 生命周期: chatSession store 管理会话列表 → sessionProcess (Electron) 管理 CLI 子进程 → turn store (src/stores/turn/) 处理流式响应与工具事件. IPC 通信: Electron main ↔ renderer, 通过 preload.ts 的 contextBridge 暴露安全 API. 单一 runner: Vitest (npm run test). 权威划分见 vitest.config.ts 的 include: 新测试优先与被测源码同处 (src/x/__tests__/ 或 electron/x/__tests__/); tests/ 保留给跨模块的集成与场景测试。三条 pattern 刻意保持宽, 不要改成枚举子目录 —— 见…

44mo agoReviewMount

hjdspaceReads credentialsAGENTS.md

SpaceCode / engine

hjdspace/SpaceCode/engine/AGENTS.md

This is a reverse-engineered / decompiled version of Anthropic's official Claude Code CLI tool. The goal is to restore core functionality while trimming secondary capabilities. Many modules are stubbed or feature-flagged off. TypeScript strict mode is enforced — bunx tsc --noEmit must pass with zero errors. 使用 Conventional Commits 规范：常见 type：feat、fix、docs、chore、refactor 示例： - feat: 添加模型 1M 上下文切换 - fix: 修复初次登陆的校验问题 - chore: remove prefetchOfficialMcpUrls call on startup 详细的测试规范、覆盖状态和改进计划见 docs/testing-spec.md。

44mo agoReviewMount

CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.