scene-capability-engine 3.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.
Files changed (336) hide show
  1. package/CHANGELOG.md +2513 -0
  2. package/LICENSE +21 -0
  3. package/README.md +765 -0
  4. package/README.zh.md +630 -0
  5. package/bin/kiro-spec-engine.js +796 -0
  6. package/bin/kse.js +3 -0
  7. package/bin/sce.js +3 -0
  8. package/bin/sco.js +3 -0
  9. package/docs/331-poc-adaptation-roadmap.md +156 -0
  10. package/docs/331-poc-dual-track-integration-guide.md +120 -0
  11. package/docs/331-poc-weekly-delivery-checklist.md +52 -0
  12. package/docs/OFFLINE_INSTALL.md +96 -0
  13. package/docs/README.md +279 -0
  14. package/docs/adopt-migration-guide.md +599 -0
  15. package/docs/adoption-guide.md +616 -0
  16. package/docs/agent-hooks-analysis.md +815 -0
  17. package/docs/architecture.md +733 -0
  18. package/docs/articles/ai-driven-development-philosophy-and-practice-review.md +208 -0
  19. package/docs/articles/ai-driven-development-philosophy-and-practice.en.md +459 -0
  20. package/docs/articles/ai-driven-development-philosophy-and-practice.md +492 -0
  21. package/docs/autonomous-control-guide.md +851 -0
  22. package/docs/command-reference.md +1368 -0
  23. package/docs/community.md +115 -0
  24. package/docs/cross-tool-guide.md +555 -0
  25. package/docs/developer-guide.md +619 -0
  26. package/docs/document-governance.md +865 -0
  27. package/docs/environment-management-guide.md +526 -0
  28. package/docs/examples/add-export-command/design.md +194 -0
  29. package/docs/examples/add-export-command/requirements.md +110 -0
  30. package/docs/examples/add-export-command/tasks.md +88 -0
  31. package/docs/examples/add-rest-api/design.md +855 -0
  32. package/docs/examples/add-rest-api/requirements.md +323 -0
  33. package/docs/examples/add-rest-api/tasks.md +355 -0
  34. package/docs/examples/add-user-dashboard/design.md +192 -0
  35. package/docs/examples/add-user-dashboard/requirements.md +143 -0
  36. package/docs/examples/add-user-dashboard/tasks.md +91 -0
  37. package/docs/faq.md +697 -0
  38. package/docs/handoffs/evidence/ontology/moqui-template-baseline-2026-02-17-232922.json +156 -0
  39. package/docs/handoffs/evidence/ontology/moqui-template-baseline-2026-02-17-232922.md +24 -0
  40. package/docs/images/wechat-qr.png +0 -0
  41. package/docs/integration-modes.md +529 -0
  42. package/docs/integration-philosophy.md +313 -0
  43. package/docs/knowledge-management-guide.md +263 -0
  44. package/docs/manual-workflows-guide.md +418 -0
  45. package/docs/moqui-capability-matrix.md +73 -0
  46. package/docs/moqui-template-core-library-playbook.md +109 -0
  47. package/docs/multi-agent-coordination-guide.md +553 -0
  48. package/docs/multi-repo-management-guide.md +1344 -0
  49. package/docs/quick-start-with-ai-tools.md +375 -0
  50. package/docs/quick-start.md +146 -0
  51. package/docs/release-checklist.md +121 -0
  52. package/docs/releases/README.md +13 -0
  53. package/docs/releases/v1.46.2-validation.md +45 -0
  54. package/docs/releases/v1.46.2.md +50 -0
  55. package/docs/scene-runtime-guide.md +347 -0
  56. package/docs/spec-collaboration-guide.md +369 -0
  57. package/docs/spec-locking-guide.md +225 -0
  58. package/docs/spec-numbering-guide.md +348 -0
  59. package/docs/spec-workflow.md +519 -0
  60. package/docs/steering-strategy-guide.md +196 -0
  61. package/docs/team-collaboration-guide.md +465 -0
  62. package/docs/testing-strategy.md +272 -0
  63. package/docs/tools/claude-guide.md +654 -0
  64. package/docs/tools/cursor-guide.md +706 -0
  65. package/docs/tools/generic-guide.md +446 -0
  66. package/docs/tools/kiro-guide.md +308 -0
  67. package/docs/tools/vscode-guide.md +445 -0
  68. package/docs/tools/windsurf-guide.md +391 -0
  69. package/docs/troubleshooting.md +1135 -0
  70. package/docs/upgrade-guide.md +639 -0
  71. package/docs/value-observability-guide.md +127 -0
  72. package/docs/zh/README.md +341 -0
  73. package/docs/zh/quick-start.md +764 -0
  74. package/docs/zh/release-checklist.md +121 -0
  75. package/docs/zh/releases/README.md +13 -0
  76. package/docs/zh/releases/v1.46.2-validation.md +45 -0
  77. package/docs/zh/releases/v1.46.2.md +50 -0
  78. package/docs/zh/spec-numbering-guide.md +348 -0
  79. package/docs/zh/tools/claude-guide.md +349 -0
  80. package/docs/zh/tools/cursor-guide.md +281 -0
  81. package/docs/zh/tools/generic-guide.md +499 -0
  82. package/docs/zh/tools/kiro-guide.md +342 -0
  83. package/docs/zh/tools/vscode-guide.md +449 -0
  84. package/docs/zh/tools/windsurf-guide.md +378 -0
  85. package/docs/zh/value-observability-guide.md +127 -0
  86. package/docs//344/272/244/344/273/230/346/270/205/345/215/225.md +75 -0
  87. package/lib/adoption/adoption-logger.js +487 -0
  88. package/lib/adoption/adoption-strategy.js +538 -0
  89. package/lib/adoption/backup-manager.js +420 -0
  90. package/lib/adoption/conflict-resolver.js +410 -0
  91. package/lib/adoption/detection-engine.js +275 -0
  92. package/lib/adoption/diff-viewer.js +226 -0
  93. package/lib/adoption/error-formatter.js +509 -0
  94. package/lib/adoption/file-classifier.js +385 -0
  95. package/lib/adoption/progress-reporter.js +534 -0
  96. package/lib/adoption/smart-orchestrator.js +470 -0
  97. package/lib/adoption/strategy-selector.js +218 -0
  98. package/lib/adoption/summary-generator.js +493 -0
  99. package/lib/adoption/template-sync.js +605 -0
  100. package/lib/auto/autonomous-engine.js +485 -0
  101. package/lib/auto/checkpoint-manager.js +300 -0
  102. package/lib/auto/close-loop-runner.js +2476 -0
  103. package/lib/auto/config-schema.js +176 -0
  104. package/lib/auto/decision-engine.js +344 -0
  105. package/lib/auto/error-recovery-manager.js +580 -0
  106. package/lib/auto/goal-decomposer.js +278 -0
  107. package/lib/auto/progress-tracker.js +502 -0
  108. package/lib/auto/safety-manager.js +186 -0
  109. package/lib/auto/semantic-decomposer.js +137 -0
  110. package/lib/auto/state-manager.js +126 -0
  111. package/lib/auto/task-queue-manager.js +340 -0
  112. package/lib/backup/backup-system.js +372 -0
  113. package/lib/backup/selective-backup.js +207 -0
  114. package/lib/collab/agent-registry.js +240 -0
  115. package/lib/collab/collab-manager.js +285 -0
  116. package/lib/collab/contract-manager.js +320 -0
  117. package/lib/collab/coordinator.js +370 -0
  118. package/lib/collab/dependency-manager.js +280 -0
  119. package/lib/collab/index.js +20 -0
  120. package/lib/collab/integration-manager.js +202 -0
  121. package/lib/collab/merge-coordinator.js +252 -0
  122. package/lib/collab/metadata-manager.js +233 -0
  123. package/lib/collab/multi-agent-config.js +120 -0
  124. package/lib/collab/spec-lifecycle-manager.js +304 -0
  125. package/lib/collab/sync-barrier.js +88 -0
  126. package/lib/collab/visualizer.js +208 -0
  127. package/lib/commands/adopt.js +749 -0
  128. package/lib/commands/auto.js +19559 -0
  129. package/lib/commands/collab.js +275 -0
  130. package/lib/commands/context.js +99 -0
  131. package/lib/commands/docs.js +808 -0
  132. package/lib/commands/doctor.js +273 -0
  133. package/lib/commands/env.js +420 -0
  134. package/lib/commands/knowledge.js +309 -0
  135. package/lib/commands/lock.js +235 -0
  136. package/lib/commands/ops.js +409 -0
  137. package/lib/commands/orchestrate.js +446 -0
  138. package/lib/commands/prompt.js +105 -0
  139. package/lib/commands/repo.js +118 -0
  140. package/lib/commands/rollback.js +219 -0
  141. package/lib/commands/scene.js +15549 -0
  142. package/lib/commands/spec-bootstrap.js +147 -0
  143. package/lib/commands/spec-gate.js +157 -0
  144. package/lib/commands/spec-pipeline.js +205 -0
  145. package/lib/commands/status.js +321 -0
  146. package/lib/commands/task.js +199 -0
  147. package/lib/commands/templates.js +654 -0
  148. package/lib/commands/upgrade.js +231 -0
  149. package/lib/commands/value.js +569 -0
  150. package/lib/commands/watch.js +684 -0
  151. package/lib/commands/workflows.js +240 -0
  152. package/lib/commands/workspace-multi.js +325 -0
  153. package/lib/commands/workspace.js +189 -0
  154. package/lib/context/context-exporter.js +378 -0
  155. package/lib/context/prompt-generator.js +482 -0
  156. package/lib/data/moqui-capability-lexicon.json +45 -0
  157. package/lib/environment/backup-system.js +189 -0
  158. package/lib/environment/environment-manager.js +379 -0
  159. package/lib/environment/environment-registry.js +168 -0
  160. package/lib/gitignore/gitignore-backup.js +229 -0
  161. package/lib/gitignore/gitignore-detector.js +239 -0
  162. package/lib/gitignore/gitignore-integration.js +267 -0
  163. package/lib/gitignore/gitignore-transformer.js +193 -0
  164. package/lib/gitignore/layered-rules-template.js +42 -0
  165. package/lib/governance/archive-tool.js +284 -0
  166. package/lib/governance/cleanup-tool.js +237 -0
  167. package/lib/governance/config-manager.js +186 -0
  168. package/lib/governance/diagnostic-engine.js +271 -0
  169. package/lib/governance/doc-reference-checker.js +200 -0
  170. package/lib/governance/execution-logger.js +243 -0
  171. package/lib/governance/file-scanner.js +285 -0
  172. package/lib/governance/hooks-manager.js +333 -0
  173. package/lib/governance/reporter.js +337 -0
  174. package/lib/governance/validation-engine.js +181 -0
  175. package/lib/i18n.js +79 -0
  176. package/lib/knowledge/entry-manager.js +208 -0
  177. package/lib/knowledge/index-manager.js +261 -0
  178. package/lib/knowledge/knowledge-manager.js +273 -0
  179. package/lib/knowledge/template-manager.js +191 -0
  180. package/lib/lock/index.js +21 -0
  181. package/lib/lock/lock-file.js +192 -0
  182. package/lib/lock/lock-manager.js +321 -0
  183. package/lib/lock/machine-identifier.js +135 -0
  184. package/lib/lock/steering-file-lock.js +207 -0
  185. package/lib/lock/task-lock-manager.js +345 -0
  186. package/lib/operations/audit-logger.js +293 -0
  187. package/lib/operations/feedback-manager.js +1147 -0
  188. package/lib/operations/index.js +23 -0
  189. package/lib/operations/models/index.js +170 -0
  190. package/lib/operations/operations-manager.js +151 -0
  191. package/lib/operations/operations-validator.js +280 -0
  192. package/lib/operations/permission-manager.js +354 -0
  193. package/lib/operations/template-loader.js +143 -0
  194. package/lib/orchestrator/agent-spawner.js +629 -0
  195. package/lib/orchestrator/bootstrap-prompt-builder.js +236 -0
  196. package/lib/orchestrator/index.js +19 -0
  197. package/lib/orchestrator/orchestration-engine.js +1270 -0
  198. package/lib/orchestrator/orchestrator-config.js +173 -0
  199. package/lib/orchestrator/status-monitor.js +591 -0
  200. package/lib/python-checker.js +209 -0
  201. package/lib/repo/config-manager.js +580 -0
  202. package/lib/repo/errors/config-error.js +13 -0
  203. package/lib/repo/errors/git-error.js +15 -0
  204. package/lib/repo/errors/repo-error.js +14 -0
  205. package/lib/repo/git-operations.js +181 -0
  206. package/lib/repo/handlers/.gitkeep +1 -0
  207. package/lib/repo/handlers/exec-handler.js +155 -0
  208. package/lib/repo/handlers/health-handler.js +169 -0
  209. package/lib/repo/handlers/init-handler.js +197 -0
  210. package/lib/repo/handlers/status-handler.js +176 -0
  211. package/lib/repo/output-formatter.js +184 -0
  212. package/lib/repo/path-resolver.js +178 -0
  213. package/lib/repo/repo-manager.js +514 -0
  214. package/lib/scene-runtime/audit-emitter.js +59 -0
  215. package/lib/scene-runtime/binding-plugin-loader.js +351 -0
  216. package/lib/scene-runtime/binding-registry.js +349 -0
  217. package/lib/scene-runtime/eval-bridge.js +44 -0
  218. package/lib/scene-runtime/index.js +19 -0
  219. package/lib/scene-runtime/moqui-adapter.js +620 -0
  220. package/lib/scene-runtime/moqui-client.js +606 -0
  221. package/lib/scene-runtime/moqui-extractor.js +2029 -0
  222. package/lib/scene-runtime/plan-compiler.js +208 -0
  223. package/lib/scene-runtime/policy-gate.js +58 -0
  224. package/lib/scene-runtime/runtime-executor.js +358 -0
  225. package/lib/scene-runtime/scene-loader.js +96 -0
  226. package/lib/scene-runtime/scene-ontology.js +959 -0
  227. package/lib/scene-runtime/scene-template-linter.js +852 -0
  228. package/lib/scene-runtime/templates/scene-template-erp-query-v0.1.yaml +28 -0
  229. package/lib/scene-runtime/templates/scene-template-hybrid-shadow-v0.1.yaml +34 -0
  230. package/lib/spec/bootstrap/context-collector.js +48 -0
  231. package/lib/spec/bootstrap/draft-generator.js +158 -0
  232. package/lib/spec/bootstrap/questionnaire-engine.js +70 -0
  233. package/lib/spec/bootstrap/trace-emitter.js +59 -0
  234. package/lib/spec/multi-spec-orchestrate.js +93 -0
  235. package/lib/spec/pipeline/constants.js +6 -0
  236. package/lib/spec/pipeline/stage-adapters.js +118 -0
  237. package/lib/spec/pipeline/stage-runner.js +146 -0
  238. package/lib/spec/pipeline/state-store.js +119 -0
  239. package/lib/spec-gate/engine/gate-engine.js +165 -0
  240. package/lib/spec-gate/policy/default-policy.js +22 -0
  241. package/lib/spec-gate/policy/policy-loader.js +103 -0
  242. package/lib/spec-gate/result-emitter.js +81 -0
  243. package/lib/spec-gate/rules/default-rules.js +156 -0
  244. package/lib/spec-gate/rules/rule-registry.js +51 -0
  245. package/lib/steering/adoption-config.js +164 -0
  246. package/lib/steering/compliance-auto-fixer.js +204 -0
  247. package/lib/steering/compliance-cache.js +99 -0
  248. package/lib/steering/compliance-error-reporter.js +70 -0
  249. package/lib/steering/context-sync-manager.js +273 -0
  250. package/lib/steering/index.js +92 -0
  251. package/lib/steering/spec-steering.js +230 -0
  252. package/lib/steering/steering-compliance-checker.js +73 -0
  253. package/lib/steering/steering-loader.js +144 -0
  254. package/lib/steering/steering-manager.js +289 -0
  255. package/lib/task/index.js +12 -0
  256. package/lib/task/task-claimer.js +489 -0
  257. package/lib/task/task-status-store.js +418 -0
  258. package/lib/templates/cache-manager.js +440 -0
  259. package/lib/templates/content-generalizer.js +247 -0
  260. package/lib/templates/frontmatter-generator.js +128 -0
  261. package/lib/templates/git-handler.js +471 -0
  262. package/lib/templates/metadata-collector.js +328 -0
  263. package/lib/templates/path-utils.js +144 -0
  264. package/lib/templates/registry-parser.js +505 -0
  265. package/lib/templates/spec-reader.js +216 -0
  266. package/lib/templates/template-applicator.js +249 -0
  267. package/lib/templates/template-creator.js +256 -0
  268. package/lib/templates/template-error.js +143 -0
  269. package/lib/templates/template-exporter.js +502 -0
  270. package/lib/templates/template-manager.js +782 -0
  271. package/lib/templates/template-validator.js +361 -0
  272. package/lib/upgrade/migration-engine.js +382 -0
  273. package/lib/upgrade/migrations/.gitkeep +52 -0
  274. package/lib/upgrade/migrations/1.0.0-to-1.1.0.js +78 -0
  275. package/lib/utils/file-diff.js +177 -0
  276. package/lib/utils/fs-utils.js +274 -0
  277. package/lib/utils/tool-detector.js +383 -0
  278. package/lib/utils/validation.js +324 -0
  279. package/lib/value/gate-summary-emitter.js +99 -0
  280. package/lib/value/metric-contract-loader.js +210 -0
  281. package/lib/value/risk-evaluator.js +117 -0
  282. package/lib/value/weekly-snapshot-builder.js +61 -0
  283. package/lib/version/version-checker.js +156 -0
  284. package/lib/version/version-manager.js +327 -0
  285. package/lib/watch/action-executor.js +458 -0
  286. package/lib/watch/event-debouncer.js +323 -0
  287. package/lib/watch/execution-logger.js +550 -0
  288. package/lib/watch/file-watcher.js +499 -0
  289. package/lib/watch/presets.js +266 -0
  290. package/lib/watch/watch-manager.js +533 -0
  291. package/lib/workspace/multi/global-config.js +150 -0
  292. package/lib/workspace/multi/index.js +22 -0
  293. package/lib/workspace/multi/path-utils.js +173 -0
  294. package/lib/workspace/multi/workspace-context-resolver.js +244 -0
  295. package/lib/workspace/multi/workspace-registry.js +196 -0
  296. package/lib/workspace/multi/workspace-state-manager.js +537 -0
  297. package/lib/workspace/multi/workspace.js +90 -0
  298. package/lib/workspace/workspace-manager.js +370 -0
  299. package/lib/workspace/workspace-sync.js +356 -0
  300. package/locales/en.json +114 -0
  301. package/locales/zh.json +114 -0
  302. package/package.json +102 -0
  303. package/template/.kiro/README.md +247 -0
  304. package/template/.kiro/hooks/check-spec-on-create.kiro.hook +17 -0
  305. package/template/.kiro/hooks/run-tests-on-save.kiro.hook +13 -0
  306. package/template/.kiro/hooks/sync-tasks-on-edit.kiro.hook +16 -0
  307. package/template/.kiro/specs/SPEC_WORKFLOW_GUIDE.md +134 -0
  308. package/template/.kiro/steering/CORE_PRINCIPLES.md +133 -0
  309. package/template/.kiro/steering/CURRENT_CONTEXT.md +30 -0
  310. package/template/.kiro/steering/ENVIRONMENT.md +35 -0
  311. package/template/.kiro/steering/RULES_GUIDE.md +46 -0
  312. package/template/.kiro/templates/operations/default/change-impact.md +112 -0
  313. package/template/.kiro/templates/operations/default/deployment.md +91 -0
  314. package/template/.kiro/templates/operations/default/feedback-response.md +269 -0
  315. package/template/.kiro/templates/operations/default/migration-plan.md +172 -0
  316. package/template/.kiro/templates/operations/default/monitoring.md +135 -0
  317. package/template/.kiro/templates/operations/default/operations.md +135 -0
  318. package/template/.kiro/templates/operations/default/rollback.md +143 -0
  319. package/template/.kiro/templates/operations/default/tools.yaml +364 -0
  320. package/template/.kiro/templates/operations/default/troubleshooting.md +123 -0
  321. package/template/.kiro/tools/backup_manager.py +295 -0
  322. package/template/.kiro/tools/configuration_manager.py +218 -0
  323. package/template/.kiro/tools/document_evaluator.py +550 -0
  324. package/template/.kiro/tools/enhancement_logger.py +168 -0
  325. package/template/.kiro/tools/error_handler.py +335 -0
  326. package/template/.kiro/tools/improvement_identifier.py +444 -0
  327. package/template/.kiro/tools/modification_applicator.py +737 -0
  328. package/template/.kiro/tools/quality_gate_enforcer.py +207 -0
  329. package/template/.kiro/tools/quality_scorer.py +305 -0
  330. package/template/.kiro/tools/report_generator.py +154 -0
  331. package/template/.kiro/tools/ultrawork_enhancer.py +676 -0
  332. package/template/.kiro/tools/ultrawork_enhancer_refactored.py +0 -0
  333. package/template/.kiro/tools/ultrawork_enhancer_v2.py +463 -0
  334. package/template/.kiro/tools/ultrawork_enhancer_v3.py +606 -0
  335. package/template/.kiro/tools/workflow_quality_gate.py +100 -0
  336. package/template/README.md +111 -0
