编码工具

使用 AGENTS.md 为你在 CrewAI 项目中的编码代理和 IDE 提供指导。

为什么使用 AGENTS.md

AGENTS.md 是一个轻量级、仓库本地的说明文件，可为编码代理提供一致且针对项目的指导。请将其放在项目根目录，并将其视为你希望助手遵循的权威来源：约定、命令、架构说明和防护规则。

使用 CLI 创建项目

使用 CrewAI CLI 搭建项目后，AGENTS.md 会自动添加到根目录。

  1. # Crew
  2. crewai create crew my_crew
  4. # Flow
  5. crewai create flow my_flow
  7. # Tool repository
  8. 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 的内容，以引入共享说明，而无需重复内容。

你可以直接使用：

  1. mv AGENTS.md CLAUDE.md

Gemini CLI 和 Google Antigravity

Gemini CLI 和 Antigravity 会从仓库根目录及父目录加载项目上下文文件（默认：GEMINI.md）。你可以通过在 Gemini CLI 设置中设置 context.fileName，将其配置为读取 AGENTS.md（或同时读取它）。例如，将其设置为仅使用 AGENTS.md，或者同时包含 AGENTS.md 和 GEMINI.md，如果你希望保留各工具各自的格式。

你可以直接使用：

  1. 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，或直接粘贴其中的内容。