编码工具

为什么使用 AGENTS.md

AGENTS.md 是一个轻量级、仓库本地的说明文件，可为编码代理提供一致的、项目专属的指导。将它放在项目根目录，并把它视为你希望助手遵循的唯一真实来源：约定、命令、架构说明和约束条件。

使用 CLI 创建项目

使用 CrewAI CLI 脚手架创建项目，然后 AGENTS.md 会自动添加到根目录。

# Crew
crewai create crew my_crew

# Flow
crewai create flow my_flow

# 工具仓库
crewai tool create my_tool

工具配置：让助手指向 AGENTS.md

Codex

Codex 可以通过放在仓库中的 AGENTS.md 文件来引导。用它们提供持久的项目上下文，例如约定、命令和工作流预期。

Claude Code

Claude Code 将项目记忆存储在 CLAUDE.md 中。你可以用 /init 初始化，再用 /memory 编辑。Claude Code 也支持在 CLAUDE.md 内导入，所以你可以像 @AGENTS.md 这样加一行，把共享说明引入进来，而无需重复编写。

你可以直接使用：

mv AGENTS.md CLAUDE.md

Gemini CLI 和 Google Antigravity

Gemini CLI 和 Antigravity 会从仓库根目录及其父目录加载项目上下文文件，默认是 GEMINI.md。你可以在 Gemini CLI 设置中把它配置为改读 AGENTS.md（或同时读两者），通过设置 context.fileName 即可。例如，只读 AGENTS.md，或者同时包含 AGENTS.md 和 GEMINI.md，以保留各工具自己的格式。

你可以直接使用：

mv AGENTS.md GEMINI.md

Cursor

Cursor 支持把 AGENTS.md 作为项目说明文件。将其放在项目根目录，即可为 Cursor 的编码助手提供指导。

Windsurf

Claude Code 提供了与 Windsurf 的官方集成。如果你在 Windsurf 中使用 Claude Code，请遵循上面的 Claude Code 指南，并从 CLAUDE.md 中导入 AGENTS.md。

如果你使用的是 Windsurf 的原生助手，请将其项目规则或说明功能（如果可用）配置为读取 AGENTS.md，或者直接粘贴其内容。