kiro-spec-engine 1.3.0 → 1.4.1

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 (36) hide show
  1. package/CHANGELOG.md +85 -0
  2. package/README.md +228 -367
  3. package/README.zh.md +0 -330
  4. package/docs/README.md +223 -0
  5. package/docs/command-reference.md +252 -0
  6. package/docs/examples/add-export-command/design.md +194 -0
  7. package/docs/examples/add-export-command/requirements.md +110 -0
  8. package/docs/examples/add-export-command/tasks.md +88 -0
  9. package/docs/examples/add-rest-api/design.md +855 -0
  10. package/docs/examples/add-rest-api/requirements.md +323 -0
  11. package/docs/examples/add-rest-api/tasks.md +355 -0
  12. package/docs/examples/add-user-dashboard/design.md +192 -0
  13. package/docs/examples/add-user-dashboard/requirements.md +143 -0
  14. package/docs/examples/add-user-dashboard/tasks.md +91 -0
  15. package/docs/faq.md +696 -0
  16. package/docs/integration-modes.md +529 -0
  17. package/docs/integration-philosophy.md +313 -0
  18. package/docs/quick-start-with-ai-tools.md +374 -0
  19. package/docs/quick-start.md +711 -0
  20. package/docs/spec-workflow.md +453 -0
  21. package/docs/tools/claude-guide.md +653 -0
  22. package/docs/tools/cursor-guide.md +705 -0
  23. package/docs/tools/generic-guide.md +445 -0
  24. package/docs/tools/kiro-guide.md +308 -0
  25. package/docs/tools/vscode-guide.md +444 -0
  26. package/docs/tools/windsurf-guide.md +390 -0
  27. package/docs/troubleshooting.md +795 -0
  28. package/docs/zh/README.md +275 -0
  29. package/docs/zh/quick-start.md +711 -0
  30. package/docs/zh/tools/claude-guide.md +348 -0
  31. package/docs/zh/tools/cursor-guide.md +280 -0
  32. package/docs/zh/tools/generic-guide.md +498 -0
  33. package/docs/zh/tools/kiro-guide.md +342 -0
  34. package/docs/zh/tools/vscode-guide.md +448 -0
  35. package/docs/zh/tools/windsurf-guide.md +377 -0
  36. package/package.json +1 -1
