首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >已发布到npm,MumuSpec CLI 使用指南

已发布到npm,MumuSpec CLI 使用指南

作者头像
用户5602664
发布2026-06-08 13:05:07
发布2026-06-08 13:05:07
320
举报

npm install -g mumuspec

MumuSpec CLI 是 MumuSpec 文档体系的命令行工具。

  1. 生成 14 份 Spec 文档模板,搭好目录结构
  2. 提供校验和维护命令,帮你追踪文档完整性、变更影响面和版本冻结

v0.1.0 还很早期,很多细节还在推敲。当前覆盖了基本的使用流程。

安装

代码语言:javascript
复制
npm install -g mumuspec

依赖 Node.js ≥ 18。

命令一览

所有命令分四组:

项目初始化

命令

作用

create <name>

生成 Spec 项目骨架(14 份模板 + AGENTS.md)

status [dir]

查看 Spec 填写进度

console [dir] [out]

生成 Spec 可视化控制台 HTML

五轮工作流

命令

轮次

产出

elicit [dir]

R1·采集

02 需求采集

propose [dir]

R2·提案

03 立项提案 + 04 PRD

anchor [dir]

R3·锚定

05 用户故事 ↔ 09 API 契约

design [dir]

R4·设计

06 FSD + 07 NFR + 08 架构 + 10 数据 + 11 安全

close [dir]

R5·收口

12 实施计划 + 13 测试策略 + 14 追溯矩阵

维护与校验

命令

作用

validate [dir]

门禁校验:检查文档完整性、AC-API 追溯、冻结状态

impact <spec-id> [dir]

变更影响分析:改这份文档会波及哪些

sync <spec-id> [dir]

变更联动:更新关联文档

freeze [dir]

版本冻结:打 Git tag + 锁定当前 Spec

角色视图

命令

作用

view --role <pm|dev|qa|arch> [dir]

按角色筛选需要关注的文档

典型使用流程

新项目

代码语言:javascript
复制
mumuspec create my-project
cd my-project
mumuspec status

status输出每份文档的填写状态。刚创建时是 0/14:

代码语言:javascript
复制
📊 MumuSpec 项目状态
  Meta         ░░ 0/2
  Proposal     ░░ 0/2
  Spec         ░░░ 0/3
  Design       ░░░░ 0/4
  Plan & Test  ░░ 0/2
  Trace        ░ 0/1
  总计: 0/14 份已填写

然后按五轮工作流逐步填写:

代码语言:javascript
复制
mumuspec elicit      # 把需求素材整理到 02
mumuspec propose     # 写立项提案和 PRD
mumuspec anchor      # 写用户故事,同时对齐 API 契约
mumuspec design      # 出技术设计
mumuspec close       # 出计划、测试策略、追溯矩阵

每一轮完成后再跑下一轮,不用一次全写完。

日常变更

改了某个 Spec 文档后,跑:

代码语言:javascript
复制
mumuspec validate

看有没有遗漏或冲突。validate的输出是按文档逐条检查:

代码语言:javascript
复制
🔍 MumuSpec 门禁校验
  ✅ 01 写作总则
  ✅ 04 产品需求 PRD
  ❌ 05 用户故事 (内容不足)
  ❌ 06 功能规格 FSD (内容不足)
  ⚠️  AC-API 追溯: 05 有 AC 但 09 未关联 US 编号
📊 通过 9/14,未通过 5/14

如果改了某份核心文档(比如 05-用户故事),跑一下影响分析:

代码语言:javascript
复制
mumuspec impact 05-user-stories
输出被波及的文档。然后用 
sync
联动更新:
mumuspec sync 05-user-stories
里程碑冻结
一个迭代的 Spec 定稿后:
mumuspec freeze
自动打 Git tag,锁定当前 Spec 版本。

按角色查看

不同角色关注不同的文档子集。指定 role 参数:

代码语言:javascript
复制
mumuspec view --role dev     # 开发者:US → FSD → API → 数据模型 → 实施计划
mumuspec view --role pm      # PM:立项提案 + PRD + 用户故事
mumuspec view --role qa      # QA:用户故事 AC + 测试策略 + 追溯矩阵
mumuspec view --role arch    # 架构师:NFR + 架构选型 + 安全设计 + 数据模型

AGENTS.md

mumuspec create同时生成 AGENTS.md,定义了 AI 编码助手在本项目中的工作流程:

代码语言:javascript
复制
接到任务 → 读取相关 Spec 文档
理解需求 → 基于 Spec 中的 AC 确认验收标准
生成代码 → 严格按 API 契约和数据模型
自检 → 对照 Spec 逐条验证 AC
提交 PR → 关联 Spec 编号

Spec 文档同时作为 AI Agent 的输入源。

v0.1.0 的边界

当前版本做的事情:

  • 生成模板、校验完整性、追踪影响面、角色视图、版本冻结
  • 五轮工作流的命令提供阶段标记和上下文提示,不自动生成 Spec 内容

当前版本没做的事情:

  • 五轮工作流命令的具体行为(每个命令应该做哪些检查、给哪些提示)还需要在实际使用中迭代
  • Delta 变更机制在文档体系中定义了,但 CLI 层面还没落地
  • Fitness Functions 的自动运行还未接入
  • 没有配置文件(mumuspec.config.yaml),项目级别设置通过命令行参数传入

后续版本会逐步补这些。

链接

  • [npm](https://www.npmjs.com/package/mumuspec)
  • [GitHub](https://github.com/lvzhaobo/mumu-coding)

Any Tool, Any Team.

MumuCoding for Every Builder.

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2026-06-06,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 沐然云计算 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 安装
  • 命令一览
  • 典型使用流程
    • 新项目
    • 日常变更
  • 按角色查看
  • AGENTS.md
  • v0.1.0 的边界
  • 链接
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档