Codex玩转agent-rules-books:AGENTS.md与.agents/skills双层配置的完整指南
【免费下载链接】agent-rules-booksAGENTS.md rules / skills for AI coding agents: Codex, Cursor & Claude Code. Inspired by Clean Code, Refactoring, DDD, Clean Architecture and DDIA programming books.项目地址: https://gitcode.com/gh_mirrors/ag/agent-rules-books
agent-rules-books 是一个把《Clean Code》《Refactoring》《Domain-Driven Design》等14本经典编程书籍提炼成 AI 编码智能体规则的开源项目,专为 Codex、Cursor 和 Claude Code 提供开箱即用的 AGENTS.md 规则与 .agents/skills 技能包,帮你用最小配置让 AI 写出更专业的代码。
为什么需要 agent-rules-books?
直接让 AI 写代码,常见问题是:代码能跑,但结构混乱、命名随意、重构失控。项目作者在 README.md 中做过一个对比实验:对同一个应用分别用「仅提到书名」和「加载 mini 版规则」两种方式让 Codex 做重构,结果加载规则的版本评分约 74 分,仅提书名仅 46 分——把书中原则写成具体规则,远比只说"参考这本书"有效。
它解决了三个痛点:
- 📚书籍知识 → 可执行规则:每本书的决策规则、触发条件、反模式都被压缩成清单式指令
- 🎯按需加载:规则分
mini/nano/full三档,不会撑爆上下文 - 🧰跨工具通用:同一套规则可用于 Codex、Cursor、Claude Code,纯 Markdown 格式
一分钟上手:clone 仓库与版本选择
克隆仓库:
git clone https://gitcode.com/gh_mirrors/ag/agent-rules-books每个书籍目录包含三个版本,选择逻辑很简单:
| 版本 | 适用场景 | 典型用途 |
|---|---|---|
mini | 默认推荐,多数真实任务 | 技能包正文、常驻项目规则 |
nano | 上下文预算极紧 | 跨工具便携基线、极小 Always 规则 |
full | 深度参考、审计 | 技能包的 reference 文件、专项会话 |
以 Clean Code 为例,三个文件分别是 clean-code.md、clean-code.mini.md 和 clean-code.nano.md。官方使用手册 docs/USAGE.md 的核心建议只有一句:用能改变 AI 决策的最小机制,默认选mini。
第一层配置:AGENTS.md 常驻规则
AGENTS.md 是 Codex 原生识别的项目级指令文件,作用是让 AI 在每个任务中保持稳定的工程风格偏好。
推荐做法:
- 在仓库根目录创建
AGENTS.md,只放入一本mini规则集 - 选择最能代表你团队偏好的书,例如日常编码与代码审查选 clean-code.mini.md,架构治理选 clean-architecture.mini.md
- 若工具常驻预算非常紧张,降级为
nano版本 - 仅在个别子目录需要不同约束时,才在子目录放嵌套
AGENTS.md或AGENTS.override.md覆盖
避坑提醒(来自 docs/USAGE.md 的 Codex 章节):
- ❌ 不要把多个
full文件全局加载,上下文会被淹 - ❌ 不要把长流程、清单写进
AGENTS.md,它只适合放"稳定的偏好基线" - ✅ 根级规则保持单一来源,多编辑器团队用同一份
AGENTS.md作为跨工具基线
第二层配置:.agents/skills 按需技能
常驻规则管"风格",技能管"流程"。当某本书的规则只在特定工作流中生效时(重构、遗留代码改造、可靠性加固、领域建模),应该做成.agents/skills/下的技能包,AI 只在任务匹配时加载,不占用日常上下文。
推荐目录结构:
project/ AGENTS.md .agents/ skills/ refactoring-pass/ SKILL.md # 由 refactoring.mini.md 派生 reference.md # 可选:链接或引用 refactoring.md好技能包的候选(官方推荐清单):
- 🛠
refactoring.mini.md→ 重构专项 - 🏚
working-effectively-with-legacy-code.mini.md→ 高风险遗留代码改动 - 🗺
domain-driven-design.mini.md→ 建模密集型任务 - 🛡
release-it.mini.md→ 生产环境可靠性变更 - 📊
designing-data-intensive-applications.mini.md→ 数据一致性与事件流
技能包正文保持精简,长示例、完整规则、可追溯性材料放到reference.md或检索系统中,而不是塞进常驻指令。
双层配置怎么选:决策速查表
| 你的需求 | 推荐机制 | 推荐版本 |
|---|---|---|
| 任务需要特定书籍偏置 | 技能或按需规则 | mini |
| 稳定的全仓工程偏好 | 根级AGENTS.md | mini(太紧用nano) |
| 极小的常驻基线 | 根级AGENTS.md | nano |
| 某个子目录需要不同约束 | 嵌套AGENTS.override.md | mini或nano |
| 多步流程(审查、迁移、发布) | 技能包,full作可选参考 | mini+full |
| 大型参考资料、频繁变更的文档 | MCP 或检索(RAG) | full |
完整的决策指南见 docs/USAGE.md 末尾的 Decision Guide 章节。
多书组合:先看兼容性矩阵
想同时加载多本书的规则时,别拍脑袋。仓库内置了 docs/COMPATIBILITY.md 兼容性矩阵,对比了全部 14 套mini规则的共存关系:
- ✅互补(78 对):可并行加载,互不裁决
- ❌冲突(2 对):例如 DDD 与 PoEAA 不要作为同级规则同时加载
- 🔁重叠(11 对):例如 Refactoring 与 Refactoring.Guru,二选一即可
经验法则:常驻规则只保留一本主力书,其余全部放进技能按需调用。矩阵中每对组合都有独立分析文档,如 refactoring/refactoring-guru 组合分析。
规则是怎么炼成的?
项目内部有一套完整的压缩工艺(规则压缩流程):每条规则先按"决策改变型 / 微决策 / 冲突裁决 / 触发器"等类别分级,只有能真正改变 AI 设计、架构、重构决策的规则才进入mini;nano则只保留纠正已知模型偏好的最小规则集,如"浅包装冒充好抽象""框架先行设计""不安全重试"等高频陷阱。每条保留/删除的规则都在traceability.md中可追溯。
这也是为什么规则文件都以# OBEY {书名} by {作者}开头——它们不是读书笔记,而是写给 AI 的工程行为契约。
常见问题
AGENTS.md 里放多少本书?一本。常驻层放一个主力mini,多书共存会互相稀释,甚至产生冲突压力。
mini 和 nano 差在哪?mini保留了书中完整的决策压力和权衡处理(约 40–65 行),适合多数任务;nano(约 30–45 行)只保留"最危险陷阱提醒",适合跨编辑器携带或预算极紧的场景。
Cursor 或 Claude Code 能用吗?可以。规则是纯 Markdown:Claude Code 在CLAUDE.md中加一行@AGENTS.md即可复用同一基线,技能放.claude/skills/;Cursor 可将mini转成.cursor/rules中按路径或按需触发的.mdc规则。详见 docs/USAGE.md。
总结
用 Codex 玩转 agent-rules-books 的核心就三条:
- 根级
AGENTS.md放一本mini规则,形成稳定基线 .agents/skills/放mini派生的技能包,按工作流按需触发- 多书组合先查兼容性矩阵,冲突对绝不并行加载
配置完成后,你可以观察 AI 在模块边界、命名、重构小步化、错误处理上的表现——这些规则的价值,正是在它让 AI 少犯那些"人类觉得显然但模型经常违反"的错误。
【免费下载链接】agent-rules-booksAGENTS.md rules / skills for AI coding agents: Codex, Cursor & Claude Code. Inspired by Clean Code, Refactoring, DDD, Clean Architecture and DDIA programming books.项目地址: https://gitcode.com/gh_mirrors/ag/agent-rules-books
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考