撰写优秀的AGENTS.md

type

status

date

slug

summary

为什么我们需要AGENTS.md

首先，我们要明确一个内容，那就是：LLM（大模型）是无状态的。当他被训练出来以后，他的知识库就被封锁了，不会随着时间学习。除非他们发了新模型。

所以这件事情就导致了：

模型对你的项目是一无所知的，他知道的所有东西，都是需要你传给他(初始化token)

每次启动新会话的时候，你都必须要告诉他关于你代码库里面的重要信息

所以，我们需要CLAUDE.md和AGENTS.md来给LLM提供一个显性管理的记忆文档。所以你会发现，你在与AGENT聊天的过程中，总是会默认带上这（两）个文档

💡

目前大家都开始支持AGENTS.md了，但是claude一直还在坚持自己的CLADUE.md，后续可能也会统一成AGENTS.md，毕竟那个是大多数

那AGENTS.md可以做什么呢

因为每次进入开启新会话，对于LLM来说，一些都是全新的。所以你需要提供这个文档来让AI熟悉你

的代码库。

💡

后续不特殊说明的情况下，文档都表示AGENTS.md/CLAUDE.md

所以，你的文档应该包含：

是什么，为什么，怎样做（感觉自己在学英语😅）

是什么：我的整个项目是用来干啥的，用的什么技术栈，项目结构是什么。你应该去什么位置找什么东西

为什么：我为什么要用这个东西，每个文件夹的功能是什么，各个组件要承担什么功能

怎样做：告诉他我的环境，WSL/Linux/Macos/Windows,我是用的是Node还是bun，还是其他语言。如何测试，编译和检查。检查的时候是否需要注意些什么

💡

关于最后一条我得着重说明一下：有的时候怎么做境对于AGENTS来说是很有必要的。为啥呢？ 1. 不同环境下，CLI总是会现调用linux语句来查询，然后如果是linux/macos，perfect，他会继续往下执行。但是如果是Windows,就得开始pwsh，然后各种语句了 2. 在我的项目里面，新老内容混合，会出现，我只需要eslint格式化我的新项目，但是如果我么有明确说明的情况下，他很有可能会把你的整个项目给格式化了。一两千个文件，全给你eslint了，到时候git修改信息全是你，找问题都没招 3. 对于不同的项目，每个人可能都会有自己的习惯，ts的位置,service放的位置，如何测试等等