AI 编程
00 / 00

AGENTS.md 与项目规则

用一份短规则文件告诉 AI 项目边界、命令和验收方式,并适配不同工具。

项目规则文件用来减少重复说明。它应该告诉 Agent:项目是什么、哪些边界不能碰、该运行什么命令、怎样才算完成。

先分清工具读取什么

工具自动读取的主要规则推荐做法
CodexAGENTS.md,支持目录分层根目录放全局规则,子目录只补局部规则
Claude CodeCLAUDE.mdCLAUDE.md 里写 @AGENTS.md,复用公共规则
Cursor.cursor/rules/*.mdc按文件范围写规则,需要时引用公共文档

Claude Code 不会把 AGENTS.md 当成通用 fallback 自动加载。想共用一份规则,可以在 CLAUDE.md 中导入:

@AGENTS.md

# Claude Code 专用补充
- 复杂任务先进入 Plan Mode。

一份够用的 AGENTS.md

# Project

这是一个 TypeScript Web App,包管理器使用 pnpm。

## 边界
- 修改前先读最接近目标文件的项目规则。
- 不改生成文件和无关模块。
- 不提交密钥、令牌和本地环境文件。

## 命令
- 开发:`pnpm dev`
- 类型检查:`pnpm type-check`
- 构建:`pnpm build`

## 完成标准
- 说明改了哪些文件。
- 运行与改动范围相符的检查。
- 没有验证的结论明确标注。

只写仓库真实存在的命令和约束。通用编程常识、长篇框架教程和临时任务不要塞进去。

Monorepo 用分层规则

project/
├── AGENTS.md
├── packages/
│   ├── api/AGENTS.md
│   └── web/AGENTS.md
└── docs/conventions/

根规则负责全局边界,子目录规则只补该模块的技术栈、命令和禁区。详细规范放在 docs/,规则文件只链接过去。

哪些约束不该只靠文字

  • 格式、类型和导入边界:交给 formatter、lint 和类型系统。
  • Schema 和接口一致性:交给代码生成或合约检查。
  • 密钥和危险文件:交给 .gitignore、扫描器和权限控制。
  • 发布门槛:交给 CI 和发布脚本。

规则文件是导航,不是安全边界。

维护检查

每次技术栈、目录或命令变化时更新规则。发现规则互相冲突,保留更具体目录的版本,并修正上层说明。

继续看:AI 编程工作流 · Codex 官方 AGENTS.md 指南 · Claude Code memory 文档

这篇文档有问题?