ai-sprint-kit 1.1.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 (59) hide show
  1. package/README.md +299 -0
  2. package/bin/cli.js +135 -0
  3. package/lib/installer.js +205 -0
  4. package/lib/scanner.js +341 -0
  5. package/package.json +55 -0
  6. package/templates/.claude/.env.example +13 -0
  7. package/templates/.claude/agents/debugger.md +667 -0
  8. package/templates/.claude/agents/devops.md +727 -0
  9. package/templates/.claude/agents/docs.md +661 -0
  10. package/templates/.claude/agents/implementer.md +235 -0
  11. package/templates/.claude/agents/planner.md +243 -0
  12. package/templates/.claude/agents/researcher.md +448 -0
  13. package/templates/.claude/agents/reviewer.md +610 -0
  14. package/templates/.claude/agents/security.md +202 -0
  15. package/templates/.claude/agents/tester.md +604 -0
  16. package/templates/.claude/commands/auto.md +85 -0
  17. package/templates/.claude/commands/code.md +301 -0
  18. package/templates/.claude/commands/debug.md +449 -0
  19. package/templates/.claude/commands/deploy.md +475 -0
  20. package/templates/.claude/commands/docs.md +519 -0
  21. package/templates/.claude/commands/plan.md +57 -0
  22. package/templates/.claude/commands/review.md +412 -0
  23. package/templates/.claude/commands/scan.md +146 -0
  24. package/templates/.claude/commands/secure.md +88 -0
  25. package/templates/.claude/commands/test.md +352 -0
  26. package/templates/.claude/commands/validate.md +238 -0
  27. package/templates/.claude/settings.json +27 -0
  28. package/templates/.claude/skills/codebase-context/SKILL.md +68 -0
  29. package/templates/.claude/skills/codebase-context/references/reading-context.md +68 -0
  30. package/templates/.claude/skills/codebase-context/references/refresh-triggers.md +82 -0
  31. package/templates/.claude/skills/implementation/SKILL.md +70 -0
  32. package/templates/.claude/skills/implementation/references/error-handling.md +106 -0
  33. package/templates/.claude/skills/implementation/references/security-patterns.md +73 -0
  34. package/templates/.claude/skills/implementation/references/validation-patterns.md +107 -0
  35. package/templates/.claude/skills/memory/SKILL.md +67 -0
  36. package/templates/.claude/skills/memory/references/decisions-format.md +68 -0
  37. package/templates/.claude/skills/memory/references/learning-format.md +74 -0
  38. package/templates/.claude/skills/planning/SKILL.md +72 -0
  39. package/templates/.claude/skills/planning/references/plan-templates.md +81 -0
  40. package/templates/.claude/skills/planning/references/research-phase.md +62 -0
  41. package/templates/.claude/skills/planning/references/solution-design.md +66 -0
  42. package/templates/.claude/skills/quality-assurance/SKILL.md +79 -0
  43. package/templates/.claude/skills/quality-assurance/references/review-checklist.md +72 -0
  44. package/templates/.claude/skills/quality-assurance/references/security-checklist.md +70 -0
  45. package/templates/.claude/skills/quality-assurance/references/testing-strategy.md +85 -0
  46. package/templates/.claude/statusline.sh +126 -0
  47. package/templates/.claude/workflows/development-rules.md +97 -0
  48. package/templates/.claude/workflows/orchestration-protocol.md +194 -0
  49. package/templates/.mcp.json.example +36 -0
  50. package/templates/CLAUDE.md +409 -0
  51. package/templates/README.md +331 -0
  52. package/templates/ai_context/codebase/.gitkeep +0 -0
  53. package/templates/ai_context/memory/active.md +15 -0
  54. package/templates/ai_context/memory/decisions.md +18 -0
  55. package/templates/ai_context/memory/learning.md +22 -0
  56. package/templates/ai_context/plans/.gitkeep +0 -0
  57. package/templates/ai_context/reports/.gitkeep +0 -0
  58. package/templates/docs/user-guide-th.md +454 -0
  59. package/templates/docs/user-guide.md +595 -0
