init-agents
为当前项目初始化 AGENTS.md。跨工具通用:不依赖、也不提及任何特定 agent 的专属机制(内置命令、专属配置路径等)。
使用方式
/init-agents
无参数。对当前工作目录操作。
步骤
- 扫描当前目录,包括说明文件、流水线配置、包的描述信息、源代码等。
- 一律中文,与仓库现有文档语言无关。
- 固定四个章节,按此顺序:
1. 项目概述 — 说明项目是什么、用什么技术栈,不能超过150字。
2. 常用命令 — 安装/构建/校验/本地运行
3. 目录结构要点 — 关键目录各自的职责;只写关键代码目录(不含vender/或node_modules等),不写文件;不要有目录里面的详细文件或符号信息,只写目录是做什么用的。
4. 注意事项 — 只包含一条规则:当且仅当项目的关键目录结构发生变更,需要实时更新AGENTS.md。 - 生成的文件顶部不加任何来源注记。
样例 AGENTS.md 文件
# AGENTS.md
## 项目概述
某业务系统的后端服务。基于 Go 1.24 与 Gin 框架,使用 GORM 操作数据库,提供核心业务的登记注册、报表与审核工作台接口,并集成若干外部服务。
## 常用命令
- 安装依赖:`go mod tidy && go mod vendor`
- 编译校验:`go build -o /dev/null main.go`
- 正式构建:`go build -mod vendor -o dist/<产物名> main.go`
- 本地运行:`go run main.go`
- 代码格式化:`goimports -w <文件路径>`
- 打包镜像:`docker build -t <镜像名> .`
## 目录结构要点
- `main.go`:程序入口,初始化日志、配置、数据库、定时任务并启动路由。
- `common/config`:配置文件加载与解析。
- `common/constant`:全局常量定义。
- `common/database`:数据库初始化与连接管理。
- `common/model`:GORM 数据模型定义。
- `common/dao`:数据访问层,封装数据库读写操作。
- `common/register`:核心业务逻辑。
- `common/crontask`:定时任务。
- `router`:HTTP 路由注册,按业务模块划分。
- `sdk`:外部服务 SDK。
- `docs`:接口文档等说明资料。
- `.workflow`:CI 流水线配置。
## 注意事项
- 当且仅当项目的关键目录结构发生变更,需要实时更新 `AGENTS.md`。