@sk8metal/michi-cli 0.10.1 → 0.11.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 (104) hide show
  1. package/README.md +77 -847
  2. package/dist/scripts/phase-runner.js +1 -1
  3. package/dist/scripts/phase-runner.js.map +1 -1
  4. package/dist/scripts/utils/multi-repo-validator.d.ts +18 -0
  5. package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
  6. package/dist/scripts/utils/multi-repo-validator.js +42 -0
  7. package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
  8. package/dist/scripts/utils/tasks-format-validator.js +3 -3
  9. package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
  10. package/docs/README.md +20 -83
  11. package/docs/getting-started/configuration.md +379 -0
  12. package/docs/getting-started/installation.md +59 -0
  13. package/docs/getting-started/quick-start.md +76 -0
  14. package/docs/guides/ai-tools.md +311 -0
  15. package/docs/guides/atlassian-integration.md +116 -0
  16. package/docs/guides/claude-code.md +155 -0
  17. package/docs/guides/multi-repo.md +117 -0
  18. package/docs/guides/workflow.md +382 -0
  19. package/docs/reference/ai-commands.md +92 -0
  20. package/docs/reference/cli.md +756 -0
  21. package/docs/reference/environment-variables.md +192 -0
  22. package/docs/troubleshooting.md +543 -0
  23. package/package.json +1 -1
  24. package/scripts/phase-runner.ts +1 -1
  25. package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
  26. package/scripts/utils/multi-repo-validator.ts +50 -0
  27. package/scripts/utils/tasks-format-validator.ts +3 -3
  28. package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
  29. package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
  30. package/templates/claude/commands/michi/e2e-plan.md +1 -1
  31. package/templates/claude/commands/michi/spec-design.md +2 -2
  32. package/templates/claude/commands/michi/spec-tasks.md +156 -0
  33. package/templates/claude/commands/michi/test-planning.md +1 -1
  34. package/templates/claude/commands/michi/validate-design.md +3 -3
  35. package/templates/claude/commands/michi-multi-repo/impl-all.md +30 -1
  36. package/templates/claude/commands/michi-multi-repo/propagate-specs.md +14 -1
  37. package/templates/claude/commands/michi-multi-repo/spec-review.md +16 -2
  38. package/templates/claude-agent/agents/repo-spec-executor.md +1 -1
  39. package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
  40. package/templates/claude-agent/rules/code-size-monitor.md +26 -0
  41. package/templates/claude-agent/rules/code-size-rules.md +32 -0
  42. package/templates/codex/AGENTS.override.md +1 -1
  43. package/templates/codex/rules/README.md +2 -2
  44. package/templates/cursor/commands/michi/spec-tasks.md +117 -0
  45. package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
  46. package/docs/context.md +0 -59
  47. package/docs/michi-development/contributing/development.md +0 -341
  48. package/docs/michi-development/contributing/release.md +0 -365
  49. package/docs/michi-development/design/config-unification.md +0 -733
  50. package/docs/michi-development/design/design-config-current-state.md +0 -330
  51. package/docs/michi-development/design/design-config-implementation.md +0 -628
  52. package/docs/michi-development/design/design-config-migration.md +0 -952
  53. package/docs/michi-development/design/design-config-security.md +0 -771
  54. package/docs/michi-development/design/design-config-solution.md +0 -583
  55. package/docs/michi-development/design/design-config-testing.md +0 -892
  56. package/docs/michi-development/testing/manual-verification-flow.md +0 -871
  57. package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
  58. package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
  59. package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
  60. package/docs/michi-development/testing-strategy.md +0 -87
  61. package/docs/plan.md +0 -275
  62. package/docs/user-guide/getting-started/github-token-setup.md +0 -510
  63. package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
  64. package/docs/user-guide/getting-started/quick-start.md +0 -212
  65. package/docs/user-guide/getting-started/setup.md +0 -819
  66. package/docs/user-guide/guides/agent-skills-integration.md +0 -222
  67. package/docs/user-guide/guides/customization.md +0 -537
  68. package/docs/user-guide/guides/internationalization.md +0 -540
  69. package/docs/user-guide/guides/migration-guide.md +0 -138
  70. package/docs/user-guide/guides/multi-project.md +0 -368
  71. package/docs/user-guide/guides/multi-repo-guide.md +0 -1590
  72. package/docs/user-guide/guides/phase-automation.md +0 -419
  73. package/docs/user-guide/guides/workflow.md +0 -574
  74. package/docs/user-guide/hands-on/README.md +0 -142
  75. package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
  76. package/docs/user-guide/hands-on/claude-setup.md +0 -452
  77. package/docs/user-guide/hands-on/cursor-setup.md +0 -353
  78. package/docs/user-guide/hands-on/troubleshooting.md +0 -964
  79. package/docs/user-guide/hands-on/verification-checklist.md +0 -439
  80. package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -1078
  81. package/docs/user-guide/reference/config.md +0 -589
  82. package/docs/user-guide/reference/multi-repo-api.md +0 -771
  83. package/docs/user-guide/reference/quick-reference.md +0 -297
  84. package/docs/user-guide/reference/security-test-payloads.md +0 -50
  85. package/docs/user-guide/reference/tasks-template.md +0 -550
  86. package/docs/user-guide/release/ci-setup-java.md +0 -114
  87. package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
  88. package/docs/user-guide/release/ci-setup-php.md +0 -102
  89. package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
  90. package/docs/user-guide/release/ci-setup.md +0 -188
  91. package/docs/user-guide/release/release-flow.md +0 -476
  92. package/docs/user-guide/templates/test-specs/README.md +0 -173
  93. package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
  94. package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
  95. package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
  96. package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
  97. package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
  98. package/docs/user-guide/testing/integration-tests.md +0 -312
  99. package/docs/user-guide/testing/tdd-cycle.md +0 -349
  100. package/docs/user-guide/testing/test-execution-flow.md +0 -396
  101. package/docs/user-guide/testing/test-failure-handling.md +0 -521
  102. package/docs/user-guide/testing/test-planning-flow.md +0 -185
  103. package/docs/user-guide/testing-strategy.md +0 -185
  104. package/docs/verification-guide.md +0 -518
