momo-ai 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,117 @@
+# Momo SDD - Spec Driven Development 工具
+
+![npm version](https://img.shields.io/npm/v/momo-ai.svg) | [![Downloads](https://img.shields.io/npm/dm/momo-ai.svg)](https://www.npmjs.com/package/momo-ai)
+> For Rachel Momo
+
+## 1. 介绍
+
+当前工具会在操作系统中安装 `momo` 命令，使用它进行 `SDD - Spec Driven Development` 开发：
+
+1. 参考：`OpenSpec / Spec-Kit / Kiro`
+2. 工具：`TRAE` 工具集成（推荐使用国际版）/ `Cursor`（推荐使用，可实现多个Agent开发）
+3. 中文规范支持，命令运行之后将 `prompt` 提示词拷贝到剪切板
+4. 多个 Agent 协同，实现 Team 团队模式的 AI 开发，无模型限制（推荐使用同一个模型进行任务协同开发）
+
+和 `OpenSpec / Spec-Kit / Kiro` 原生工具不同，当前工具以 AI Agent 开发为核心，提供从 Plan -> Deployment
+完整生命周期的整体开发流程，属于上层项目实施的开发工具——暴力、简单、易懂。由于 IDE（ `TRAE / Cursor`
+）中可直接选择使用的模型，本工具不提供任何模型选择，模型本身取决于你所使用的工具本身，命令行只是一个辅助，核心开发模式为：
+`AI 开发 + 人工审核`，本工具的宗旨就是 `prompt` 的模板化。
+
+> 多个异构Agent！中文优先！
+
+## 2. 使用
+
+- 执行 `momo repo` 的过程中会依赖一个已经初始化好的项目 `Git` 地址，且当前项目本身依赖一个 `Git`（因为项目是以
+  `submodule` 的方式添加到环境中的）。
+- 移除相关命令如 `submodule` 只支持 Linux/Mac 的脚本，这个用独立脚本防止更改丢失。
+
+### 2.1. 安装
+
+```bash
+npm install -g momo-ai
+# 查看帮助
+momo help
+```
+
+### 2.2. 控制台：定模型
+
+> 控制台开发中（Lain 模式）
+
+### 2.3. 命令：不定模型
+
+```bash
+# ------------ 工程初始化 -----------------
+# 检查环境相关信息
+momo env                    # 环境检查
+
+# momo init
+momo init -d app-fly        # 初始化 directory = app-fly 的项目
+momo init                   # 初始化当前项目
+
+# momo repo 
+momo repo -a https://xxx/repo.git   # 克隆远程代码库 -> source/repo/develop-01（名称靠解析） -> git submodule
+momo repo -a xxx -i 10              # 克隆远程代码库（10个副本）
+
+momo open                           # 交互式使用 TRAE / Lingma / Cursor / Kiro 打开当前项目
+
+# ------------ 需求管理 -----------------
+# momo add
+momo add -n "需求名称"               # 添加新需求 -> changes 下追加新内容 -> 包括任务
+momo add -n "需求 md 文档路径"        # 添加需求文档 -> changes 下追加新内容 -> 包括任务，如果带后缀直接用文件名做需求名称
+
+# momo plan               
+momo plan -n "需求名称"              # 生成需求的整体开发计划 -> prompt 剪切板
+
+# momo archive
+momo archive -n "需求名称"           # 需求归档 -> archive 下追加新内容，删除 changes 下内容
+
+# momo show
+momo show -n "需求名称"              # 显示需求 -> 显示 changes 下内容
+
+# momo validate
+momo validate -n "需求名称"          # 需求校验 -> 校验 changes 下内容
+
+# momo list
+momo list                           # 列出所有需求 -> changes 下内容
+
+# ------------ 任务执行 -----------------
+# momo tasks
+momo tasks                          # 显示任务 -> 需求 / 任务 / 状态 -> 状态 = 待办 / 进行中 / 已完成
+
+# momo actors
+momo actors                         # 列出所有角色
+
+# momo actor                        
+momo actor -a "角色名称"             # 添加新角色 -> 交互式命令，每个角色可以指定不同的大模型
+
+# momo run                          ( 生成提示词 -> 剪切板，自动计算空闲的 source-01 ）
+momo run -a {actor} -t {task}       # 将任务分配给角色，检查执行目录看哪些任务正在执行
+momo unlock                         # 解锁任务 -> 任务状态 = 待办
+```
+
+## 3. 操作步骤
+
+1. 使用 `momo init` 初始化协同工程项目（运行之前可使用 `momo env` 检查环境）。
+2. 使用 `momo repo` 添加项目代码库以及工程实例（有多少个 `Agent` 工作就添加多少工程实例），添加完成后可使用 `momo open`
+   直接打开工程。
+3. 更新 `project.md / project-model.md / requirement.md` 的细节文档（可用AI帮助拆分和书写）
+4. 使用 `momo add -n 需求名称` 添加细节需求（可用AI帮助拆分和书写：`momo plan -n 需求名称`）
+5. 使用 `momo tasks` 列出所有任务，并且使用 `momo run` 运行任务得到任务提示词
+
+> 带 (CV) 标记的命令运行成功后可直接“Ctrl + V”粘贴到 TRAE / Lingma / Cursor / Kiro 中执行。
+
+## 4. 参考链接
+
+### 4.1. 旧版
+
+- （后端）Zero Ecotope：<https://www.zerows.io>
+- （前端）Zero UI：<https://www.vertxui.cn>
+- （工具）Zero AI：<https://www.vertxai.cn>
+- （标准）Zero Schema：<https://www.vertx-cloud.cn>
+
+### 4.2. 新增
+
+- Maven 统一版本管理：<https://gitee.com/silentbalanceyh/rachel-momo>
+- Rapid快速开发框架：<https://gitee.com/silentbalanceyh/r2mo-rapid>
+- Zero Epoch：<https://www.zerows.io>
+- Zero Demo：<https://gitee.com/zero-ws/zero-rachel-momo>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "momo-ai",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Rachel Momo ( OpenSpec )",
     "main": "src/momo.js",
     "bin": {

package/src/_template/LAIN/.momo/advanced/actor.md

@@ -0,0 +1,42 @@
+# 角色描述
+
+## LLM
+
+[LLM 描述，当前角色能使用的大模型的详细信息，每个角色使用的模型都必须在 `integration` 中进行相关配置]
+
+集成模型类型参考：
+- openspec: OpenSpec 集成
+- spec-kit: SpecKit 集成
+- kiro: Kiro 集成
+- trea: Trea 集成
+- cursor: Cursor 集成
+- lingma: Lingma 集成
+- qoder: Qoder 集成
+- windsurf: WindSurf 集成
+- github: Github Copilot 集成
+- claude-code: Claude Code 集成
+- chatgpt: ChatGPT 集成
+
+## 技能说明
+
+[开发技能、如此角色应该局限的开发领域相关说明，不牵涉技能之外的细节]
+
+技能领域包括但不限于：
+- 前端开发
+- 后端开发
+- 数据库设计
+- 接口设计
+- 测试开发
+- 部署运维
+
+## 角色限制
+
+[角色在使用时的限制说明，如仅限某些场景、条件等]
+
+常见的限制类型：
+- 仅限管理型任务
+- 仅限新功能开发
+- 仅限前端任务
+- 仅限后端任务
+- 不允许修改核心架构
+- 不允许引入新依赖

package/src/_template/LAIN/.momo/scripts/submodule-clean.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+set -e
+
+# 获取当前工作目录（用户项目根目录）
+PROJECT_ROOT="$(pwd)"
+
+# 检查是否在 Git 仓库中
+if [ ! -d "$PROJECT_ROOT/.git" ]; then
+  echo "❌ 错误：当前目录不是 Git 仓库根目录（未找到 .git）"
+  echo "   请在 Git 仓库根目录下运行此脚本。"
+  exit 1
+fi
+
+# 检查是否存在 .gitmodules
+if [ ! -f "$PROJECT_ROOT/.gitmodules" ]; then
+  echo "ℹ️  未检测到 .gitmodules 文件，当前仓库没有子模块。"
+  exit 0
+fi
+
+echo "🔍 在 $PROJECT_ROOT 中检测到子模块，开始清理..."
+
+# 临时切换到项目根（虽然 pwd 已经是，但确保一致性）
+cd "$PROJECT_ROOT"
+
+while IFS= read -r path; do
+  if [ -n "$path" ]; then
+    echo "🗑️  移除子模块: $path"
+
+    # 安全反初始化
+    git submodule deinit -f -- "$path" 2>/dev/null || true
+
+    # 删除工作区目录
+    rm -rf "$path"
+
+    # 删除 Git 子模块元数据
+    if [ -d ".git/modules/$path" ]; then
+      rm -rf ".git/modules/$path"
+    fi
+  fi
+done < <(grep -E '^\[submodule "' .gitmodules | sed 's/.*path = //')
+
+# 从 Git 索引中移除子模块条目
+submodule_paths=$(git config --file .gitmodules --get-regexp path | awk '{print $2}')
+if [ -n "$submodule_paths" ]; then
+  git rm -f $submodule_paths 2>/dev/null || true
+fi
+
+# 清理配置文件
+rm -f .gitmodules
+
+echo "✅ 所有子模块已清除！"
+echo "💡 请检查状态并提交变更："
+echo "   git status"
+echo "   git add ."
+echo "   git commit -m 'Remove all submodules'"

package/src/_template/LAIN/AGENTS.md

@@ -0,0 +1,103 @@
+# AI Agents 集成说明
+
+本文档描述了项目中支持的 AI Agents 及其集成方式，确保所有 Agent 能够正确理解项目结构和工作流程。
+
+## 支持的 AI Agents
+
+### OpenSpec
+- 集成目录: `integration/openspec/`
+- 配置文件: `integration/openspec/config.json`
+- 用途: OpenSpec 标准化开发流程集成
+
+### SpecKit
+- 集成目录: `integration/spec-kit/`
+- 用途: SpecKit 工具链集成
+
+### Kiro
+- 集成目录: `integration/kiro/`
+- 用途: Kiro 开发框架集成
+
+### Trea
+- 集成目录: `integration/trea/`
+- 用途: Trea 工具集集成
+
+### Cursor
+- 集成目录: `integration/cursor/`
+- 用途: Cursor IDE 集成
+
+### Lingma
+- 集成目录: `integration/lingma/`
+- 用途: Lingma 开发助手集成
+
+### Qoder
+- 集成目录: `integration/qoder/`
+- 用途: Qoder 编码助手集成
+
+### WindSurf
+- 集成目录: `integration/windsurf/`
+- 用途: WindSurf 开发工具集成
+
+### GitHub Copilot
+- 集成目录: `integration/github/`
+- 用途: GitHub Copilot 集成
+
+### Claude Code
+- 集成目录: `integration/claude-code/`
+- 用途: Claude Code Assistant 集成
+
+### ChatGPT
+- 集成目录: `integration/chatgpt/`
+- 用途: ChatGPT 集成
+
+## 项目结构说明
+
+### 核心目录
+
+1. `.momo/` - Momo AI 核心配置目录
+   - `prompt/` - 提示词存储目录
+   - `template/` - 模板文件目录
+   - `advanced/` - 高级配置目录
+   - `scripts/` - 自定义脚本目录
+
+2. `specification/` - 规范文档目录
+   - `project.md` - 项目基本信息
+   - `project-model.md` - 项目数据模型
+   - `requirement.md` - 基础需求说明
+   - `changes/` - 需求变更目录
+   - `actor/` - 角色定义目录
+   - `.archives/` - 归档需求目录
+   - `.activities/` - 活动记录目录
+
+3. `source/` - 源代码目录
+   - 包含多个开发实例目录，如 `develop-01`, `develop-02` 等
+
+4. `integration/` - 工具集成目录
+   - 包含各种 AI 工具的集成配置
+
+## 工作流程
+
+### 需求管理流程
+
+1. 使用 `momo add` 添加新需求
+2. 使用 `momo plan` 制定开发计划
+3. 使用 `momo run` 执行具体任务
+4. 使用 `momo archive` 归档完成的需求
+
+### 角色管理流程
+
+1. 使用 `momo actors` 查看所有角色
+2. 使用 `momo actor` 添加新角色
+3. 角色配置文件存储在 `specification/actor/` 目录下
+
+## 提示词使用规范
+
+1. 所有提示词存储在 `.momo/prompt/` 目录中
+2. 使用 `momo run` 命令时会自动将相关提示词复制到剪贴板
+3. 提示词内容基于项目规范和需求文档生成
+
+## 注意事项
+
+1. 请勿直接修改 `specification/changes/` 目录下的文件，应通过 `momo` 命令进行管理
+2. 所有需求变更应遵循 OpenSpec 标准流程
+3. 归档的需求存储在 `specification/.archives/` 目录中，可通过时间戳识别
+4. 不同 AI 工具应使用对应的 `integration/` 子目录进行配置

package/src/_template/LAIN/changes/proposal.md

@@ -0,0 +1,39 @@
+<!-- CODE:需求编号 -->
+
+# 需求提案
+
+## 需求概述
+
+[简要描述该需求的核心内容、目标和预期效果]
+
+### 背景描述
+
+[详细描述该需求的背景信息，包括：
+
+- 当前存在的问题或不足
+- 为什么需要这个功能或改进
+- 业务价值和意义]
+
+### 用户群体
+
+[描述该需求涉及的用户群体，包括：
+
+- 直接用户
+- 间接用户
+- 用户特征和需求]
+
+## 需求详情
+
+### 功能描述
+
+[详细描述需求的功能点，包括：
+
+- 核心功能
+- 辅助功能
+- 用户交互流程]
+
+### 场景描述
+
+- 场景1：
+- 场景2：
+- ...

package/src/_template/LAIN/changes/tasks/task-detail.md

@@ -0,0 +1,45 @@
+# 任务细节
+
+## 基本信息
+
+- 任务编号：[M01-T001-01 格式]
+- 任务名称：[简要描述任务内容]
+- 所属模块：[任务关联的系统模块]
+- 任务类型：[开发/测试/部署/文档等]
+- 预估工时：[完成任务预估需要的时间]
+- 优先级：[高/中/低]
+- 执行类型：[关联Agent执行步骤]
+
+## 任务描述
+
+[详细描述任务的具体内容，包括需要完成的工作和达到的目标]
+
+## 详细要求
+
+### 功能要求
+
+[列出任务需要实现的具体功能点]
+
+### 技术要求
+
+[列出任务需要遵循的技术规范和要求]
+
+### 质量要求
+
+[列出任务的质量标准，如代码规范、测试覆盖率等]
+
+## 实现方案
+
+[简要描述任务的实现方案和关键步骤]
+
+## 验收标准
+
+[列出任务完成的验收标准，用于确认任务是否正确完成]
+
+## 依赖项
+
+[列出任务的前置依赖，如其他任务、资源等]
+
+## 输出产物
+
+[列出任务完成后应该交付的产物，如代码、文档、测试用例等]

package/src/_template/LAIN/changes/tasks.md

@@ -0,0 +1,49 @@
+# 任务清单
+
+## 任务总表
+
+[列出所有需要完成的任务项]
+
+- [ ] [任务1简要描述](tasks/M01-T001-01.md)
+- [ ] [任务2简要描述](tasks/M01-T001-02.md)
+- [ ] [任务3简要描述](tasks/M01-T002-01.md)
+
+## 任务分类
+
+### 前端开发任务
+
+[列出所有前端开发相关任务]
+
+### 后端开发任务
+
+[列出所有后端开发相关任务]
+
+### 数据库任务
+
+[列出所有数据库相关任务]
+
+### 测试任务
+
+[列出所有测试相关任务]
+
+### 部署任务
+
+[列出所有部署相关任务]
+
+## 任务依赖关系
+
+[描述任务之间的依赖关系，如：任务2需要在任务1完成后才能开始]
+
+## 时间安排
+
+### 预估开始时间
+
+[预估任务开始时间]
+
+### 预估完成时间
+
+[预估任务完成时间]
+
+### 关键里程碑
+
+[列出关键的里程碑节点]

package/src/_template/LAIN/execute/admin-n-f-dashboard.md

@@ -0,0 +1,53 @@
+# 管理型前端看板页开发执行步骤
+
+## 任务准备阶段
+
+1. 检查 `specification/.activities/` 目录下是否存在空闲的任务项目
+2. 若不存在，则创建新任务目录：`{actor}@{changeId}`
+3. 确认 `source/` 目录中是否有足够的项目副本
+4. 查看 `specification/changes/{changeId}/proposal.md` 了解需求背景
+5. 查看 `specification/changes/{changeId}/tasks.md` 明确任务清单
+
+## 任务执行阶段
+
+### 看板页开发
+
+1. 创建看板页组件
+2. 添加数据统计卡片
+3. 添加图表展示区域
+4. 添加最新动态列表
+5. 添加快捷操作按钮
+6. 配置路由
+7. 对接数据统计接口
+8. 对接图表数据接口
+9. 对接最新动态接口
+10. 实现基础交互效果
+
+### 质量保证
+
+1. 确保代码符合项目规范
+2. 进行必要的代码检查
+
+## 任务完成阶段
+
+1. 提交代码到版本控制系统
+2. 使用命令执行任务：`momo:run -a {actor} -t {task}`
+3. 更新 `specification/changes/{changeId}/tasks.md` 中的任务状态
+4. 使用命令查看任务状态：`momo:tasks`
+5. 归档需求：`momo archive -n "{changeId}"`
+
+## 变更结构参考
+
+```
+specification/
+  changes/
+    {changeId}/
+      proposal.md     # 变更提案说明文件
+      tasks.md        # 变更任务列表说明
+      design.md       # 变更设计说明文件（可选）
+      tasks/          # 任务详细内容
+        M01-T001-01.md # 具体任务文件
+      specs/          # 能力变更详情
+        [capability]/
+          spec.md     # ADDED/MODIFIED/REMOVED需求
+```

package/src/_template/LAIN/execute/admin-n-f-form.md

@@ -0,0 +1,51 @@
+# 管理型前端表单页开发执行步骤
+
+## 任务准备阶段
+
+1. 检查 `specification/.activities/` 目录下是否存在空闲的任务项目
+2. 若不存在，则创建新任务目录：`{actor}@{changeId}`
+3. 确认 `source/` 目录中是否有足够的项目副本
+4. 查看 `specification/changes/{changeId}/proposal.md` 了解需求背景
+5. 查看 `specification/changes/{changeId}/tasks.md` 明确任务清单
+
+## 任务执行阶段
+
+### 表单页开发
+
+1. 创建表单页组件
+2. 添加表单字段区域
+3. 添加提交和取消按钮
+4. 配置路由
+5. 对接表单数据获取接口（编辑场景）
+6. 对接表单数据提交接口
+7. 实现表单验证
+8. 实现表单提交反馈
+
+### 质量保证
+
+1. 确保代码符合项目规范
+2. 进行必要的代码检查
+
+## 任务完成阶段
+
+1. 提交代码到版本控制系统
+2. 使用命令执行任务：`momo:run -a {actor} -t {task}`
+3. 更新 `specification/changes/{changeId}/tasks.md` 中的任务状态
+4. 使用命令查看任务状态：`momo:tasks`
+5. 归档需求：`momo archive -n "{changeId}"`
+
+## 变更结构参考
+
+```
+specification/
+  changes/
+    {changeId}/
+      proposal.md     # 变更提案说明文件
+      tasks.md        # 变更任务列表说明
+      design.md       # 变更设计说明文件（可选）
+      tasks/          # 任务详细内容
+        M01-T001-01.md # 具体任务文件
+      specs/          # 能力变更详情
+        [capability]/
+          spec.md     # ADDED/MODIFIED/REMOVED需求
+```

package/src/_template/LAIN/execute/admin-n-f-home.md

@@ -0,0 +1,49 @@
+# 管理型前端首页开发执行步骤
+
+## 任务准备阶段
+
+1. 检查 `specification/.activities/` 目录下是否存在空闲的任务项目
+2. 若不存在，则创建新任务目录：`{actor}@{changeId}`
+3. 确认 `source/` 目录中是否有足够的项目副本
+4. 查看 `specification/changes/{changeId}/proposal.md` 了解需求背景
+5. 查看 `specification/changes/{changeId}/tasks.md` 明确任务清单
+
+## 任务执行阶段
+
+### 首页开发
+
+1. 创建首页组件
+2. 实现页面布局
+3. 添加导航菜单
+4. 配置路由
+5. 对接必要接口
+6. 实现基础交互效果
+
+### 质量保证
+
+1. 确保代码符合项目规范
+2. 进行必要的代码检查
+
+## 任务完成阶段
+
+1. 提交代码到版本控制系统
+2. 使用命令执行任务：`momo:run -a {actor} -t {task}`
+3. 更新 `specification/changes/{changeId}/tasks.md` 中的任务状态
+4. 使用命令查看任务状态：`momo:tasks`
+5. 归档需求：`momo archive -n "{changeId}"`
+
+## 变更结构参考
+
+```
+specification/
+  changes/
+    {changeId}/
+      proposal.md     # 变更提案说明文件
+      tasks.md        # 变更任务列表说明
+      design.md       # 变更设计说明文件（可选）
+      tasks/          # 任务详细内容
+        M01-T001-01.md # 具体任务文件
+      specs/          # 能力变更详情
+        [capability]/
+          spec.md     # ADDED/MODIFIED/REMOVED需求
+```

package/src/_template/LAIN/execute/admin-n-f-list.md

@@ -0,0 +1,52 @@
+# 管理型前端列表页开发执行步骤
+
+## 任务准备阶段
+
+1. 检查 `specification/.activities/` 目录下是否存在空闲的任务项目
+2. 若不存在，则创建新任务目录：`{actor}@{changeId}`
+3. 确认 `source/` 目录中是否有足够的项目副本
+4. 查看 `specification/changes/{changeId}/proposal.md` 了解需求背景
+5. 查看 `specification/changes/{changeId}/tasks.md` 明确任务清单
+
+## 任务执行阶段
+
+### 列表页开发
+
+1. 创建列表页组件
+2. 实现数据展示表格
+3. 添加搜索条件区域
+4. 添加操作按钮区域
+5. 添加分页组件
+6. 配置路由
+7. 对接查询接口
+8. 实现搜索和分页功能
+9. 实现基础交互效果
+
+### 质量保证
+
+1. 确保代码符合项目规范
+2. 进行必要的代码检查
+
+## 任务完成阶段
+
+1. 提交代码到版本控制系统
+2. 使用命令执行任务：`momo:run -a {actor} -t {task}`
+3. 更新 `specification/changes/{changeId}/tasks.md` 中的任务状态
+4. 使用命令查看任务状态：`momo:tasks`
+5. 归档需求：`momo archive -n "{changeId}"`
+
+## 变更结构参考
+
+```
+specification/
+  changes/
+    {changeId}/
+      proposal.md     # 变更提案说明文件
+      tasks.md        # 变更任务列表说明
+      design.md       # 变更设计说明文件（可选）
+      tasks/          # 任务详细内容
+        M01-T001-01.md # 具体任务文件
+      specs/          # 能力变更详情
+        [capability]/
+          spec.md     # ADDED/MODIFIED/REMOVED需求
+```