当前位置: 首页 > news >正文

什么是 AGENTS.md?如何为 Claude Code、Codex、Cursor 及其他 AI 编程代理创建它

如果你最近在现有代码库上启动过 Claude Code、Cursor 或 Codex,很可能在项目根目录中遇到过一个名为AGENTS.md的文件,并好奇是谁把它放在那里的。它不是README。它不是给团队看的文档。它是一组专门为即将开始编辑你代码的AI 代理编写的指令

我一度忽略了这些文件,以为它们只是炒作。然后我目睹 Codex 在一个已经用了两年 pnpm 的客户端项目上运行了npm install。它删除了锁文件,然后愉快地发起了一个拉取请求。这正是AGENTS.md存在要防止的问题。花 10 分钟写一个,代理就不会在每次会话中重复犯同样的错误了。

以下是关于它你需要知道的一切。

什么是 AGENTS.md?

AGENTS.md是一个纯Markdown 文件,你把它放在仓库根目录,用来告诉 AI 编程代理你的项目是如何工作的。你可以把它想象成一份写给机器而不是人看的README。它包含构建命令、测试命令、编码约定以及代理无法仅通过阅读你的源代码就能猜到的硬性规则

该标准的制定者将其描述为一个可预测的、专用的位置,用于为编码代理提供它们所需的上下文。你的README涵盖的是面向人类的内容,比如快速入门、徽章和贡献说明。AGENTS.md涵盖的是操作细节,这些细节放在 README 里会显得杂乱,但代理在触碰任何东西之前确实需要知道。

它没有模式,没有 YAML,没有需要学习的特殊语法。它只是带有标题Markdown。代理会阅读文本,并将其视为该仓库长期指令。

为什么 AI 编码工具开始使用 AGENTS.md

每个编码代理都有同样的盲点:会话之间没有记忆。关闭终端,你教会它的所有东西都会消失。打开一个会话,你又得回到解释是的,我们用的是make test-integration而不是pytest,还有,这个遗留文件夹确实还在故意使用回调。

如果没有持久的指令文件,代理往往会:

  • 运行错误的设置或测试命令,破坏你的工作流
  • 默认采用训练数据中最常见的编码风格,而不是你的
  • 忽略项目约定,
http://www.cnnetsun.cn/news/3326926.html

相关文章:

  • Vendure插件开发实战:5个高级场景深度解析
  • 企业获客软件获客效率技术对比:获客工具与CRM的操作链路与数据能力差异分析
  • 2026餐饮店怎么选GEO服务商:6类核心能力对比分析,全程0代码
  • Open Design 中文保姆级下载安装教程及入门教程(2026最新版)
  • Linux游戏性能翻倍秘籍:lsfg-vk无损帧生成技术深度解析
  • A/B 测试 3 大统计陷阱:辛普森悖论如何扭曲实验结论
  • LiveAutoRecord:跨平台直播自动录制的终极解决方案
  • 从0到1部署WebWalker:LLM网页遍历智能体的本地化与规模化实践指南
  • Glorytun安全配置详解:保护你的UDP隧道通信的完整策略
  • QEMU 8.2.2 Windows 部署 UOS ARM 虚拟机:3步脚本配置与 SSH 端口 2222 映射
  • 3个秘籍让旧版Python在Windows上重获新生
  • 告别 Demo 陷阱:用 LangGraph 构建可观测的生产级 Agent 工作流
  • Inventory Kamera未来路线图:计划中的新功能和改进方向 [特殊字符]
  • 2026年AI论文生成工具哪家强?5款热门工具实测对比
  • 终极指南:1500+ AI代理技能库如何彻底改变你的开发工作流
  • 如何快速上手Laguna-XS-2.1-bf16:5分钟完成MLX模型安装与推理
  • 探索CountryPicker核心功能:国旗显示、本地化名称与ISO标准支持
  • AI 写达梦/金仓代码疯狂翻车?我手撸了一套“信创专属 AI 生成引擎”,把大模型的方言幻觉按在地上摩擦!
  • 关于算法优化的量化评估与测试框架设计7
  • BSC信道下重复码纠错性能仿真 P124302178 李云徽
  • 如何在macOS上构建Windows应用运行环境的3种终极方案
  • Ream插件开发指南:打造属于你的自定义功能扩展
  • TVA:具身智能动力引擎与能力底座(23)
  • Frame用户系统API启动器:5分钟快速搭建企业级用户管理系统
  • BunnyPHP TLS/SSL安全连接配置完全指南
  • NVIDIA Eagle VLM架构详解:动态分块和混合视觉编码器的创新设计
  • TRON Wallet CLI安全配置指南:多重签名与账户权限设置
  • 探索Rhythm的Material 3设计:打造视觉与听觉的双重盛宴
  • AI Agent自动客服上线前必须完成的17项合规性检查(含GDPR/《生成式AI服务管理暂行办法》双标对照表)
  • Edalize未来路线图:AI辅助硬件设计和云EDA集成的发展趋势