@@ -1,819 +0,0 @@
1
- # Michi セットアップガイド
2
-
3
- > **このガイドについて**: 既存のプロジェクトにMichiを導入する手順です。
4
- > 新規プロジェクトを作成する場合は [新規リポジトリセットアップガイド](./new-repository-setup.md) を参照してください。
5
- > Michiの開発に貢献する場合は [開発環境セットアップガイド](../contributing/development.md) を参照してください。
6
-
7
- ## 前提条件
8
-
9
- - Node.js 20.x以上
10
- - npm 10.x以上
11
- - Git(または Jujutsu (jj) も使用可能)
12
- - Cursor IDE または VS Code
13
- - GitHub CLI (gh) - PR作成時に使用
14
- - **cc-sdd**: AI駆動開発ワークフローのコアフレームワーク
15
-
16
- ## Step 1: Michi CLIのインストール
17
-
18
- ```bash
19
- # グローバルインストール
20
- npm install -g @sk8metal/michi-cli
21
-
22
- # インストール確認
23
- michi --version
24
- michi --help
25
- ```
26
-
27
- **注意**: 初回実行時は依存関係のダウンロードに時間がかかる場合があります。
28
-
29
- > **開発者向け**: Michiの開発に貢献したい場合や、最新の開発版を使用したい場合は [開発環境セットアップガイド](../contributing/development.md) を参照してください。
30
-
31
-
32
- ## Step 2: cc-sddとMichiのセットアップ
33
-
34
- Michiは、cc-sddをコアフレームワークとして使用します。セットアップは2段階で行います:
35
-
36
- 1. **cc-sdd**: AI駆動開発ワークフローの基盤
37
- 2. **Michi**: Confluence/JIRA連携などの拡張機能
38
-
39
- 詳細な手順については、以下のセクションを参照してください:
40
-
41
- ### クイックスタート(3ステップ)
42
-
43
- ```bash
44
- # Step 1: cc-sddで標準ファイル生成
45
- npx cc-sdd@latest --cursor --lang ja
46
-
47
- # Step 2: Michi固有ファイルを追加
48
- npx @sk8metal/michi-cli setup-existing --cursor --lang ja
49
-
50
- # Step 3: 環境設定
51
- npm run setup:interactive
52
- ```
53
-
54
- 👉 **詳細な手順**: [推奨ワークフロー(cc-ssd + Michi)](#step-25-推奨ワークフローcc-ssd--michi) を参照してください。
55
-
56
- ## Step 2.5: 推奨ワークフロー(cc-sdd + Michi)
57
-
58
- 既存リポジトリにMichiを導入する標準的な手順は以下の通りです:
59
-
60
- ### 3ステップワークフロー
61
-
62
- ```bash
63
- # Step 1: cc-sddで標準ファイル生成
64
- npx cc-sdd@latest --cursor --lang ja
65
-
66
- # Step 2: Michi固有ファイルを追加
67
- npx @sk8metal/michi-cli setup-existing --cursor --lang ja
68
- # または npm run michi:setup:cursor
69
-
70
- # Step 3: 環境設定
71
- npm run setup:interactive
72
- ```
73
-
74
- ### 各ステップの詳細
75
-
76
- #### Step 1: cc-sdd導入
77
-
78
- cc-sddは、AI駆動開発ワークフローのコアフレームワークです。以下を自動生成します:
79
-
80
- - `.kiro/settings/` - テンプレート設定
81
- - `.cursor/commands/kiro/` - 11のスラッシュコマンド
82
- - `CLAUDE.md` - プロジェクト設定
83
-
84
- **実行例(IDE別)**:
85
-
86
- ```bash
87
- # Cursor IDE
88
- npx cc-sdd@latest --cursor --lang ja
89
-
90
- # Claude Code
91
- npx cc-sdd@latest --claude --lang ja
92
-
93
- # Gemini CLI
94
- npx cc-sdd@latest --gemini --lang ja
95
-
96
- # Codex CLI
97
- npx cc-sdd@next --codex --lang ja
98
-
99
- # Windsurf IDE
100
- npx cc-sdd@next --windsurf --lang ja
101
- ```
102
-
103
- #### Step 2: Michi固有ファイル追加
104
-
105
- Michiの専用機能(Confluence/JIRA連携、マルチプロジェクト管理)を追加します:
106
-
107
- **実行例**:
108
-
109
- ```bash
110
- # Cursor IDE
111
- npx @sk8metal/michi-cli setup-existing --cursor --lang ja
112
- # または npm run michi:setup:cursor
113
-
114
- # Claude Code
115
- npx @sk8metal/michi-cli setup-existing --claude --lang ja
116
- # または npm run michi:setup:claude
117
-
118
- # Claude Code Subagents
119
- npx @sk8metal/michi-cli setup-existing --claude-agent --lang ja
120
- # または npm run michi:setup:claude-agent
121
- ```
122
-
123
- **追加されるもの**:
124
-
125
- - 共通ルール(`.cursor/rules/`または`.claude/rules/`)
126
- - Michi専用コマンド(`.cursor/commands/michi/`または`.claude/commands/michi/`)
127
- - Steeringテンプレート(`.kiro/steering/`)
128
- - Specテンプレート(`.kiro/settings/templates/`)
129
- - プロジェクトメタデータ(`.kiro/project.json`)
130
- - 環境変数テンプレート(`.env`)
131
-
132
- #### Step 3: 環境設定
133
-
134
- 対話的設定ツールで認証情報とプロジェクトメタデータを設定します:
135
-
136
- ```bash
137
- npm run setup:interactive
138
- ```
139
-
140
- このツールが以下を設定します:
141
-
142
- - プロジェクト情報(`project.json`)
143
- - 認証情報(`.env`)
144
-
145
- 詳細は [Step 3: 環境変数の設定](#step-3-環境変数の設定) を参照してください。
146
-
147
- ### なぜこの順序なのか?
148
-
149
- 1. **cc-sdd → Michi**: cc-sddが基盤を作り、Michiが拡張機能を追加
150
- 2. **ファイル追加 → 環境設定**: 設定ファイルが先に存在する必要がある
151
- 3. **標準化**: すべてのプロジェクトで一貫した手順
152
-
153
-
154
- ## Step 3: 環境変数の設定
155
-
156
- ### 3-1. .env ファイルの作成
157
-
158
- **重要**: 作業するプロジェクトのルートディレクトリで実行してください。
159
-
160
- ```bash
161
- # 作業プロジェクトのルートディレクトリに移動
162
- cd /path/to/your-project
163
-
164
- # GitHubリポジトリから直接取得(推奨)
165
- curl -o .env https://raw.githubusercontent.com/sk8metalme/michi/main/env.example
166
-
167
- # または wget を使用
168
- wget -O .env https://raw.githubusercontent.com/sk8metalme/michi/main/env.example
169
- ```
170
-
171
- **注意**:
172
- - `.env` ファイルは作業するプロジェクトのルートディレクトリに作成されます
173
- - 別のディレクトリにいる場合は、まずプロジェクトルートに移動してください
174
-
175
- ## Step 3.5: 設定の作成と管理
176
-
177
- Michiには2段階の設定があります。
178
-
179
- | 設定レベル | コマンド | 出力先 | タイミング |
180
- |---------|---------|--------|-----------|
181
- | **グローバル設定** | `npm run config:global` | `~/.michi/config.json` | 初回セットアップ時(推奨) |
182
- | **プロジェクト設定** | `michi init` または手動作成 | `.michi/config.json` | プロジェクトごとのカスタマイズ時 |
183
-
184
- ### グローバル設定のメリット
185
-
186
- `npm run config:global` を使用すると、以下の設定を全プロジェクトで共有できます:
187
- - Confluence階層構造設定
188
- - JIRA Story作成粒度
189
- - ワークフロー承認ゲート
190
-
191
- ### プロジェクト固有の設定
192
-
193
- プロジェクト固有の設定は以下の方法で作成できます:
194
- 1. **自動コピー**: `michi init` 実行時にグローバル設定から自動コピー
195
- 2. **手動作成**: グローバル設定をコピーして `.michi/config.json` として編集
196
-
197
- **推奨フロー:**
198
- 1. 初回: `npm run config:global` でグローバル設定を作成
199
- 2. プロジェクトごと: `michi init` で初期化(グローバル設定を自動コピー)
200
- 3. カスタマイズ: 必要に応じて `.michi/config.json` を手動編集
201
-
202
- ### 3-2. 認証情報の設定
203
-
204
- `.env` ファイルを編集して、実際の認証情報を設定します:
205
-
206
- ```bash
207
- # Atlassian設定
208
- ATLASSIAN_URL=https://your-domain.atlassian.net
209
- ATLASSIAN_EMAIL=your-email@company.com
210
- ATLASSIAN_API_TOKEN=<ATLASSIANトークン>
211
-
212
- # GitHub設定
213
- GITHUB_ORG=your-org
214
- GITHUB_TOKEN=<GitHubトークン>
215
- # Note: リポジトリ情報は .kiro/project.json の repository フィールドで管理されます
216
-
217
- # Confluence設定
218
- CONFLUENCE_PRD_SPACE=PRD
219
- CONFLUENCE_QA_SPACE=QA
220
- CONFLUENCE_RELEASE_SPACE=RELEASE
221
-
222
- # JIRA設定
223
- JIRA_PROJECT_KEYS=MICHI
224
-
225
- # JIRA Issue Type IDs(JIRAインスタンス固有の値 - 必須)
226
- JIRA_ISSUE_TYPE_STORY=10036
227
- JIRA_ISSUE_TYPE_SUBTASK=10037
228
-
229
- # Slack通知(オプション)
230
- SLACK_WEBHOOK_URL=<SlackWebhook URL>
231
- ```
232
-
233
- #### 各設定値の確認方法
234
-
235
- ##### Atlassian設定
236
-
237
- **`ATLASSIAN_URL`**
238
- - **確認方法**: ブラウザでAtlassianにアクセスした際のURL
239
- - **形式**: `https://your-domain.atlassian.net`
240
- - **例**: `https://mycompany.atlassian.net`
241
-
242
- **`ATLASSIAN_EMAIL`**
243
- - **確認方法**: Atlassianにログインする際に使用するメールアドレス
244
- - **形式**: メールアドレス形式
245
- - **例**: `user@company.com`
246
-
247
- **`ATLASSIAN_API_TOKEN`**
248
- - **確認方法**: 3-3セクション「Atlassian API Token」を参照
249
-
250
- ##### GitHub設定
251
-
252
- **`GITHUB_ORG`**
253
- - **確認方法**: GitHubの組織名またはユーザー名
254
- - **確認手順**:
255
- 1. GitHubにログイン
256
- 2. 組織のページにアクセス(例: `https://github.com/your-org`)
257
- 3. URLの `/your-org` 部分が組織名
258
- - **例**: `sk8metal`、`mycompany`
259
- - **使用機能**:
260
- - プロジェクト一覧表示(`michi project:list`): 組織内の全リポジトリをスキャンしてプロジェクト情報を表示
261
- - 複数プロジェクト見積もり集計(`michi multi-estimate`): 組織内の全リポジトリから `design.md` を取得して見積もり情報を集計
262
- - プロジェクトリソースダッシュボード(`michi project:dashboard`): 組織内の全プロジェクト情報を集計してConfluenceダッシュボードを生成
263
- - 新規プロジェクト作成(`michi create-project`): 新規リポジトリ作成時の組織名として使用
264
-
265
- **`GITHUB_TOKEN`**
266
- - **確認方法**: 3-3セクション「GitHub Token」を参照
267
- - **使用機能**: すべてのGitHub連携機能で認証に使用(API呼び出し時の認証トークン)
268
-
269
- > **Note**: リポジトリ情報(以前の `GITHUB_REPO` 環境変数)は `.kiro/project.json` の `repository` フィールドで管理されるようになりました。
270
- > 形式: `https://github.com/org/repo.git` または `git@github.com:org/repo.git`
271
- > 例: `.kiro/project.json` に `"repository": "https://github.com/sk8metalme/michi.git"` と設定
272
-
273
- ##### Confluence設定
274
-
275
- **`CONFLUENCE_PRD_SPACE`、`CONFLUENCE_QA_SPACE`、`CONFLUENCE_RELEASE_SPACE`**
276
- - **確認方法**: Confluenceスペースのキー(スペースキー)
277
- - **確認手順**:
278
- 1. Confluenceにログイン
279
- 2. スペース一覧ページにアクセス: `https://your-domain.atlassian.net/wiki/spaces`
280
- 3. 各スペースのページにアクセス(例: `https://your-domain.atlassian.net/wiki/spaces/PRD`)
281
- 4. URLの `/spaces/PRD` 部分の `PRD` がスペースキー
282
- - **形式**: 大文字の英数字(通常は3-10文字)
283
- - **例**: `PRD`、`QA`、`RELEASE`、`ENG`
284
-
285
- ##### JIRA設定
286
-
287
- **`JIRA_PROJECT_KEYS`**
288
- - **確認方法**: JIRAプロジェクトのキー(プロジェクトキー)
289
- - **確認手順**:
290
- 1. JIRAにログイン
291
- 2. プロジェクト一覧ページにアクセス: `https://your-domain.atlassian.net/jira/projects`
292
- 3. 各プロジェクトのページにアクセス(例: `https://your-domain.atlassian.net/jira/projects/MICHI`)
293
- 4. URLの `/projects/MICHI` 部分の `MICHI` がプロジェクトキー
294
- 5. 複数のプロジェクトを使用する場合は、カンマ区切りで指定(例: `MICHI,PRJA,PRJB`)
295
- - **形式**: 大文字の英数字(通常は2-10文字)
296
- - **例**: `MICHI`、`PROJ`、`DEV`
297
-
298
- **`JIRA_ISSUE_TYPE_STORY`、`JIRA_ISSUE_TYPE_SUBTASK`**
299
- - **確認方法**: JIRAインスタンス固有のIssue Type ID
300
- - **確認手順**:
301
- 1. **JIRA管理画面から確認**:
302
- - JIRAに管理者権限でログイン
303
- - Settings(設定)> Issues(課題)> Issue types(課題タイプ)
304
- - 「Story」と「Subtask」のIDを確認
305
- 2. **REST APIから確認**:
306
- ```bash
307
- curl -u your-email@company.com:your-api-token \
308
- https://your-domain.atlassian.net/rest/api/3/issuetype
309
- ```
310
- レスポンスから "Story" と "Subtask" の "id" フィールドを取得
311
- - 例: `{"id": "10036", "name": "Story", ...}`
312
- - **形式**: 数値(通常は5桁)
313
- - **例**: `10036`、`10037`
314
- - **重要**: これらの値は各JIRAインスタンスで異なるため、必ず実際の値を設定してください
315
-
316
- ##### Slack設定(オプション)
317
-
318
- **`SLACK_WEBHOOK_URL`**
319
- - **確認方法**: 3-3セクション「Slack Webhook URL」を参照
320
-
321
- ### 3-3. 認証トークンの取得方法
322
-
323
- #### Atlassian API Token
324
- 1. https://id.atlassian.com/manage-profile/security/api-tokens にアクセス
325
- 2. 「APIトークンを作成」をクリック
326
- 3. トークン名を入力(例: michi-automation)
327
- 4. 生成されたトークンをコピーして `.env` に貼り付け
328
-
329
- #### GitHub Token
330
-
331
- **重要**: GitHubトークンをまだ作成していない場合は、以下の詳細ガイドを参照してください:
332
-
333
- 📖 **[GitHubトークン作成ガイド](./github-token-setup.md)**
334
-
335
- トークン作成ガイドでは以下を解説しています:
336
- - Fine-grained tokens と Tokens (classic) の違い
337
- - 必要な権限の詳細説明
338
- - トークンの作成手順(ステップバイステップ)
339
- - セキュリティベストプラクティス
340
- - トラブルシューティング
341
-
342
- **クイックガイド**(既にトークンを持っている場合):
343
-
344
- ```bash
345
- # GitHub CLIを使用する場合
346
- gh auth login
347
- gh auth token
348
-
349
- # 生成されたトークンを .env に設定
350
- ```
351
-
352
- トークン作成後、`.env` の `GITHUB_TOKEN` に設定:
353
-
354
- ```bash
355
- GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
356
- ```
357
-
358
- **必要な権限**:
359
- - `repo` (Full control of private repositories)
360
- - `workflow` (Update GitHub Action workflows)
361
-
362
- 詳細は [GitHubトークン作成ガイド](./github-token-setup.md) を参照してください。
363
-
364
- #### Slack Webhook URL(オプション)
365
- 1. https://api.slack.com/apps にアクセス
366
- 2. 新しいアプリを作成
367
- 3. Incoming Webhooks を有効化
368
- 4. Webhook URL を生成して `.env` に設定
369
-
370
- ## Step 4: Atlassian MCP サーバーの設定
371
-
372
- ### 4-1. MCP設定ファイルの作成
373
-
374
- ホームディレクトリに `~/.cursor/mcp.json` を作成:
375
-
376
- ```bash
377
- # ホームディレクトリに .cursor ディレクトリを作成
378
- mkdir -p ~/.cursor
379
-
380
- # GitHubリポジトリから直接取得
381
- curl -o ~/.cursor/mcp.json https://raw.githubusercontent.com/sk8metalme/michi/main/mcp.json.example
382
-
383
- # または wget を使用
384
- wget -O ~/.cursor/mcp.json https://raw.githubusercontent.com/sk8metalme/michi/main/mcp.json.example
385
- ```
386
-
387
- ### 4-2. 実際の認証情報に置き換え
388
-
389
- `~/.cursor/mcp.json` を編集して、`.env` と同じ認証情報を設定:
390
-
391
- ```json
392
- {
393
- "mcpServers": {
394
- "atlassian": {
395
- "command": "npx",
396
- "args": ["-y", "@atlassian/mcp-server-atlassian"],
397
- "env": {
398
- "ATLASSIAN_URL": "https://your-domain.atlassian.net",
399
- "ATLASSIAN_EMAIL": "your-email@company.com",
400
- "ATLASSIAN_API_TOKEN": "your-token-here"
401
- }
402
- }
403
- }
404
- }
405
- ```
406
-
407
- ## Step 5: プロジェクトメタデータの設定
408
-
409
- `.kiro/project.json` は、プロジェクトのメタデータ(プロジェクトID、JIRAキー、Confluenceラベルなど)を管理するファイルです。
410
-
411
- **重要**: すべてのプロジェクト(単一プロジェクトも含む)は`projects/{project-id}/`配下に配置されます。
412
-
413
- > **補足**: 新規プロジェクトを作成する場合や、既存プロジェクトにMichiを自動導入する場合は [新規リポジトリセットアップガイド](./new-repository-setup.md) を参照してください。
414
-
415
- ### 5-1. `.kiro/project.json` の作成
416
-
417
- **重要**: 作業するプロジェクトのルートディレクトリで実行してください。
418
-
419
- 手動で `.kiro/project.json` を作成します:
420
-
421
- ```bash
422
- # プロジェクトルートに .kiro ディレクトリを作成
423
- mkdir -p .kiro
424
-
425
- # project.json を作成
426
- cat > .kiro/project.json << 'EOF'
427
- {
428
- "projectId": "your-project-id",
429
- "projectName": "プロジェクト名",
430
- "jiraProjectKey": "PROJ",
431
- "confluenceLabels": ["project:your-project", "service:your-service"],
432
- "status": "active",
433
- "team": ["@developer1"],
434
- "stakeholders": ["@pm", "@director"],
435
- "repository": "https://github.com/your-org/your-repo",
436
- "description": "プロジェクトの説明"
437
- }
438
- EOF
439
- ```
440
-
441
- ### 5-2. `.kiro/project.json` の確認・編集
442
-
443
- 既に `.kiro/project.json` が存在する場合、または作成後に必要に応じて編集してください:
444
-
445
- ```json
446
- {
447
- "projectId": "michi",
448
- "projectName": "Michi - Managed Intelligent Comprehensive Hub for Integration",
449
- "jiraProjectKey": "MICHI",
450
- "confluenceLabels": ["project:michi", "service:hub"],
451
- "status": "active",
452
- "team": ["@developer1"],
453
- "stakeholders": ["@pm", "@director"],
454
- "repository": "https://github.com/your-org/your-repo",
455
- "description": "プロジェクトの説明"
456
- }
457
- ```
458
-
459
- **各フィールドの説明**:
460
- - `projectId`: プロジェクトの一意識別子(通常はリポジトリ名)
461
- - `projectName`: プロジェクトの表示名
462
- - `jiraProjectKey`: JIRAプロジェクトキー(`.env` の `JIRA_PROJECT_KEYS` と一致させる)
463
- - `confluenceLabels`: Confluenceページに付与するラベル(配列形式)
464
- - `status`: プロジェクトのステータス(`active`、`archived` など)
465
- - `team`: チームメンバーのリスト(`@` プレフィックス付き)
466
- - `stakeholders`: ステークホルダーのリスト(`@` プレフィックス付き)
467
- - `repository`: GitHubリポジトリのURL(オプション)
468
- - `description`: プロジェクトの説明(オプション)
469
-
470
- ## Step 6: Cursor IDE の設定
471
-
472
- ### 6-1. Cursor でプロジェクトを開く
473
-
474
- ```bash
475
- cursor .
476
- ```
477
-
478
- ### 6-2. 利用可能なコマンドの確認
479
-
480
- Cursor のコマンドパネル(Cmd+Shift+P)で `/kiro:` と入力すると、以下のコマンドが表示されます:
481
-
482
- - `/kiro:spec-init <機能説明>` - 新機能の仕様を初期化
483
- - `/kiro:spec-requirements <feature>` - 要件定義を生成
484
- - `/kiro:spec-design <feature>` - 設計ドキュメントを生成
485
- - `/kiro:spec-tasks <feature>` - 実装タスクを生成
486
- - `/kiro:spec-impl <feature> <tasks>` - TDDで実装
487
- - `/kiro:steering` - プロジェクトステアリングを作成/更新
488
-
489
- 凡例の詳細は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
490
-
491
- ## Step 7: 動作確認
492
-
493
- ### 7-1. 基本的な動作確認
494
-
495
- ```bash
496
- # Michiコマンドが利用可能か確認
497
- michi --version
498
-
499
- # ヘルプを表示
500
- michi --help
501
-
502
- # 利用可能なコマンド一覧
503
- michi help
504
- ```
505
-
506
- ## トラブルシューティング
507
-
508
- ### cc-sddのインストールに失敗する
509
-
510
- **症状**: `npx cc-sdd@latest` が失敗する
511
-
512
- **原因**:
513
- - npmキャッシュの問題
514
- - ネットワーク接続の問題
515
- - Node.jsのバージョンが古い
516
-
517
- **解決方法**:
518
-
519
- ```bash
520
- # キャッシュをクリア
521
- npm cache clean --force
522
-
523
- # 再度実行
524
- npx cc-sdd@latest --cursor --lang ja
525
-
526
- # それでも失敗する場合は、Node.jsバージョンを確認
527
- node --version
528
- # 20.0.0以上が必要
529
- ```
530
-
531
- ### setup-existing の実行エラー
532
-
533
- **症状**: `npx @sk8metal/michi-cli setup-existing` が失敗する
534
-
535
- **原因**:
536
- - ネットワーク接続の問題
537
- - 必要な依存関係がインストールされていない
538
- - 権限の問題
539
-
540
- **解決方法**:
541
-
542
- ```bash
543
- # NPMキャッシュをクリア
544
- npm cache clean --force
545
-
546
- # 再度実行
547
- npx @sk8metal/michi-cli setup-existing --cursor --lang ja
548
-
549
- # または、開発リポジトリから実行する場合
550
- cd /path/to/michi
551
- npm run michi:setup:cursor
552
- ```
553
-
554
- ### 環境変数設定のミス
555
-
556
- **症状**: Confluence/JIRA連携が動作しない
557
-
558
- **原因**:
559
- - `.env`ファイルの認証情報が間違っている
560
- - 環境変数が正しく読み込まれていない
561
-
562
- **解決方法**:
563
-
564
- ```bash
565
- # .envファイルの内容を確認
566
- cat .env
567
-
568
- # 認証情報が正しいか確認
569
- # - ATLASSIAN_URL: https://your-domain.atlassian.net 形式
570
- # - ATLASSIAN_EMAIL: メールアドレス形式
571
- # - ATLASSIAN_API_TOKEN: 有効なトークン
572
- # - GITHUB_TOKEN: ghp_ で始まるトークン
573
-
574
- # トークンの有効性を確認
575
- curl -u your-email@company.com:your-api-token \
576
- https://your-domain.atlassian.net/rest/api/3/myself
577
- ```
578
-
579
- ### MCP サーバーが動作しない
580
-
581
- **症状**: Cursor IDEでAtlassian MCPが接続できない
582
-
583
- **原因**:
584
- - `~/.cursor/mcp.json`の設定が間違っている
585
- - Atlassian API Tokenが無効
586
- - Cursorが設定を読み込んでいない
587
-
588
- **解決方法**:
589
-
590
- 1. Cursor を再起動
591
- 2. `~/.cursor/mcp.json` の認証情報を確認
592
-
593
- ```bash
594
- # mcp.jsonの内容を確認
595
- cat ~/.cursor/mcp.json
596
-
597
- # 認証情報が.envと一致しているか確認
598
- ```
599
-
600
- 3. Atlassian API Token が有効か確認
601
-
602
- ```bash
603
- # トークンの有効性をテスト
604
- curl -u your-email@company.com:your-token \
605
- https://your-domain.atlassian.net/rest/api/3/myself
606
- ```
607
-
608
- 4. Cursor のログを確認
609
-
610
- - Cursor > View > Toggle Developer Tools
611
- - Console タブでエラーを確認
612
-
613
- ### JIRA Issue Type ID の取得方法
614
-
615
- **症状**: `JIRA_ISSUE_TYPE_STORY`や`JIRA_ISSUE_TYPE_SUBTASK`の値がわからない
616
-
617
- **解決方法**:
618
-
619
- **方法1: JIRA管理画面から確認(管理者権限が必要)**
620
-
621
- 1. JIRAに管理者権限でログイン
622
- 2. Settings(設定)> Issues(課題)> Issue types(課題タイプ)
623
- 3. 「Story」と「Subtask」のIDを確認
624
-
625
- **方法2: REST APIで確認(推奨)**
626
-
627
- ```bash
628
- # すべてのIssue Typeを取得
629
- curl -u your-email@company.com:your-api-token \
630
- https://your-domain.atlassian.net/rest/api/3/issuetype | jq
631
-
632
- # 出力例:
633
- # [
634
- # {
635
- # "id": "10036",
636
- # "name": "Story",
637
- # ...
638
- # },
639
- # {
640
- # "id": "10037",
641
- # "name": "Subtask",
642
- # ...
643
- # }
644
- # ]
645
- ```
646
-
647
- **方法3: jqがない場合**
648
-
649
- ```bash
650
- # jqなしで確認
651
- curl -u your-email@company.com:your-api-token \
652
- https://your-domain.atlassian.net/rest/api/3/issuetype
653
-
654
- # 出力から "Story" と "Subtask" の "id" フィールドを探す
655
- ```
656
-
657
- ### GitHub認証エラー
658
-
659
- ```bash
660
- gh auth status
661
- gh auth login
662
- gh auth setup-git
663
- ```
664
-
665
- ## セットアップ完了
666
-
667
- これでセットアップは完了です。次のステップ:
668
-
669
- - [クイックスタート](./quick-start.md) - 5分で始める
670
- - [ワークフローガイド](../guides/workflow.md) - AI開発フロー
671
- - [マルチプロジェクト管理](../guides/multi-project.md) - 複数プロジェクト管理
672
-
673
- ## オプション設定
674
-
675
- 以下の設定は任意です。必要に応じて設定してください。
676
-
677
- ### ワークフロー承認ゲートの設定
678
-
679
- ワークフロー実行時(`michi workflow:run`)の承認ゲートで使用するロール名を設定できます。
680
-
681
- #### 設定方法
682
-
683
- `.env` ファイルに以下の環境変数を追加:
684
-
685
- ```bash
686
- # 要件定義フェーズの承認者
687
- APPROVAL_GATES_REQUIREMENTS=pm,director
688
-
689
- # 設計フェーズの承認者
690
- APPROVAL_GATES_DESIGN=architect,director
691
-
692
- # リリースフェーズの承認者
693
- APPROVAL_GATES_RELEASE=sm,director
694
- ```
695
-
696
- #### 設定例
697
-
698
- **英語ロール名を使用する場合:**
699
- ```bash
700
- APPROVAL_GATES_REQUIREMENTS=product-manager,cto,legal
701
- APPROVAL_GATES_DESIGN=tech-lead,architect,security
702
- APPROVAL_GATES_RELEASE=release-manager,qa-lead,director
703
- ```
704
-
705
- **日本語ロール名を使用する場合:**
706
- ```bash
707
- APPROVAL_GATES_REQUIREMENTS=企画,部長
708
- APPROVAL_GATES_DESIGN=アーキテクト,部長
709
- APPROVAL_GATES_RELEASE=SM,部長
710
- ```
711
-
712
- **組織固有のロール名を使用する場合:**
713
- ```bash
714
- APPROVAL_GATES_REQUIREMENTS=プロダクトマネージャー,CTO,法務
715
- APPROVAL_GATES_DESIGN=テックリード,アーキテクト,セキュリティ
716
- APPROVAL_GATES_RELEASE=リリースマネージャー,QAリード,部長
717
- ```
718
-
719
- #### デフォルト値
720
-
721
- 環境変数が設定されていない場合、以下のデフォルト値が使用されます:
722
-
723
- - `APPROVAL_GATES_REQUIREMENTS`: `pm,director`
724
- - `APPROVAL_GATES_DESIGN`: `architect,director`
725
- - `APPROVAL_GATES_RELEASE`: `sm,director`
726
-
727
- #### 注意事項
728
-
729
- - ロール名はカンマ区切りで指定します
730
- - 各ロール名の前後の空白は自動的にトリムされます
731
- - 空のロール名は無視されます
732
- - 環境変数が未設定の場合は、デフォルト値が使用されます
733
-
734
- ### プロジェクト固有設定ファイル(.michi/config.json)
735
-
736
- `.michi/config.json` を作成することで、Confluence/JIRAの動作をカスタマイズできます。
737
-
738
- #### 設定ファイルの作成
739
-
740
- プロジェクトルートに `.michi/config.json` を作成:
741
-
742
- **注意**: 以前は `.kiro/config.json` を使用していましたが、Michi専用の設定ファイルとして `.michi/config.json` に変更されました。
743
-
744
- ```json
745
- {
746
- "confluence": {
747
- "pageCreationGranularity": "by-hierarchy",
748
- "spaces": {
749
- "requirements": "Michi",
750
- "design": "Michi",
751
- "tasks": "Michi"
752
- },
753
- "hierarchy": {
754
- "mode": "simple",
755
- "parentPageTitle": "[{projectName}] {featureName}"
756
- }
757
- },
758
- "jira": {
759
- "createEpic": true,
760
- "storyCreationGranularity": "all",
761
- "storyPoints": "auto",
762
- "issueTypes": {
763
- "story": "10036",
764
- "subtask": "10037"
765
- }
766
- },
767
- "workflow": {
768
- "enabledPhases": ["requirements", "design", "tasks"],
769
- "approvalGates": {
770
- "requirements": ["leader", "director"],
771
- "design": ["leader", "director"],
772
- "release": ["service-manager", "director"]
773
- }
774
- }
775
- }
776
- ```
777
-
778
- #### 設定値の詳細
779
-
780
- すべての設定値の詳細は [設定値リファレンス](../reference/config.md) を参照してください。
781
-
782
- #### 設定の優先順位
783
-
784
- 設定値は以下の優先順位で決定されます:
785
-
786
- 1. **`spec.json`**: 機能固有の設定(最優先)
787
- 2. **`.michi/config.json`**: プロジェクト固有の設定
788
- 3. **`~/.michi/config.json`**: グローバル設定
789
- 4. **環境変数**: システム環境変数または`.env`ファイル
790
- 5. **デフォルト値**: スキーマで定義されたデフォルト値
791
-
792
- #### よくある設定パターン
793
-
794
- 詳細は [カスタマイズガイド](../guides/customization.md) を参照してください。
795
-
796
- ## 参考リンク
797
-
798
- ### AI開発フレームワーク
799
-
800
- - [cc-sdd公式ドキュメント](https://github.com/gotalab/cc-sdd/blob/main/tools/cc-sdd/README_ja.md)
801
- - [cc-sdd コマンドリファレンス](https://github.com/gotalab/cc-sdd/blob/main/docs/guides/command-reference.md)
802
- - [cc-sdd カスタマイズガイド](https://github.com/gotalab/cc-sdd/blob/main/docs/guides/customization-guide.md)
803
- - [Kiro IDE](https://kiro.dev/docs/)
804
-
805
- ### バージョン管理
806
-
807
- - [Jujutsu (jj) 公式サイト](https://martinvonz.github.io/jj/)
808
- - [Jujutsu インストールガイド](https://martinvonz.github.io/jj/latest/install-and-setup/)
809
-
810
- ### Atlassian統合
811
-
812
- - [Atlassian MCP Server](https://www.atlassian.com/ja/platform/remote-mcp-server)
813
- - [Atlassian API トークン作成](https://id.atlassian.com/manage-profile/security/api-tokens)
814
-
815
- ### IDE・開発ツール
816
-
817
- - [Cursor IDE](https://cursor.sh/)
818
- - [GitHub CLI](https://cli.github.com/)
819
-