Setup commands【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.mdInstall deps:pnpm installRun tests:pnpm testCode styleTypeScript strict mode之所以单独做一份、而不是塞进 README是因为读者不同README 服务人类讲项目是干嘛的AGENTS.md 服务 AI讲在这个项目里该怎么干活。混在一起README 变臃肿AI 也在长文里抓不住重点。 ## 二、AI 助手总跑偏问题出在哪 AI 跑偏多数不是模型不够聪明是它不知道你的项目怎么运转。它得靠猜猜装依赖用 pnpm 还是 npm猜测试命令是哪个猜单引号还是双引号。猜错了要么来回返工要么悄悄产出风格不一致的代码。 传统做法是把这些都写进 README 或者口头交代坑有两个 - README 越写越长人和 AI 的信息互相干扰 - 换个工具、换个同事这些信息又得重说一遍 AGENTS.md 的思路是把给 AI 的指令单独放一个固定位置。写进去的内容大致分四类 - 项目概览这是做什么的代码怎么组织 - 常用命令装依赖、起服务、跑测试、跑 lint - 代码风格命名、引号、分号、文件组织 - 规矩与红线提交信息格式、哪些目录别碰、部署流程、安全注意点 写全之后AI 每次开工第一件事就是读它不用从零探索。这个仓库本身就是活例子——它根目录的 [AGENTS.md](https://link.gitcode.com/i/f305d416a4601317adc582ef7153107a) 里明确要求 AI 用 dev server 迭代、别在会话里跑生产构建改完依赖要同步 lockfile 并重启服务。每一条都是真实团队踩过的坑。 ## 三、我的 AI 工具能用 AGENTS.md 吗 基本都能。目前 Cursor、Codex、GitHub Copilot、Aider、Gemini CLI、VS Code、Windsurf、Devin、Zed、goose 等二十多个工具都支持读 AGENTS.md清单见 [components/CompatibilitySection.tsx](https://link.gitcode.com/i/af9ebe2b14047b6e71337434c145188b)。 这对选型很有意义你写一份文件所有工具共用不用给每家工具各配一套规则文件。今天用 Cursor、明天换别的项目上下文原样保留。 个别老工具需要手动指一下路径比如 Aider 在 .aider.conf.yml 里加一行 read: AGENTS.mdGemini CLI 在 .gemini/settings.json 里配置 context.fileName 指向它。 ## 四、AGENTS.md 快速上手三步配置法 不用 clone 任何东西在项目里新建一个文件就行如果要看更多真实案例可以拉一下仓库 bash git clone https://gitcode.com/GitHub_Trending/ag/agents.md【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考