放在哪里
快速生成
在项目目录中启动工具后输入/init,AI 会分析代码库并自动生成一份说明文件。生成后再按需修改。
模板
AGENTS.md
写好说明文件
- 写 AI 猜不到的内容:常用命令、特殊约定、容易踩的坑。能从代码中直接看出来的内容不用写
- 保持简短:说明文件每次对话都会读取,内容越长,每次消耗的 Token 越多
- 持续更新:发现 AI 反复犯同一个错误时,把正确做法补充进去
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
用 CLAUDE.md 和 AGENTS.md 告诉 AI 你的项目规范,减少反复解释。
| 工具 | 文件名 |
|---|---|
| Claude Code | CLAUDE.md |
| Codex | AGENTS.md |
AGENTS.md,然后在 CLAUDE.md 中写一行 @AGENTS.md 引用它。| 位置 | 作用范围 |
|---|---|
| 项目根目录 | 对当前项目生效,可以提交到仓库与团队共享 |
~/.claude/CLAUDE.md 或 ~/.codex/AGENTS.md | 对你的所有项目生效,适合写个人习惯 |
/init,AI 会分析代码库并自动生成一份说明文件。生成后再按需修改。
# 项目说明
## 项目简介
一个基于 Next.js 的电商后台管理系统,使用 TypeScript、Prisma 和 PostgreSQL。
## 常用命令
- 安装依赖:`pnpm install`
- 启动开发服务器:`pnpm dev`
- 运行测试:`pnpm test`
- 类型检查:`pnpm typecheck`
## 目录结构
- `src/app/`:页面和路由
- `src/server/`:后端接口和数据库访问
- `prisma/schema.prisma`:数据库模型
## 编码规范
- 使用函数组件和 Hooks,不使用 class 组件
- 新增接口必须编写对应的测试
- 修改数据库模型后运行 `pnpm prisma migrate dev`
## 注意事项
- 不要修改 `src/generated/` 下的文件,它们由脚本自动生成
- 提交前确保 `pnpm typecheck` 和 `pnpm test` 通过
