@sk8metal/michi-cli 0.0.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.
- package/LICENSE +22 -0
- package/README.md +465 -0
- package/dist/scripts/config/config-schema.d.ts +707 -0
- package/dist/scripts/config/config-schema.d.ts.map +1 -0
- package/dist/scripts/config/config-schema.js +100 -0
- package/dist/scripts/config/config-schema.js.map +1 -0
- package/dist/scripts/config-interactive.d.ts +10 -0
- package/dist/scripts/config-interactive.d.ts.map +1 -0
- package/dist/scripts/config-interactive.js +357 -0
- package/dist/scripts/config-interactive.js.map +1 -0
- package/dist/scripts/confluence-sync.d.ts +54 -0
- package/dist/scripts/confluence-sync.d.ts.map +1 -0
- package/dist/scripts/confluence-sync.js +407 -0
- package/dist/scripts/confluence-sync.js.map +1 -0
- package/dist/scripts/create-project.d.ts +12 -0
- package/dist/scripts/create-project.d.ts.map +1 -0
- package/dist/scripts/create-project.js +244 -0
- package/dist/scripts/create-project.js.map +1 -0
- package/dist/scripts/jira-sync.d.ts +39 -0
- package/dist/scripts/jira-sync.d.ts.map +1 -0
- package/dist/scripts/jira-sync.js +549 -0
- package/dist/scripts/jira-sync.js.map +1 -0
- package/dist/scripts/list-projects.d.ts +7 -0
- package/dist/scripts/list-projects.d.ts.map +1 -0
- package/dist/scripts/list-projects.js +61 -0
- package/dist/scripts/list-projects.js.map +1 -0
- package/dist/scripts/markdown-to-confluence.d.ts +19 -0
- package/dist/scripts/markdown-to-confluence.d.ts.map +1 -0
- package/dist/scripts/markdown-to-confluence.js +121 -0
- package/dist/scripts/markdown-to-confluence.js.map +1 -0
- package/dist/scripts/multi-project-estimate.d.ts +27 -0
- package/dist/scripts/multi-project-estimate.d.ts.map +1 -0
- package/dist/scripts/multi-project-estimate.js +202 -0
- package/dist/scripts/multi-project-estimate.js.map +1 -0
- package/dist/scripts/phase-runner.d.ts +19 -0
- package/dist/scripts/phase-runner.d.ts.map +1 -0
- package/dist/scripts/phase-runner.js +260 -0
- package/dist/scripts/phase-runner.js.map +1 -0
- package/dist/scripts/pr-automation.d.ts +12 -0
- package/dist/scripts/pr-automation.d.ts.map +1 -0
- package/dist/scripts/pr-automation.js +45 -0
- package/dist/scripts/pr-automation.js.map +1 -0
- package/dist/scripts/pre-flight-check.d.ts +15 -0
- package/dist/scripts/pre-flight-check.d.ts.map +1 -0
- package/dist/scripts/pre-flight-check.js +244 -0
- package/dist/scripts/pre-flight-check.js.map +1 -0
- package/dist/scripts/resource-dashboard.d.ts +7 -0
- package/dist/scripts/resource-dashboard.d.ts.map +1 -0
- package/dist/scripts/resource-dashboard.js +100 -0
- package/dist/scripts/resource-dashboard.js.map +1 -0
- package/dist/scripts/setup-existing-project.d.ts +13 -0
- package/dist/scripts/setup-existing-project.d.ts.map +1 -0
- package/dist/scripts/setup-existing-project.js +334 -0
- package/dist/scripts/setup-existing-project.js.map +1 -0
- package/dist/scripts/utils/config-loader.d.ts +20 -0
- package/dist/scripts/utils/config-loader.d.ts.map +1 -0
- package/dist/scripts/utils/config-loader.js +291 -0
- package/dist/scripts/utils/config-loader.js.map +1 -0
- package/dist/scripts/utils/config-validator.d.ts +34 -0
- package/dist/scripts/utils/config-validator.d.ts.map +1 -0
- package/dist/scripts/utils/config-validator.js +286 -0
- package/dist/scripts/utils/config-validator.js.map +1 -0
- package/dist/scripts/utils/confluence-hierarchy.d.ts +47 -0
- package/dist/scripts/utils/confluence-hierarchy.d.ts.map +1 -0
- package/dist/scripts/utils/confluence-hierarchy.js +516 -0
- package/dist/scripts/utils/confluence-hierarchy.js.map +1 -0
- package/dist/scripts/utils/feature-name-validator.d.ts +25 -0
- package/dist/scripts/utils/feature-name-validator.d.ts.map +1 -0
- package/dist/scripts/utils/feature-name-validator.js +113 -0
- package/dist/scripts/utils/feature-name-validator.js.map +1 -0
- package/dist/scripts/utils/project-meta.d.ts +23 -0
- package/dist/scripts/utils/project-meta.d.ts.map +1 -0
- package/dist/scripts/utils/project-meta.js +50 -0
- package/dist/scripts/utils/project-meta.js.map +1 -0
- package/dist/scripts/validate-phase.d.ts +17 -0
- package/dist/scripts/validate-phase.d.ts.map +1 -0
- package/dist/scripts/validate-phase.js +234 -0
- package/dist/scripts/validate-phase.js.map +1 -0
- package/dist/scripts/workflow-orchestrator.d.ts +35 -0
- package/dist/scripts/workflow-orchestrator.d.ts.map +1 -0
- package/dist/scripts/workflow-orchestrator.js +130 -0
- package/dist/scripts/workflow-orchestrator.js.map +1 -0
- package/dist/src/cli.d.ts +11 -0
- package/dist/src/cli.d.ts.map +1 -0
- package/dist/src/cli.js +229 -0
- package/dist/src/cli.js.map +1 -0
- package/docs/config-reference.md +666 -0
- package/docs/customization-guide.md +432 -0
- package/docs/multi-project.md +233 -0
- package/docs/new-project-setup.md +576 -0
- package/docs/phase-automation.md +361 -0
- package/docs/quick-reference.md +291 -0
- package/docs/setup.md +404 -0
- package/docs/tasks-template.md +550 -0
- package/docs/testing.md +202 -0
- package/docs/workflow.md +342 -0
- package/env.example +44 -0
- package/mcp.json.example +14 -0
- package/package.json +97 -0
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
# フェーズ自動化ガイド
|
|
2
|
+
|
|
3
|
+
> **凡例について**: `<feature>` などの記号の意味は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
|
|
4
|
+
|
|
5
|
+
## 概要
|
|
6
|
+
|
|
7
|
+
AI-DLC(AI Development Life Cycle)の各フェーズで、Confluence/JIRA作成を**確実に実行**するためのスクリプトガイドです。
|
|
8
|
+
|
|
9
|
+
## 問題: AIだけでは抜け漏れが発生する
|
|
10
|
+
|
|
11
|
+
**従来の問題**:
|
|
12
|
+
- AIが要件定義書(requirements.md)を作成
|
|
13
|
+
- しかし、Confluenceページ作成を忘れる ❌
|
|
14
|
+
- PMや部長がレビューできない状態で設計フェーズへ進んでしまう
|
|
15
|
+
|
|
16
|
+
**解決策**:
|
|
17
|
+
- **スクリプトによる自動化**で、Confluence/JIRA作成を確実に実行
|
|
18
|
+
- **バリデーション**で、必須項目の抜け漏れをチェック
|
|
19
|
+
|
|
20
|
+
## 使い方
|
|
21
|
+
|
|
22
|
+
### Phase 1: 要件定義
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Step 1: AIで requirements.md を作成
|
|
26
|
+
# 凡例
|
|
27
|
+
/kiro:spec-requirements <feature>
|
|
28
|
+
|
|
29
|
+
# 具体例
|
|
30
|
+
/kiro:spec-requirements user-auth
|
|
31
|
+
|
|
32
|
+
# Step 2: スクリプトでConfluence作成+バリデーション(必須)
|
|
33
|
+
# 凡例
|
|
34
|
+
npm run phase:run <feature> requirements
|
|
35
|
+
|
|
36
|
+
# 具体例
|
|
37
|
+
npm run phase:run user-auth requirements
|
|
38
|
+
|
|
39
|
+
# 実行内容:
|
|
40
|
+
# ✅ requirements.md 存在確認
|
|
41
|
+
# ✅ Confluenceページ自動作成(要件定義)
|
|
42
|
+
# ✅ spec.json自動更新
|
|
43
|
+
# ✅ バリデーション実行
|
|
44
|
+
#
|
|
45
|
+
# 成功時:
|
|
46
|
+
# 🎉 要件定義フェーズが完了しました!
|
|
47
|
+
# 📢 PMや部長にConfluenceでレビューを依頼してください
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Phase 2: 設計
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Step 1: AIで design.md を作成
|
|
54
|
+
# 凡例
|
|
55
|
+
/kiro:spec-design <feature>
|
|
56
|
+
|
|
57
|
+
# 具体例
|
|
58
|
+
/kiro:spec-design user-auth
|
|
59
|
+
|
|
60
|
+
# Step 2: スクリプトでConfluence作成+バリデーション(必須)
|
|
61
|
+
# 凡例
|
|
62
|
+
npm run phase:run <feature> design
|
|
63
|
+
|
|
64
|
+
# 具体例
|
|
65
|
+
npm run phase:run user-auth design
|
|
66
|
+
|
|
67
|
+
# 実行内容:
|
|
68
|
+
# ✅ design.md 存在確認
|
|
69
|
+
# ✅ 要件定義完了チェック(前提条件)
|
|
70
|
+
# ✅ Confluenceページ自動作成(設計書)
|
|
71
|
+
# ✅ spec.json自動更新
|
|
72
|
+
# ✅ バリデーション実行
|
|
73
|
+
#
|
|
74
|
+
# 成功時:
|
|
75
|
+
# 🎉 設計フェーズが完了しました!
|
|
76
|
+
# 📢 PMや部長にConfluenceでレビューを依頼してください
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Phase 3: タスク分割
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
# Step 1: AIで tasks.md を作成(営業日ベース)
|
|
83
|
+
# 凡例
|
|
84
|
+
/kiro:spec-tasks <feature>
|
|
85
|
+
|
|
86
|
+
# 具体例
|
|
87
|
+
/kiro:spec-tasks user-auth
|
|
88
|
+
|
|
89
|
+
# Step 2: スクリプトでJIRA作成+バリデーション(必須)
|
|
90
|
+
# 凡例
|
|
91
|
+
npm run phase:run <feature> tasks
|
|
92
|
+
|
|
93
|
+
# 具体例
|
|
94
|
+
npm run phase:run user-auth tasks
|
|
95
|
+
|
|
96
|
+
# 実行内容:
|
|
97
|
+
# ✅ tasks.md 存在確認(営業日表記チェック)
|
|
98
|
+
# ✅ 設計完了チェック(前提条件)
|
|
99
|
+
# ✅ JIRA Epic自動作成
|
|
100
|
+
# ✅ JIRA Story自動作成(全ストーリー)
|
|
101
|
+
# ✅ spec.json自動更新
|
|
102
|
+
# ✅ バリデーション実行
|
|
103
|
+
#
|
|
104
|
+
# 成功時:
|
|
105
|
+
# 🎉 タスク分割フェーズが完了しました!
|
|
106
|
+
# 📢 開発チームに実装開始を通知してください
|
|
107
|
+
# 🚀 次のステップ: /kiro:spec-impl <feature>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## バリデーションスクリプト
|
|
111
|
+
|
|
112
|
+
フェーズが完了しているか確認するだけの場合:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
# 凡例
|
|
116
|
+
npm run validate:phase <feature> <phase>
|
|
117
|
+
|
|
118
|
+
# 具体例
|
|
119
|
+
npm run validate:phase user-auth requirements # 要件定義のバリデーション
|
|
120
|
+
npm run validate:phase user-auth design # 設計のバリデーション
|
|
121
|
+
npm run validate:phase user-auth tasks # タスク分割のバリデーション
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### バリデーション項目
|
|
125
|
+
|
|
126
|
+
#### 要件定義
|
|
127
|
+
|
|
128
|
+
- [ ] requirements.md作成済み
|
|
129
|
+
- [ ] **Confluenceページ作成済み** ← 重要
|
|
130
|
+
- [ ] spec.jsonにconfluence.requirementsPageId記録
|
|
131
|
+
- [ ] spec.jsonにconfluence.spaceKey記録
|
|
132
|
+
|
|
133
|
+
#### 設計
|
|
134
|
+
|
|
135
|
+
- [ ] design.md作成済み
|
|
136
|
+
- [ ] 要件定義完了(前提条件)
|
|
137
|
+
- [ ] **Confluenceページ作成済み** ← 重要
|
|
138
|
+
- [ ] spec.jsonにconfluence.designPageId記録
|
|
139
|
+
|
|
140
|
+
#### タスク分割
|
|
141
|
+
|
|
142
|
+
- [ ] tasks.md作成済み
|
|
143
|
+
- [ ] tasks.mdに営業日表記(月、火、水...)
|
|
144
|
+
- [ ] tasks.mdに営業日カウント(Day 1, Day 2...)
|
|
145
|
+
- [ ] tasks.mdに土日休みの明記
|
|
146
|
+
- [ ] 設計完了(前提条件)
|
|
147
|
+
- [ ] **JIRA Epic作成済み** ← 重要
|
|
148
|
+
- [ ] **JIRA Story作成済み** ← 重要
|
|
149
|
+
- [ ] spec.jsonにjira.epicKey記録
|
|
150
|
+
- [ ] spec.jsonにjira.stories記録
|
|
151
|
+
|
|
152
|
+
## エラー時の対処
|
|
153
|
+
|
|
154
|
+
### Confluenceスペース不在エラー
|
|
155
|
+
|
|
156
|
+
```text
|
|
157
|
+
❌ Confluenceスペースが存在しません: PRD
|
|
158
|
+
→ Confluenceで新しいスペースを作成: https://0kuri0n.atlassian.net/wiki/spaces
|
|
159
|
+
→ または、.envのCONFLUENCE_PRD_SPACEを修正してください
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
**対処法1**: Confluenceでスペースを作成
|
|
163
|
+
1. [Confluenceスペース一覧](https://0kuri0n.atlassian.net/wiki/spaces) にアクセス
|
|
164
|
+
2. 「スペースを作成」をクリック
|
|
165
|
+
3. スペースキーを「PRD」または「Michi」で作成
|
|
166
|
+
|
|
167
|
+
**対処法2**: .envを修正
|
|
168
|
+
```bash
|
|
169
|
+
vim .env
|
|
170
|
+
# 既存のスペースキーに変更
|
|
171
|
+
CONFLUENCE_PRD_SPACE=Michi # ← 実際に存在するスペース
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Confluenceページ作成エラー
|
|
175
|
+
|
|
176
|
+
```text
|
|
177
|
+
❌ Confluenceページ(要件定義)が作成されていません
|
|
178
|
+
→ 実行: npm run confluence:sync <feature> requirements
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
**対処**:
|
|
182
|
+
```bash
|
|
183
|
+
# 個別に実行
|
|
184
|
+
npm run confluence:sync calculator-app requirements
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### JIRAプロジェクト不在エラー
|
|
188
|
+
|
|
189
|
+
```text
|
|
190
|
+
❌ JIRAプロジェクトが存在しません: PRAC1
|
|
191
|
+
→ JIRAプロジェクト作成: https://0kuri0n.atlassian.net/jira/projects/create
|
|
192
|
+
→ プロジェクト一覧: https://0kuri0n.atlassian.net/jira/settings/projects
|
|
193
|
+
→ または、.kiro/project.jsonのjiraProjectKeyを修正してください
|
|
194
|
+
現在の設定: "PRAC1" → 実際に存在するキーに変更
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
**対処法1**: JIRAでプロジェクトを作成
|
|
198
|
+
1. [JIRAプロジェクト作成](https://0kuri0n.atlassian.net/jira/projects/create) にアクセス
|
|
199
|
+
2. プロジェクト名とキーを入力
|
|
200
|
+
- 名前: michi-practice1
|
|
201
|
+
- キー: PRAC1(または任意)
|
|
202
|
+
3. プロジェクトタイプ: ソフトウェア開発
|
|
203
|
+
|
|
204
|
+
**対処法2**: project.jsonを修正
|
|
205
|
+
```bash
|
|
206
|
+
vim .kiro/project.json
|
|
207
|
+
# 既存のプロジェクトキーに変更
|
|
208
|
+
{
|
|
209
|
+
"jiraProjectKey": "MP" # ← 実際に存在するプロジェクトキー
|
|
210
|
+
}
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### JIRA作成エラー
|
|
214
|
+
|
|
215
|
+
```text
|
|
216
|
+
❌ JIRA Epicが作成されていません
|
|
217
|
+
→ 実行: npm run jira:sync <feature>
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
**対処**:
|
|
221
|
+
```bash
|
|
222
|
+
# 個別に実行
|
|
223
|
+
npm run jira:sync calculator-app
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### 認証エラー
|
|
227
|
+
|
|
228
|
+
```text
|
|
229
|
+
Authentication failed: {"code":401,"message":"Unauthorized"}
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
**対処**:
|
|
233
|
+
1. Cursorを再起動(Cmd+Q → 再起動)
|
|
234
|
+
2. Atlassian MCP認証トークンがリフレッシュされる
|
|
235
|
+
3. 再度スクリプトを実行
|
|
236
|
+
|
|
237
|
+
## 推奨ワークフロー(確実な方法)
|
|
238
|
+
|
|
239
|
+
```bash
|
|
240
|
+
# 1. 要件定義
|
|
241
|
+
/kiro:spec-requirements calculator-app # AI実行
|
|
242
|
+
npm run phase:run calculator-app requirements # スクリプト実行(必須)
|
|
243
|
+
|
|
244
|
+
# 2. 設計
|
|
245
|
+
/kiro:spec-design calculator-app # AI実行
|
|
246
|
+
npm run phase:run calculator-app design # スクリプト実行(必須)
|
|
247
|
+
|
|
248
|
+
# 3. タスク分割
|
|
249
|
+
/kiro:spec-tasks calculator-app # AI実行
|
|
250
|
+
npm run phase:run calculator-app tasks # スクリプト実行(必須)
|
|
251
|
+
|
|
252
|
+
# 4. バリデーション(全フェーズ)
|
|
253
|
+
npm run validate:phase calculator-app requirements
|
|
254
|
+
npm run validate:phase calculator-app design
|
|
255
|
+
npm run validate:phase calculator-app tasks
|
|
256
|
+
|
|
257
|
+
# 5. 実装開始
|
|
258
|
+
/kiro:spec-impl calculator-app
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
## メリット
|
|
262
|
+
|
|
263
|
+
### 1. 抜け漏れ防止
|
|
264
|
+
|
|
265
|
+
- スクリプトが確実にConfluence/JIRAを作成
|
|
266
|
+
- AIの判断ミスをカバー
|
|
267
|
+
|
|
268
|
+
### 2. 自動バリデーション
|
|
269
|
+
|
|
270
|
+
- 必須項目の完了チェック
|
|
271
|
+
- エラーメッセージで対処法を表示
|
|
272
|
+
|
|
273
|
+
### 3. Exit Code対応
|
|
274
|
+
|
|
275
|
+
- スクリプトの成功/失敗がExit Codeで判定可能
|
|
276
|
+
- CI/CDパイプラインに組み込み可能
|
|
277
|
+
|
|
278
|
+
### 4. 再実行安全(冪等性)
|
|
279
|
+
|
|
280
|
+
**Confluence**:
|
|
281
|
+
- 既存ページがあれば更新(バージョン番号が上がる)
|
|
282
|
+
- 何度実行しても重複ページは作成されない
|
|
283
|
+
|
|
284
|
+
**JIRA**:
|
|
285
|
+
- spec.jsonに記録されたEpic/Storyキーをチェック
|
|
286
|
+
- 既存のEpic/Storyがあればスキップ
|
|
287
|
+
- 新しいStoryのみ作成
|
|
288
|
+
|
|
289
|
+
## 2回実行した場合の動作(冪等性)
|
|
290
|
+
|
|
291
|
+
### Confluence(requirements/design)
|
|
292
|
+
|
|
293
|
+
```bash
|
|
294
|
+
# 1回目
|
|
295
|
+
npm run phase:run calculator-app requirements
|
|
296
|
+
→ Confluenceページ新規作成(version 1)
|
|
297
|
+
|
|
298
|
+
# 2回目(誤って再実行)
|
|
299
|
+
npm run phase:run calculator-app requirements
|
|
300
|
+
→ 既存ページを検索
|
|
301
|
+
→ 既存ページ更新(version 1 → 2)
|
|
302
|
+
→ ✅ 重複なし
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
**結果**: 最新の内容で上書き更新されるだけ ✅
|
|
306
|
+
|
|
307
|
+
### JIRA(tasks)
|
|
308
|
+
|
|
309
|
+
```bash
|
|
310
|
+
# 1回目
|
|
311
|
+
npm run phase:run calculator-app tasks
|
|
312
|
+
→ spec.jsonをチェック(Epic未記録)
|
|
313
|
+
→ JQL検索(既存Epicなし)
|
|
314
|
+
→ Epic作成: MP-1
|
|
315
|
+
→ Story作成: MP-2〜MP-14(13個)
|
|
316
|
+
→ spec.jsonに記録
|
|
317
|
+
|
|
318
|
+
# 2回目(誤って再実行)
|
|
319
|
+
npm run phase:run calculator-app tasks
|
|
320
|
+
→ spec.jsonをチェック(Epic: MP-1記録済み)
|
|
321
|
+
→ 既存Epic検出: MP-1
|
|
322
|
+
→ Epic作成スキップ ✅
|
|
323
|
+
→ JQL検索(既存Story: MP-2〜MP-14)
|
|
324
|
+
→ 既存Storyをスキップ ✅
|
|
325
|
+
→ 新しいStoryのみ作成(0個)
|
|
326
|
+
→ ✅ 重複なし
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
**結果**: 既存のEpic/Storyはスキップされ、重複作成されない ✅
|
|
330
|
+
|
|
331
|
+
### tasks.mdを修正した場合
|
|
332
|
+
|
|
333
|
+
```bash
|
|
334
|
+
# tasks.mdに新しいStoryを追加
|
|
335
|
+
# Story 8.1: 新機能を追加
|
|
336
|
+
|
|
337
|
+
# 再実行
|
|
338
|
+
npm run phase:run calculator-app tasks
|
|
339
|
+
→ 既存Epic: MP-1(スキップ)
|
|
340
|
+
→ 既存Story: MP-2〜MP-14(スキップ)
|
|
341
|
+
→ 新しいStory: MP-15(作成) ← 新規のみ作成
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
**結果**: 追加分のみが作成される ✅
|
|
345
|
+
|
|
346
|
+
## まとめ
|
|
347
|
+
|
|
348
|
+
**AIだけ**: 抜け漏れの可能性あり ❌
|
|
349
|
+
**AI + スクリプト**: 確実に実行 ✅
|
|
350
|
+
|
|
351
|
+
**冪等性**: 何度実行しても安全 ✅
|
|
352
|
+
- Confluence: 既存ページを更新
|
|
353
|
+
- JIRA: 既存Epic/Storyをスキップ
|
|
354
|
+
|
|
355
|
+
**今後の開発フロー**:
|
|
356
|
+
1. AIでMarkdownファイル作成
|
|
357
|
+
2. **スクリプトでConfluence/JIRA作成(必須)**
|
|
358
|
+
3. バリデーションで確認
|
|
359
|
+
4. レビュー依頼
|
|
360
|
+
5. 次のフェーズへ
|
|
361
|
+
|
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
# クイックリファレンス
|
|
2
|
+
|
|
3
|
+
> **凡例について**: `<feature>` などの記号の意味は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
|
|
4
|
+
|
|
5
|
+
## 新規プロジェクト作成
|
|
6
|
+
|
|
7
|
+
### パターンA: 既存リポジトリにMichiワークフローを追加(最も簡単 ⭐)
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# 既存プロジェクトに移動
|
|
11
|
+
cd /path/to/existing-repo
|
|
12
|
+
|
|
13
|
+
# 対話式セットアップスクリプト実行
|
|
14
|
+
bash /path/to/michi/scripts/setup-existing.sh
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
プロジェクト名、JIRAキーを入力するだけで完了!
|
|
18
|
+
|
|
19
|
+
### パターンB: 新規リポジトリを作成してセットアップ
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Michiから実行
|
|
23
|
+
cd /path/to/michi
|
|
24
|
+
|
|
25
|
+
# 凡例
|
|
26
|
+
npm run create-project -- \
|
|
27
|
+
--name "<project-id>" \
|
|
28
|
+
--project-name "<project-name>" \
|
|
29
|
+
--jira-key "<jira-key>"
|
|
30
|
+
|
|
31
|
+
# 具体例
|
|
32
|
+
npm run create-project -- \
|
|
33
|
+
--name "customer-a-service-1" \
|
|
34
|
+
--project-name "A社 サービス1" \
|
|
35
|
+
--jira-key "PRJA"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**リポジトリ名**: `--name`で指定した値がそのままGitHubリポジトリ名として使用されます。
|
|
39
|
+
|
|
40
|
+
**例**:
|
|
41
|
+
- `--name "customer-a-service-1"` → GitHubリポジトリ: `org/customer-a-service-1`
|
|
42
|
+
- `--name "payment-api"` → GitHubリポジトリ: `org/payment-api`
|
|
43
|
+
|
|
44
|
+
**注意**: リポジトリ名はkebab-case(小文字、ハイフン区切り)を推奨します。
|
|
45
|
+
|
|
46
|
+
### パターンC: 完全手動セットアップ
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# 1. リポジトリ作成・クローン
|
|
50
|
+
gh repo create org/repo-name --private
|
|
51
|
+
jj git clone https://github.com/org/repo-name
|
|
52
|
+
cd repo-name
|
|
53
|
+
|
|
54
|
+
# 2. cc-sdd導入
|
|
55
|
+
npx cc-sdd@latest --cursor --lang ja --yes
|
|
56
|
+
|
|
57
|
+
# 3. プロジェクトメタデータ作成
|
|
58
|
+
cat > .kiro/project.json << 'EOF'
|
|
59
|
+
{
|
|
60
|
+
"projectId": "repo-name",
|
|
61
|
+
"projectName": "プロジェクト名",
|
|
62
|
+
"jiraProjectKey": "PRJX",
|
|
63
|
+
"confluenceLabels": ["project:x", "service:y"]
|
|
64
|
+
}
|
|
65
|
+
EOF
|
|
66
|
+
|
|
67
|
+
# 4. Michiから共通ファイルコピー(自動スクリプト推奨)
|
|
68
|
+
npx tsx /path/to/michi/scripts/setup-existing-project.ts \
|
|
69
|
+
--michi-path /path/to/michi \
|
|
70
|
+
--project-name "プロジェクト名" \
|
|
71
|
+
--jira-key "PRJX"
|
|
72
|
+
|
|
73
|
+
# 5. npm install
|
|
74
|
+
# 6. 初期コミット
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
詳細: [新規プロジェクトセットアップガイド](./new-project-setup.md)
|
|
78
|
+
|
|
79
|
+
## 開発フロー
|
|
80
|
+
|
|
81
|
+
詳細なワークフローは [AI開発ワークフローガイド](./workflow.md) を参照してください。
|
|
82
|
+
|
|
83
|
+
### クイックコマンド一覧
|
|
84
|
+
|
|
85
|
+
**要件定義**:
|
|
86
|
+
```bash
|
|
87
|
+
/kiro:spec-init <機能説明>
|
|
88
|
+
/kiro:spec-requirements <feature>
|
|
89
|
+
jj commit -m "docs: 要件定義" && jj git push
|
|
90
|
+
npx @michi/cli phase:run <feature> requirements
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**設計**:
|
|
94
|
+
```bash
|
|
95
|
+
/kiro:spec-design <feature>
|
|
96
|
+
jj commit -m "docs: 設計" && jj git push
|
|
97
|
+
npx @michi/cli phase:run <feature> design
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**タスク分割**:
|
|
101
|
+
```bash
|
|
102
|
+
/kiro:spec-tasks <feature>
|
|
103
|
+
jj commit -m "docs: タスク分割" && jj git push
|
|
104
|
+
npx @michi/cli phase:run <feature> tasks
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
**実装**:
|
|
108
|
+
```bash
|
|
109
|
+
/kiro:spec-impl <feature> <tasks>
|
|
110
|
+
jj commit -m "feat: 実装 [<jira-key>-XXX]"
|
|
111
|
+
jj bookmark create <project-id>/feature/<feature> -r '@-'
|
|
112
|
+
jj git push --bookmark <project-id>/feature/<feature> --allow-new
|
|
113
|
+
gh pr create --head <project-id>/feature/<feature> --base init
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Cursorコマンド一覧
|
|
117
|
+
|
|
118
|
+
| コマンド | 説明 |
|
|
119
|
+
|---------|------|
|
|
120
|
+
| `/kiro:spec-init <description>` | 仕様初期化 |
|
|
121
|
+
| `/kiro:spec-requirements <feature>` | 要件定義生成 |
|
|
122
|
+
| `/kiro:spec-design <feature>` | 設計生成 |
|
|
123
|
+
| `/kiro:spec-tasks <feature>` | タスク分割 |
|
|
124
|
+
| `/kiro:spec-impl <feature> <tasks>` | TDD実装 |
|
|
125
|
+
| `/kiro:spec-status <feature>` | 進捗確認 |
|
|
126
|
+
| `/kiro:steering` | Steering作成/更新 |
|
|
127
|
+
| `/kiro:confluence-sync <feature> [type]` | Confluence同期 |
|
|
128
|
+
| `/kiro:project-switch <project_id>` | プロジェクト切り替え |
|
|
129
|
+
|
|
130
|
+
## Michi CLIコマンド一覧
|
|
131
|
+
|
|
132
|
+
**使用方法**: `npx @michi/cli <command>` または `michi <command>`(グローバルインストール後)
|
|
133
|
+
|
|
134
|
+
| コマンド | 説明 |
|
|
135
|
+
|---------|------|
|
|
136
|
+
| `michi jira:sync <feature>` | JIRA連携(tasks.md → Epic/Stories) |
|
|
137
|
+
| `michi confluence:sync <feature> [type]` | Confluence同期(requirements/design) |
|
|
138
|
+
| `michi phase:run <feature> <phase>` | フェーズ実行(requirements/design/tasks) |
|
|
139
|
+
| `michi validate:phase <feature> <phase>` | フェーズ完了バリデーション |
|
|
140
|
+
| `michi preflight [phase]` | プリフライトチェック |
|
|
141
|
+
| `michi project:list` | プロジェクト一覧 |
|
|
142
|
+
| `michi project:dashboard` | リソースダッシュボード生成 |
|
|
143
|
+
| `michi workflow:run --feature <name>` | 統合ワークフロー実行 |
|
|
144
|
+
| `michi config:interactive` | 対話式設定ツール(.kiro/config.json作成) |
|
|
145
|
+
| `michi config:validate` | 設定ファイルのバリデーション |
|
|
146
|
+
| `michi --help` | ヘルプ表示 |
|
|
147
|
+
| `michi --version` | バージョン表示 |
|
|
148
|
+
|
|
149
|
+
**インストール方法**:
|
|
150
|
+
- **npx実行(推奨)**: `npx @michi/cli <command>` - 常に最新版を使用
|
|
151
|
+
- **グローバルインストール**: `npm install -g @michi/cli` 後、`michi <command>`
|
|
152
|
+
- **ローカル開発**: `npm run michi <command>` または `tsx src/cli.ts <command>`
|
|
153
|
+
|
|
154
|
+
## npmスクリプト一覧(michiリポジトリ内)
|
|
155
|
+
|
|
156
|
+
| コマンド | 説明 |
|
|
157
|
+
|---------|------|
|
|
158
|
+
| `npm run setup:env` | .env テンプレート作成 |
|
|
159
|
+
| `npm run create-project` | 新規プロジェクト作成 |
|
|
160
|
+
| `npm run multi-estimate` | 見積もり集計 |
|
|
161
|
+
| `npm run michi` | ローカルCLIツール実行 |
|
|
162
|
+
|
|
163
|
+
## プロジェクト切り替え
|
|
164
|
+
|
|
165
|
+
### 方法1: Cursorコマンド
|
|
166
|
+
|
|
167
|
+
```
|
|
168
|
+
/kiro:project-switch <project-id>
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### 方法2: ターミナル
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
cd ~/work/projects/<project-name>
|
|
175
|
+
cat .kiro/project.json
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## プロジェクト横断操作
|
|
179
|
+
|
|
180
|
+
### すべてのプロジェクトを確認
|
|
181
|
+
|
|
182
|
+
```bash
|
|
183
|
+
cd /path/to/michi
|
|
184
|
+
# 全プロジェクトの一覧を表示
|
|
185
|
+
npx @michi/cli project:list
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### リソースダッシュボード
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
# Confluenceにプロジェクト横断ダッシュボードを作成
|
|
192
|
+
npx @michi/cli project:dashboard
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### 見積もり集計
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
npm run multi-estimate
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Git/Jujutsuコマンド
|
|
202
|
+
|
|
203
|
+
### 基本フロー
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
# 作業開始
|
|
207
|
+
jj new main
|
|
208
|
+
|
|
209
|
+
# コミット
|
|
210
|
+
jj commit -m "message"
|
|
211
|
+
|
|
212
|
+
# ブックマーク作成(PR用)
|
|
213
|
+
jj bookmark create <project-id>/feature/<name> -r '@-'
|
|
214
|
+
|
|
215
|
+
# プッシュ
|
|
216
|
+
jj git push --bookmark <project-id>/feature/<name> --allow-new
|
|
217
|
+
|
|
218
|
+
# PR作成
|
|
219
|
+
gh pr create --head <bookmark> --base main
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### ブランチ命名規則
|
|
223
|
+
|
|
224
|
+
```
|
|
225
|
+
<project-id>/feature/<feature-name>
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
例:
|
|
229
|
+
- `michi/feature/user-auth`
|
|
230
|
+
- `customer-a-service-1/feature/payment`
|
|
231
|
+
- `customer-b-api/feature/user-endpoint`
|
|
232
|
+
|
|
233
|
+
## トラブルシューティング
|
|
234
|
+
|
|
235
|
+
### GitHub認証エラー
|
|
236
|
+
|
|
237
|
+
```bash
|
|
238
|
+
gh auth status
|
|
239
|
+
gh auth login
|
|
240
|
+
gh auth setup-git
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Confluence/JIRA認証エラー
|
|
244
|
+
|
|
245
|
+
`.env` の認証情報を確認:
|
|
246
|
+
```bash
|
|
247
|
+
cat .env | grep ATLASSIAN
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### MCP接続エラー
|
|
251
|
+
|
|
252
|
+
1. Cursor 再起動
|
|
253
|
+
2. `~/.cursor/mcp.json` 確認
|
|
254
|
+
3. Atlassian API Token 再生成
|
|
255
|
+
|
|
256
|
+
### npm installエラー
|
|
257
|
+
|
|
258
|
+
```bash
|
|
259
|
+
npm cache clean --force
|
|
260
|
+
rm -rf node_modules package-lock.json
|
|
261
|
+
npm install
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
## ファイルパス
|
|
265
|
+
|
|
266
|
+
### プロジェクトメタデータ
|
|
267
|
+
- `.kiro/project.json`
|
|
268
|
+
|
|
269
|
+
### テンプレート
|
|
270
|
+
- `.kiro/settings/templates/requirements.md`
|
|
271
|
+
- `.kiro/settings/templates/design.md`
|
|
272
|
+
- `.kiro/settings/templates/tasks.md`
|
|
273
|
+
|
|
274
|
+
### 仕様書(GitHub SSoT)
|
|
275
|
+
- `.kiro/specs/<feature>/requirements.md`
|
|
276
|
+
- `.kiro/specs/<feature>/design.md`
|
|
277
|
+
- `.kiro/specs/<feature>/tasks.md`
|
|
278
|
+
|
|
279
|
+
### Steering
|
|
280
|
+
- `.kiro/steering/product.md`
|
|
281
|
+
- `.kiro/steering/tech.md`
|
|
282
|
+
- `.kiro/steering/structure.md`
|
|
283
|
+
|
|
284
|
+
## 参考リンク
|
|
285
|
+
|
|
286
|
+
- [セットアップガイド](./setup.md)
|
|
287
|
+
- [新規プロジェクトセットアップ](./new-project-setup.md)
|
|
288
|
+
- [ワークフローガイド](./workflow.md)
|
|
289
|
+
- [マルチプロジェクト管理](./multi-project.md)
|
|
290
|
+
- [テスト・検証](./testing.md)
|
|
291
|
+
|