编码工具

使用 AGENTS.md 在你的 CrewAI 项目中指导编码智能体和 IDE。

为什么使用 AGENTS.md

AGENTS.md 是一个轻量的、位于仓库内的指令文件，为编码智能体提供一致且贴合项目的指导。把它放在项目根目录，并将其视为你希望助手如何工作的权威依据：约定、命令、架构说明和护栏。

使用 CLI 创建项目

使用 CrewAI CLI 搭建项目脚手架。AGENTS.md 会被添加到根目录，同时还会生成一个导入它的 CLAUDE.md 和一个 GEMINI.md，这样 Claude Code 和 Gemini CLI 就能读取与其他所有助手相同的指导内容。

# Crew
crewai create crew my_crew

# Flow
crewai create flow my_flow

# Tool repository
crewai create tool my_tool

NOTE

crewai tool create 已弃用，但仍可使用（会有警告）。请改用 crewai create tool。

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

Codex

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

Claude Code

Claude Code 读取 CLAUDE.md，并忽略 AGENTS.md。脚手架生成的项目会附带一个 CLAUDE.md，其唯一指令就是导入行 @AGENTS.md，因此共享指导会被加载而无需重复。在该行下方添加 Claude 专属说明，并把共享约定保留在 AGENTS.md 中。

对于在 CLAUDE.md 加入脚手架之前创建的项目，请自行添加导入：

printf '@AGENTS.md\n' > CLAUDE.md

不要将 AGENTS.md 重命名为 CLAUDE.md：Codex 和 Cursor 读取 AGENTS.md，重命名会使它们看不到该文件。

Gemini CLI 和 Google Antigravity

Gemini CLI 和 Antigravity 会从仓库根目录及父目录加载项目上下文文件（默认：GEMINI.md）。脚手架生成的项目会附带一个 GEMINI.md，其唯一指令就是导入行 @./AGENTS.md，因此共享指导会被加载而无需重复。在该行下方添加 Gemini 专属说明，并把共享约定保留在 AGENTS.md 中。

对于在 GEMINI.md 加入脚手架之前创建的项目，请自行添加导入：

printf '@./AGENTS.md\n' > GEMINI.md

或者，在 Gemini CLI 设置中设置 context.fileName 以包含 AGENTS.md，Gemini 便会直接读取它。不要将 AGENTS.md 重命名为 GEMINI.md：Codex 和 Cursor 读取 AGENTS.md，重命名会使它们看不到该文件。

Cursor

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

Windsurf

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

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