@zeyue0329/xiaoma-cli 1.9.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +98 -65
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,109 +1,142 @@
|
|
|
1
|
-
|
|
1
|
+
# XiaoMa CLI
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](LICENSE)
|
|
5
|
-
[](https://nodejs.org)
|
|
6
|
-
[](https://discord.gg/gk8jAdXWmj)
|
|
3
|
+
XiaoMa CLI 是一个 AI 驱动的敏捷开发框架工具。它将专业的 AI 智能体、结构化工作流和可复用技能安装到你的项目中，配合 AI IDE（Claude Code、Cursor 等）使用，实现从需求分析到交付的全生命周期敏捷开发。
|
|
7
4
|
|
|
8
|
-
|
|
5
|
+
## 能力边界
|
|
9
6
|
|
|
10
|
-
|
|
7
|
+
### XiaoMa CLI 能做什么
|
|
11
8
|
|
|
12
|
-
|
|
9
|
+
**智能体协作**
|
|
13
10
|
|
|
14
|
-
|
|
11
|
+
XiaoMa 提供 8 个专业智能体，覆盖敏捷开发的核心角色：
|
|
15
12
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
13
|
+
| 智能体 | 角色 | 职责 |
|
|
14
|
+
|--------|------|------|
|
|
15
|
+
| Analyst | 分析师 | 需求调研、产品简报、竞品分析 |
|
|
16
|
+
| PM | 产品经理 | PRD 编写、需求验证、产品规划 |
|
|
17
|
+
| UX Designer | UX 设计师 | 用户体验设计、交互方案 |
|
|
18
|
+
| Architect | 架构师 | 技术架构设计、方案评审 |
|
|
19
|
+
| Dev | 开发者 | 故事实现、代码编写 |
|
|
20
|
+
| QA | 测试工程师 | 测试策略、端到端测试生成 |
|
|
21
|
+
| SM | Scrum Master | Sprint 规划、进度跟踪、回顾 |
|
|
22
|
+
| Quick Flow Solo Dev | 独立开发者 | 快速流程，适合小型项目 |
|
|
22
23
|
|
|
23
|
-
|
|
24
|
+
**结构化工作流（34+）**
|
|
24
25
|
|
|
25
|
-
|
|
26
|
+
按开发阶段组织，覆盖完整的软件交付生命周期：
|
|
26
27
|
|
|
27
|
-
|
|
28
|
+
- **分析阶段** — 需求管道、产品简报创建、市场调研
|
|
29
|
+
- **规划阶段** — PRD 创建/编辑/验证、UX 设计
|
|
30
|
+
- **方案阶段** — 架构设计、Epic 和 Story 拆分、实施就绪检查
|
|
31
|
+
- **实施阶段** — Sprint 规划、Story 开发、代码评审、回顾、Sprint 状态跟踪
|
|
32
|
+
- **全流程管道** — 端到端自动化，从需求到交付一键执行
|
|
28
33
|
|
|
29
|
-
|
|
34
|
+
**可复用技能（11 个）**
|
|
30
35
|
|
|
31
|
-
|
|
36
|
+
| 技能 | 用途 |
|
|
37
|
+
|------|------|
|
|
38
|
+
| `xiaoma-help` | 智能导航，告诉你下一步该做什么 |
|
|
39
|
+
| `xiaoma-brainstorming` | 结构化头脑风暴 |
|
|
40
|
+
| `xiaoma-party-mode` | 多智能体协作讨论 |
|
|
41
|
+
| `xiaoma-distillator` | 信息提炼和摘要 |
|
|
42
|
+
| `xiaoma-editorial-review-prose` | 文案内容审校 |
|
|
43
|
+
| `xiaoma-editorial-review-structure` | 文档结构审校 |
|
|
44
|
+
| `xiaoma-review-adversarial-general` | 对抗性审查 |
|
|
45
|
+
| `xiaoma-review-edge-case-hunter` | 边界场景审查 |
|
|
46
|
+
| `xiaoma-advanced-elicitation` | 高级需求引导 |
|
|
47
|
+
| `xiaoma-index-docs` | 文档索引 |
|
|
48
|
+
| `xiaoma-shard-doc` | 文档分片处理 |
|
|
32
49
|
|
|
33
|
-
|
|
50
|
+
**规模自适应**
|
|
34
51
|
|
|
35
|
-
|
|
52
|
+
根据项目复杂度自动调整规划深度——从小型 Bug 修复到企业级系统，无需手动配置。
|
|
36
53
|
|
|
37
|
-
|
|
54
|
+
### XiaoMa CLI 不能做什么
|
|
55
|
+
|
|
56
|
+
- **不是代码生成器** — 不会直接生成完整的应用代码，而是通过结构化流程引导你和 AI 协作产出高质量代码
|
|
57
|
+
- **不替代 AI IDE** — 需要配合 Claude Code、Cursor 等 AI IDE 使用，本身不提供代码编辑能力
|
|
58
|
+
- **不是项目管理工具** — 不替代 Jira、Linear 等，而是补充敏捷流程中的 AI 协作环节
|
|
59
|
+
- **不处理部署运维** — 聚焦于开发生命周期，不涉及 CI/CD 管道配置、服务器部署等运维任务
|
|
60
|
+
- **不支持非 Node.js 环境** — 安装工具本身需要 Node.js v20+（但生成的工作产物不限语言）
|
|
61
|
+
|
|
62
|
+
## 安装与使用
|
|
63
|
+
|
|
64
|
+
### 环境要求
|
|
65
|
+
|
|
66
|
+
- [Node.js](https://nodejs.org) v20 或更高版本
|
|
67
|
+
|
|
68
|
+
### 快速安装
|
|
38
69
|
|
|
39
70
|
```bash
|
|
40
71
|
npx xiaoma-cli install
|
|
41
72
|
```
|
|
42
73
|
|
|
43
|
-
|
|
74
|
+
按照交互式提示选择模块和目标 IDE，安装完成后在项目目录中打开你的 AI IDE 即可开始使用。
|
|
44
75
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
**Non-Interactive Installation** (for CI/CD):
|
|
76
|
+
### 非交互式安装（CI/CD）
|
|
48
77
|
|
|
49
78
|
```bash
|
|
50
79
|
npx xiaoma-cli install --directory /path/to/project --modules xmc --tools claude-code --yes
|
|
51
80
|
```
|
|
52
81
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
> **Not sure what to do?** Ask `xiaoma-help` — it tells you exactly what's next and what's optional. You can also ask questions like `xiaoma-help I just finished the architecture, what do I do next?`
|
|
56
|
-
|
|
57
|
-
## Modules
|
|
82
|
+
### CLI 命令
|
|
58
83
|
|
|
59
|
-
|
|
84
|
+
| 命令 | 说明 |
|
|
85
|
+
|------|------|
|
|
86
|
+
| `npx xiaoma-cli install` | 安装 XiaoMa 到目标项目 |
|
|
87
|
+
| `npx xiaoma-cli status` | 查看当前安装状态 |
|
|
88
|
+
| `npx xiaoma-cli uninstall` | 卸载 XiaoMa |
|
|
60
89
|
|
|
61
|
-
|
|
62
|
-
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
63
|
-
| **[XiaoMa Method (BMM)](https://github.com/zqyl-xiaoma/XiaoMa-CLI)** | Core framework with 34+ workflows |
|
|
64
|
-
| **[XiaoMa Builder (BMB)](https://github.com/zqyl-xiaoma/xiaoma-builder)** | Create custom XiaoMa agents and workflows |
|
|
65
|
-
| **[Test Architect (TEA)](https://github.com/zqyl-xiaoma/xiaoma-cli-test-architecture-enterprise)** | Risk-based test strategy and automation |
|
|
66
|
-
| **[Game Dev Studio (BMGD)](https://github.com/zqyl-xiaoma/xiaoma-module-game-dev-studio)** | Game development workflows (Unity, Unreal, Godot) |
|
|
67
|
-
| **[Creative Intelligence Suite (CIS)](https://github.com/zqyl-xiaoma/xiaoma-module-creative-intelligence-suite)** | Innovation, brainstorming, design thinking |
|
|
90
|
+
### 使用流程
|
|
68
91
|
|
|
69
|
-
|
|
92
|
+
1. **安装** — 在项目中运行 `npx xiaoma-cli install`
|
|
93
|
+
2. **启动 AI IDE** — 打开 Claude Code、Cursor 等，进入项目目录
|
|
94
|
+
3. **获取指引** — 使用 `xiaoma-help` 了解当前可用的工作流和下一步操作
|
|
95
|
+
4. **按阶段推进** — 从分析到实施，按工作流引导逐步完成开发
|
|
70
96
|
|
|
71
|
-
|
|
97
|
+
### 使用示例
|
|
72
98
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
- [Upgrading from Previous Versions](https://docs.xiaoma-cli.org/how-to/upgrade-to-v6/)
|
|
76
|
-
- [Test Architect Documentation](https://zqyl-xiaoma.github.io/xiaoma-cli-test-architecture-enterprise/)
|
|
99
|
+
```
|
|
100
|
+
# 在 AI IDE 中使用以下命令
|
|
77
101
|
|
|
102
|
+
# 获取帮助
|
|
103
|
+
xiaoma-help
|
|
78
104
|
|
|
79
|
-
|
|
105
|
+
# 获取特定场景的帮助
|
|
106
|
+
xiaoma-help 我刚完成了架构设计，接下来该做什么？
|
|
80
107
|
|
|
81
|
-
|
|
82
|
-
-
|
|
83
|
-
- [GitHub Issues](https://github.com/zqyl-xiaoma/XiaoMa-CLI/issues) — Bug reports and feature requests
|
|
84
|
-
- [Discussions](https://github.com/zqyl-xiaoma/XiaoMa-CLI/discussions) — Community conversations
|
|
108
|
+
# 创建产品简报
|
|
109
|
+
@analyst create-product-brief
|
|
85
110
|
|
|
86
|
-
|
|
111
|
+
# 创建 PRD
|
|
112
|
+
@pm create-prd
|
|
87
113
|
|
|
88
|
-
|
|
114
|
+
# 架构设计
|
|
115
|
+
@architect create-architecture
|
|
89
116
|
|
|
90
|
-
|
|
91
|
-
-
|
|
92
|
-
- 🏢 Corporate sponsorship — DM on Discord
|
|
93
|
-
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord)
|
|
117
|
+
# Sprint 规划
|
|
118
|
+
@sm sprint-planning
|
|
94
119
|
|
|
95
|
-
|
|
120
|
+
# 开发 Story
|
|
121
|
+
@dev dev-story
|
|
96
122
|
|
|
97
|
-
|
|
123
|
+
# 代码评审
|
|
124
|
+
@dev code-review
|
|
98
125
|
|
|
99
|
-
|
|
126
|
+
# 多智能体协作讨论
|
|
127
|
+
xiaoma-party-mode
|
|
128
|
+
```
|
|
100
129
|
|
|
101
|
-
|
|
130
|
+
## 模块生态
|
|
102
131
|
|
|
103
|
-
|
|
132
|
+
XiaoMa 支持通过模块扩展能力，以下为可用模块：
|
|
104
133
|
|
|
105
|
-
|
|
134
|
+
| 模块 | 说明 |
|
|
135
|
+
|------|------|
|
|
136
|
+
| **XiaoMa Method (XMC)** | 核心框架，包含全部智能体和 34+ 工作流 |
|
|
137
|
+
| **XiaoMa Builder (BMB)** | 创建自定义智能体和工作流 |
|
|
138
|
+
| **Test Architect (TEA)** | 基于风险的测试策略和自动化 |
|
|
139
|
+
| **Game Dev Studio (BMGD)** | 游戏开发工作流（Unity、Unreal、Godot） |
|
|
140
|
+
| **Creative Intelligence Suite (CIS)** | 创新、头脑风暴、设计思维 |
|
|
106
141
|
|
|
107
|
-
[](https://github.com/zqyl-xiaoma/XiaoMa-CLI/graphs/contributors)
|
|
108
142
|
|
|
109
|
-
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
|