kiro-spec-engine 1.2.3 → 1.4.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/CHANGELOG.md +135 -0
- package/README.md +239 -213
- package/README.zh.md +0 -330
- package/bin/kiro-spec-engine.js +62 -0
- package/docs/README.md +223 -0
- package/docs/agent-hooks-analysis.md +815 -0
- package/docs/command-reference.md +252 -0
- package/docs/cross-tool-guide.md +554 -0
- package/docs/examples/add-export-command/design.md +194 -0
- package/docs/examples/add-export-command/requirements.md +110 -0
- package/docs/examples/add-export-command/tasks.md +88 -0
- package/docs/examples/add-rest-api/design.md +855 -0
- package/docs/examples/add-rest-api/requirements.md +323 -0
- package/docs/examples/add-rest-api/tasks.md +355 -0
- package/docs/examples/add-user-dashboard/design.md +192 -0
- package/docs/examples/add-user-dashboard/requirements.md +143 -0
- package/docs/examples/add-user-dashboard/tasks.md +91 -0
- package/docs/faq.md +696 -0
- package/docs/integration-modes.md +525 -0
- package/docs/integration-philosophy.md +313 -0
- package/docs/manual-workflows-guide.md +417 -0
- package/docs/quick-start-with-ai-tools.md +374 -0
- package/docs/quick-start.md +711 -0
- package/docs/spec-workflow.md +453 -0
- package/docs/steering-strategy-guide.md +196 -0
- package/docs/tools/claude-guide.md +653 -0
- package/docs/tools/cursor-guide.md +705 -0
- package/docs/tools/generic-guide.md +445 -0
- package/docs/tools/kiro-guide.md +308 -0
- package/docs/tools/vscode-guide.md +444 -0
- package/docs/tools/windsurf-guide.md +390 -0
- package/docs/troubleshooting.md +795 -0
- package/docs/zh/README.md +275 -0
- package/docs/zh/quick-start.md +711 -0
- package/docs/zh/tools/claude-guide.md +348 -0
- package/docs/zh/tools/cursor-guide.md +280 -0
- package/docs/zh/tools/generic-guide.md +498 -0
- package/docs/zh/tools/kiro-guide.md +342 -0
- package/docs/zh/tools/vscode-guide.md +448 -0
- package/docs/zh/tools/windsurf-guide.md +377 -0
- package/lib/adoption/detection-engine.js +14 -4
- package/lib/commands/adopt.js +117 -3
- package/lib/commands/context.js +99 -0
- package/lib/commands/prompt.js +105 -0
- package/lib/commands/status.js +225 -0
- package/lib/commands/task.js +199 -0
- package/lib/commands/watch.js +569 -0
- package/lib/commands/workflows.js +240 -0
- package/lib/commands/workspace.js +189 -0
- package/lib/context/context-exporter.js +378 -0
- package/lib/context/prompt-generator.js +482 -0
- package/lib/steering/adoption-config.js +164 -0
- package/lib/steering/steering-manager.js +289 -0
- package/lib/task/task-claimer.js +430 -0
- package/lib/utils/tool-detector.js +383 -0
- package/lib/watch/action-executor.js +458 -0
- package/lib/watch/event-debouncer.js +323 -0
- package/lib/watch/execution-logger.js +550 -0
- package/lib/watch/file-watcher.js +499 -0
- package/lib/watch/presets.js +266 -0
- package/lib/watch/watch-manager.js +533 -0
- package/lib/workspace/workspace-manager.js +370 -0
- package/lib/workspace/workspace-sync.js +356 -0
- package/package.json +3 -1
- package/template/.kiro/tools/backup_manager.py +295 -0
- package/template/.kiro/tools/configuration_manager.py +218 -0
- package/template/.kiro/tools/document_evaluator.py +550 -0
- package/template/.kiro/tools/enhancement_logger.py +168 -0
- package/template/.kiro/tools/error_handler.py +335 -0
- package/template/.kiro/tools/improvement_identifier.py +444 -0
- package/template/.kiro/tools/modification_applicator.py +737 -0
- package/template/.kiro/tools/quality_gate_enforcer.py +207 -0
- package/template/.kiro/tools/quality_scorer.py +305 -0
- package/template/.kiro/tools/report_generator.py +154 -0
- package/template/.kiro/tools/ultrawork_enhancer_refactored.py +0 -0
- package/template/.kiro/tools/ultrawork_enhancer_v2.py +463 -0
- package/template/.kiro/tools/ultrawork_enhancer_v3.py +606 -0
- package/template/.kiro/tools/workflow_quality_gate.py +100 -0
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
# kse 文档索引
|
|
2
|
+
|
|
3
|
+
> kse (Kiro Spec Engine) 的完整文档 - AI 辅助开发的上下文管理系统
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
**版本**: 1.0.0
|
|
8
|
+
**最后更新**: 2026-01-23
|
|
9
|
+
**语言**: 简体中文
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 📚 文档概述
|
|
14
|
+
|
|
15
|
+
本文档集合提供了使用 kse 进行 Spec 驱动开发所需的一切。无论你是初学者还是高级用户,你都会在这里找到所需的指导。
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 🚀 入门指南
|
|
20
|
+
|
|
21
|
+
从这里开始你的 kse 之旅:
|
|
22
|
+
|
|
23
|
+
### [快速入门指南](quick-start.md)
|
|
24
|
+
**5 分钟教程** - 从安装到第一个 AI 辅助功能实现
|
|
25
|
+
- 安装 kse
|
|
26
|
+
- 创建你的第一个 Spec
|
|
27
|
+
- 导出上下文
|
|
28
|
+
- 使用 AI 工具实现功能
|
|
29
|
+
|
|
30
|
+
### [常见问题 (FAQ)](faq.md)
|
|
31
|
+
**常见问题解答** - 关于 kse 的快速答案
|
|
32
|
+
- kse 是什么?
|
|
33
|
+
- 它如何与 AI 工具配合使用?
|
|
34
|
+
- 我应该使用哪个 AI 工具?
|
|
35
|
+
- 常见误解
|
|
36
|
+
|
|
37
|
+
### [故障排除](troubleshooting.md)
|
|
38
|
+
**问题解决** - 常见问题和解决方案
|
|
39
|
+
- 安装问题
|
|
40
|
+
- 采用问题
|
|
41
|
+
- 命令错误
|
|
42
|
+
- 集成问题
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 📋 核心概念
|
|
47
|
+
|
|
48
|
+
深入理解 kse 的工作原理:
|
|
49
|
+
|
|
50
|
+
### [Spec 工作流](spec-workflow.md)
|
|
51
|
+
**深入指南** - 理解 Spec 驱动开发
|
|
52
|
+
- 什么是 Spec?
|
|
53
|
+
- Requirements → Design → Tasks 工作流
|
|
54
|
+
- 创建有效 Spec 的最佳实践
|
|
55
|
+
- 示例 Spec 演练
|
|
56
|
+
|
|
57
|
+
### [集成模式](integration-modes.md)
|
|
58
|
+
**三种集成方式** - 选择最适合你的模式
|
|
59
|
+
- 原生集成(Kiro、Windsurf)
|
|
60
|
+
- 手动导出(Claude、Cursor、ChatGPT)
|
|
61
|
+
- Watch 模式(所有工具)
|
|
62
|
+
- 每种模式的优缺点
|
|
63
|
+
|
|
64
|
+
### [命令参考](command-reference.md)
|
|
65
|
+
**完整命令列表** - 所有 kse 命令及示例
|
|
66
|
+
- 项目设置命令
|
|
67
|
+
- 上下文管理命令
|
|
68
|
+
- 任务管理命令
|
|
69
|
+
- 自动化命令
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 🔧 工具专用指南
|
|
74
|
+
|
|
75
|
+
为你的 AI 工具选择集成指南:
|
|
76
|
+
|
|
77
|
+
### IDE 集成
|
|
78
|
+
|
|
79
|
+
#### [Cursor 指南](tools/cursor-guide.md)
|
|
80
|
+
**Cursor IDE** - 带 AI 结对编程的 IDE
|
|
81
|
+
- 手动导出模式
|
|
82
|
+
- Composer 集成
|
|
83
|
+
- 最佳实践
|
|
84
|
+
|
|
85
|
+
#### [Windsurf 指南](tools/windsurf-guide.md)
|
|
86
|
+
**Windsurf IDE** - 带命令执行的 AI 代理
|
|
87
|
+
- 原生集成
|
|
88
|
+
- Watch 模式
|
|
89
|
+
- 自动化工作流
|
|
90
|
+
|
|
91
|
+
#### [Kiro 指南](tools/kiro-guide.md)
|
|
92
|
+
**Kiro IDE** - 专为 Spec 驱动开发设计
|
|
93
|
+
- 完全原生集成
|
|
94
|
+
- 可视化工具
|
|
95
|
+
- 零配置
|
|
96
|
+
|
|
97
|
+
#### [VS Code + Copilot 指南](tools/vscode-guide.md)
|
|
98
|
+
**VS Code** - 带 GitHub Copilot
|
|
99
|
+
- 内联注释集成
|
|
100
|
+
- Copilot Chat
|
|
101
|
+
- 代码片段
|
|
102
|
+
|
|
103
|
+
### 聊天机器人集成
|
|
104
|
+
|
|
105
|
+
#### [Claude 指南](tools/claude-guide.md)
|
|
106
|
+
**Claude Code** - Anthropic 的 AI 助手
|
|
107
|
+
- 对话式开发
|
|
108
|
+
- 长上下文窗口
|
|
109
|
+
- 示例提示
|
|
110
|
+
|
|
111
|
+
### 通用集成
|
|
112
|
+
|
|
113
|
+
#### [通用 AI 工具指南](tools/generic-guide.md)
|
|
114
|
+
**适用于任何 AI 工具** - 灵活的集成方法
|
|
115
|
+
- 三种集成模式
|
|
116
|
+
- 工具无关工作流
|
|
117
|
+
- 自定义集成
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 💡 示例和模板
|
|
122
|
+
|
|
123
|
+
从真实示例中学习:
|
|
124
|
+
|
|
125
|
+
### 完整 Spec 示例
|
|
126
|
+
|
|
127
|
+
#### [API 功能示例](examples/add-rest-api/)
|
|
128
|
+
**RESTful API Spec** - 带认证的完整 API
|
|
129
|
+
- 完整的 requirements.md
|
|
130
|
+
- 详细的 design.md
|
|
131
|
+
- 分步 tasks.md
|
|
132
|
+
|
|
133
|
+
#### [UI 功能示例](examples/add-user-dashboard/)
|
|
134
|
+
**React 仪表板 Spec** - 前端功能
|
|
135
|
+
- 组件层次结构
|
|
136
|
+
- 状态管理设计
|
|
137
|
+
- UI 实现任务
|
|
138
|
+
|
|
139
|
+
#### [CLI 功能示例](examples/add-export-command/)
|
|
140
|
+
**CLI 命令 Spec** - 命令行工具
|
|
141
|
+
- 命令设计
|
|
142
|
+
- 参数处理
|
|
143
|
+
- 测试策略
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## 📖 高级主题
|
|
148
|
+
|
|
149
|
+
对于有经验的用户:
|
|
150
|
+
|
|
151
|
+
### [采用指南](adoption-guide.md)
|
|
152
|
+
**在现有项目中采用 kse** - 迁移策略
|
|
153
|
+
- 评估你的项目
|
|
154
|
+
- 采用策略
|
|
155
|
+
- 迁移现有文档
|
|
156
|
+
|
|
157
|
+
### [升级指南](upgrade-guide.md)
|
|
158
|
+
**版本升级** - 保持 kse 最新
|
|
159
|
+
- 升级过程
|
|
160
|
+
- 版本兼容性
|
|
161
|
+
- 迁移指南
|
|
162
|
+
|
|
163
|
+
### [手动工作流](manual-workflows-guide.md)
|
|
164
|
+
**分步工作流** - 详细过程
|
|
165
|
+
- 创建 Spec 工作流
|
|
166
|
+
- 实现工作流
|
|
167
|
+
- 审查工作流
|
|
168
|
+
|
|
169
|
+
### [开发者指南](developer-guide.md)
|
|
170
|
+
**贡献和扩展 kse** - 对于贡献者
|
|
171
|
+
- 项目结构
|
|
172
|
+
- 开发设置
|
|
173
|
+
- 贡献指南
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 🗺️ 学习路径
|
|
178
|
+
|
|
179
|
+
### 对于初学者
|
|
180
|
+
|
|
181
|
+
1. 从[快速入门指南](quick-start.md)开始
|
|
182
|
+
2. 阅读[Spec 工作流](spec-workflow.md)
|
|
183
|
+
3. 选择你的工具指南:
|
|
184
|
+
- [Cursor](tools/cursor-guide.md)
|
|
185
|
+
- [Claude](tools/claude-guide.md)
|
|
186
|
+
- [Windsurf](tools/windsurf-guide.md)
|
|
187
|
+
- [VS Code](tools/vscode-guide.md)
|
|
188
|
+
4. 查看[示例](examples/add-rest-api/)
|
|
189
|
+
5. 查阅[FAQ](faq.md)和[故障排除](troubleshooting.md)
|
|
190
|
+
|
|
191
|
+
### 对于有经验的用户
|
|
192
|
+
|
|
193
|
+
1. 查看[集成模式](integration-modes.md)
|
|
194
|
+
2. 探索[高级主题](#-高级主题)
|
|
195
|
+
3. 阅读[开发者指南](developer-guide.md)
|
|
196
|
+
4. 贡献到项目
|
|
197
|
+
|
|
198
|
+
### 对于团队
|
|
199
|
+
|
|
200
|
+
1. 阅读[采用指南](adoption-guide.md)
|
|
201
|
+
2. 设置团队约定
|
|
202
|
+
3. 创建共享 Spec 模板
|
|
203
|
+
4. 建立审查流程
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## 🔍 按主题查找
|
|
208
|
+
|
|
209
|
+
### 安装和设置
|
|
210
|
+
- [快速入门 - 安装](quick-start.md#步骤-1安装-kse30-秒)
|
|
211
|
+
- [故障排除 - 安装问题](troubleshooting.md)
|
|
212
|
+
- [采用指南](adoption-guide.md)
|
|
213
|
+
|
|
214
|
+
### 创建 Spec
|
|
215
|
+
- [快速入门 - 创建 Spec](quick-start.md#步骤-3创建你的第一个-spec2-分钟)
|
|
216
|
+
- [Spec 工作流](spec-workflow.md)
|
|
217
|
+
- [示例 Spec](examples/add-rest-api/)
|
|
218
|
+
|
|
219
|
+
### AI 工具集成
|
|
220
|
+
- [集成模式](integration-modes.md)
|
|
221
|
+
- [工具专用指南](#-工具专用指南)
|
|
222
|
+
- [通用指南](tools/generic-guide.md)
|
|
223
|
+
|
|
224
|
+
### 任务管理
|
|
225
|
+
- [命令参考 - 任务命令](command-reference.md)
|
|
226
|
+
- [Spec 工作流 - 任务](spec-workflow.md)
|
|
227
|
+
|
|
228
|
+
### 自动化
|
|
229
|
+
- [集成模式 - Watch 模式](integration-modes.md)
|
|
230
|
+
- [Windsurf 指南 - Watch 配置](tools/windsurf-guide.md)
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## 📞 获取帮助
|
|
235
|
+
|
|
236
|
+
### 文档
|
|
237
|
+
- 📖 从[快速入门指南](quick-start.md)开始
|
|
238
|
+
- 🤔 查看[常见问题](faq.md)
|
|
239
|
+
- 🔧 查阅[故障排除](troubleshooting.md)
|
|
240
|
+
|
|
241
|
+
### 社区
|
|
242
|
+
- 💬 [GitHub Discussions](https://github.com/yourusername/kiro-spec-engine/discussions)
|
|
243
|
+
- 🐛 [GitHub Issues](https://github.com/yourusername/kiro-spec-engine/issues)
|
|
244
|
+
- 📧 support@example.com
|
|
245
|
+
|
|
246
|
+
---
|
|
247
|
+
|
|
248
|
+
## 🤝 贡献
|
|
249
|
+
|
|
250
|
+
帮助改进文档:
|
|
251
|
+
|
|
252
|
+
- 📝 报告文档问题
|
|
253
|
+
- ✏️ 建议改进
|
|
254
|
+
- 🌍 帮助翻译
|
|
255
|
+
- 📖 分享你的经验
|
|
256
|
+
|
|
257
|
+
查看[贡献指南](../CONTRIBUTING.md)了解详情。
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## 📄 许可证
|
|
262
|
+
|
|
263
|
+
本文档根据 MIT 许可证授权。查看[LICENSE](../LICENSE)了解详情。
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
**准备好开始了吗?** 🚀
|
|
268
|
+
|
|
269
|
+
从[快速入门指南](quick-start.md)开始你的 kse 之旅!
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
**版本**: 1.0.0
|
|
274
|
+
**最后更新**: 2026-01-23
|
|
275
|
+
**语言**: 简体中文
|