DevTk.AI

AGENTS.md 生成器

生成 AGENTS.md 文件指导 AI 编码代理。支持 Claude Code、Copilot、Cursor、Devin 等。

Project Overview
Development Environment
Codebase Structure
Code Style & Conventions
Testing Instructions
PR & Commit Guidelines
Security Considerations
Additional Rules

AGENTS.md Preview

6 lines
# AGENTS.md

## Development Environment

- Package manager: `npm`

Compatible AI Coding Agents

Claude CodeGitHub CopilotCursorWindsurfDevinGemini CLIAiderVS Code AI

AGENTS.md is supported by 60,000+ open-source projects and all major AI coding agents. Place the file in your project root.

如何使用此工具

  1. 选择快速预设,自动填充 React + TypeScript、Next.js、Python + FastAPI、Go 或 Rust 等热门技术栈。或选择「自定义」从头开始。
  2. 填写项目概述:名称、描述和技术栈。帮助 AI 代理理解项目是什么。
  3. 添加开发环境信息:包管理器、开发/构建/测试/lint 命令。这些是最关键的字段——代理会频繁使用这些命令。
  4. 描述代码结构,让代理知道在哪里查找和放置文件。
  5. 定义代码风格和约定:编码模式、命名规范和错误处理规则。
  6. 添加测试说明、PR 和提交规范以及安全注意事项。
  7. 在右侧面板预览生成的 AGENTS.md。点击复制或下载保存到项目根目录。

为什么每个 AI 辅助项目都需要 AGENTS.md

AGENTS.md 是一个指导 AI 编码代理的开放标准。可以把它看作是面向 AI 的 README——一个专门为 AI 系统提供项目上下文和指令的文件。它由社区创建,由 Linux Foundation 下的 Agentic AI Foundation (AAIF) 支持。

没有 AGENTS.md,AI 编码代理(如 Claude Code、GitHub Copilot、Cursor、Devin)只能猜测你的项目约定。它们可能会使用错误的包管理器、用错误的框架写测试或违反命名规范。AGENTS.md 通过提供所有代理都能理解的结构化指令来消除这种猜测。

自 2025 年推出以来,已有超过 60,000 个开源项目采用了 AGENTS.md。所有主流 AI 编码工具都支持它:Claude Code、GitHub Copilot、Cursor、Windsurf、Devin、Gemini CLI、VS Code AI 等。格式是简单的 Markdown——易于编写、维护,且到处通用。

最佳实践:将 AGENTS.md 放在项目根目录。对于 monorepo,还可以在子包中放置子 AGENTS.md 文件——代理会读取目录树中最近的文件。保持内容聚焦于可执行的指令:构建命令、测试命令、代码风格规则和安全约束。随着项目演进不断更新。

最后更新:2026年2月

常见问题

什么是 AGENTS.md?

AGENTS.md 是一个指导 AI 编码代理的开放标准。它是放在项目根目录的 Markdown 文件,告诉 Claude Code、GitHub Copilot、Cursor、Devin 等 AI 工具如何使用你的代码库——包括构建命令、代码规范、测试说明和项目结构。

哪些 AI 编码工具支持 AGENTS.md?

所有主流 AI 编码代理都支持 AGENTS.md:Claude Code(Anthropic)、GitHub Copilot(GitHub)、Cursor、Windsurf(Codeium)、Devin(Cognition)、Gemini CLI(Google)、Aider、VS Code AI 等。自 2025 年以来已有超过 60,000 个开源项目采用。

AGENTS.md 文件应该放在哪里?

将 AGENTS.md 放在项目根目录。对于 monorepo,还可以在子包中放置额外的 AGENTS.md 文件。AI 代理会读取目录树中最近的文件,最近的优先级最高。

AGENTS.md 与 CLAUDE.md 或 .cursorrules 有什么区别?

AGENTS.md 是一个通用的、工具无关的标准,被所有主流 AI 编码代理支持。CLAUDE.md 仅适用于 Claude Code,.cursorrules 仅适用于 Cursor IDE。如果你使用多个 AI 工具,AGENTS.md 确保所有工具的行为一致。你仍然可以同时使用特定工具的配置文件来使用工具特有功能。

AGENTS.md 在 monorepo 中如何工作?

在 monorepo 中,你可以在多个层级放置 AGENTS.md 文件——项目根目录和子包内部。AI 代理会读取目录树中最近的 AGENTS.md 文件,最近的文件优先级最高。这允许你在根目录定义全局约定,在子目录中定义包特定规则。

相关工具