Web 实践

AGENTS.md 规范

AI Agent 协作规范入口文件

什么是 AGENTS.md?

AGENTS.md 是 AI Agent 进入项目时读取的配置文件,告诉它:

  • 项目用什么技术栈
  • 有什么约束和规范
  • 该怎么执行任务

不同 Agent 工具对应不同文件名:

Agent文件名
Claude CodeCLAUDE.md(0.1.4 起建议作为跳转壳,指向 AGENTS.md)
Cursor / Copilot / CodexAGENTS.md

快速生成

使用 agents-markdown 脚手架自动生成:

请从 .ai-coding/ENTRY.md 开始,按其中流程初始化这个项目的 AI Coding 脚手架。

文件结构

<!-- ai-coding-scaffold: v0.1.4 -->

# AI Coding 协作规范

## 对话模式
workflow / continue / general

## AI 行为规范
- PROJECT_STATE.md 管理(8 固定区块)
- Commit Policy
- 质量审查
- 上下文管理

## 文档导航
指向项目架构与状态文件

兼容说明(平滑升级)

  • 0.1.3 及更早版本中,CLAUDE.md 常与 AGENTS.md 维护同内容。
  • 0.1.4 起建议统一入口到 AGENTS.mdCLAUDE.md 仅作兼容跳转壳。
  • 历史迁移步骤见 agents-markdown 的升级指南。

相关资源

目录