agentleFS

AGENTS.md examples from real projects

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

Worked for most · soon
worldwondererAGENTS.md

oh-story-claudecode

worldwonderer/oh-story-claudecode/AGENTS.md

本文件是 oh-story-claudecode 仓库自身的开发指引,给维护这个 skill 套件的 coding agent 读。它不是部署到用户写作项目里的那份 AGENTS.md;用户项目的 AGENTS.md / CLAUDE.md 由 story-setup 按 skills/story-setup/references/*/AGENTS.md.tmpl 生成,与本文件无关。 一个网文写作 skill 套件:14 个 skill(skills/<name>/SKILL.md + references/),加上面向 Claude Code、Codex、OpenCode、OpenClaw、Antigravity、ZCode、Reasonix 七个编程 Agent(宿主)的适配层。产品是写在 Markdown 里的写作方法与工作流契约,不是运行时程序。scripts/ 下是仓库自己的守卫、测试和代码生成脚本(索引见 scripts/README.md),不是 skill 运行时脚本。 完整规则、各编程 Agent 适配维护步骤与提交流程见 CONTRIBUTING.md。 强制清单以 .github/workflows/cross-platform.yml 为准;提交前按 CONTRIBUTING.md「CI 检查」里的本地命令跑一遍与改动相关的守卫,至少 bash scripts/static-check.sh、python3 scripts/skill-numbering.py check、bash scripts/check-doc-budget.sh、bash scripts/check-shared-files.sh。 决策笔记放在 .agents/notes/{proposed,implemented,rejected}/{feature,bug-fix,simplification,architecture,process,testing}/yyyy-mm-dd-topic.md,沿用 DeepSeek Harness 的 agent-notes 约定(方法见 https://github.com/czm15053/write-notes-like-deepseek)。正文中文,小节标题保留英文。

8.4k4d agoReviewMountCreate a free account to mount
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.