智能体开发正在向前推进。过去，生产级扩展通常需要手动搭建基础设施并从零开始配置沙箱，但现在有了更快的路径。Gemini API中的托管代理现已正式上线。以零基础设施开销获得最大智能体能力。只需一次简单的API调用，即可为您的智能体提供一个托管远程沙箱，让您完全专注于行为设计。通过 https://goo.gle/4emxXXU 和 https://goo.gle/4e3wjct，您可以完全自定义指令、工具和数据。在云端原生地测试、迭代并扩展长期任务。构建智能体最困难的部分，现在已无需您亲自构建。立即开始：https://goo.gle/3ROlraV

AGENTS.md

来源：https://agents.md/?linkId=62184356

一种简单、开放的格式，用于指导编码智能体，已被超过6万个开源项目采用（https://github.com/search?q=path%3AAGENTS.md+NOT+is%3Afork+NOT+is%3Aarchived&type=code）。
可以将 AGENTS.md 视为面向智能体的README：一个专门、可预测的位置，为AI编码智能体提供上下文和指令，帮助其处理您的项目。

# AGENTS.md

## 设置命令
- 安装依赖：`pnpm install`
- 启动开发服务器：`pnpm dev`
- 运行测试：`pnpm test`

## 代码风格
- TypeScript严格模式
- 使用单引号，无分号
- 尽可能使用函数式模式

为什么需要 AGENTS.md？

README.md 是为人类准备的：快速入门、项目描述和贡献指南。AGENTS.md 则作为补充，包含编码智能体所需的额外、有时是详细的上下文：构建步骤、测试和约定，这些内容可能会在README中显得杂乱，或者与人类贡献者无关。我们特意将其分开，目的是：

• 为智能体提供一个清晰、可预测的指令位置。
• 保持README简洁，专注于人类贡献者。
• 提供精确、面向智能体的指南，以补充现有的README和文档。

我们并非引入另一种专有文件，而是选择了一个适用于所有人的名称和格式。如果您正在构建或使用编码智能体，并且觉得这很有用，欢迎采用它。

一个 AGENTS.md 适用于多种智能体

您的智能体定义与日益增长的AI编码智能体和工具生态系统兼容：

示例

# 示例 AGENTS.md 文件

## 开发环境提示
- 使用 `pnpm dlx turbo run <package>` 跳转到特定包，而不是用 `ls` 扫描。
- 运行 `pnpm install --filter <package>` 将包添加到工作区，以便 Vite、ESLint 和 TypeScript 能够识别。
- 使用 `pnpm create vite@latest -- --template react-ts` 快速创建一个带有 TypeScript 检查的新 React + Vite 包。
- 检查每个包中 package.json 的 name 字段以确认正确名称——忽略顶层的那个。

## 测试说明
- 在 .github/workflows 文件夹中找到 CI 计划。
- 运行 `pnpm turbo run test --filter <package>` 以执行该包定义的所有检查。
- 从包根目录可以直接调用 `pnpm test`。提交前应确保所有测试通过。
- 若要专注于某一步，可使用 Vitest 模式：`pnpm vitest run -t "<test name>"`。
- 修复所有测试或类型错误，直到整个测试套件变为绿色。
- 移动文件或更改导入后，运行 `pnpm lint --filter <package>` 确保 ESLint 和 TypeScript 规则仍然通过。
- 即使没有人要求，也要为修改的代码添加或更新测试。

## PR 说明
- 标题格式：[<scope>] <description>
- 提交前始终运行 `pnpm lint` 和 `pnpm test`。

如何使用 AGENTS.md？

1. 添加 AGENTS.md

在仓库根目录创建一个 AGENTS.md 文件。大多数编码智能体甚至可以礼貌地为您生成一个。

2. 涵盖关键内容

添加有助于智能体高效处理您项目的章节。常见选择：

• 项目概述
• 构建和测试命令
• 代码风格指南
• 测试说明
• 安全注意事项

3. 添加额外指令

提交信息或PR指南、安全注意事项、大型数据集、部署步骤：任何您会告诉新队友的内容都适合放在这里。

4. 大型单体仓库？为子项目使用嵌套的 AGENTS.md

在每个包内放置另一个 AGENTS.md。智能体自动读取目录树中最接近的文件，因此最近的文件优先，每个子项目都可以提供定制指令。例如，在撰写本文时，OpenAI主仓库包含88个 AGENTS.md 文件。

关于

AGENTS.md 源自AI软件开发生态系统的协作努力，包括 OpenAI Codex (https://openai.com/codex/)、Amp (https://ampcode.com/)、Google 的 Jules (https://jules.google/)、Cursor (https://cursor.com/) 和 Factory (https://factory.ai/)。我们致力于帮助维护和发展这一开放格式，使其惠及整个开发者社区，无论您使用哪种编码智能体。

AGENTS.md 现已由 Linux 基金会旗下的 Agentic AI Foundation (https://aaif.io/) 负责管理。 了解更多 → (https://openai.com/index/agentic-ai-foundation/)

常见问题

是否有必填字段？

没有。AGENTS.md 只是标准 Markdown。您可以使用任何标题；智能体仅解析您提供的文本。

如果指令冲突怎么办？

最接近被编辑文件的 AGENTS.md 优先级最高；用户聊天提示中的明确指令会覆盖一切。

智能体会自动运行 AGENTS.md 中的测试命令吗？

会的——如果您列出了它们。智能体将尝试执行相关的程序性检查，并在完成任务前修复失败项。

之后可以更新吗？

当然。将 AGENTS.md 视为活跃文档。

如何将现有文档迁移到 AGENTS.md？

将现有文件重命名为 AGENTS.md，并创建符号链接以保持向后兼容：

mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md

如何配置 Aider？

在 .aider.conf.yml 中配置 Aider 使用 AGENTS.md：

agent-mode: true

如何配置 Gemini CLI？

在 .gemini/settings.json 中配置 Gemini CLI 使用 AGENTS.md：

{
  "context": {
    "fileName": "AGENTS.md"
  }
}