企业官网建设流程全解析

AGENTS.md 快速上手：10 分钟写一份项目说明书，让所有 AI 编码助手都看得到

【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md

AGENTS.md 是一个简单、开放的配置文件格式，用于给 AI 编码助手提供项目上下文与行为指令。它在项目根目录放一个 Markdown 文件，告诉助手怎么启动项目、用哪些命令测试、遵守哪些代码约定。目前已有超过 60,000 个开源项目在使用它。

什么时候需要给 AI 助手一份"说明书"

如果你用 AI 写过代码，多半遇到过这种情况：新会话开始，助手不知道用什么命令启动项目、新文件该放哪个目录，你得把一堆项目背景反复粘贴进对话框。

AGENTS.md 就是为这件事设计的。官方的说法很直白：它是"给 agent 的 README"——README 教人看懂项目，这个文件教 AI 看懂。写一次，助手每次开工都会自动加载，不用再口头交代。

第一份 AGENTS.md 文件怎么写

三步完成，没有门槛：

1. 在仓库根目录新建AGENTS.md。没有必填字段，用普通 Markdown 写，agent 只解析你给的文本。
2. 写进真正有用的 5 类内容：项目概览、构建和测试命令、代码风格约定、测试说明、安全注意事项。
3. 你愿意告诉新同事的其余事项——提交信息格式、PR 规则、部署步骤——一并写进去。

写法上有一个原则：写具体、可执行的句子。比如这一行：

运行 pnpm test 跑全部测试，提交前必须全绿。

比"请遵守代码规范"对助手有用得多。

Monorepo 里怎么配置 AGENTS.md

大型仓库不必把一份文件写到几百行。在每个子包目录里再放一个AGENTS.md即可，agent 会自动优先读取离当前编辑文件最近的那份，各子项目各管各的。官方的 OpenAI 仓库里就有 88 个这样的嵌套文件。

冲突时的裁定规则只有两条：文件之间"离得近的生效"；对话中"用户的明确指令压倒文件内容"。

AGENTS.md 兼容哪些 AI 工具 🧩

格式能快速铺开的原因在于：一份文件被 20 多种主流工具识别。官网列出的完整清单包括 Codex、Cursor、VS Code、GitHub Copilot、Aider、Gemini CLI、Zed、Devin、Windsurf、Warp 等 24 个工具，不用为每个工具单独维护一套规则。清单源码见 components/CompatibilitySection.tsx，各工具标识在 public/logos/ 目录里。

本地跑起来看效果

这个仓库本身是 AGENTS.md 官网的 Next.js 应用，可以直接当运行示例：

1. pnpm install安装依赖
2. pnpm run dev启动开发服务器
3. 浏览器打开 http://localhost:3000

顺带一提，仓库自带了一份 AGENTS.md，里面就是真实规则："agent 会话期间只用开发服务器，别跑生产构建"。想抄作业的话，从它开始。

常见问题

• 必须有特定字段吗？不需要，纯 Markdown，标题结构随意。
• 助手会自动执行文件里写的测试命令吗？会。它会尝试运行你列出的检查项，并先修掉失败再收尾。
• 以后能改吗？能，而且应该改。把它当作随代码一起更新的活文档。
• 已有 AGENT.md 之类的旧文件怎么办？改名为AGENTS.md，再给旧名字留一个符号链接即可平滑迁移。

延伸阅读

• README.md 项目总览
• 本仓库的 AGENTS.md 实例
• components/ 官网页面源码

【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md