@@ -0,0 +1,313 @@
1
+ # kse 集成哲学
2
+
3
+ > kse 如何与 AI 编码工具配合工作
4
+
5
+ ---
6
+
7
+ ## 核心定位
8
+
9
+ **kse 不是替代 AI 工具,而是增强 AI 工具**
10
+
11
+ ```
12
+ ┌─────────────────────────────────────┐
13
+ │ AI 编码工具 │
14
+ │ (Codex/Claude/Cursor/Windsurf) │
15
+ │ │
16
+ │ 用户主要工作界面 ← 这里写代码 │
17
+ └──────────────┬──────────────────────┘
18
+
19
+ │ 读取上下文
20
+
21
+ ┌─────────────────────────────────────┐
22
+ │ kse │
23
+ │ │
24
+ │ Spec 管理 + 上下文生成 │
25
+ │ (后台运行,提供结构化信息) │
26
+ └─────────────────────────────────────┘
27
+ ```
28
+
29
+ ---
30
+
31
+ ## 三种集成模式
32
+
33
+ ### 模式 1:AI 主动调用 kse(最佳)⭐
34
+
35
+ **适用工具**:Windsurf、Cline、Aider(可执行命令的 AI)
36
+
37
+ **工作流**:
38
+ ```
39
+ 用户 → AI 工具 → AI 自动执行 kse 命令 → 获取上下文 → 生成代码
40
+ ```
41
+
42
+ **示例对话**:
43
+ ```
44
+ 用户:我要实现用户登录功能
45
+
46
+ AI:好的,让我先查看项目的 Spec
47
+ [自动执行] kse context export 01-00-user-login
48
+ [读取文件] .kiro/specs/01-00-user-login/context-export.md
49
+
50
+ 我看到设计文档中定义了 AuthController...
51
+ [生成代码]
52
+
53
+ [自动执行] kse task claim 01-00-user-login 1.1
54
+ 任务已认领,开始实现...
55
+ ```
56
+
57
+ **配置方法**:
58
+
59
+ 在 AI 工具的系统提示中添加:
60
+ ```markdown
61
+ 你可以使用以下 kse 命令来管理项目:
62
+
63
+ - `kse context export <spec-name>` - 导出 Spec 上下文
64
+ - `kse prompt generate <spec-name> <task-id>` - 生成任务提示
65
+ - `kse task claim <spec-name> <task-id>` - 认领任务
66
+ - `kse status` - 查看项目状态
67
+
68
+ 在实现功能前,先用 kse 命令查看相关 Spec。
69
+ ```
70
+
71
+ **优势**:
72
+ - ✅ 完全自动化
73
+ - ✅ 用户无需手动操作
74
+ - ✅ AI 自动管理 Spec 生命周期
75
+
76
+ ---
77
+
78
+ ### 模式 2:手动导出 + AI 使用(当前)
79
+
80
+ **适用工具**:Claude Code、ChatGPT、GitHub Copilot
81
+
82
+ **工作流**:
83
+ ```
84
+ 用户 → 手动执行 kse 命令 → 复制上下文 → 粘贴到 AI → AI 生成代码
85
+ ```
86
+
87
+ **示例流程**:
88
+ ```bash
89
+ # 1. 用户手动导出
90
+ kse context export 01-00-user-login
91
+
92
+ # 2. 复制内容
93
+ cat .kiro/specs/01-00-user-login/context-export.md | pbcopy
94
+
95
+ # 3. 粘贴到 Claude/ChatGPT
96
+
97
+ # 4. 对话
98
+ 用户:请实现任务 1.1
99
+ AI:[生成代码]
100
+
101
+ # 5. 手动更新任务状态
102
+ # 编辑 tasks.md: - [x] 1.1 ...
103
+ ```
104
+
105
+ **改进建议**:
106
+ ```bash
107
+ # 添加快捷命令
108
+ kse clip 01-00-user-login # 自动复制到剪贴板
109
+ kse clip 01-00-user-login 1.1 # 只复制任务 1.1 的上下文
110
+ ```
111
+
112
+ **优势**:
113
+ - ✅ 适用于所有 AI 工具
114
+ - ✅ 用户完全控制
115
+
116
+ **劣势**:
117
+ - ❌ 需要手动操作
118
+ - ❌ 步骤较多
119
+
120
+ ---
121
+
122
+ ### 模式 3:Watch Mode 自动化(进阶)
123
+
124
+ **适用场景**:频繁修改 Spec 的项目
125
+
126
+ **工作流**:
127
+ ```
128
+ 用户修改 Spec → kse 自动检测 → 自动重新导出 → AI 工具自动刷新
129
+ ```
130
+
131
+ **配置**:
132
+ ```bash
133
+ # 启动 Watch Mode
134
+ kse watch init
135
+ kse watch install auto-export
136
+ kse watch start
137
+
138
+ # 现在修改任何 Spec 文件,都会自动重新导出
139
+ ```
140
+
141
+ **Watch 配置示例**:
142
+ ```json
143
+ {
144
+ "patterns": [
145
+ ".kiro/specs/**/requirements.md",
146
+ ".kiro/specs/**/design.md",
147
+ ".kiro/specs/**/tasks.md"
148
+ ],
149
+ "actions": [
150
+ {
151
+ "name": "auto-export",
152
+ "command": "kse context export ${spec-name}"
153
+ }
154
+ ]
155
+ }
156
+ ```
157
+
158
+ **优势**:
159
+ - ✅ 完全自动化
160
+ - ✅ Spec 修改立即生效
161
+
162
+ ---
163
+
164
+ ## 推荐配置
165
+
166
+ ### 对于 Windsurf/Cline 用户(推荐)⭐
167
+
168
+ **在 AI 系统提示中添加**:
169
+
170
+ ```markdown
171
+ # Spec 管理规则
172
+
173
+ 项目使用 kse (Kiro Spec Engine) 管理需求和设计。
174
+
175
+ ## 工作流程
176
+
177
+ 1. **查看 Spec**:实现功能前,先执行 `kse context export <spec-name>` 查看设计
178
+ 2. **认领任务**:开始工作前,执行 `kse task claim <spec-name> <task-id>`
179
+ 3. **实现代码**:严格按照 Spec 中的设计实现
180
+ 4. **更新状态**:完成后,在 tasks.md 中标记任务为完成 `[x]`
181
+
182
+ ## 可用命令
183
+
184
+ - `kse status` - 查看项目状态
185
+ - `kse context export <spec-name>` - 导出 Spec 上下文
186
+ - `kse task claim <spec-name> <task-id>` - 认领任务
187
+ - `kse prompt generate <spec-name> <task-id>` - 生成任务提示
188
+
189
+ ## 示例
190
+
191
+ 用户说:"实现用户登录"
192
+ 你应该:
193
+ 1. 执行 `kse context export 01-00-user-login`
194
+ 2. 读取导出的上下文
195
+ 3. 根据设计文档实现代码
196
+ 4. 执行 `kse task claim 01-00-user-login 1.1`
197
+ ```
198
+
199
+ ### 对于 Claude/ChatGPT 用户
200
+
201
+ **创建快捷脚本**:
202
+
203
+ ```bash
204
+ # ~/.bashrc 或 ~/.zshrc
205
+ alias kse-clip='kse context export $1 && cat .kiro/specs/$1/context-export.md | pbcopy && echo "✅ 已复制到剪贴板"'
206
+
207
+ # 使用
208
+ kse-clip 01-00-user-login
209
+ # 然后直接粘贴到 Claude
210
+ ```
211
+
212
+ ### 对于 Cursor 用户
213
+
214
+ **使用 Cursor Rules**:
215
+
216
+ 创建 `.cursorrules` 文件:
217
+ ```markdown
218
+ # Spec 驱动开发
219
+
220
+ 项目使用 kse 管理 Spec。实现功能前:
221
+
222
+ 1. 查看 `.kiro/specs/<spec-name>/design.md`
223
+ 2. 按照设计实现
224
+ 3. 更新 `.kiro/specs/<spec-name>/tasks.md`
225
+
226
+ 示例:
227
+ - 设计文档:`.kiro/specs/01-00-user-login/design.md`
228
+ - 任务列表:`.kiro/specs/01-00-user-login/tasks.md`
229
+ ```
230
+
231
+ ---
232
+
233
+ ## 未来改进方向
234
+
235
+ ### 1. MCP (Model Context Protocol) 集成
236
+
237
+ 让 AI 工具通过 MCP 直接访问 kse:
238
+
239
+ ```javascript
240
+ // AI 工具可以直接调用
241
+ const context = await mcp.call('kse.getContext', '01-00-user-login');
242
+ const tasks = await mcp.call('kse.getTasks', '01-00-user-login');
243
+ ```
244
+
245
+ ### 2. IDE 插件
246
+
247
+ 为主流 IDE 提供插件:
248
+ - VS Code Extension
249
+ - Cursor Extension
250
+ - JetBrains Plugin
251
+
252
+ 功能:
253
+ - 右键菜单:"导出到 AI 工具"
254
+ - 状态栏显示当前 Spec
255
+ - 快捷键快速导出
256
+
257
+ ### 3. Web Dashboard
258
+
259
+ 提供 Web 界面:
260
+ ```bash
261
+ kse serve
262
+ # 打开 http://localhost:3000
263
+ # 可视化管理 Spec,一键复制上下文
264
+ ```
265
+
266
+ ---
267
+
268
+ ## 常见问题
269
+
270
+ ### Q: 为什么不把 kse 做成 AI 工具的插件?
271
+
272
+ **A**:
273
+ - kse 是**通用工具**,支持所有 AI 工具
274
+ - 做成插件会限制在特定工具
275
+ - CLI 工具更灵活,可以被任何工具调用
276
+
277
+ ### Q: 能否让 AI 工具自动读取 .kiro/ 目录?
278
+
279
+ **A**:
280
+ - 部分工具支持(Cursor、Copilot)
281
+ - 但需要明确的上下文导出更可靠
282
+ - kse 的价值在于**结构化和格式化**上下文
283
+
284
+ ### Q: 两套工具确实有点麻烦,有更简单的方案吗?
285
+
286
+ **A**:
287
+ - **短期**:使用 Windsurf/Cline,让 AI 自动调用 kse
288
+ - **中期**:使用快捷脚本(如 `kse-clip`)
289
+ - **长期**:MCP 集成,完全无缝
290
+
291
+ ---
292
+
293
+ ## 总结
294
+
295
+ **kse 的定位**:
296
+ - ❌ 不是独立的开发工具
297
+ - ❌ 不是 AI 工具的竞争对手
298
+ - ✅ 是 AI 工具的**上下文提供者**
299
+ - ✅ 是项目的**Spec 管理系统**
300
+
301
+ **最佳实践**:
302
+ 1. **用 kse 管理 Spec**(需求、设计、任务)
303
+ 2. **用 AI 工具写代码**(主要工作界面)
304
+ 3. **让 AI 工具调用 kse**(自动化集成)
305
+
306
+ **选择合适的模式**:
307
+ - 能执行命令的 AI → 模式 1(AI 主动调用)⭐
308
+ - 不能执行命令的 AI → 模式 2(手动导出)
309
+ - 频繁修改 Spec → 模式 3(Watch Mode)
310
+
311
+ ---
312
+
313
+ **记住**:kse 是幕后英雄,AI 工具是前台明星。两者配合,才能发挥最大价值!🚀
@@ -0,0 +1,263 @@
1
+ # Knowledge Management Guide
2
+
3
+ ## Overview
4
+
5
+ The Knowledge Management system allows you to build and maintain a personal knowledge base within your kse projects. Capture experiences, patterns, best practices, and lessons learned as you work.
6
+
7
+ ## Quick Start
8
+
9
+ ### Initialize Knowledge Base
10
+
11
+ ```bash
12
+ kse knowledge init
13
+ ```
14
+
15
+ This creates `.kiro/knowledge/` directory with:
16
+ - `patterns/` - Design patterns and solutions
17
+ - `lessons/` - Lessons learned
18
+ - `workflows/` - Custom workflows
19
+ - `checklists/` - Task checklists
20
+ - `references/` - Reference materials
21
+
22
+ ### Add Knowledge Entry
23
+
24
+ ```bash
25
+ # Add a design pattern
26
+ kse knowledge add pattern "Repository Pattern Best Practices" \
27
+ --tags "design-pattern,database" \
28
+ --category backend
29
+
30
+ # Add a lesson learned
31
+ kse knowledge add lesson "Avoid N+1 Queries" \
32
+ --tags "performance,database" \
33
+ --category optimization
34
+ ```
35
+
36
+ ### List Entries
37
+
38
+ ```bash
39
+ # List all entries
40
+ kse knowledge list
41
+
42
+ # Filter by type
43
+ kse knowledge list --type pattern
44
+
45
+ # Filter by tag
46
+ kse knowledge list --tag database
47
+
48
+ # Sort by date
49
+ kse knowledge list --sort created:desc
50
+ ```
51
+
52
+ ### Search
53
+
54
+ ```bash
55
+ # Search in titles and tags
56
+ kse knowledge search "database"
57
+
58
+ # Full-text search in content
59
+ kse knowledge search "repository" --full-text
60
+ ```
61
+
62
+ ### View Entry
63
+
64
+ ```bash
65
+ kse knowledge show kb-1770099318706-4dmali
66
+ ```
67
+
68
+ ### Delete Entry
69
+
70
+ ```bash
71
+ # With confirmation
72
+ kse knowledge delete kb-xxx
73
+
74
+ # Skip confirmation
75
+ kse knowledge delete kb-xxx --force
76
+
77
+ # Without backup
78
+ kse knowledge delete kb-xxx --force --no-backup
79
+ ```
80
+
81
+ ### Statistics
82
+
83
+ ```bash
84
+ kse knowledge stats
85
+ ```
86
+
87
+ ## Entry Types
88
+
89
+ ### Pattern
90
+ Design patterns, architectural solutions, code patterns.
91
+
92
+ **Template sections**:
93
+ - Context - When to use
94
+ - Problem - What it solves
95
+ - Solution - How to implement
96
+ - Examples - Code examples
97
+ - Trade-offs - Pros and cons
98
+ - References - Related resources
99
+
100
+ ### Lesson
101
+ Lessons learned from experience, mistakes, successes.
102
+
103
+ **Template sections**:
104
+ - Situation - Context
105
+ - Challenge - Problem faced
106
+ - Action - What you did
107
+ - Result - Outcome
108
+ - Lesson Learned - Key takeaway
109
+ - Application - Future use
110
+
111
+ ### Workflow
112
+ Custom workflows, processes, procedures.
113
+
114
+ **Template sections**:
115
+ - Purpose - What it's for
116
+ - Prerequisites - Requirements
117
+ - Steps - Step-by-step guide
118
+ - Verification - How to verify
119
+ - Troubleshooting - Common issues
120
+ - References - Related docs
121
+
122
+ ### Checklist
123
+ Task checklists, verification lists.
124
+
125
+ **Template sections**:
126
+ - Purpose - What it's for
127
+ - Checklist Items - Items to check
128
+ - Notes - Additional context
129
+ - References - Related resources
130
+
131
+ ### Reference
132
+ Reference materials, links, documentation.
133
+
134
+ **Template sections**:
135
+ - Overview - Brief description
136
+ - Key Information - Important details
137
+ - Usage - How to use
138
+ - Examples - Practical examples
139
+ - Related - Related references
140
+
141
+ ## Best Practices
142
+
143
+ ### When to Add Knowledge
144
+
145
+ - ✅ After solving a difficult problem
146
+ - ✅ When discovering a useful pattern
147
+ - ✅ After making a mistake (lesson learned)
148
+ - ✅ When creating a reusable workflow
149
+ - ✅ When finding useful references
150
+
151
+ ### Tagging Strategy
152
+
153
+ Use consistent, descriptive tags:
154
+ - **Technology**: `javascript`, `python`, `react`, `node`
155
+ - **Domain**: `backend`, `frontend`, `database`, `api`
156
+ - **Type**: `design-pattern`, `performance`, `security`, `testing`
157
+ - **Level**: `beginner`, `intermediate`, `advanced`
158
+
159
+ ### Organization Tips
160
+
161
+ 1. **Be Specific**: Clear, descriptive titles
162
+ 2. **Add Context**: Explain when and why
163
+ 3. **Include Examples**: Code snippets, screenshots
164
+ 4. **Link Related**: Reference other entries
165
+ 5. **Keep Updated**: Review and update periodically
166
+
167
+ ## Advanced Usage
168
+
169
+ ### Custom Templates
170
+
171
+ Create custom templates in `.kiro/knowledge/.templates/`:
172
+
173
+ ```markdown
174
+ ---
175
+ id: {{ID}}
176
+ type: custom-type
177
+ title: {{TITLE}}
178
+ created: {{DATE}}
179
+ updated: {{DATE}}
180
+ tags: []
181
+ status: active
182
+ ---
183
+
184
+ ## Your Custom Sections
185
+
186
+ Content here...
187
+ ```
188
+
189
+ ### Bulk Operations
190
+
191
+ ```bash
192
+ # Export all entries
193
+ kse knowledge export --output my-knowledge.zip
194
+
195
+ # Import entries
196
+ kse knowledge import my-knowledge.zip
197
+ ```
198
+
199
+ ### Integration with Project
200
+
201
+ Knowledge entries can reference project files:
202
+
203
+ ```markdown
204
+ ## Related Code
205
+
206
+ See implementation in `lib/repository/user-repository.js`
207
+ ```
208
+
209
+ ## Troubleshooting
210
+
211
+ ### Knowledge Base Not Found
212
+
213
+ ```bash
214
+ Error: Knowledge base not initialized
215
+ ```
216
+
217
+ **Solution**: Run `kse knowledge init`
218
+
219
+ ### Entry Not Found
220
+
221
+ ```bash
222
+ Error: Entry not found: kb-xxx
223
+ ```
224
+
225
+ **Solution**: Check ID with `kse knowledge list`
226
+
227
+ ### Corrupted Index
228
+
229
+ ```bash
230
+ Error: Failed to load index
231
+ ```
232
+
233
+ **Solution**: Rebuild index:
234
+ ```bash
235
+ # Delete index.json
236
+ rm .kiro/knowledge/index.json
237
+
238
+ # Reinitialize
239
+ kse knowledge init
240
+ ```
241
+
242
+ ## FAQ
243
+
244
+ **Q: Where is knowledge stored?**
245
+ A: In `.kiro/knowledge/` directory, organized by type.
246
+
247
+ **Q: Can I edit entries manually?**
248
+ A: Yes, they're just Markdown files with YAML frontmatter.
249
+
250
+ **Q: How do I share knowledge with team?**
251
+ A: Commit `.kiro/knowledge/` to git (except `.backups/`).
252
+
253
+ **Q: Can I use custom entry types?**
254
+ A: Yes, create custom templates in `.kiro/knowledge/.templates/`.
255
+
256
+ **Q: How do I backup my knowledge?**
257
+ A: Use `kse knowledge export` or commit to git.
258
+
259
+ ## See Also
260
+
261
+ - [Command Reference](./command-reference.md)
262
+ - [Quick Start](./quick-start.md)
263
+ - [Spec Workflow](./spec-workflow.md)