@@ -0,0 +1,308 @@
1
+ # Using kse with Kiro IDE
2
+
3
+ > Native integration guide for kse with Kiro IDE
4
+
5
+ ---
6
+
7
+ **Version**: 1.0.0
8
+ **Last Updated**: 2026-01-23
9
+ **Tool**: Kiro IDE
10
+ **Integration Mode**: Native Integration
11
+ **Estimated Setup Time**: None (built-in)
12
+
13
+ ---
14
+
15
+ ## Overview
16
+
17
+ **Kiro IDE** is the native development environment for kse with built-in Spec-driven development support.
18
+
19
+ **kse integration with Kiro** uses **Native Integration** - no manual export needed, everything is automatic.
20
+
21
+ ### Why Use kse with Kiro?
22
+
23
+ - ✅ **Zero setup** - Works out of the box
24
+ - ✅ **Fully automatic** - No manual commands needed
25
+ - ✅ **Seamless workflow** - AI reads Specs directly
26
+ - ✅ **Auto task tracking** - Tasks update automatically
27
+ - ✅ **Best experience** - Purpose-built for kse
28
+
29
+ ---
30
+
31
+ ## Integration Mode
32
+
33
+ **Mode:** Native Integration (Fully Automatic)
34
+
35
+ **How it works:**
36
+ 1. You create Specs in kse
37
+ 2. Kiro AI automatically reads Spec files
38
+ 3. Kiro AI implements features based on Specs
39
+ 4. Kiro AI updates tasks.md automatically
40
+ 5. No manual export or copy-paste needed
41
+
42
+ ---
43
+
44
+ ## Setup
45
+
46
+ ### Prerequisites
47
+
48
+ - **Kiro IDE installed**
49
+ - **Project with .kiro/ directory**
50
+
51
+ ### No Setup Required!
52
+
53
+ Kiro IDE automatically detects and uses kse Specs. Just start working.
54
+
55
+ ---
56
+
57
+ ## Workflow
58
+
59
+ ### Method 1: Natural Language (Recommended) ⭐
60
+
61
+ **Simply tell Kiro what you want:**
62
+
63
+ ```
64
+ You: "Implement the user login feature"
65
+
66
+ Kiro AI:
67
+ [Automatically reads] .kiro/specs/01-00-user-login/
68
+ [Understands] Requirements, Design, Tasks
69
+ [Implements] Code according to design
70
+ [Updates] tasks.md automatically
71
+ [Shows] "Implemented tasks 1.1-1.3, ready for review"
72
+ ```
73
+
74
+ **No commands needed. No context export. Just natural conversation.**
75
+
76
+ ### Method 2: Spec-Specific Instructions
77
+
78
+ ```
79
+ You: "Check the Spec for 01-00-user-login and implement task 2.1"
80
+
81
+ Kiro AI:
82
+ [Reads Spec]
83
+ [Implements task 2.1]
84
+ [Updates tasks.md]
85
+ [Done]
86
+ ```
87
+
88
+ ### Method 3: Design Review
89
+
90
+ ```
91
+ You: "Review the design for user login and suggest improvements"
92
+
93
+ Kiro AI:
94
+ [Reads design.md]
95
+ [Analyzes architecture]
96
+ [Provides feedback]
97
+ [Suggests improvements]
98
+ ```
99
+
100
+ ---
101
+
102
+ ## Example Workflow
103
+
104
+ ### Complete Feature Implementation
105
+
106
+ **1. Create Spec (using Kiro or command line)**
107
+ ```
108
+ You: "Create a new Spec for user login"
109
+
110
+ Kiro AI:
111
+ [Creates] .kiro/specs/01-00-user-login/
112
+ [Generates] requirements.md, design.md, tasks.md templates
113
+ [Opens] Files for editing
114
+ ```
115
+
116
+ **2. Write or refine Spec**
117
+ ```
118
+ You: "Help me write the requirements for user login"
119
+
120
+ Kiro AI:
121
+ [Suggests] User stories
122
+ [Suggests] Acceptance criteria
123
+ [Suggests] Non-functional requirements
124
+ ```
125
+
126
+ **3. Implement**
127
+ ```
128
+ You: "Implement this Spec"
129
+
130
+ Kiro AI:
131
+ [Reads all Spec files]
132
+ [Implements all tasks]
133
+ [Runs tests]
134
+ [Updates tasks.md]
135
+ [Reports] "Feature complete, all tests passing"
136
+ ```
137
+
138
+ **4. Review**
139
+ ```
140
+ You: "Show me what you implemented"
141
+
142
+ Kiro AI:
143
+ [Shows] File changes
144
+ [Shows] Completed tasks
145
+ [Shows] Test results
146
+ ```
147
+
148
+ ---
149
+
150
+ ## Key Features
151
+
152
+ ### 1. Automatic Spec Detection
153
+
154
+ Kiro automatically finds and reads Specs. No need to specify paths.
155
+
156
+ ```
157
+ You: "What Specs do we have?"
158
+ Kiro: "Found 3 Specs: 01-00-user-login, 02-00-password-reset, 03-00-user-profile"
159
+ ```
160
+
161
+ ### 2. Intelligent Task Management
162
+
163
+ Kiro tracks tasks automatically.
164
+
165
+ ```
166
+ You: "What's the status of user login?"
167
+ Kiro: "5 tasks complete, 3 in progress, 2 not started. Next: Implement rate limiting"
168
+ ```
169
+
170
+ ### 3. Design-First Development
171
+
172
+ Kiro enforces following the design.
173
+
174
+ ```
175
+ You: "Implement AuthController"
176
+ Kiro: [Reads design.md] [Implements exactly as designed] [No deviations]
177
+ ```
178
+
179
+ ### 4. Continuous Validation
180
+
181
+ Kiro validates against requirements.
182
+
183
+ ```
184
+ Kiro: "Implementation complete. Validating against requirements..."
185
+ Kiro: "✓ All acceptance criteria met"
186
+ Kiro: "✓ All non-functional requirements satisfied"
187
+ ```
188
+
189
+ ---
190
+
191
+ ## Tips & Best Practices
192
+
193
+ ### 1. Trust the Automation
194
+
195
+ Let Kiro handle Spec reading and task tracking. Don't manually export context.
196
+
197
+ ### 2. Use Natural Language
198
+
199
+ ```
200
+ Good: "Implement user login"
201
+ Also good: "Build the login feature"
202
+ Also good: "Let's work on authentication"
203
+ ```
204
+
205
+ ### 3. Leverage Design Review
206
+
207
+ ```
208
+ "Review the design before we start implementing"
209
+ ```
210
+
211
+ ### 4. Iterative Refinement
212
+
213
+ ```
214
+ "Implement task 1.1"
215
+ [Review]
216
+ "Good, now task 1.2"
217
+ [Review]
218
+ "Perfect, continue with remaining tasks"
219
+ ```
220
+
221
+ ### 5. Ask for Status Anytime
222
+
223
+ ```
224
+ "What's our progress on user login?"
225
+ "Which tasks are complete?"
226
+ "What should we work on next?"
227
+ ```
228
+
229
+ ---
230
+
231
+ ## Advantages Over Other Tools
232
+
233
+ ### vs Manual Export (Claude, Cursor)
234
+
235
+ - ✅ No manual export needed
236
+ - ✅ No copy-paste
237
+ - ✅ Always up-to-date
238
+ - ✅ Automatic task tracking
239
+
240
+ ### vs AI-Executed Commands (Windsurf)
241
+
242
+ - ✅ No command execution needed
243
+ - ✅ Faster (no command overhead)
244
+ - ✅ More reliable (no command failures)
245
+ - ✅ Better integration
246
+
247
+ ### vs Watch Mode
248
+
249
+ - ✅ No background process needed
250
+ - ✅ No configuration required
251
+ - ✅ Instant updates
252
+ - ✅ Lower resource usage
253
+
254
+ ---
255
+
256
+ ## Troubleshooting
257
+
258
+ ### Issue: Kiro doesn't see my Spec
259
+
260
+ **Check:**
261
+ 1. Spec is in `.kiro/specs/` directory
262
+ 2. Spec has requirements.md, design.md, tasks.md
263
+ 3. Files are not empty
264
+
265
+ ### Issue: Kiro doesn't follow design
266
+
267
+ **This shouldn't happen with Kiro.** If it does:
268
+ 1. Check design.md is complete and clear
269
+ 2. Report as a bug
270
+
271
+ ### Issue: Tasks not updating
272
+
273
+ **This shouldn't happen with Kiro.** If it does:
274
+ 1. Check tasks.md file permissions
275
+ 2. Report as a bug
276
+
277
+ ---
278
+
279
+ ## Related Documentation
280
+
281
+ - **[Quick Start Guide](../quick-start.md)** - Get started with kse
282
+ - **[Integration Modes](../integration-modes.md)** - Understanding integration modes
283
+ - **[Spec Workflow](../spec-workflow.md)** - Creating effective Specs
284
+
285
+ ---
286
+
287
+ ## Summary
288
+
289
+ **Kiro + kse = Perfect Integration**
290
+
291
+ **Zero setup, zero manual work:**
292
+ 1. Create Spec
293
+ 2. Tell Kiro what to build
294
+ 3. Kiro does everything automatically
295
+ 4. Review and approve
296
+
297
+ **This is the ideal kse experience.** All other tools require workarounds because they weren't built for kse. Kiro was.
298
+
299
+ **Start using:** 🚀
300
+ ```
301
+ Just open Kiro IDE and say:
302
+ "Create a Spec for user login and implement it"
303
+ ```
304
+
305
+ ---
306
+
307
+ **Version**: 1.0.0
308
+ **Last Updated**: 2026-01-23