AGENTS.md:给 AI 编程助手的一份「交接文档」,23k Star 的开源协议火了

AI 编程助手开发的时候,你有没有遇到过这种崩溃时刻——新建了一个 Claude Code / Cursor 项目,让 AI 读 README,结果它根本不知道你们团队的代码规范、测试流程、PR 格式,甚至不知道项目用的是 monorepo 还是单仓库,每次都要从头解释一遍。

AGENTS.md 就是来解决这个问题的。

它是什么

AGENTS.md 是一个开源的、给 AI 编程 Agent 看的「项目说明文件」。你可以把它理解为「给 AI 的 README」——放在项目根目录,Claude Code、Cursor、GitHub Copilot 这类工具启动时自动读取,里面写清楚:项目怎么跑、怎么测试、PR 怎么命名、monorepo 里怎么找到具体的 package。

格式超级简单,就是一个 Markdown 文件,但约定了结构,AI 能准确理解。

为什么爆了 23k Star

这项目在 GitHub 已经有 23.7k Star,最近还冲上了 Trending 榜。原因很简单——它踩中了 AI 编程工作流的真实痛点。

现在的 AI 编程工具越来越强,但它们有一个共同缺陷:对项目上下文一无所知。代码规范、依赖管理、CI/CD 流程……这些每个团队都不一样,AI 却只能靠猜。AGENTS.md 把这些信息标准化了,AI 读完之后就知道「这个项目里 pnpm install –filter 是用来给特定 package 加依赖的」,而不是乱来。

说白了,它把「团队 Best Practice」变成了一份 AI 能读懂、能执行的文档。

怎么用

在项目根目录新建 AGENTS.md,参考官方示例这样写:

## Dev environment tips
- Run `pnpm dlx turbo run where <project_name>` 找到目标 package
- Run `pnpm install --filter <project_name>` 添加依赖

## Testing instructions
- Run `pnpm turbo run test --filter <project_name>` 执行全套检查
- Always run `pnpm lint` 和 `pnpm test` 再提交

## PR instructions
- Title format: [<project_name>] <Title>

把你团队的工作流写进去,AI 下次就知道怎么配合你了。

谁适合用

个人开发者:给自己的项目留一份清晰的说明,换电脑或者过段时间回头看,AI 能快速接管。

团队项目:把 Code Review 规范、PR 流程、测试要求写进去,新成员 + AI 都能快速上手,减少无效沟通。

开源项目:给贡献者一份标准指南,降低参与门槛。

小结

AGENTS.md 本质上是在解决「AI 和项目之间的上下文断层」问题。它不是一个框架,不是一个 CLI 工具,就是一个 Markdown 文件——但正因为足够简单,门槛极低,效果立竿见影。

23k Star 说明这个需求是真实存在的。如果你经常用 AI 编程工具,强烈建议在项目里加一份 AGENTS.md,试一次就知道差距。

GitHub 仓库https://github.com/agentsmd/agents.md


GitHub: https://github.com/agentsmd/agents.md

评论区

0 条评论

登录后可评论。

陈一铭 10 阅读