@@ -0,0 +1,454 @@
1
+ # คู่มือการใช้งาน AI Sprint
2
+
3
+ คู่มือฉบับสมบูรณ์สำหรับการใช้งาน AI Sprint กับ Claude Code
4
+
5
+ ## สารบัญ
6
+
7
+ 1. [เริ่มต้นใช้งาน](#เริ่มต้นใช้งาน)
8
+ 2. [วิธีใช้งานแบบต่างๆ](#วิธีใช้งานแบบต่างๆ)
9
+ 3. [คำสั่งทั้งหมด](#คำสั่งทั้งหมด)
10
+ 4. [ตั้งค่าเครื่องมือเสริม MCP](#ตั้งค่าเครื่องมือเสริม-mcp)
11
+ 5. [เคล็ดลับการใช้งาน](#เคล็ดลับการใช้งาน)
12
+ 6. [แก้ปัญหาที่พบบ่อย](#แก้ปัญหาที่พบบ่อย)
13
+
14
+ ---
15
+
16
+ ## เริ่มต้นใช้งาน
17
+
18
+ ### AI Sprint คืออะไร?
19
+
20
+ AI Sprint คือเครื่องมือที่ช่วยให้คุณสร้างซอฟต์แวร์ได้ง่ายขึ้น โดยมี AI ช่วยเขียนโค้ด ทดสอบ และตรวจสอบความปลอดภัยให้อัตโนมัติ
21
+
22
+ **ข้อดีหลักๆ:**
23
+ - 🤖 มี AI ผู้เชี่ยวชาญ 9 ตัว ช่วยงานแต่ละด้าน
24
+ - ⚡ มีคำสั่งลัด 10 คำสั่ง ใช้งานง่าย
25
+ - 🔒 ตรวจสอบความปลอดภัยอัตโนมัติ
26
+ - 📝 สร้างเอกสารให้อัตโนมัติ
27
+
28
+ ### สิ่งที่ต้องมีก่อนใช้งาน
29
+
30
+ 1. **Claude Code** - โปรแกรมหลักที่ใช้รัน AI
31
+ 2. **Node.js** เวอร์ชัน 18 ขึ้นไป
32
+
33
+ ### เริ่มใช้งานครั้งแรก
34
+
35
+ หลังจากติดตั้งเสร็จแล้ว ให้ทำตามขั้นตอนนี้:
36
+
37
+ ```bash
38
+ # 1. เปิด Claude Code
39
+ claude
40
+
41
+ # 2. ลองใช้คำสั่ง /auto (ทำทุกอย่างอัตโนมัติ)
42
+ /auto "สร้าง API สำหรับแสดงข้อมูลสินค้า"
43
+ ```
44
+
45
+ เพียงเท่านี้ AI จะสร้างโค้ด, ทดสอบ, และตรวจสอบความปลอดภัยให้อัตโนมัติ!
46
+
47
+ ### โครงสร้างโฟลเดอร์
48
+
49
+ หลังติดตั้ง จะมีโฟลเดอร์ใหม่ในโปรเจกต์ของคุณ:
50
+
51
+ ```
52
+ โปรเจกต์ของคุณ/
53
+ ├── .claude/ ← ไฟล์ตั้งค่าของ AI
54
+ ├── ai_context/ ← ผลงานที่ AI สร้าง
55
+ │ ├── plans/ ← แผนการทำงาน
56
+ │ ├── reports/ ← รายงานต่างๆ
57
+ │ └── memory/ ← บันทึกความจำของ AI
58
+ ├── docs/ ← คู่มือ (รวมถึงไฟล์นี้)
59
+ └── CLAUDE.md ← คำแนะนำสำหรับ AI
60
+ ```
61
+
62
+ ---
63
+
64
+ ## วิธีใช้งานแบบต่างๆ
65
+
66
+ ### วิธีที่ 1: อัตโนมัติเต็มรูปแบบ (แนะนำสำหรับมือใหม่)
67
+
68
+ วิธีที่ง่ายที่สุด - บอก AI ว่าอยากได้อะไร แล้วให้ทำทุกอย่างเอง:
69
+
70
+ ```bash
71
+ /auto "สร้างระบบลงทะเบียนสมาชิกด้วยอีเมลและรหัสผ่าน"
72
+ ```
73
+
74
+ **AI จะทำอะไรบ้าง:**
75
+ 1. วางแผนการทำงาน
76
+ 2. เขียนโค้ด
77
+ 3. สร้างและรันการทดสอบ
78
+ 4. ตรวจสอบคุณภาพโค้ด
79
+ 5. ตรวจสอบความปลอดภัย
80
+ 6. สร้างเอกสาร
81
+
82
+ **เหมาะกับ:** ฟีเจอร์ใหม่, งานที่ไม่ซับซ้อนมาก
83
+
84
+ ### วิธีที่ 2: ทำทีละขั้นตอน (สำหรับควบคุมรายละเอียด)
85
+
86
+ ถ้าอยากตรวจสอบแต่ละขั้นตอน:
87
+
88
+ ```bash
89
+ # ขั้นที่ 1: วางแผน
90
+ /plan "สร้างระบบลงทะเบียนสมาชิก"
91
+ # ดูแผนใน ai_context/plans/ แล้วค่อยไปต่อ
92
+
93
+ # ขั้นที่ 2: เขียนโค้ด
94
+ /code "สร้างระบบตามแผนที่วางไว้"
95
+
96
+ # ขั้นที่ 3: ทดสอบ
97
+ /test
98
+
99
+ # ขั้นที่ 4: ตรวจสอบคุณภาพ
100
+ /review
101
+
102
+ # ขั้นที่ 5: ตรวจสอบความปลอดภัย
103
+ /secure
104
+ ```
105
+
106
+ **เหมาะกับ:** งานซับซ้อน, เมื่อต้องการตรวจสอบทุกขั้นตอน
107
+
108
+ ### วิธีที่ 3: แก้บัค (Bug)
109
+
110
+ เมื่อโปรแกรมมีปัญหา:
111
+
112
+ ```bash
113
+ # ขั้นที่ 1: หาสาเหตุ
114
+ /debug "หน้าลงทะเบียนแสดง Error 500 ตอนกดสมัคร"
115
+
116
+ # ขั้นที่ 2: แก้ไข
117
+ /code "แก้ไขปัญหาตามที่วิเคราะห์"
118
+
119
+ # ขั้นที่ 3: ทดสอบว่าแก้ได้จริง
120
+ /test
121
+ ```
122
+
123
+ ### วิธีที่ 4: ตรวจสอบก่อนส่งงาน
124
+
125
+ **ทำทุกครั้ง** ก่อนบันทึกโค้ดลง Git:
126
+
127
+ ```bash
128
+ /validate
129
+ ```
130
+
131
+ คำสั่งนี้จะ:
132
+ - รันการทดสอบทั้งหมด
133
+ - ตรวจสอบคุณภาพโค้ด
134
+ - ตรวจสอบความปลอดภัย
135
+
136
+ ถ้าพบปัญหา จะแจ้งเตือนให้แก้ไขก่อน
137
+
138
+ ---
139
+
140
+ ## คำสั่งทั้งหมด
141
+
142
+ ### /plan - วางแผนการทำงาน
143
+
144
+ บอก AI ว่าอยากสร้างอะไร แล้วให้วางแผนก่อน
145
+
146
+ ```bash
147
+ /plan "สร้างระบบตะกร้าสินค้า"
148
+ /plan "เพิ่มระบบ Login ด้วย Google"
149
+ ```
150
+
151
+ **ผลลัพธ์:** ได้แผนการทำงานใน `ai_context/plans/`
152
+
153
+ ---
154
+
155
+ ### /code - เขียนโค้ด
156
+
157
+ ให้ AI เขียนหรือแก้ไขโค้ด
158
+
159
+ ```bash
160
+ /code "สร้างระบบตามแผนที่วางไว้"
161
+ /code "เพิ่มปุ่มออกจากระบบ"
162
+ /code "แก้ไขหน้าแสดงสินค้าให้โหลดเร็วขึ้น"
163
+ ```
164
+
165
+ ---
166
+
167
+ ### /test - ทดสอบโค้ด
168
+
169
+ สร้างและรันการทดสอบอัตโนมัติ
170
+
171
+ ```bash
172
+ /test
173
+ ```
174
+
175
+ **สิ่งที่ได้:**
176
+ - การทดสอบใหม่สำหรับโค้ดที่เขียน
177
+ - รายงานว่าผ่าน/ไม่ผ่าน
178
+ - เปอร์เซ็นต์ความครอบคลุม (ต้องได้ 80% ขึ้นไป)
179
+
180
+ ---
181
+
182
+ ### /review - ตรวจสอบคุณภาพ
183
+
184
+ ให้ AI ตรวจสอบว่าโค้ดเขียนดีหรือไม่
185
+
186
+ ```bash
187
+ /review
188
+ ```
189
+
190
+ **AI จะดู:**
191
+ - โค้ดเข้าใจง่ายไหม
192
+ - มีข้อผิดพลาดที่อาจเกิดขึ้นไหม
193
+ - ทำงานเร็วพอไหม
194
+ - มีจุดที่อาจไม่ปลอดภัยไหม
195
+
196
+ ---
197
+
198
+ ### /secure - ตรวจสอบความปลอดภัย
199
+
200
+ ตรวจหาช่องโหว่และปัญหาด้านความปลอดภัย
201
+
202
+ ```bash
203
+ /secure
204
+ ```
205
+
206
+ **AI จะตรวจ:**
207
+ - รหัสผ่านหรือข้อมูลลับที่ฝังในโค้ด
208
+ - ช่องโหว่ที่แฮกเกอร์อาจโจมตีได้
209
+ - ไลบรารีที่มีปัญหาความปลอดภัย
210
+
211
+ ---
212
+
213
+ ### /deploy - ตั้งค่าการ Deploy
214
+
215
+ ตั้งค่าระบบ CI/CD สำหรับ Deploy อัตโนมัติ
216
+
217
+ ```bash
218
+ /deploy
219
+ ```
220
+
221
+ ---
222
+
223
+ ### /docs - สร้างเอกสาร
224
+
225
+ สร้างเอกสารอธิบายโค้ดอัตโนมัติ
226
+
227
+ ```bash
228
+ /docs
229
+ ```
230
+
231
+ ---
232
+
233
+ ### /debug - หาสาเหตุปัญหา
234
+
235
+ เมื่อโปรแกรมมีบัค ให้ AI ช่วยหาสาเหตุ
236
+
237
+ ```bash
238
+ /debug "หน้าเว็บโหลดช้ามากเมื่อมีสินค้าเยอะ"
239
+ /debug "ระบบล็อกอินใช้ไม่ได้"
240
+ ```
241
+
242
+ **ผลลัพธ์:** รายงานวิเคราะห์สาเหตุและวิธีแก้ไข
243
+
244
+ ---
245
+
246
+ ### /validate - ตรวจสอบก่อนส่งงาน
247
+
248
+ รวมการทดสอบ + ตรวจคุณภาพ + ตรวจความปลอดภัย
249
+
250
+ ```bash
251
+ /validate
252
+ ```
253
+
254
+ **ใช้ทุกครั้งก่อนบันทึกโค้ด!**
255
+
256
+ ---
257
+
258
+ ### /auto - ทำทุกอย่างอัตโนมัติ
259
+
260
+ คำสั่งเดียวทำครบทุกขั้นตอน
261
+
262
+ ```bash
263
+ /auto "สร้างหน้าแสดงรายการสั่งซื้อ"
264
+ ```
265
+
266
+ **AI จะทำ:** วางแผน → เขียนโค้ด → ทดสอบ → ตรวจคุณภาพ → ตรวจความปลอดภัย → สร้างเอกสาร
267
+
268
+ ---
269
+
270
+ ## ตั้งค่าเครื่องมือเสริม MCP
271
+
272
+ MCP คือเครื่องมือเสริมที่ช่วยให้ AI ทำงานได้ดีขึ้น (ไม่บังคับแต่แนะนำ)
273
+
274
+ ### ตั้งค่าเบื้องต้น
275
+
276
+ ```bash
277
+ # 1. คัดลอกไฟล์ตัวอย่าง
278
+ cp .mcp.json.example .mcp.json
279
+
280
+ # 2. แก้ไขไฟล์ .mcp.json ใส่ API Key ของคุณ
281
+ ```
282
+
283
+ ### เครื่องมือที่มีให้ใช้
284
+
285
+ | เครื่องมือ | ประโยชน์ | รับ API Key ได้ที่ |
286
+ |-----------|---------|-------------------|
287
+ | **exa** | ค้นหาข้อมูลบนเว็บ (ดีกว่าปกติ) | https://exa.ai |
288
+ | **context7** | ดูเอกสารของไลบรารีต่างๆ | https://context7.com |
289
+ | **chrome-devtools** | Debug เว็บไซต์ | ไม่ต้องใช้ Key |
290
+ | **sequential-thinking** | คิดวิเคราะห์ซับซ้อน | ไม่ต้องใช้ Key |
291
+
292
+ ### วิธีตั้งค่า
293
+
294
+ เปิดไฟล์ `.mcp.json` แล้วใส่ API Key:
295
+
296
+ ```json
297
+ {
298
+ "mcpServers": {
299
+ "exa": {
300
+ "command": "npx",
301
+ "args": ["-y", "exa-mcp-server"],
302
+ "env": {
303
+ "EXA_API_KEY": "ใส่-key-ของคุณ-ตรงนี้"
304
+ }
305
+ }
306
+ }
307
+ }
308
+ ```
309
+
310
+ ### ทำไมควรตั้งค่า?
311
+
312
+ - **exa** - ช่วยให้ AI ค้นหาข้อมูลใหม่ๆ บนอินเทอร์เน็ตได้
313
+ - **context7** - ช่วยให้ AI อ่านเอกสารของไลบรารีที่ใช้ได้
314
+
315
+ ---
316
+
317
+ ## เคล็ดลับการใช้งาน
318
+
319
+ ### 1. เริ่มต้นด้วยการวางแผนเสมอ
320
+
321
+ สำหรับงานที่ซับซ้อน ให้วางแผนก่อนเขียนโค้ด:
322
+
323
+ ```bash
324
+ /plan "อธิบายสิ่งที่ต้องการ"
325
+ # ดูแผนก่อน แล้วค่อย
326
+ /code "สร้างตามแผน"
327
+ ```
328
+
329
+ ### 2. ใช้ /validate ทุกครั้งก่อนบันทึก
330
+
331
+ ```bash
332
+ /validate
333
+ # ถ้าผ่าน ค่อยบันทึกโค้ด
334
+ git add .
335
+ git commit -m "เพิ่มฟีเจอร์ใหม่"
336
+ ```
337
+
338
+ ### 3. อ่านรายงานที่ AI สร้าง
339
+
340
+ AI จะบันทึกผลการทำงานไว้ใน `ai_context/reports/`
341
+
342
+ ```bash
343
+ # ดูรายงานความปลอดภัย
344
+ cat ai_context/reports/security-*.md
345
+ ```
346
+
347
+ ### 4. ใช้ /auto สำหรับงานง่ายๆ
348
+
349
+ ฟีเจอร์เล็กๆ ใช้ /auto ได้เลย:
350
+
351
+ ```bash
352
+ /auto "เพิ่มปุ่มกลับหน้าแรก"
353
+ ```
354
+
355
+ ### 5. ใช้ทีละขั้นตอนสำหรับงานซับซ้อน
356
+
357
+ งานใหญ่ๆ ควรทำทีละขั้น:
358
+
359
+ ```bash
360
+ /plan "ระบบซับซ้อน"
361
+ # ดูแผน
362
+ /code "ทำส่วนที่ 1"
363
+ /test
364
+ /code "ทำส่วนที่ 2"
365
+ /test
366
+ /validate
367
+ ```
368
+
369
+ ---
370
+
371
+ ## แก้ปัญหาที่พบบ่อย
372
+
373
+ ### การทดสอบไม่ผ่าน
374
+
375
+ ```bash
376
+ # ดูว่าผิดพลาดตรงไหน
377
+ /test
378
+
379
+ # ให้ AI ช่วยหาสาเหตุ
380
+ /debug "การทดสอบ X ไม่ผ่าน แสดง Error Y"
381
+ ```
382
+
383
+ ### ความครอบคลุมการทดสอบต่ำ
384
+
385
+ ```bash
386
+ # สร้างการทดสอบเพิ่ม
387
+ /test "สร้างการทดสอบเพิ่มสำหรับฟังก์ชันที่ยังไม่ได้ทดสอบ"
388
+ ```
389
+
390
+ ### พบปัญหาความปลอดภัย
391
+
392
+ ```bash
393
+ # ดูรายงาน
394
+ cat ai_context/reports/security-*.md
395
+
396
+ # แก้ไข
397
+ /code "แก้ไขปัญหาความปลอดภัยตามรายงาน"
398
+
399
+ # ตรวจสอบอีกครั้ง
400
+ /secure
401
+ ```
402
+
403
+ ### คำสั่งไม่ทำงาน
404
+
405
+ ตรวจสอบว่าอยู่ในโฟลเดอร์ที่มี `.claude/`:
406
+
407
+ ```bash
408
+ ls .claude/
409
+ ```
410
+
411
+ ถ้าไม่มี ให้ติดตั้งใหม่:
412
+
413
+ ```bash
414
+ npx ai-sprint init --force
415
+ ```
416
+
417
+ ### MCP ไม่ทำงาน
418
+
419
+ ตรวจสอบว่าไฟล์ `.mcp.json` ถูกต้อง:
420
+
421
+ ```bash
422
+ # ดูว่ามีไฟล์ไหม
423
+ cat .mcp.json
424
+
425
+ # ตรวจสอบว่าไม่มี placeholder
426
+ grep "YOUR_" .mcp.json
427
+ # ถ้าพบ YOUR_ แสดงว่ายังไม่ได้ใส่ API Key จริง
428
+ ```
429
+
430
+ ---
431
+
432
+ ## สรุปคำสั่งลัด
433
+
434
+ | ต้องการทำอะไร | ใช้คำสั่ง |
435
+ |--------------|---------|
436
+ | ทำทุกอย่างอัตโนมัติ | `/auto "คำอธิบาย"` |
437
+ | วางแผนก่อน | `/plan "คำอธิบาย"` |
438
+ | เขียนโค้ด | `/code "สิ่งที่ต้องการ"` |
439
+ | ทดสอบ | `/test` |
440
+ | ตรวจคุณภาพ | `/review` |
441
+ | ตรวจความปลอดภัย | `/secure` |
442
+ | หาสาเหตุบัค | `/debug "ปัญหาที่เจอ"` |
443
+ | ตรวจก่อนส่งงาน | `/validate` |
444
+
445
+ ---
446
+
447
+ ## ต้องการความช่วยเหลือเพิ่มเติม?
448
+
449
+ - ดูคู่มือภาษาอังกฤษ: `docs/user-guide.md`
450
+ - ดูคำแนะนำโดยละเอียด: `CLAUDE.md`
451
+
452
+ ---
453
+
454
+ **สร้างด้วย ❤️ สำหรับนักพัฒนาทุกคน**