#Lynx 下的 AGENTS.md

AGENTS.md 是面向 coding agent 的项目级指令文件，类似于 README.md 面向人类开发者的作用。

#快速开始

通过 Quick Start 创建的新 Lynx 项目已经包含 AGENTS.md。对于已有项目，可以复制模板并根据你的项目进行调整：

• AGENTS.md in Lynx Template Project

#引导 Agent 阅读 Lynx 文档

最重要的是添加一个指向 llms.txt 的引用，它是所有 Lynx 文档的 LLM 友好格式入口。在你的 AGENTS.md 中添加如下内容：

## Read in Advance

Read the docs below in advance to help you understand the library or frameworks this project depends on.

- Lynx: [llms.txt](https://lynxjs.org/llms.txt).
  While dealing with a Lynx task, an agent **MUST** read this doc because it is an entry point of all available docs about Lynx.

这并不是什么魔法咒语。它之所以有效，是因为这段内容给了 agent 一个可以直接获取的具体 URL，而强调性的措辞（"MUST"）会让 agent 优先阅读文档，而非依赖训练数据进行猜测。

如果 agent 仍然忽略文档，可以将 llms.txt 的完整内容直接内联到 AGENTS.md 中：

curl https://lynxjs.org/llms.txt > AGENTS.md

如需自动保持最新，可以将此命令添加到 package.json 的 prepare 脚本中，并将生成的文件加入 gitignore。

#Monorepo 配置

在 monorepo 中，根目录放置全局 AGENTS.md 用于通用指导，各子包放置各自的文件用于项目特定上下文。Agent 会优先读取最近的文件，然后向上查找。

$ tree
.
├── AGENTS.md           # 全局指导
├── README.md
└── packages
    ├── web
    │   ├── AGENTS.md   # Web 项目专用
    │   ├── package-a
    │   │   └── AGENTS.md
    │   └── package-b
    │       └── AGENTS.md
    └── lynx
        ├── AGENTS.md   # Lynx 项目专用
        ├── package-c
        │   └── AGENTS.md
        └── package-d
            └── AGENTS.md

将 Lynx 特有的指导放在 packages/lynx/AGENTS.md 中。确保各文件之间的信息不要相互冲突。