mcp-probe-kit 1.15.0 → 2.0.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 +113 -1642
- package/build/index.js +75 -42
- package/build/lib/elicitation-helper.d.ts +73 -0
- package/build/lib/elicitation-helper.js +130 -0
- package/build/lib/response.d.ts +32 -0
- package/build/lib/response.js +28 -0
- package/build/lib/tasks-manager.d.ts +116 -0
- package/build/lib/tasks-manager.js +217 -0
- package/build/lib/toolset-manager.d.ts +48 -0
- package/build/lib/toolset-manager.js +112 -0
- package/build/schemas/basic-tools.d.ts +0 -32
- package/build/schemas/basic-tools.js +0 -34
- package/build/schemas/code-analysis-tools.d.ts +0 -36
- package/build/schemas/code-analysis-tools.js +0 -38
- package/build/schemas/code-gen-tools.d.ts +0 -44
- package/build/schemas/code-gen-tools.js +0 -46
- package/build/schemas/doc-util-tools.d.ts +0 -54
- package/build/schemas/doc-util-tools.js +0 -58
- package/build/schemas/index.d.ts +0 -188
- package/build/schemas/orchestration-tools.d.ts +0 -22
- package/build/schemas/orchestration-tools.js +0 -23
- package/build/schemas/output/core-tools.d.ts +817 -0
- package/build/schemas/output/core-tools.js +421 -0
- package/build/schemas/output/generation-tools.d.ts +936 -0
- package/build/schemas/output/generation-tools.js +446 -0
- package/build/schemas/output/helper-tools.d.ts +243 -0
- package/build/schemas/output/helper-tools.js +138 -0
- package/build/schemas/output/index.d.ts +76 -0
- package/build/schemas/output/index.js +96 -0
- package/build/schemas/output/project-tools.d.ts +702 -0
- package/build/schemas/output/project-tools.js +339 -0
- package/build/schemas/output/ui-ux-tools.d.ts +469 -0
- package/build/schemas/output/ui-ux-tools.js +218 -0
- package/build/schemas/output/workflow-tools.d.ts +267 -0
- package/build/schemas/output/workflow-tools.js +179 -0
- package/build/schemas/structured-output.d.ts +1317 -0
- package/build/schemas/structured-output.js +1017 -0
- package/build/tools/__tests__/start_ui.integration.test.js +5 -5
- package/build/tools/__tests__/start_ui.property.test.js +11 -11
- package/build/tools/add_feature.d.ts +1 -13
- package/build/tools/add_feature.js +48 -13
- package/build/tools/analyze_project.js +57 -18
- package/build/tools/check_deps.d.ts +1 -13
- package/build/tools/check_deps.js +24 -15
- package/build/tools/code_review.d.ts +1 -13
- package/build/tools/code_review.js +19 -16
- package/build/tools/css_order.js +55 -55
- package/build/tools/debug.d.ts +1 -13
- package/build/tools/debug.js +18 -16
- package/build/tools/estimate.d.ts +1 -19
- package/build/tools/estimate.js +36 -6
- package/build/tools/fix_bug.d.ts +1 -13
- package/build/tools/fix_bug.js +24 -6
- package/build/tools/gen_mock.d.ts +1 -19
- package/build/tools/gen_mock.js +42 -227
- package/build/tools/genapi.d.ts +1 -13
- package/build/tools/genapi.js +18 -15
- package/build/tools/genchangelog.d.ts +1 -13
- package/build/tools/genchangelog.js +36 -212
- package/build/tools/gencommit.d.ts +1 -7
- package/build/tools/gencommit.js +21 -13
- package/build/tools/gendoc.d.ts +1 -13
- package/build/tools/gendoc.js +18 -15
- package/build/tools/genpr.d.ts +1 -13
- package/build/tools/genpr.js +28 -157
- package/build/tools/genreadme.d.ts +1 -13
- package/build/tools/genreadme.js +22 -587
- package/build/tools/gensql.d.ts +1 -13
- package/build/tools/gensql.js +24 -283
- package/build/tools/gentest.d.ts +1 -13
- package/build/tools/gentest.js +49 -16
- package/build/tools/index.d.ts +0 -10
- package/build/tools/index.js +0 -10
- package/build/tools/init_component_catalog.d.ts +3 -20
- package/build/tools/init_component_catalog.js +141 -786
- package/build/tools/init_project.d.ts +7 -13
- package/build/tools/init_project.js +54 -16
- package/build/tools/init_project_context.d.ts +1 -13
- package/build/tools/init_project_context.js +41 -14
- package/build/tools/perf.d.ts +1 -13
- package/build/tools/perf.js +18 -15
- package/build/tools/refactor.d.ts +1 -13
- package/build/tools/refactor.js +54 -15
- package/build/tools/render_ui.d.ts +2 -19
- package/build/tools/render_ui.js +201 -347
- package/build/tools/resolve_conflict.d.ts +1 -13
- package/build/tools/resolve_conflict.js +18 -15
- package/build/tools/security_scan.d.ts +1 -13
- package/build/tools/security_scan.js +16 -5
- package/build/tools/start_api.d.ts +7 -13
- package/build/tools/start_api.js +69 -157
- package/build/tools/start_bugfix.d.ts +1 -7
- package/build/tools/start_bugfix.js +38 -2
- package/build/tools/start_doc.d.ts +7 -13
- package/build/tools/start_doc.js +76 -169
- package/build/tools/start_feature.d.ts +1 -7
- package/build/tools/start_feature.js +54 -2
- package/build/tools/start_onboard.d.ts +1 -7
- package/build/tools/start_onboard.js +40 -2
- package/build/tools/start_ralph.d.ts +1 -7
- package/build/tools/start_ralph.js +88 -2
- package/build/tools/start_refactor.d.ts +7 -13
- package/build/tools/start_refactor.js +75 -148
- package/build/tools/start_release.d.ts +7 -13
- package/build/tools/start_release.js +56 -131
- package/build/tools/start_review.d.ts +7 -13
- package/build/tools/start_review.js +70 -142
- package/build/tools/start_ui.d.ts +1 -7
- package/build/tools/start_ui.js +98 -8
- package/build/tools/ui-ux-tools.d.ts +3 -39
- package/build/tools/ui-ux-tools.js +201 -125
- package/docs/data/tools.js +864 -0
- package/docs/index.html +594 -0
- package/docs/pages/all-tools.html +649 -0
- package/docs/pages/examples.html +564 -0
- package/docs/pages/getting-started.html +529 -0
- package/docs/pages/migration.html +308 -0
- package/docs/specs/algorithm-enhancement/roadmap.md +619 -0
- package/docs/specs/vnext-upgrade/00-OVERVIEW.md +258 -0
- package/docs/specs/vnext-upgrade/BETA_RELEASE_GUIDE.md +328 -0
- package/docs/specs/vnext-upgrade/GITHUB_DISCUSSION_TEMPLATE.md +236 -0
- package/docs/specs/vnext-upgrade/M8.9-PROGRESS-UPDATE.md +248 -0
- package/docs/specs/vnext-upgrade/PROGRESS-SUMMARY.md +195 -0
- package/docs/specs/vnext-upgrade/QUICK_REFERENCE.md +338 -0
- package/docs/specs/vnext-upgrade/README.md +125 -0
- package/docs/specs/vnext-upgrade/STATUS-UPDATE-2026-01-26.md +230 -0
- package/docs/specs/vnext-upgrade/TOOL_CLEANUP.md +343 -0
- package/docs/specs/vnext-upgrade/completed/M1-M2-SUMMARY.md +27 -0
- package/docs/specs/vnext-upgrade/completed/M3_COMPLETION_SUMMARY.md +273 -0
- package/docs/specs/vnext-upgrade/completed/M4-SUMMARY.md +19 -0
- package/docs/specs/vnext-upgrade/completed/M5_COMPLETION_SUMMARY.md +0 -0
- package/docs/specs/vnext-upgrade/completed/M8.1-SUMMARY.md +247 -0
- package/docs/specs/vnext-upgrade/completed/M8.2-SUMMARY.md +296 -0
- package/docs/specs/vnext-upgrade/completed/M8.3-SUMMARY.md +241 -0
- package/docs/specs/vnext-upgrade/completed/M8.3-TEST-SUMMARY.md +216 -0
- package/docs/specs/vnext-upgrade/completed/M8.4-SUMMARY.md +217 -0
- package/docs/specs/vnext-upgrade/completed/M8.4-TEST-SUMMARY.md +198 -0
- package/docs/specs/vnext-upgrade/completed/M8.5-SUMMARY.md +202 -0
- package/docs/specs/vnext-upgrade/completed/M8.5-TEST-SUMMARY.md +223 -0
- package/docs/specs/vnext-upgrade/completed/M8.6-SUMMARY.md +299 -0
- package/docs/specs/vnext-upgrade/completed/M8.8-TEST-SUMMARY.md +216 -0
- package/docs/specs/vnext-upgrade/completed/TOOL-CLEANUP-SUMMARY.md +210 -0
- package/docs/specs/vnext-upgrade/design.md +848 -0
- package/docs/specs/vnext-upgrade/requirements.md +221 -0
- package/docs/specs/vnext-upgrade/tasks/00-INDEX.md +335 -0
- package/docs/specs/vnext-upgrade/tasks/M8.1-SCHEMA-DEFINITION.md +300 -0
- package/docs/specs/vnext-upgrade/tasks/M8.2-P1-TOOLS.md +249 -0
- package/docs/specs/vnext-upgrade/tasks/M8.3-GENERATION-TOOLS.md +49 -0
- package/docs/specs/vnext-upgrade/tasks/M8.4-ORCHESTRATION-TOOLS.md +28 -0
- package/docs/specs/vnext-upgrade/tasks/M8.5-PROJECT-TOOLS.md +29 -0
- package/docs/specs/vnext-upgrade/tasks/M8.6-UI-TOOLS.md +66 -0
- package/docs/specs/vnext-upgrade/tasks/M8.7-HELPER-TOOLS.md +24 -0
- package/docs/specs/vnext-upgrade/tasks/M8.8-INTEGRATION-TESTS.md +90 -0
- package/docs/specs/vnext-upgrade/tasks/M8.9-DOCUMENTATION.md +103 -0
- package/docs/styles/docs.css +556 -0
- package/docs/styles/page.css +815 -0
- package/docs/vnext/MCP_2025-11-25_GUIDE.md +276 -0
- package/docs/vnext/vNext-PRD.md +488 -0
- package/package.json +4 -4
- package/build/utils/design-docs-generator.d.ts +0 -1
- package/build/utils/design-docs-generator.js +0 -1
- package/docs/BEST_PRACTICES.md +0 -1185
- package/docs/HOW_TO_TRIGGER.md +0 -1141
- package/docs/MCP-Probe-Kit-/344/275/277/347/224/250/346/211/213/345/206/214.html +0 -544
- package/docs/MCP-Probe-Kit-/344/275/277/347/224/250/346/211/213/345/206/214.md +0 -1447
|
@@ -1,1447 +0,0 @@
|
|
|
1
|
-
# MCP Probe Kit 工具使用手册
|
|
2
|
-
|
|
3
|
-
> **版本**: v1.15.0 | **工具总数**: 49 个(37 个基础工具 + 9 个智能编排 + 3 个 UI/UX 新增)
|
|
4
|
-
|
|
5
|
-
## � UI/UX Pro Max 工具 🆕
|
|
6
|
-
|
|
7
|
-
> **数据来源**: [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) 项目
|
|
8
|
-
> **同步方式**: 通过 npm 包 `uipro-cli` 自动同步最新数据
|
|
9
|
-
> **实现方式**: Python 原版 → TypeScript 移植(功能完全一致)
|
|
10
|
-
|
|
11
|
-
### 1. ui_design_system - 设计系统生成器
|
|
12
|
-
**用途:** 基于 100 条行业规则的智能推荐,生成设计系统推荐和创作指导
|
|
13
|
-
|
|
14
|
-
**核心功能:**
|
|
15
|
-
- **智能推理引擎**:6 步推理流程(产品类型匹配 → 应用推理规则 → 多领域搜索 → 优先级选择 → 组合效果 → 生成推荐)
|
|
16
|
-
- **100 条行业规则**:覆盖 SaaS、电商、医疗、金融、教育等多个行业
|
|
17
|
-
- **完整设计系统**:色彩(11 级色阶)、字体(Sans/Serif/Mono)、间距(基于 4px)、组件样式
|
|
18
|
-
- **多技术栈支持**:React、Vue、Next.js、Tailwind、Svelte、Astro 等
|
|
19
|
-
- **双格式输出**:ASCII Box 推荐 + JSON 配置数据
|
|
20
|
-
- **AI 驱动创作**:提供创作指导,AI 根据推荐自由创作文档 ✨
|
|
21
|
-
|
|
22
|
-
**提问示例:**
|
|
23
|
-
- "帮我生成一个 React 设计系统"
|
|
24
|
-
- "为我的 Next.js 项目生成 Tailwind 配置"
|
|
25
|
-
- "生成一个蓝色主题的设计系统"
|
|
26
|
-
|
|
27
|
-
**参数说明:**
|
|
28
|
-
- `product_type`: 产品类型(推荐)- SaaS/E-commerce/Healthcare/Fintech 等
|
|
29
|
-
- `stack`: 技术栈(可选)- react/vue/nextjs/tailwind/svelte/astro
|
|
30
|
-
- `color_scheme`: 色彩方案(可选)- light/dark/auto
|
|
31
|
-
- `primary_color`: 主色调(可选)- 十六进制颜色值
|
|
32
|
-
- `typography`: 字体方案(可选)- modern/classic/minimal
|
|
33
|
-
- `spacing`: 间距系统(可选)- compact/normal/relaxed
|
|
34
|
-
- `border_radius`: 圆角风格(可选)- none/small/medium/large
|
|
35
|
-
|
|
36
|
-
**输出内容:**
|
|
37
|
-
- **ASCII Box 推荐**:核心设计推荐(颜色、字体、间距等)
|
|
38
|
-
- **JSON 配置数据**:精确的设计规范数值
|
|
39
|
-
- **文件索引**:需要创建的文件列表(按顺序)
|
|
40
|
-
- **创作指导**:每个文档应包含的主题和提示
|
|
41
|
-
|
|
42
|
-
**工作流程:**
|
|
43
|
-
1. 工具返回设计推荐和创作指导
|
|
44
|
-
2. AI 根据指导创建文档内容
|
|
45
|
-
3. 生成文档:设计原则、交互规范、布局规范、技术配置
|
|
46
|
-
|
|
47
|
-
**注意:**
|
|
48
|
-
- 工具不再自动生成完整文档内容
|
|
49
|
-
- AI 会根据推荐和指导自由创作
|
|
50
|
-
- 这样可以根据具体情况调整文档内容和结构
|
|
51
|
-
|
|
52
|
-
**使用示例:**
|
|
53
|
-
```
|
|
54
|
-
你: "我要做一个 React 项目,帮我生成一套蓝色主题的设计系统"
|
|
55
|
-
|
|
56
|
-
AI 调用: ui_design_system
|
|
57
|
-
参数: {
|
|
58
|
-
product_type: "SaaS",
|
|
59
|
-
stack: "react",
|
|
60
|
-
primary_color: "#3b82f6"
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
返回:
|
|
64
|
-
✅ 设计推荐和创作指导
|
|
65
|
-
- ASCII Box 推荐(核心设计)
|
|
66
|
-
- JSON 配置数据(精确数值)
|
|
67
|
-
- 文件索引(要创建的文件)
|
|
68
|
-
- 创作指导(每个文档的主题)
|
|
69
|
-
|
|
70
|
-
AI 根据指导创建文档:
|
|
71
|
-
├─ docs/design-system.md(主文档)
|
|
72
|
-
├─ docs/design-system.json(JSON 配置)
|
|
73
|
-
└─ docs/design-guidelines/(详细规范)
|
|
74
|
-
├─ 01-principles.md(设计原则)
|
|
75
|
-
├─ 02-interaction.md(交互规范)
|
|
76
|
-
├─ 03-layout.md(布局规范)
|
|
77
|
-
└─ 04-config.md(技术配置)
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
### 2. ui_search - UI/UX 智能搜索
|
|
83
|
-
**用途:** 搜索 UI 组件、颜色方案、图标、设计模式、最佳实践
|
|
84
|
-
|
|
85
|
-
**核心功能:**
|
|
86
|
-
- **BM25 算法**:智能相关性排序(与原版一致)
|
|
87
|
-
- **24 类数据**:colors、icons、charts、landing、products、typography、styles、ux-guidelines 等
|
|
88
|
-
- **多语言支持**:中英文搜索
|
|
89
|
-
- **技术栈过滤**:React、Vue、Next.js、Flutter、SwiftUI 等
|
|
90
|
-
- **精准匹配**:按类别和技术栈过滤
|
|
91
|
-
|
|
92
|
-
**提问示例:**
|
|
93
|
-
- "我需要一个 React 的主按钮组件"
|
|
94
|
-
- "搜索一下蓝色主题的配色方案"
|
|
95
|
-
- "表单验证有什么 UX 最佳实践?"
|
|
96
|
-
- "给我推荐一些图标"
|
|
97
|
-
|
|
98
|
-
**参数说明:**
|
|
99
|
-
- `query`: 搜索关键词(必填)
|
|
100
|
-
- `category`: 数据类别(可选)- colors/icons/charts/react/vue 等
|
|
101
|
-
- `stack`: 技术栈过滤(可选)
|
|
102
|
-
- `limit`: 返回结果数量(可选,默认 10)
|
|
103
|
-
- `min_score`: 最小相关性得分(可选,默认 0)
|
|
104
|
-
|
|
105
|
-
**可搜索的类别:**
|
|
106
|
-
- **设计元素**: colors(颜色), icons(图标), typography(字体), styles(样式)
|
|
107
|
-
- **组件**: charts(图表), landing(落地页), products(产品), web-interface(Web 界面)
|
|
108
|
-
- **指南**: ux-guidelines(UX 设计指南), react-performance(React 性能)
|
|
109
|
-
- **技术栈**: react, vue, nextjs, nuxtjs, svelte, astro, flutter, react-native, swiftui, shadcn 等
|
|
110
|
-
|
|
111
|
-
**使用示例:**
|
|
112
|
-
```
|
|
113
|
-
你: "我需要一个 React 的主按钮组件"
|
|
114
|
-
|
|
115
|
-
AI 调用: ui_search
|
|
116
|
-
参数: {
|
|
117
|
-
query: "button primary",
|
|
118
|
-
category: "react",
|
|
119
|
-
limit: 5
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
返回: 5 个按钮组件实现,包括:
|
|
123
|
-
- 组件代码
|
|
124
|
-
- Props 说明
|
|
125
|
-
- 使用示例
|
|
126
|
-
- 相关性得分
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
### 3. sync_ui_data - 数据同步工具
|
|
132
|
-
**用途:** 同步最新的 UI/UX 数据到本地缓存
|
|
133
|
-
|
|
134
|
-
**核心功能:**
|
|
135
|
-
- **自动检查更新**:对比本地版本与 npm registry 最新版本
|
|
136
|
-
- **智能同步**:仅在有新版本时下载(可强制同步)
|
|
137
|
-
- **数据来源**:npm 包 `uipro-cli`(该包从 [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) 项目同步数据)
|
|
138
|
-
- **格式转换**:自动将 CSV 转换为 JSON
|
|
139
|
-
- **版本管理**:记录同步时间和版本号
|
|
140
|
-
|
|
141
|
-
**提问示例:**
|
|
142
|
-
- "检查一下 UI 数据有没有更新"
|
|
143
|
-
- "更新 UI/UX 数据"
|
|
144
|
-
- "强制同步 UI 数据"
|
|
145
|
-
|
|
146
|
-
**参数说明:**
|
|
147
|
-
- `force`: 是否强制同步(可选,默认 false)
|
|
148
|
-
- `verbose`: 是否显示详细日志(可选,默认 false)
|
|
149
|
-
|
|
150
|
-
**数据存储位置:**
|
|
151
|
-
- **内嵌数据**: npm 包内部 `src/resources/ui-ux-data/`(构建时同步)
|
|
152
|
-
- **缓存数据**: `~/.mcp-probe-kit/ui-ux-data/`(运行时更新)
|
|
153
|
-
|
|
154
|
-
**数据流程:**
|
|
155
|
-
```
|
|
156
|
-
GitHub 项目 (ui-ux-pro-max-skill)
|
|
157
|
-
↓
|
|
158
|
-
npm 包 (uipro-cli)
|
|
159
|
-
↓
|
|
160
|
-
MCP Probe Kit (构建时/运行时同步)
|
|
161
|
-
↓
|
|
162
|
-
本地缓存 (~/.mcp-probe-kit/ui-ux-data/)
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
**使用示例:**
|
|
166
|
-
```
|
|
167
|
-
你: "检查一下 UI 数据有没有更新"
|
|
168
|
-
|
|
169
|
-
AI 调用: sync_ui_data
|
|
170
|
-
参数: { force: false }
|
|
171
|
-
|
|
172
|
-
返回:
|
|
173
|
-
✅ UI/UX 数据已是最新版本
|
|
174
|
-
当前版本: 2.2.0
|
|
175
|
-
最新版本: 2.2.0
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
**📖 相关资源:**
|
|
179
|
-
- **原版项目**: [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) (Python)
|
|
180
|
-
- **数据包**: [uipro-cli](https://www.npmjs.com/package/uipro-cli) (npm)
|
|
181
|
-
- **本实现**: TypeScript 移植版(功能完全一致)
|
|
182
|
-
|
|
183
|
-
---
|
|
184
|
-
|
|
185
|
-
### 4. init_component_catalog - 组件目录生成器 🆕
|
|
186
|
-
**用途:** 基于设计系统规范生成组件目录,定义可用的 UI 组件及其属性
|
|
187
|
-
|
|
188
|
-
**核心功能:**
|
|
189
|
-
- **自动读取设计规范**:从 `docs/design-system.json` 读取配置
|
|
190
|
-
- **占位符语法**:组件样式使用 `{colors.primary.500}` 格式
|
|
191
|
-
- **渲染时替换**:`render_ui` 工具会自动替换占位符为实际值
|
|
192
|
-
- **样式统一**:所有组件使用相同的设计规范
|
|
193
|
-
- **自动保存文件**:自动保存到 `docs/component-catalog.json` ✨
|
|
194
|
-
|
|
195
|
-
**提问示例:**
|
|
196
|
-
- "生成组件目录"
|
|
197
|
-
- "初始化 UI 组件库"
|
|
198
|
-
|
|
199
|
-
**参数说明:**
|
|
200
|
-
- 无需参数(自动读取 `docs/design-system.json`)
|
|
201
|
-
|
|
202
|
-
**前置条件:**
|
|
203
|
-
- 必须先运行 `ui_design_system` 生成设计系统
|
|
204
|
-
|
|
205
|
-
**生成的组件:**
|
|
206
|
-
- **基础组件**(7 个):Button, Input, Card, Form, Modal, Table, Alert
|
|
207
|
-
- **布局组件**(3 个):Container, Stack, Grid
|
|
208
|
-
|
|
209
|
-
**输出文件:**
|
|
210
|
-
- `docs/ui/component-catalog.json` - 组件目录(包含占位符)
|
|
211
|
-
|
|
212
|
-
**组件定义示例:**
|
|
213
|
-
```json
|
|
214
|
-
{
|
|
215
|
-
"name": "Button",
|
|
216
|
-
"description": "按钮组件",
|
|
217
|
-
"props": {
|
|
218
|
-
"variant": "primary | secondary | outline",
|
|
219
|
-
"size": "sm | md | lg",
|
|
220
|
-
"label": "string"
|
|
221
|
-
},
|
|
222
|
-
"baseClasses": "bg-[{colors.primary.500}] text-white hover:bg-[{colors.primary.600}]"
|
|
223
|
-
}
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
**使用示例:**
|
|
227
|
-
```
|
|
228
|
-
你: "生成组件目录"
|
|
229
|
-
|
|
230
|
-
AI 调用: init_component_catalog
|
|
231
|
-
|
|
232
|
-
返回:
|
|
233
|
-
✅ 组件目录生成成功
|
|
234
|
-
文件: docs/ui/component-catalog.json
|
|
235
|
-
包含 10 个组件(7 个基础 + 3 个布局)
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
---
|
|
239
|
-
|
|
240
|
-
### 5. render_ui - UI 渲染引擎 🆕
|
|
241
|
-
**用途:** 将 JSON 模板渲染为最终代码,自动应用设计规范
|
|
242
|
-
|
|
243
|
-
**核心功能:**
|
|
244
|
-
- **读取三个文件**:模板 JSON、组件目录、设计规范
|
|
245
|
-
- **占位符替换**:`{colors.primary.500}` → `#3b82f6`
|
|
246
|
-
- **代码生成**:React/Vue/HTML 完整组件代码
|
|
247
|
-
- **样式统一**:所有组件自动应用设计规范
|
|
248
|
-
|
|
249
|
-
**提问示例:**
|
|
250
|
-
- "渲染这个 UI 模板"
|
|
251
|
-
- "把 login-form.json 转换成 React 代码"
|
|
252
|
-
|
|
253
|
-
**参数说明:**
|
|
254
|
-
- `template`: 模板文件路径(必填,如 `docs/ui/pages/login-form.json`)
|
|
255
|
-
- `framework`: 目标框架(可选,默认 react)
|
|
256
|
-
|
|
257
|
-
**占位符替换规则:**
|
|
258
|
-
- `{colors.primary.500}` → 从 design-system.json 读取颜色
|
|
259
|
-
- `{typography.fontSize.base}` → 从 design-system.json 读取字体大小
|
|
260
|
-
- `{spacing.scale.4}` → 从 design-system.json 读取间距
|
|
261
|
-
- `{borderRadius.md}` → 从 design-system.json 读取圆角
|
|
262
|
-
- `{shadows.md}` → 从 design-system.json 读取阴影
|
|
263
|
-
|
|
264
|
-
**使用示例:**
|
|
265
|
-
```
|
|
266
|
-
你: "把 login-form.json 转换成 React 代码"
|
|
267
|
-
|
|
268
|
-
AI 调用: render_ui
|
|
269
|
-
参数: {
|
|
270
|
-
template: "docs/ui/pages/login-form.json",
|
|
271
|
-
framework: "react"
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
返回: 完整的 React 组件代码(已应用设计规范)
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
---
|
|
278
|
-
|
|
279
|
-
### 6. start_ui - 统一 UI 开发编排 🆕
|
|
280
|
-
**用途:** 一键完成整个 UI 开发流程,从设计系统到最终代码
|
|
281
|
-
|
|
282
|
-
**核心功能:**
|
|
283
|
-
- **智能文件检查**:自动检查设计系统和组件目录是否存在,存在则跳过生成
|
|
284
|
-
- **简洁指导输出**:提供清晰的步骤指导(<800 tokens),AI 代理可准确执行
|
|
285
|
-
- **双模式支持**:manual(手动模式,提供步骤指导)和 auto(自动模式,智能推理参数)
|
|
286
|
-
- **安全字符串处理**:正确处理特殊字符,避免替换错误
|
|
287
|
-
|
|
288
|
-
**提问示例:**
|
|
289
|
-
- "生成一个登录页面"
|
|
290
|
-
- "我要做一个用户列表"
|
|
291
|
-
- "帮我生成设置页面"
|
|
292
|
-
|
|
293
|
-
**参数说明:**
|
|
294
|
-
- `description`: UI 需求描述(必填)
|
|
295
|
-
- `framework`: 目标框架(可选,默认 react)
|
|
296
|
-
- `template`: 模板名称(可选,自动生成)
|
|
297
|
-
- `mode`: 运行模式(可选,默认 manual)
|
|
298
|
-
- `manual`: 提供步骤指导,AI 按步骤调用工具
|
|
299
|
-
- `auto`: 智能推理产品类型和参数,自动优化执行计划
|
|
300
|
-
|
|
301
|
-
**完整工作流(manual 模式):**
|
|
302
|
-
```
|
|
303
|
-
第1步:生成设计系统(如不存在)✅
|
|
304
|
-
├─ 检查 docs/design-system.md 是否存在
|
|
305
|
-
└─ 不存在则调用 ui_design_system
|
|
306
|
-
|
|
307
|
-
第2步:生成组件目录(如不存在)🔄
|
|
308
|
-
├─ 检查 docs/component-catalog.json 是否存在
|
|
309
|
-
└─ 不存在则调用 init_component_catalog
|
|
310
|
-
|
|
311
|
-
第3步:搜索 UI 模板 🔍
|
|
312
|
-
├─ 调用 ui_search --mode=template
|
|
313
|
-
└─ 如果没找到,使用默认模板
|
|
314
|
-
|
|
315
|
-
第4步:渲染最终代码 🎨
|
|
316
|
-
├─ 调用 render_ui
|
|
317
|
-
└─ 输出完整的组件代码
|
|
318
|
-
```
|
|
319
|
-
|
|
320
|
-
**使用示例(manual 模式):**
|
|
321
|
-
```
|
|
322
|
-
你: "生成一个登录页面"
|
|
323
|
-
|
|
324
|
-
AI 调用: start_ui
|
|
325
|
-
参数: {
|
|
326
|
-
description: "登录页面",
|
|
327
|
-
framework: "react"
|
|
328
|
-
}
|
|
329
|
-
|
|
330
|
-
返回: 清晰的步骤指导
|
|
331
|
-
# 快速开始
|
|
332
|
-
|
|
333
|
-
执行以下工具:
|
|
334
|
-
|
|
335
|
-
1. 检查 `docs/design-system.md` 是否存在,不存在则调用 `ui_design_system --product_type="SaaS" --stack="react"`
|
|
336
|
-
2. 检查 `docs/component-catalog.json` 是否存在,不存在则调用 `init_component_catalog`
|
|
337
|
-
3. `ui_search --mode=template --query="登录页面"`
|
|
338
|
-
4. `render_ui --template="docs/ui/login-page.json" --framework="react"`
|
|
339
|
-
|
|
340
|
-
[详细步骤说明...]
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
**使用示例(auto 模式):**
|
|
344
|
-
```
|
|
345
|
-
你: "生成一个电商商品列表页面"
|
|
346
|
-
|
|
347
|
-
AI 调用: start_ui
|
|
348
|
-
参数: {
|
|
349
|
-
description: "电商商品列表页面",
|
|
350
|
-
framework: "react",
|
|
351
|
-
mode: "auto"
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
返回: 智能推理结果和优化的执行计划
|
|
355
|
-
# 🚀 智能 UI 开发计划
|
|
356
|
-
|
|
357
|
-
基于您的描述 "**电商商品列表页面**",AI 引擎已为您规划了最佳开发路径。
|
|
358
|
-
|
|
359
|
-
## 🧠 智能分析结果
|
|
360
|
-
|
|
361
|
-
- **产品类型**: E-commerce
|
|
362
|
-
- **推荐风格**: Modern, Clean, Conversion-focused
|
|
363
|
-
- **关键特性**: product-grid, filters, cart-integration
|
|
364
|
-
- **技术栈**: react
|
|
365
|
-
|
|
366
|
-
[优化的执行步骤...]
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
**💡 使用技巧:**
|
|
370
|
-
|
|
371
|
-
**技巧 1:快速原型(manual 模式)**
|
|
372
|
-
```bash
|
|
373
|
-
# 一键生成多个页面
|
|
374
|
-
start_ui "登录页面"
|
|
375
|
-
start_ui "注册页面"
|
|
376
|
-
start_ui "用户列表"
|
|
377
|
-
start_ui "设置页面"
|
|
378
|
-
```
|
|
379
|
-
所有页面自动使用相同的设计规范!
|
|
380
|
-
|
|
381
|
-
**技巧 2:智能推理(auto 模式)**
|
|
382
|
-
```bash
|
|
383
|
-
# AI 自动推理产品类型和最佳参数
|
|
384
|
-
start_ui "电商商品列表" --mode=auto
|
|
385
|
-
start_ui "医疗预约系统" --mode=auto
|
|
386
|
-
start_ui "金融数据看板" --mode=auto
|
|
387
|
-
```
|
|
388
|
-
AI 引擎会根据描述自动选择最合适的设计风格和参数!
|
|
389
|
-
|
|
390
|
-
**技巧 3:修改设计规范**
|
|
391
|
-
1. 编辑 `docs/design-system.json`
|
|
392
|
-
2. 修改颜色、字体等
|
|
393
|
-
3. 重新运行 `start_ui`
|
|
394
|
-
4. 所有页面自动应用新规范
|
|
395
|
-
|
|
396
|
-
**技巧 4:保存模板**
|
|
397
|
-
- 生成的模板保存在 `docs/ui/pages/` 目录
|
|
398
|
-
- 可以复用、修改、版本控制
|
|
399
|
-
|
|
400
|
-
---
|
|
401
|
-
|
|
402
|
-
### 7. ui_search(增强版)- UI/UX 智能搜索 🆕
|
|
403
|
-
**用途:** 搜索 UI 组件、颜色方案、图标、设计模式、组件目录、UI 模板
|
|
404
|
-
|
|
405
|
-
**新增模式:**
|
|
406
|
-
- **search 模式**(默认):搜索 UI/UX 数据库
|
|
407
|
-
- **catalog 模式**:查看组件目录
|
|
408
|
-
- **template 模式**:搜索 UI 模板
|
|
409
|
-
|
|
410
|
-
**提问示例:**
|
|
411
|
-
- "查看组件目录"(catalog 模式)
|
|
412
|
-
- "搜索登录表单模板"(template 模式)
|
|
413
|
-
- "我需要一个 React 的主按钮组件"(search 模式)
|
|
414
|
-
|
|
415
|
-
**参数说明:**
|
|
416
|
-
- `mode`: 搜索模式(可选,默认 search)
|
|
417
|
-
- `search`: 搜索 UI/UX 数据
|
|
418
|
-
- `catalog`: 查看组件目录
|
|
419
|
-
- `template`: 搜索 UI 模板
|
|
420
|
-
- `query`: 搜索关键词(catalog 模式不需要)
|
|
421
|
-
- `category`: 数据类别(仅 search 模式)
|
|
422
|
-
- `stack`: 技术栈过滤(仅 search 模式)
|
|
423
|
-
- `limit`: 返回结果数量(默认 10)
|
|
424
|
-
- `min_score`: 最小相关性得分(默认 0)
|
|
425
|
-
|
|
426
|
-
**使用示例:**
|
|
427
|
-
|
|
428
|
-
**示例 1:查看组件目录**
|
|
429
|
-
```
|
|
430
|
-
你: "查看组件目录"
|
|
431
|
-
|
|
432
|
-
AI 调用: ui_search
|
|
433
|
-
参数: { mode: "catalog" }
|
|
434
|
-
|
|
435
|
-
返回:
|
|
436
|
-
📦 组件目录
|
|
437
|
-
共 10 个可用组件
|
|
438
|
-
|
|
439
|
-
1. Button
|
|
440
|
-
描述: 按钮组件
|
|
441
|
-
Props: variant, size, label
|
|
442
|
-
样式: primary, secondary, outline
|
|
443
|
-
|
|
444
|
-
2. Input
|
|
445
|
-
描述: 输入框组件
|
|
446
|
-
Props: label, type, placeholder
|
|
447
|
-
样式: default, error
|
|
448
|
-
...
|
|
449
|
-
```
|
|
450
|
-
|
|
451
|
-
**示例 2:搜索 UI 模板**
|
|
452
|
-
```
|
|
453
|
-
你: "搜索登录表单模板"
|
|
454
|
-
|
|
455
|
-
AI 调用: ui_search
|
|
456
|
-
参数: {
|
|
457
|
-
mode: "template",
|
|
458
|
-
query: "登录表单"
|
|
459
|
-
}
|
|
460
|
-
|
|
461
|
-
返回:
|
|
462
|
-
📄 UI 模板搜索结果
|
|
463
|
-
找到 1 个匹配模板
|
|
464
|
-
|
|
465
|
-
1. LoginForm
|
|
466
|
-
文件: docs/ui/pages/login-form.json
|
|
467
|
-
描述: 登录表单页面
|
|
468
|
-
组件数: 5
|
|
469
|
-
```
|
|
470
|
-
|
|
471
|
-
**示例 3:搜索 UI/UX 数据**
|
|
472
|
-
```
|
|
473
|
-
你: "我需要一个 React 的主按钮组件"
|
|
474
|
-
|
|
475
|
-
AI 调用: ui_search
|
|
476
|
-
参数: {
|
|
477
|
-
mode: "search",
|
|
478
|
-
query: "button primary",
|
|
479
|
-
category: "react",
|
|
480
|
-
limit: 5
|
|
481
|
-
}
|
|
482
|
-
|
|
483
|
-
返回: React 按钮组件的搜索结果
|
|
484
|
-
```
|
|
485
|
-
|
|
486
|
-
---
|
|
487
|
-
|
|
488
|
-
## 🎨 完整 UI 开发工作流
|
|
489
|
-
|
|
490
|
-
### 工作流程图
|
|
491
|
-
|
|
492
|
-
```
|
|
493
|
-
┌─────────────────────────────────────────────────────────────┐
|
|
494
|
-
│ 完整 UI 开发工作流 │
|
|
495
|
-
└─────────────────────────────────────────────────────────────┘
|
|
496
|
-
|
|
497
|
-
第1步:生成设计系统
|
|
498
|
-
↓
|
|
499
|
-
ui_design_system --product_type="SaaS" --stack="react"
|
|
500
|
-
↓
|
|
501
|
-
输出: docs/design-system.md(人类阅读)
|
|
502
|
-
docs/ui/design-system.json(机器读取)
|
|
503
|
-
|
|
504
|
-
第2步:初始化组件目录(可选,start_ui 会自动调用)
|
|
505
|
-
↓
|
|
506
|
-
init_component_catalog
|
|
507
|
-
↓
|
|
508
|
-
输出: docs/ui/component-catalog.json
|
|
509
|
-
|
|
510
|
-
第3步:生成 UI 页面(一键完成)
|
|
511
|
-
↓
|
|
512
|
-
start_ui "登录页面"
|
|
513
|
-
↓
|
|
514
|
-
自动执行:
|
|
515
|
-
├─ 检查设计系统 ✅
|
|
516
|
-
├─ 生成组件目录 🔄
|
|
517
|
-
├─ 生成 UI 模板 🔍
|
|
518
|
-
└─ 渲染最终代码 🎨
|
|
519
|
-
↓
|
|
520
|
-
输出: docs/ui/pages/login-page.json(模板)
|
|
521
|
-
完整的 React 组件代码
|
|
522
|
-
|
|
523
|
-
第4步:生成更多页面
|
|
524
|
-
↓
|
|
525
|
-
start_ui "用户列表"
|
|
526
|
-
start_ui "设置页面"
|
|
527
|
-
↓
|
|
528
|
-
所有页面自动使用相同的设计规范 ✨
|
|
529
|
-
```
|
|
530
|
-
|
|
531
|
-
### 工具关系图
|
|
532
|
-
|
|
533
|
-
```
|
|
534
|
-
基础层(Base Layer)
|
|
535
|
-
├─ ui_design_system → 生成设计规范
|
|
536
|
-
├─ init_component_catalog → 生成组件目录
|
|
537
|
-
└─ ui_search → 搜索数据/模板/组件
|
|
538
|
-
|
|
539
|
-
渲染层(Rendering Layer)
|
|
540
|
-
└─ render_ui → JSON 模板 → 代码
|
|
541
|
-
|
|
542
|
-
编排层(Orchestration Layer)
|
|
543
|
-
└─ start_ui → 一键完成整个流程
|
|
544
|
-
```
|
|
545
|
-
|
|
546
|
-
### 适用场景
|
|
547
|
-
|
|
548
|
-
**场景 1:新项目启动**
|
|
549
|
-
```bash
|
|
550
|
-
# 第1步:生成设计系统
|
|
551
|
-
ui_design_system --product_type="SaaS" --stack="react"
|
|
552
|
-
|
|
553
|
-
# 第2步:生成多个页面
|
|
554
|
-
start_ui "登录页面"
|
|
555
|
-
start_ui "注册页面"
|
|
556
|
-
start_ui "用户列表"
|
|
557
|
-
start_ui "设置页面"
|
|
558
|
-
|
|
559
|
-
# 结果:所有页面样式完全统一 ✨
|
|
560
|
-
```
|
|
561
|
-
|
|
562
|
-
**场景 2:快速原型**
|
|
563
|
-
```bash
|
|
564
|
-
# 一键生成(自动检查设计系统)
|
|
565
|
-
start_ui "登录页面"
|
|
566
|
-
start_ui "数据表格"
|
|
567
|
-
start_ui "表单页面"
|
|
568
|
-
```
|
|
569
|
-
|
|
570
|
-
**场景 3:高级定制**
|
|
571
|
-
```bash
|
|
572
|
-
# 第1步:生成设计系统
|
|
573
|
-
ui_design_system --product_type="E-commerce" --stack="vue"
|
|
574
|
-
|
|
575
|
-
# 第2步:自定义组件目录
|
|
576
|
-
# 编辑 docs/component-catalog.json
|
|
577
|
-
|
|
578
|
-
# 第3步:生成页面
|
|
579
|
-
start_ui "商品列表" --framework=vue
|
|
580
|
-
```
|
|
581
|
-
|
|
582
|
-
---
|
|
583
|
-
|
|
584
|
-
## 🎯 需求访谈工具
|
|
585
|
-
|
|
586
|
-
### 1. interview - 需求访谈模式
|
|
587
|
-
**用途:** 在开发前通过结构化访谈澄清需求,避免理解偏差
|
|
588
|
-
|
|
589
|
-
**核心理念:** 先慢下来,把问题想清楚,反而能更快地交付正确的解决方案
|
|
590
|
-
|
|
591
|
-
**提问示例:**
|
|
592
|
-
- "interview 用户登录功能"
|
|
593
|
-
- "帮我访谈一下这个需求:商品推荐系统"
|
|
594
|
-
- "需求不太明确,先访谈一下"
|
|
595
|
-
|
|
596
|
-
**参数说明:**
|
|
597
|
-
- `description`: 功能描述(必填)
|
|
598
|
-
- `context`: 补充背景(可选)
|
|
599
|
-
|
|
600
|
-
**访谈内容:**
|
|
601
|
-
- **阶段 1**: 背景理解(3个问题)- 痛点、用户、业务驱动
|
|
602
|
-
- **阶段 2**: 功能边界(4个问题)- 核心价值、范围、输入输出
|
|
603
|
-
- **阶段 3**: 技术约束(4个问题)- 技术栈、性能、兼容性、安全
|
|
604
|
-
- **阶段 4**: 验收标准(3个问题)- 成功标准、测试场景、效果衡量
|
|
605
|
-
|
|
606
|
-
**工作流程:**
|
|
607
|
-
```
|
|
608
|
-
1. AI 生成 12-15 个结构化问题
|
|
609
|
-
2. 用户回答所有问题
|
|
610
|
-
3. AI 生成访谈记录 docs/interviews/{feature-name}-interview.md
|
|
611
|
-
4. 用户选择:
|
|
612
|
-
- 立即开发: start_feature --from-interview {feature-name}
|
|
613
|
-
- 生成规格: add_feature --from-interview {feature-name}
|
|
614
|
-
- 稍后开发: 访谈记录已保存,随时可用
|
|
615
|
-
```
|
|
616
|
-
|
|
617
|
-
**适用场景:**
|
|
618
|
-
- ✅ 需求不明确的新功能
|
|
619
|
-
- ✅ 复杂的业务功能
|
|
620
|
-
- ✅ 涉及多方协作的功能
|
|
621
|
-
- ❌ 简单的 Bug 修复
|
|
622
|
-
- ❌ 需求非常明确的功能
|
|
623
|
-
|
|
624
|
-
---
|
|
625
|
-
|
|
626
|
-
### 2. ask_user - AI 主动提问
|
|
627
|
-
**用途:** AI 可在任何时候向用户提问,澄清不确定的信息
|
|
628
|
-
|
|
629
|
-
**提问示例:**
|
|
630
|
-
- AI 会自动调用(当遇到不确定因素时)
|
|
631
|
-
- 用户也可主动触发:"有什么需要我确认的吗?"
|
|
632
|
-
|
|
633
|
-
**参数说明:**
|
|
634
|
-
- `question`: 问题内容(必填)
|
|
635
|
-
- `questions`: 多个问题列表(可选)
|
|
636
|
-
- `options`: 选项列表(可选)
|
|
637
|
-
- `context`: 问题背景(可选)
|
|
638
|
-
- `required`: 是否必答(可选)
|
|
639
|
-
|
|
640
|
-
**使用场景:**
|
|
641
|
-
```
|
|
642
|
-
场景1: 代码审查时
|
|
643
|
-
AI: "发现了性能问题,但不确定优先级"
|
|
644
|
-
调用: ask_user "这个性能问题的优先级如何?是否需要立即优化?"
|
|
645
|
-
|
|
646
|
-
场景2: 技术方案选择
|
|
647
|
-
AI: "可以用两种方案,不确定你的偏好"
|
|
648
|
-
调用: ask_user --options ["方案A: 性能优先", "方案B: 可读性优先"]
|
|
649
|
-
|
|
650
|
-
场景3: Bug 修复时
|
|
651
|
-
AI: "需要确认是否向后兼容"
|
|
652
|
-
调用: ask_user "修复这个 Bug 是否需要保持向后兼容?"
|
|
653
|
-
```
|
|
654
|
-
|
|
655
|
-
---
|
|
656
|
-
|
|
657
|
-
## 📋 基础生成工具
|
|
658
|
-
|
|
659
|
-
### 1. gencommit - 生成 Git 提交信息
|
|
660
|
-
**用途:** 根据代码变更自动生成规范的 commit 消息
|
|
661
|
-
|
|
662
|
-
**提问示例:**
|
|
663
|
-
- "帮我生成这次改动的 commit 消息"
|
|
664
|
-
- "根据当前 git diff 生成 commit"
|
|
665
|
-
- "生成一个 feat 类型的提交信息"
|
|
666
|
-
|
|
667
|
-
**参数说明:**
|
|
668
|
-
- `type`: fix/feat/docs/style/chore/refactor/test
|
|
669
|
-
- `changes`: 代码变更内容(可选,默认使用 git diff)
|
|
670
|
-
|
|
671
|
-
---
|
|
672
|
-
|
|
673
|
-
### 2. gentest - 生成单元测试
|
|
674
|
-
**用途:** 为函数/类/模块生成测试代码
|
|
675
|
-
|
|
676
|
-
**提问示例:**
|
|
677
|
-
- "为这个函数生成单元测试:[粘贴代码]"
|
|
678
|
-
- "生成 Jest 测试用例"
|
|
679
|
-
- "帮我写这个组件的测试"
|
|
680
|
-
|
|
681
|
-
**参数说明:**
|
|
682
|
-
- `code`: 需要测试的代码(必填)
|
|
683
|
-
- `framework`: jest/vitest/mocha(可选)
|
|
684
|
-
|
|
685
|
-
---
|
|
686
|
-
|
|
687
|
-
### 3. genapi - 生成 API 文档
|
|
688
|
-
**用途:** 根据接口代码生成文档
|
|
689
|
-
|
|
690
|
-
**提问示例:**
|
|
691
|
-
- "为这个 API 生成文档:[粘贴路由代码]"
|
|
692
|
-
- "生成 OpenAPI 格式的接口文档"
|
|
693
|
-
- "帮我写这个 Controller 的 API 文档"
|
|
694
|
-
|
|
695
|
-
**参数说明:**
|
|
696
|
-
- `code`: API 代码(必填)
|
|
697
|
-
- `format`: markdown/openapi/jsdoc
|
|
698
|
-
|
|
699
|
-
---
|
|
700
|
-
|
|
701
|
-
### 4. gendoc - 生成代码注释
|
|
702
|
-
**用途:** 为代码补充 JSDoc/TSDoc 注释
|
|
703
|
-
|
|
704
|
-
**提问示例:**
|
|
705
|
-
- "为这个函数添加注释:[粘贴代码]"
|
|
706
|
-
- "生成 TSDoc 格式的注释"
|
|
707
|
-
- "补充这个类的文档注释"
|
|
708
|
-
|
|
709
|
-
**参数说明:**
|
|
710
|
-
- `code`: 需要注释的代码(必填)
|
|
711
|
-
- `style`: jsdoc/tsdoc/javadoc
|
|
712
|
-
- `lang`: zh/en
|
|
713
|
-
|
|
714
|
-
---
|
|
715
|
-
|
|
716
|
-
### 5. genreadme - 生成 README
|
|
717
|
-
**用途:** 生成项目说明文档
|
|
718
|
-
|
|
719
|
-
**提问示例:**
|
|
720
|
-
- "为这个项目生成 README"
|
|
721
|
-
- "生成详细版的 README 文档"
|
|
722
|
-
- "帮我写项目介绍文档"
|
|
723
|
-
|
|
724
|
-
**参数说明:**
|
|
725
|
-
- `project_info`: 项目信息或代码(必填)
|
|
726
|
-
- `style`: standard/minimal/detailed
|
|
727
|
-
|
|
728
|
-
---
|
|
729
|
-
|
|
730
|
-
### 6. genchangelog - 生成变更日志
|
|
731
|
-
**用途:** 根据 commit 历史生成 CHANGELOG
|
|
732
|
-
|
|
733
|
-
**提问示例:**
|
|
734
|
-
- "生成 v1.2.0 的 CHANGELOG"
|
|
735
|
-
- "从 v1.0.0 到现在的变更日志"
|
|
736
|
-
- "帮我整理这个版本的更新内容"
|
|
737
|
-
|
|
738
|
-
**参数说明:**
|
|
739
|
-
- `version`: 版本号(必填)
|
|
740
|
-
- `from`: 起始 tag/commit
|
|
741
|
-
- `to`: 结束 tag/commit
|
|
742
|
-
|
|
743
|
-
---
|
|
744
|
-
|
|
745
|
-
### 7. genpr - 生成 PR 描述
|
|
746
|
-
**用途:** 生成 Pull Request 说明
|
|
747
|
-
|
|
748
|
-
**提问示例:**
|
|
749
|
-
- "为当前分支生成 PR 描述"
|
|
750
|
-
- "根据 commit 历史生成 PR 说明"
|
|
751
|
-
- "帮我写 PR 文档"
|
|
752
|
-
|
|
753
|
-
**参数说明:**
|
|
754
|
-
- `branch`: 分支名称(可选)
|
|
755
|
-
- `commits`: commit 历史(可选)
|
|
756
|
-
|
|
757
|
-
---
|
|
758
|
-
|
|
759
|
-
### 8. gensql - 自然语言转 SQL
|
|
760
|
-
**用途:** 根据描述生成 SQL 语句
|
|
761
|
-
|
|
762
|
-
**提问示例:**
|
|
763
|
-
- "查询所有状态为已发布的商品,按创建时间倒序"
|
|
764
|
-
- "生成一个联表查询,关联用户和订单表"
|
|
765
|
-
- "写一个统计每个分类下商品数量的 SQL"
|
|
766
|
-
|
|
767
|
-
**参数说明:**
|
|
768
|
-
- `description`: 查询需求描述(必填)
|
|
769
|
-
- `dialect`: postgres/mysql/sqlite
|
|
770
|
-
|
|
771
|
-
---
|
|
772
|
-
|
|
773
|
-
### 9. genui - 生成 UI 组件
|
|
774
|
-
**用途:** 根据描述生成前端组件代码
|
|
775
|
-
|
|
776
|
-
**提问示例:**
|
|
777
|
-
- "生成一个带搜索的表格组件"
|
|
778
|
-
- "创建一个 Vue 的用户卡片组件"
|
|
779
|
-
- "帮我写一个 React 的表单组件"
|
|
780
|
-
|
|
781
|
-
**参数说明:**
|
|
782
|
-
- `description`: 组件功能描述(必填)
|
|
783
|
-
- `framework`: react/vue/html
|
|
784
|
-
|
|
785
|
-
---
|
|
786
|
-
|
|
787
|
-
### 10. gen_mock - 生成 Mock 数据
|
|
788
|
-
**用途:** 根据类型定义生成测试数据
|
|
789
|
-
|
|
790
|
-
**提问示例:**
|
|
791
|
-
- "根据这个接口生成 10 条 mock 数据:[粘贴 interface]"
|
|
792
|
-
- "生成用户列表的测试数据"
|
|
793
|
-
- "帮我造一些商品数据"
|
|
794
|
-
|
|
795
|
-
**参数说明:**
|
|
796
|
-
- `schema`: 数据结构定义(必填)
|
|
797
|
-
- `count`: 生成数量(默认 1)
|
|
798
|
-
- `format`: json/typescript/javascript/csv
|
|
799
|
-
- `locale`: zh-CN/en-US
|
|
800
|
-
|
|
801
|
-
---
|
|
802
|
-
|
|
803
|
-
### 11. gen_skill - 生成 Agent Skills 文档
|
|
804
|
-
**用途:** 为工具生成技能文档
|
|
805
|
-
|
|
806
|
-
**提问示例:**
|
|
807
|
-
- "生成所有工具的技能文档"
|
|
808
|
-
- "为 code_review 生成 SKILL.md"
|
|
809
|
-
- "导出工具使用说明"
|
|
810
|
-
|
|
811
|
-
**参数说明:**
|
|
812
|
-
- `scope`: all/basic/generation/analysis(可选)
|
|
813
|
-
- `tool_name`: 指定工具名称(可选)
|
|
814
|
-
- `lang`: zh/en
|
|
815
|
-
- `output_dir`: 输出目录(可选)
|
|
816
|
-
|
|
817
|
-
---
|
|
818
|
-
|
|
819
|
-
### 12. design2code - 设计稿转代码
|
|
820
|
-
**用途:** 将设计稿转换为前端代码
|
|
821
|
-
|
|
822
|
-
**提问示例:**
|
|
823
|
-
- "根据这个设计稿生成代码:[图片 URL]"
|
|
824
|
-
- "把这个 UI 转成 Vue 组件"
|
|
825
|
-
- "实现这个页面布局:[描述或图片]"
|
|
826
|
-
|
|
827
|
-
**参数说明:**
|
|
828
|
-
- `input`: 图片 URL/base64/HTML/描述(必填)
|
|
829
|
-
- `framework`: vue/react
|
|
830
|
-
- `component_type`: page/component
|
|
831
|
-
- `style_solution`: tailwind/css-modules/styled-components
|
|
832
|
-
|
|
833
|
-
---
|
|
834
|
-
|
|
835
|
-
## 🔍 分析诊断工具
|
|
836
|
-
|
|
837
|
-
### 1. debug - 错误调试分析
|
|
838
|
-
**用途:** 分析错误信息,定位问题根因
|
|
839
|
-
|
|
840
|
-
**提问示例:**
|
|
841
|
-
- "帮我调试这个错误:TypeError: Cannot read property 'map' of undefined at ProductList.vue:45"
|
|
842
|
-
- "分析这个报错:[粘贴完整错误堆栈]"
|
|
843
|
-
- "为什么会出现这个问题:[描述错误现象]"
|
|
844
|
-
|
|
845
|
-
**参数说明:**
|
|
846
|
-
- `error`: 完整错误信息(必填)
|
|
847
|
-
- `context`: 相关代码、复现步骤
|
|
848
|
-
|
|
849
|
-
---
|
|
850
|
-
|
|
851
|
-
### 2. code_review - 代码审查
|
|
852
|
-
**用途:** 审查代码质量、安全性、性能
|
|
853
|
-
|
|
854
|
-
**提问示例:**
|
|
855
|
-
- "审查这段代码:[粘贴代码]"
|
|
856
|
-
- "检查这个文件的安全问题"
|
|
857
|
-
- "帮我 review 这个 PR 的代码"
|
|
858
|
-
|
|
859
|
-
**参数说明:**
|
|
860
|
-
- `code`: 代码内容(必填)
|
|
861
|
-
- `focus`: quality/security/performance/all
|
|
862
|
-
|
|
863
|
-
---
|
|
864
|
-
|
|
865
|
-
### 3. security_scan - 安全扫描
|
|
866
|
-
**用途:** 专项安全漏洞检测
|
|
867
|
-
|
|
868
|
-
**提问示例:**
|
|
869
|
-
- "扫描这段代码的安全问题:[粘贴代码]"
|
|
870
|
-
- "检查 SQL 注入风险"
|
|
871
|
-
- "分析这个接口的安全隐患"
|
|
872
|
-
|
|
873
|
-
**参数说明:**
|
|
874
|
-
- `code`: 代码内容(必填)
|
|
875
|
-
- `scan_type`: all/injection/auth/crypto/sensitive_data
|
|
876
|
-
|
|
877
|
-
---
|
|
878
|
-
|
|
879
|
-
### 4. perf - 性能分析
|
|
880
|
-
**用途:** 分析性能瓶颈
|
|
881
|
-
|
|
882
|
-
**提问示例:**
|
|
883
|
-
- "分析这段代码的性能问题:[粘贴代码]"
|
|
884
|
-
- "检查这个循环的性能"
|
|
885
|
-
- "优化这个 React 组件的渲染"
|
|
886
|
-
|
|
887
|
-
**参数说明:**
|
|
888
|
-
- `code`: 代码内容(必填)
|
|
889
|
-
- `type`: algorithm/memory/react/database/all
|
|
890
|
-
|
|
891
|
-
---
|
|
892
|
-
|
|
893
|
-
### 5. check_deps - 依赖检查
|
|
894
|
-
**用途:** 检查依赖健康度和安全漏洞
|
|
895
|
-
|
|
896
|
-
**提问示例:**
|
|
897
|
-
- "检查项目依赖的安全问题"
|
|
898
|
-
- "分析 package.json 的依赖版本"
|
|
899
|
-
- "有哪些依赖需要升级"
|
|
900
|
-
|
|
901
|
-
**无需参数**
|
|
902
|
-
|
|
903
|
-
---
|
|
904
|
-
|
|
905
|
-
### 6. explain - 代码解释
|
|
906
|
-
**用途:** 解释代码逻辑和实现原理
|
|
907
|
-
|
|
908
|
-
**提问示例:**
|
|
909
|
-
- "解释这段代码的作用:[粘贴代码]"
|
|
910
|
-
- "这个函数是怎么工作的"
|
|
911
|
-
- "帮我理解这个算法"
|
|
912
|
-
|
|
913
|
-
**参数说明:**
|
|
914
|
-
- `code`: 代码内容(必填)
|
|
915
|
-
- `context`: 补充说明(可选)
|
|
916
|
-
|
|
917
|
-
---
|
|
918
|
-
|
|
919
|
-
### 7. analyze_project - 项目分析
|
|
920
|
-
**用途:** 分析项目结构、技术栈、架构
|
|
921
|
-
|
|
922
|
-
**提问示例:**
|
|
923
|
-
- "分析当前项目的结构"
|
|
924
|
-
- "生成项目技术栈报告"
|
|
925
|
-
- "帮我了解这个项目的架构"
|
|
926
|
-
|
|
927
|
-
**参数说明:**
|
|
928
|
-
- `project_path`: 项目路径(可选)
|
|
929
|
-
- `max_depth`: 目录深度(默认 5)
|
|
930
|
-
- `include_content`: 是否包含文件内容
|
|
931
|
-
|
|
932
|
-
---
|
|
933
|
-
|
|
934
|
-
## 🔧 重构优化工具
|
|
935
|
-
|
|
936
|
-
### 1. refactor - 重构建议
|
|
937
|
-
**用途:** 提供代码重构方案
|
|
938
|
-
|
|
939
|
-
**提问示例:**
|
|
940
|
-
- "这段代码如何重构:[粘贴代码]"
|
|
941
|
-
- "帮我优化这个函数的可读性"
|
|
942
|
-
- "提取这段重复代码"
|
|
943
|
-
|
|
944
|
-
**参数说明:**
|
|
945
|
-
- `code`: 代码内容(必填)
|
|
946
|
-
- `goal`: improve_readability/reduce_complexity/extract_function/remove_duplication
|
|
947
|
-
|
|
948
|
-
---
|
|
949
|
-
|
|
950
|
-
### 2. fix - 自动修复
|
|
951
|
-
**用途:** 自动修复 Lint/格式化/类型错误
|
|
952
|
-
|
|
953
|
-
**提问示例:**
|
|
954
|
-
- "修复这段代码的 Lint 错误:[粘贴代码]"
|
|
955
|
-
- "自动格式化这个文件"
|
|
956
|
-
- "修复 TypeScript 类型错误"
|
|
957
|
-
|
|
958
|
-
**参数说明:**
|
|
959
|
-
- `code`: 代码内容(必填)
|
|
960
|
-
- `type`: lint/type/format/import/unused/all
|
|
961
|
-
|
|
962
|
-
---
|
|
963
|
-
|
|
964
|
-
### 3. convert - 代码转换
|
|
965
|
-
**用途:** 转换代码格式或框架
|
|
966
|
-
|
|
967
|
-
**提问示例:**
|
|
968
|
-
- "把这段 JS 转成 TS:[粘贴代码]"
|
|
969
|
-
- "将 Vue2 代码转换为 Vue3"
|
|
970
|
-
- "Class 组件改成 Hooks"
|
|
971
|
-
|
|
972
|
-
**参数说明:**
|
|
973
|
-
- `code`: 源代码(必填)
|
|
974
|
-
- `from`: 源格式(js/ts/vue2/vue3/class/hooks)
|
|
975
|
-
- `to`: 目标格式
|
|
976
|
-
|
|
977
|
-
---
|
|
978
|
-
|
|
979
|
-
### 4. split - 文件拆分
|
|
980
|
-
**用途:** 拆分大文件为小模块
|
|
981
|
-
|
|
982
|
-
**提问示例:**
|
|
983
|
-
- "拆分这个大文件:[粘贴代码]"
|
|
984
|
-
- "按功能拆分这个组件"
|
|
985
|
-
- "帮我模块化这段代码"
|
|
986
|
-
|
|
987
|
-
**参数说明:**
|
|
988
|
-
- `file`: 文件内容或路径(必填)
|
|
989
|
-
- `strategy`: auto/type/function/component/feature
|
|
990
|
-
|
|
991
|
-
---
|
|
992
|
-
|
|
993
|
-
### 5. resolve_conflict - 解决冲突
|
|
994
|
-
**用途:** 分析并解决 Git 合并冲突
|
|
995
|
-
|
|
996
|
-
**提问示例:**
|
|
997
|
-
- "帮我解决这个合并冲突:[粘贴冲突内容]"
|
|
998
|
-
- "分析这个 conflict 应该保留哪边"
|
|
999
|
-
- "合并这两个版本的代码"
|
|
1000
|
-
|
|
1001
|
-
**参数说明:**
|
|
1002
|
-
- `conflicts`: 冲突文件内容(必填)
|
|
1003
|
-
|
|
1004
|
-
---
|
|
1005
|
-
|
|
1006
|
-
### 6. design2code - 设计稿转代码
|
|
1007
|
-
**用途:** 将设计稿转换为前端代码
|
|
1008
|
-
|
|
1009
|
-
**提问示例:**
|
|
1010
|
-
- "根据这个设计稿生成代码:[图片 URL]"
|
|
1011
|
-
- "把这个 UI 转成 Vue 组件"
|
|
1012
|
-
- "实现这个页面布局:[描述或图片]"
|
|
1013
|
-
|
|
1014
|
-
**参数说明:**
|
|
1015
|
-
- `input`: 图片 URL/base64/HTML/描述(必填)
|
|
1016
|
-
- `framework`: vue/react
|
|
1017
|
-
- `component_type`: page/component
|
|
1018
|
-
- `style_solution`: tailwind/css-modules/styled-components
|
|
1019
|
-
|
|
1020
|
-
---
|
|
1021
|
-
|
|
1022
|
-
## 🎯 工作流编排工具
|
|
1023
|
-
|
|
1024
|
-
### 1. start_feature - 新功能开发流程
|
|
1025
|
-
**用途:** 完整的新功能开发编排
|
|
1026
|
-
|
|
1027
|
-
**提问示例:**
|
|
1028
|
-
- "开始开发用户认证功能"
|
|
1029
|
-
- "新增商品推荐模块"
|
|
1030
|
-
- "创建订单管理功能"
|
|
1031
|
-
|
|
1032
|
-
**参数说明:**
|
|
1033
|
-
- `feature_name`: 功能名称(必填)
|
|
1034
|
-
- `description`: 功能描述(必填)
|
|
1035
|
-
- `docs_dir`: 文档目录(可选)
|
|
1036
|
-
|
|
1037
|
-
**流程:** 检查上下文 → 生成规格 → 估算工作量
|
|
1038
|
-
|
|
1039
|
-
---
|
|
1040
|
-
|
|
1041
|
-
### 2. start_bugfix - Bug 修复流程
|
|
1042
|
-
**用途:** 完整的 Bug 修复编排
|
|
1043
|
-
|
|
1044
|
-
**提问示例:**
|
|
1045
|
-
- "修复这个 Bug:点击推荐按钮报错"
|
|
1046
|
-
- "解决登录失败的问题"
|
|
1047
|
-
- "处理这个错误:[粘贴错误信息]"
|
|
1048
|
-
|
|
1049
|
-
**参数说明:**
|
|
1050
|
-
- `error_message`: 错误信息(必填)
|
|
1051
|
-
- `stack_trace`: 堆栈跟踪(可选)
|
|
1052
|
-
|
|
1053
|
-
**流程:** 检查上下文 → 分析定位 → 修复方案 → 生成测试
|
|
1054
|
-
|
|
1055
|
-
---
|
|
1056
|
-
|
|
1057
|
-
### 3. start_review - 代码全面体检
|
|
1058
|
-
**用途:** 代码审查 + 安全扫描 + 性能分析
|
|
1059
|
-
|
|
1060
|
-
**提问示例:**
|
|
1061
|
-
- "全面审查这段代码:[粘贴代码]"
|
|
1062
|
-
- "对这个文件做完整的代码体检"
|
|
1063
|
-
- "综合分析这个模块的质量"
|
|
1064
|
-
|
|
1065
|
-
**参数说明:**
|
|
1066
|
-
- `code`: 代码内容(必填)
|
|
1067
|
-
- `language`: 编程语言(可选)
|
|
1068
|
-
|
|
1069
|
-
---
|
|
1070
|
-
|
|
1071
|
-
### 4. start_release - 发布准备流程
|
|
1072
|
-
**用途:** 生成 Changelog + PR 描述
|
|
1073
|
-
|
|
1074
|
-
**提问示例:**
|
|
1075
|
-
- "准备发布 v1.2.0"
|
|
1076
|
-
- "生成这个版本的发布文档"
|
|
1077
|
-
- "整理发布内容"
|
|
1078
|
-
|
|
1079
|
-
**参数说明:**
|
|
1080
|
-
- `version`: 版本号(必填)
|
|
1081
|
-
- `from_tag`: 起始 tag(可选)
|
|
1082
|
-
- `branch`: 分支名称(可选)
|
|
1083
|
-
|
|
1084
|
-
---
|
|
1085
|
-
|
|
1086
|
-
### 5. start_refactor - 重构流程
|
|
1087
|
-
**用途:** 审查现状 → 重构建议 → 生成测试
|
|
1088
|
-
|
|
1089
|
-
**提问示例:**
|
|
1090
|
-
- "重构这段代码:[粘贴代码]"
|
|
1091
|
-
- "优化这个模块的结构"
|
|
1092
|
-
- "改进代码可读性"
|
|
1093
|
-
|
|
1094
|
-
**参数说明:**
|
|
1095
|
-
- `code`: 代码内容(必填)
|
|
1096
|
-
- `goal`: 重构目标(可选)
|
|
1097
|
-
|
|
1098
|
-
---
|
|
1099
|
-
|
|
1100
|
-
### 6. start_onboard - 快速上手流程
|
|
1101
|
-
**用途:** 分析项目 → 生成上下文文档
|
|
1102
|
-
|
|
1103
|
-
**提问示例:**
|
|
1104
|
-
- "帮我快速了解这个项目"
|
|
1105
|
-
- "生成项目上手文档"
|
|
1106
|
-
- "分析项目结构并生成说明"
|
|
1107
|
-
|
|
1108
|
-
**参数说明:**
|
|
1109
|
-
- `project_path`: 项目路径(可选)
|
|
1110
|
-
- `docs_dir`: 文档目录(可选)
|
|
1111
|
-
|
|
1112
|
-
---
|
|
1113
|
-
|
|
1114
|
-
### 7. start_api - API 开发流程
|
|
1115
|
-
**用途:** 生成文档 → 生成 Mock → 生成测试
|
|
1116
|
-
|
|
1117
|
-
**提问示例:**
|
|
1118
|
-
- "为这个 API 生成完整文档:[粘贴代码]"
|
|
1119
|
-
- "开发这个接口的完整流程"
|
|
1120
|
-
- "生成 API 文档和测试"
|
|
1121
|
-
|
|
1122
|
-
**参数说明:**
|
|
1123
|
-
- `code`: API 代码(必填)
|
|
1124
|
-
- `format`: markdown/openapi
|
|
1125
|
-
- `language`: 编程语言(可选)
|
|
1126
|
-
|
|
1127
|
-
---
|
|
1128
|
-
|
|
1129
|
-
### 8. start_doc - 文档补全流程
|
|
1130
|
-
**用途:** 注释 → README → API 文档
|
|
1131
|
-
|
|
1132
|
-
**提问示例:**
|
|
1133
|
-
- "为这个项目补全所有文档"
|
|
1134
|
-
- "生成完整的项目文档"
|
|
1135
|
-
- "补充代码注释和说明"
|
|
1136
|
-
|
|
1137
|
-
**参数说明:**
|
|
1138
|
-
- `code`: 代码或项目信息(必填)
|
|
1139
|
-
- `lang`: zh/en
|
|
1140
|
-
- `style`: jsdoc/tsdoc
|
|
1141
|
-
|
|
1142
|
-
---
|
|
1143
|
-
|
|
1144
|
-
### 9. start_ralph - Ralph Wiggum Loop 循环开发 🆕
|
|
1145
|
-
**用途:** 生成 Ralph Loop 工作目录和安全模式脚本,实现循环迭代开发
|
|
1146
|
-
|
|
1147
|
-
**核心理念:** 通过循环喂同一个 PROMPT 让 agent 多轮迭代完成任务,同时提供多重安全保护防止无人值守时费用失控
|
|
1148
|
-
|
|
1149
|
-
**提问示例:**
|
|
1150
|
-
- "启动 Ralph Loop 开发用户认证功能"
|
|
1151
|
-
- "用 Ralph 模式修复登录 bug"
|
|
1152
|
-
- "创建 Ralph Loop 循环开发环境"
|
|
1153
|
-
|
|
1154
|
-
**参数说明:**
|
|
1155
|
-
- `goal`: 目标描述(必填)- 例如:"实现用户认证功能"
|
|
1156
|
-
- `mode`: safe(安全模式,默认)/ normal(普通模式)
|
|
1157
|
-
- `completion_promise`: 完成条件(可选)- 默认:"tests passing + requirements met"
|
|
1158
|
-
- `test_command`: 测试命令(可选)- 默认:"npm test"
|
|
1159
|
-
- `cli_command`: CLI 命令名(可选)- 默认:"claude-code"
|
|
1160
|
-
- `max_iterations`: 最大迭代次数(可选)- safe 默认:8
|
|
1161
|
-
- `max_minutes`: 最大运行分钟(可选)- safe 默认:25
|
|
1162
|
-
- `confirm_every`: 确认频率(可选)- safe 默认:1(每轮确认)
|
|
1163
|
-
- `confirm_timeout`: 确认超时秒数(可选)- safe 默认:20
|
|
1164
|
-
- `max_same_output`: 最大重复次数(可选)- safe 默认:2
|
|
1165
|
-
- `max_diff_lines`: 最大变更行数(可选)- safe 默认:300
|
|
1166
|
-
- `cooldown_seconds`: 冷却时间(可选)- safe 默认:8
|
|
1167
|
-
|
|
1168
|
-
**生成内容:**
|
|
1169
|
-
```
|
|
1170
|
-
.ralph/
|
|
1171
|
-
├── PROMPT.md # 循环 prompt(含目标、规则、退出条件)
|
|
1172
|
-
├── @fix_plan.md # 任务分解清单(agent 更新)
|
|
1173
|
-
├── PROGRESS.md # 迭代日志(agent 更新)
|
|
1174
|
-
├── ralph_loop_safe.sh # 安全模式脚本(默认,推荐)
|
|
1175
|
-
└── ralph_loop.sh # 普通模式脚本(可选)
|
|
1176
|
-
```
|
|
1177
|
-
|
|
1178
|
-
**安全保护机制(Safe Mode):**
|
|
1179
|
-
1. **硬上限**
|
|
1180
|
-
- 最大迭代次数:达到上限必停
|
|
1181
|
-
- 最大运行时间:达到时长必停
|
|
1182
|
-
|
|
1183
|
-
2. **人工确认**
|
|
1184
|
-
- 每轮提示确认(可配置频率)
|
|
1185
|
-
- 超时自动停止(默认 20 秒)
|
|
1186
|
-
- 非交互环境拒绝运行
|
|
1187
|
-
|
|
1188
|
-
3. **紧急停止**
|
|
1189
|
-
- 创建 `STOP` 文件立即退出
|
|
1190
|
-
- Ctrl+C 手动停止
|
|
1191
|
-
|
|
1192
|
-
4. **失控保护**
|
|
1193
|
-
- 输出重复检测(避免卡死循环)
|
|
1194
|
-
- Git diff 变更量检测(超过阈值停止)
|
|
1195
|
-
- 冷却时间(降低请求频率)
|
|
1196
|
-
|
|
1197
|
-
5. **双门控退出**
|
|
1198
|
-
- 必须同时满足:`COMPLETION_PROMISE_MET: true` + `EXIT_SIGNAL: true`
|
|
1199
|
-
- 避免误判提前退出
|
|
1200
|
-
|
|
1201
|
-
**使用流程:**
|
|
1202
|
-
```bash
|
|
1203
|
-
# 1. 生成 Ralph Loop 环境
|
|
1204
|
-
claude-code "使用 start_ralph 启动开发,goal='实现用户认证功能'"
|
|
1205
|
-
|
|
1206
|
-
# 2. 创建 .ralph 目录并复制文件
|
|
1207
|
-
mkdir -p .ralph
|
|
1208
|
-
cd .ralph
|
|
1209
|
-
# 复制生成的 PROMPT.md、@fix_plan.md、PROGRESS.md、脚本文件
|
|
1210
|
-
|
|
1211
|
-
# 3. 运行安全模式脚本
|
|
1212
|
-
chmod +x ralph_loop_safe.sh
|
|
1213
|
-
./ralph_loop_safe.sh
|
|
1214
|
-
|
|
1215
|
-
# 4. 监控进度
|
|
1216
|
-
tail -f ralph.log # 查看日志
|
|
1217
|
-
cat PROGRESS.md # 查看进度
|
|
1218
|
-
cat @fix_plan.md # 查看任务
|
|
1219
|
-
|
|
1220
|
-
# 5. 紧急停止(如需要)
|
|
1221
|
-
touch STOP
|
|
1222
|
-
```
|
|
1223
|
-
|
|
1224
|
-
**调整参数:**
|
|
1225
|
-
```bash
|
|
1226
|
-
# 增加最大迭代次数
|
|
1227
|
-
MAX_ITERS=15 ./ralph_loop_safe.sh
|
|
1228
|
-
|
|
1229
|
-
# 延长运行时间
|
|
1230
|
-
MAX_MINUTES=40 ./ralph_loop_safe.sh
|
|
1231
|
-
|
|
1232
|
-
# 使用不同的 CLI 命令
|
|
1233
|
-
CLI_COMMAND='claude' ./ralph_loop_safe.sh
|
|
1234
|
-
|
|
1235
|
-
# 减少确认频率(每 3 轮确认一次)
|
|
1236
|
-
CONFIRM_EVERY=3 ./ralph_loop_safe.sh
|
|
1237
|
-
```
|
|
1238
|
-
|
|
1239
|
-
**与其他工具协同:**
|
|
1240
|
-
```bash
|
|
1241
|
-
# 推荐工作流:
|
|
1242
|
-
# 1. 生成项目上下文
|
|
1243
|
-
claude-code "使用 init_project_context 生成项目文档"
|
|
1244
|
-
|
|
1245
|
-
# 2. 生成功能规格(可选)
|
|
1246
|
-
claude-code "使用 start_feature 生成用户认证功能规格"
|
|
1247
|
-
|
|
1248
|
-
# 3. 启动 Ralph Loop
|
|
1249
|
-
claude-code "使用 start_ralph 启动开发,goal='实现 docs/specs/user-auth/ 中的功能'"
|
|
1250
|
-
|
|
1251
|
-
# 4. 执行循环
|
|
1252
|
-
cd .ralph && ./ralph_loop_safe.sh
|
|
1253
|
-
```
|
|
1254
|
-
|
|
1255
|
-
**适用场景:**
|
|
1256
|
-
- ✅ 需要多轮迭代的复杂功能开发
|
|
1257
|
-
- ✅ Bug 修复需要多次尝试
|
|
1258
|
-
- ✅ 代码重构需要小步快跑
|
|
1259
|
-
- ✅ 测试驱动开发(TDD)流程
|
|
1260
|
-
- ❌ 简单的一次性任务
|
|
1261
|
-
- ❌ 需要大量人工决策的任务
|
|
1262
|
-
|
|
1263
|
-
**注意事项:**
|
|
1264
|
-
- 默认安全模式非常保守,适合首次使用
|
|
1265
|
-
- 确保测试命令正确(首轮会自动识别)
|
|
1266
|
-
- 在 git 仓库中使用效果最佳
|
|
1267
|
-
- 监控 API 费用,避免超支
|
|
1268
|
-
- 普通模式无确认,谨慎使用
|
|
1269
|
-
|
|
1270
|
-
---
|
|
1271
|
-
|
|
1272
|
-
## 🏗️ 项目管理工具
|
|
1273
|
-
|
|
1274
|
-
### 1. init_project - 初始化项目
|
|
1275
|
-
**用途:** 创建项目结构和任务分解
|
|
1276
|
-
|
|
1277
|
-
**提问示例:**
|
|
1278
|
-
- "初始化一个电商管理系统项目"
|
|
1279
|
-
- "创建博客系统的项目结构"
|
|
1280
|
-
- "搭建新项目框架"
|
|
1281
|
-
|
|
1282
|
-
**参数说明:**
|
|
1283
|
-
- `project_name`: 项目名称(可选)
|
|
1284
|
-
- `input`: 项目需求描述(可选)
|
|
1285
|
-
|
|
1286
|
-
---
|
|
1287
|
-
|
|
1288
|
-
### 2. init_project_context - 生成项目上下文
|
|
1289
|
-
**用途:** 生成技术栈/架构/编码规范文档
|
|
1290
|
-
|
|
1291
|
-
**提问示例:**
|
|
1292
|
-
- "生成项目上下文文档"
|
|
1293
|
-
- "创建开发规范文档"
|
|
1294
|
-
- "整理项目技术文档"
|
|
1295
|
-
|
|
1296
|
-
**参数说明:**
|
|
1297
|
-
- `docs_dir`: 文档目录(可选)
|
|
1298
|
-
|
|
1299
|
-
---
|
|
1300
|
-
|
|
1301
|
-
### 3. add_feature - 添加功能规格
|
|
1302
|
-
**用途:** 生成功能需求/设计/任务清单
|
|
1303
|
-
|
|
1304
|
-
**提问示例:**
|
|
1305
|
-
- "添加用户权限管理功能"
|
|
1306
|
-
- "新增商品评论模块"
|
|
1307
|
-
- "创建数据导出功能"
|
|
1308
|
-
|
|
1309
|
-
**参数说明:**
|
|
1310
|
-
- `feature_name`: 功能名称(必填)
|
|
1311
|
-
- `description`: 功能描述(必填)
|
|
1312
|
-
- `docs_dir`: 文档目录(可选)
|
|
1313
|
-
|
|
1314
|
-
---
|
|
1315
|
-
|
|
1316
|
-
### 4. fix_bug - Bug 修复指导
|
|
1317
|
-
**用途:** 根因分析 + 修复方案 + 验证步骤
|
|
1318
|
-
|
|
1319
|
-
**提问示例:**
|
|
1320
|
-
- "指导修复这个 Bug:[描述问题]"
|
|
1321
|
-
- "提供 Bug 修复方案"
|
|
1322
|
-
- "如何解决这个问题"
|
|
1323
|
-
|
|
1324
|
-
**参数说明:**
|
|
1325
|
-
- `error_message`: 错误信息(必填)
|
|
1326
|
-
- `stack_trace`: 堆栈跟踪(可选)
|
|
1327
|
-
- `expected_behavior`: 期望行为(可选)
|
|
1328
|
-
- `actual_behavior`: 实际行为(可选)
|
|
1329
|
-
|
|
1330
|
-
---
|
|
1331
|
-
|
|
1332
|
-
### 5. estimate - 工作量估算
|
|
1333
|
-
**用途:** 估算开发时间和风险
|
|
1334
|
-
|
|
1335
|
-
**提问示例:**
|
|
1336
|
-
- "估算这个功能的开发时间:[描述需求]"
|
|
1337
|
-
- "评估工作量:实现用户登录模块"
|
|
1338
|
-
- "这个任务需要多久"
|
|
1339
|
-
|
|
1340
|
-
**参数说明:**
|
|
1341
|
-
- `task_description`: 任务描述(必填)
|
|
1342
|
-
- `code_context`: 相关代码(可选)
|
|
1343
|
-
- `experience_level`: junior/mid/senior
|
|
1344
|
-
- `team_size`: 团队规模(可选)
|
|
1345
|
-
|
|
1346
|
-
---
|
|
1347
|
-
|
|
1348
|
-
## 🛠️ 其他工具
|
|
1349
|
-
|
|
1350
|
-
### 1. detect_shell - 检测 AI 环境
|
|
1351
|
-
**用途:** 识别是否为套壳产品
|
|
1352
|
-
|
|
1353
|
-
**提问示例:**
|
|
1354
|
-
- "检测当前 AI 环境"
|
|
1355
|
-
- "分析环境指纹"
|
|
1356
|
-
|
|
1357
|
-
**参数说明:**
|
|
1358
|
-
- `nonce`: 随机字符串(可选)
|
|
1359
|
-
- `skip_network`: 是否跳过网络探测(可选)
|
|
1360
|
-
|
|
1361
|
-
---
|
|
1362
|
-
|
|
1363
|
-
### 2. init_setting - 初始化 Cursor 配置
|
|
1364
|
-
**用途:** 写入推荐的 AI 设置
|
|
1365
|
-
|
|
1366
|
-
**提问示例:**
|
|
1367
|
-
- "初始化 Cursor 配置"
|
|
1368
|
-
- "设置推荐的 AI 参数"
|
|
1369
|
-
|
|
1370
|
-
**参数说明:**
|
|
1371
|
-
- `project_path`: 项目路径(可选)
|
|
1372
|
-
|
|
1373
|
-
---
|
|
1374
|
-
|
|
1375
|
-
### 3. css_order - CSS 属性排序
|
|
1376
|
-
**用途:** 按规范重排 CSS 属性
|
|
1377
|
-
|
|
1378
|
-
**提问示例:**
|
|
1379
|
-
- "整理这段 CSS 的属性顺序"
|
|
1380
|
-
- "规范化 CSS 代码"
|
|
1381
|
-
|
|
1382
|
-
**无需参数**
|
|
1383
|
-
|
|
1384
|
-
---
|
|
1385
|
-
|
|
1386
|
-
### 4. gen_skill - 生成 Agent Skills 文档
|
|
1387
|
-
**用途:** 为工具生成技能文档
|
|
1388
|
-
|
|
1389
|
-
**提问示例:**
|
|
1390
|
-
- "生成所有工具的技能文档"
|
|
1391
|
-
- "导出工具使用说明"
|
|
1392
|
-
|
|
1393
|
-
**参数说明:**
|
|
1394
|
-
- `scope`: all/basic/generation/analysis(可选)
|
|
1395
|
-
- `tool_name`: 指定工具名称(可选)
|
|
1396
|
-
- `lang`: zh/en
|
|
1397
|
-
- `output_dir`: 输出目录(可选)
|
|
1398
|
-
|
|
1399
|
-
---
|
|
1400
|
-
|
|
1401
|
-
## 💡 使用技巧
|
|
1402
|
-
|
|
1403
|
-
### 1. Interview 模式最佳实践 🆕
|
|
1404
|
-
|
|
1405
|
-
**何时使用 Interview 模式:**
|
|
1406
|
-
- ✅ 需求描述简短、不明确
|
|
1407
|
-
- ✅ 复杂的业务功能
|
|
1408
|
-
- ✅ 涉及多方协作的功能
|
|
1409
|
-
- ❌ 简单的 Bug 修复
|
|
1410
|
-
- ❌ 需求非常明确的功能
|
|
1411
|
-
|
|
1412
|
-
**工作流程:**
|
|
1413
|
-
```
|
|
1414
|
-
方式1: 立即开发
|
|
1415
|
-
1. interview "用户登录功能"
|
|
1416
|
-
2. 回答 12-15 个问题
|
|
1417
|
-
3. start_feature --from-interview user-login
|
|
1418
|
-
4. 根据 tasks.md 开始编码
|
|
1419
|
-
|
|
1420
|
-
方式2: 分步进行
|
|
1421
|
-
第1天: interview "用户登录功能" → 回答问题
|
|
1422
|
-
第3天: start_feature --from-interview user-login → 开始开发
|
|
1423
|
-
```
|
|
1424
|
-
|
|
1425
|
-
---
|
|
1426
|
-
|
|
1427
|
-
### 2. 组合使用
|
|
1428
|
-
- 先用 `debug` 定位问题 → 再用 `fix` 自动修复
|
|
1429
|
-
- 先用 `analyze_project` 了解项目 → 再用 `add_feature` 添加功能
|
|
1430
|
-
- 先用 `code_review` 审查 → 再用 `refactor` 重构
|
|
1431
|
-
|
|
1432
|
-
### 3. 工作流优先
|
|
1433
|
-
- 复杂任务优先使用 `start_*` 系列工具(自动编排多个步骤)
|
|
1434
|
-
- 简单任务使用单个工具(更快更直接)
|
|
1435
|
-
|
|
1436
|
-
### 4. 提供完整信息
|
|
1437
|
-
- 粘贴完整的错误堆栈(不要截断)
|
|
1438
|
-
- 提供相关代码上下文(不要只给一行)
|
|
1439
|
-
- 描述清楚期望结果
|
|
1440
|
-
|
|
1441
|
-
### 5. 善用可选参数
|
|
1442
|
-
- 大多数工具会自动检测(如框架、语言)
|
|
1443
|
-
- 只在需要明确指定时才传参数
|
|
1444
|
-
|
|
1445
|
-
---
|
|
1446
|
-
|
|
1447
|
-
**打印建议:** A4 纸双面打印,建议缩放至 85% 以适应页面
|