--- name: gen-context category: gen command: context description: 生成项目上下文文档 triggers: - "生成 {project} 的上下文" - "为 {project} 创建上下文文档" - "{project} 项目概览" - "@gen/context {project}" --- # @gen/context - 生成上下文 生成项目的综合上下文文档,用于快速了解项目结构。 ## 参数 | 参数 | 类型 | 必填 | 说明 | |------|------|------|------| | `project` | string | 是 | 项目名称 | | `--output` | string | 否 | 输出路径,默认输出到终端 | | `--depth` | number | 否 | 目录深度,默认 3 | ## 执行步骤 ### 1. 读取项目配置 - 读取 `{project}/CLAUDE.md` - 读取 `{project}/architecture.canvas` ### 2. 扫描项目结构 ```bash tree -L {depth} {project} ``` ### 3. 提取关键信息 - 项目名称和类型 - 技术栈 - 子项目列表 - 主要功能模块 - API 路由(如后端) - 页面路由(如前端) ### 4. 生成上下文文档 ## 输出格式 ```markdown # {project} 项目上下文 ## 基本信息 | 属性 | 值 | |------|-----| | 名称 | {name} | | 类型 | {type} | | 技术栈 | {stack} | ## 项目结构 {tree_output} ## 子项目 | 子项目 | 类型 | 说明 | |--------|------|------| | {subproject} | {type} | {description} | ## 核心功能 - {feature1} - {feature2} ## API 路由 (如适用) | 方法 | 路由 | 说明 | |------|------|------| | GET | /api/xxx | xxx | ## 页面路由 (如适用) | 路由 | 页面 | 说明 | |------|------|------| | /xxx | xxx | xxx | --- 生成时间: {timestamp} ``` ## 示例 ```bash # 生成上下文到终端 @gen/context tg-live-game # 保存到文件 @gen/context tg-live-game --output ./context.md # 更深的目录结构 @gen/context tg-live-game --depth 5 ``` ## 自然语言等效 - "生成 tg-live-game 的项目上下文" - "给我 tg-live-game 的项目概览" - "总结一下 yshop 项目"