@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.
- package/README.md +77 -847
- package/dist/scripts/phase-runner.js +1 -1
- package/dist/scripts/phase-runner.js.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.d.ts +18 -0
- package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.js +42 -0
- package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
- package/dist/scripts/utils/tasks-format-validator.js +3 -3
- package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
- package/docs/README.md +20 -83
- package/docs/getting-started/configuration.md +379 -0
- package/docs/getting-started/installation.md +59 -0
- package/docs/getting-started/quick-start.md +76 -0
- package/docs/guides/ai-tools.md +311 -0
- package/docs/guides/atlassian-integration.md +116 -0
- package/docs/guides/claude-code.md +155 -0
- package/docs/guides/multi-repo.md +117 -0
- package/docs/guides/workflow.md +382 -0
- package/docs/reference/ai-commands.md +92 -0
- package/docs/reference/cli.md +756 -0
- package/docs/reference/environment-variables.md +192 -0
- package/docs/troubleshooting.md +543 -0
- package/package.json +1 -1
- package/scripts/phase-runner.ts +1 -1
- package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
- package/scripts/utils/multi-repo-validator.ts +50 -0
- package/scripts/utils/tasks-format-validator.ts +3 -3
- package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
- package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
- package/templates/claude/commands/michi/e2e-plan.md +1 -1
- package/templates/claude/commands/michi/spec-design.md +2 -2
- package/templates/claude/commands/michi/spec-tasks.md +156 -0
- package/templates/claude/commands/michi/test-planning.md +1 -1
- package/templates/claude/commands/michi/validate-design.md +3 -3
- package/templates/claude/commands/michi-multi-repo/impl-all.md +30 -1
- package/templates/claude/commands/michi-multi-repo/propagate-specs.md +14 -1
- package/templates/claude/commands/michi-multi-repo/spec-review.md +16 -2
- package/templates/claude-agent/agents/repo-spec-executor.md +1 -1
- package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
- package/templates/claude-agent/rules/code-size-monitor.md +26 -0
- package/templates/claude-agent/rules/code-size-rules.md +32 -0
- package/templates/codex/AGENTS.override.md +1 -1
- package/templates/codex/rules/README.md +2 -2
- package/templates/cursor/commands/michi/spec-tasks.md +117 -0
- package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
- package/docs/context.md +0 -59
- package/docs/michi-development/contributing/development.md +0 -341
- package/docs/michi-development/contributing/release.md +0 -365
- package/docs/michi-development/design/config-unification.md +0 -733
- package/docs/michi-development/design/design-config-current-state.md +0 -330
- package/docs/michi-development/design/design-config-implementation.md +0 -628
- package/docs/michi-development/design/design-config-migration.md +0 -952
- package/docs/michi-development/design/design-config-security.md +0 -771
- package/docs/michi-development/design/design-config-solution.md +0 -583
- package/docs/michi-development/design/design-config-testing.md +0 -892
- package/docs/michi-development/testing/manual-verification-flow.md +0 -871
- package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
- package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
- package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
- package/docs/michi-development/testing-strategy.md +0 -87
- package/docs/plan.md +0 -275
- package/docs/user-guide/getting-started/github-token-setup.md +0 -510
- package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
- package/docs/user-guide/getting-started/quick-start.md +0 -212
- package/docs/user-guide/getting-started/setup.md +0 -819
- package/docs/user-guide/guides/agent-skills-integration.md +0 -222
- package/docs/user-guide/guides/customization.md +0 -537
- package/docs/user-guide/guides/internationalization.md +0 -540
- package/docs/user-guide/guides/migration-guide.md +0 -138
- package/docs/user-guide/guides/multi-project.md +0 -368
- package/docs/user-guide/guides/multi-repo-guide.md +0 -1590
- package/docs/user-guide/guides/phase-automation.md +0 -419
- package/docs/user-guide/guides/workflow.md +0 -574
- package/docs/user-guide/hands-on/README.md +0 -142
- package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
- package/docs/user-guide/hands-on/claude-setup.md +0 -452
- package/docs/user-guide/hands-on/cursor-setup.md +0 -353
- package/docs/user-guide/hands-on/troubleshooting.md +0 -964
- package/docs/user-guide/hands-on/verification-checklist.md +0 -439
- package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -1078
- package/docs/user-guide/reference/config.md +0 -589
- package/docs/user-guide/reference/multi-repo-api.md +0 -771
- package/docs/user-guide/reference/quick-reference.md +0 -297
- package/docs/user-guide/reference/security-test-payloads.md +0 -50
- package/docs/user-guide/reference/tasks-template.md +0 -550
- package/docs/user-guide/release/ci-setup-java.md +0 -114
- package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
- package/docs/user-guide/release/ci-setup-php.md +0 -102
- package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
- package/docs/user-guide/release/ci-setup.md +0 -188
- package/docs/user-guide/release/release-flow.md +0 -476
- package/docs/user-guide/templates/test-specs/README.md +0 -173
- package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
- package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
- package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
- package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
- package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
- package/docs/user-guide/testing/integration-tests.md +0 -312
- package/docs/user-guide/testing/tdd-cycle.md +0 -349
- package/docs/user-guide/testing/test-execution-flow.md +0 -396
- package/docs/user-guide/testing/test-failure-handling.md +0 -521
- package/docs/user-guide/testing/test-planning-flow.md +0 -185
- package/docs/user-guide/testing-strategy.md +0 -185
- package/docs/verification-guide.md +0 -518
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
# AIツール統合ガイド
|
|
2
|
+
|
|
3
|
+
Michiは、Claude Code以外のAI開発ツールもサポートしています。
|
|
4
|
+
このガイドでは、Cursor、Gemini CLI、Codex CLI、Clineの各ツールでMichiを使用するためのセットアップと基本的な使い方を説明します。
|
|
5
|
+
|
|
6
|
+
## 対応AIツール一覧
|
|
7
|
+
|
|
8
|
+
| ツール | 種別 | 推奨用途 | セットアップコマンド |
|
|
9
|
+
|--------|------|---------|---------------------|
|
|
10
|
+
| Claude Code | CLI | メイン開発ツール | `michi setup --claude` |
|
|
11
|
+
| Cursor | エディタ統合 | コード編集・生成 | `michi setup --cursor` |
|
|
12
|
+
| Gemini CLI | CLI | Google AI活用 | `michi setup --gemini` |
|
|
13
|
+
| Codex CLI | CLI | プロンプトベース開発 | `michi setup --codex` |
|
|
14
|
+
| Cline | VS Code拡張 | エディタ統合AI | `michi setup --cline` |
|
|
15
|
+
|
|
16
|
+
**注意**: すべてのツールで同じワークフロー(`/kiro:*`、`/michi:*`コマンド)が利用可能です。
|
|
17
|
+
|
|
18
|
+
## 共通セットアップ手順
|
|
19
|
+
|
|
20
|
+
### 1. cc-sddのインストール
|
|
21
|
+
|
|
22
|
+
すべてのツールで、まずcc-sddをインストールします。
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx cc-sdd@latest --lang ja
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**生成されるファイル**:
|
|
29
|
+
- `.kiro/settings/` - cc-sdd標準のルール、テンプレート(`.gitignore`対象)
|
|
30
|
+
- `.kiro/steering/` - プロジェクト固有のコンテキスト
|
|
31
|
+
- `.kiro/specs/` - 機能仕様(Git管理)
|
|
32
|
+
|
|
33
|
+
### 2. 環境変数の設定(オプション)
|
|
34
|
+
|
|
35
|
+
JIRA/Confluence連携を使用する場合、環境変数を設定してください。
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# .envファイルに以下を追加
|
|
39
|
+
ATLASSIAN_URL=https://your-domain.atlassian.net
|
|
40
|
+
ATLASSIAN_EMAIL=your-email@example.com
|
|
41
|
+
ATLASSIAN_API_TOKEN=your-api-token
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
詳細は [環境変数リファレンス](../reference/environment-variables.md) を参照してください。
|
|
45
|
+
|
|
46
|
+
## Cursor
|
|
47
|
+
|
|
48
|
+
### 概要
|
|
49
|
+
|
|
50
|
+
Cursorは、AI統合エディタです。コードエディタ内でAIによるコード生成、リファクタリング、ドキュメント作成を行えます。
|
|
51
|
+
|
|
52
|
+
### セットアップ
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
# Cursor固有の拡張をインストール
|
|
56
|
+
michi setup --cursor
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**生成されるファイル**:
|
|
60
|
+
- `.cursor/rules/` - Cursor固有ルール
|
|
61
|
+
- `michi-core.md` - Michi基本原則
|
|
62
|
+
- `atlassian-mcp.md` - Atlassian MCP統合
|
|
63
|
+
- `github-ssot.md` - GitHub SSoT原則
|
|
64
|
+
- `multi-project.mdc` - マルチプロジェクト管理
|
|
65
|
+
- `.cursor/commands/michi/` - Michiコマンド
|
|
66
|
+
- `confluence-sync.md` - Confluence同期
|
|
67
|
+
- `project-switch.md` - プロジェクト切り替え
|
|
68
|
+
- `.cursor/commands/kiro/` - Kiroコマンド
|
|
69
|
+
- `kiro-spec-tasks.md` - タスク分割
|
|
70
|
+
- `kiro-spec-impl.md` - TDD実装
|
|
71
|
+
|
|
72
|
+
### 利用可能なコマンド
|
|
73
|
+
|
|
74
|
+
Cursorでは、以下のコマンドが利用できます:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# cc-sdd標準コマンド
|
|
78
|
+
/kiro:spec-init "機能の説明"
|
|
79
|
+
/kiro:spec-requirements {feature}
|
|
80
|
+
/kiro:spec-design {feature}
|
|
81
|
+
/michi:spec-tasks {feature}
|
|
82
|
+
/kiro:spec-impl {feature}
|
|
83
|
+
|
|
84
|
+
# Michi拡張コマンド
|
|
85
|
+
/michi:confluence-sync {feature} {type}
|
|
86
|
+
/michi:project-switch
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### 特徴
|
|
90
|
+
|
|
91
|
+
- エディタ内でのリアルタイムコード提案
|
|
92
|
+
- MCP(Model Context Protocol)によるAtlassian統合
|
|
93
|
+
- プロジェクト切り替え機能
|
|
94
|
+
|
|
95
|
+
## Gemini CLI
|
|
96
|
+
|
|
97
|
+
### 概要
|
|
98
|
+
|
|
99
|
+
Gemini CLIは、Google AIを活用したCLIツールです。プロンプトベースで仕様書やコードを生成できます。
|
|
100
|
+
|
|
101
|
+
### セットアップ
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# Gemini CLI固有の拡張をインストール
|
|
105
|
+
michi setup --gemini
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**生成されるファイル**:
|
|
109
|
+
- `.gemini/GEMINI.md` - Gemini CLI設定
|
|
110
|
+
- `.gemini/commands/` - Gemini CLI専用コマンド
|
|
111
|
+
|
|
112
|
+
### 利用可能なコマンド
|
|
113
|
+
|
|
114
|
+
Gemini CLIでは、以下のコマンドが利用できます:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
# cc-sdd標準コマンド
|
|
118
|
+
/kiro:spec-init "機能の説明"
|
|
119
|
+
/kiro:spec-requirements {feature}
|
|
120
|
+
/kiro:spec-design {feature}
|
|
121
|
+
/michi:spec-tasks {feature}
|
|
122
|
+
/kiro:spec-impl {feature}
|
|
123
|
+
|
|
124
|
+
# Gemini固有の操作
|
|
125
|
+
# GitHubにコミット後、Confluence同期を実行
|
|
126
|
+
michi confluence:sync {feature} requirements
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### 特徴
|
|
130
|
+
|
|
131
|
+
- Google AIの最新モデルを使用
|
|
132
|
+
- プロジェクトコンテキスト(`.kiro/project.json`)の自動参照
|
|
133
|
+
- GitHub SSoT原則(GitHub→Confluence同期)
|
|
134
|
+
|
|
135
|
+
## Codex CLI
|
|
136
|
+
|
|
137
|
+
### 概要
|
|
138
|
+
|
|
139
|
+
Codex CLIは、プロンプトベースのAI開発ツールです。エージェントベースのワークフローをサポートします。
|
|
140
|
+
|
|
141
|
+
### セットアップ
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
# Codex CLI固有の拡張をインストール
|
|
145
|
+
michi setup --codex
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
**生成されるファイル**:
|
|
149
|
+
- `AGENTS.override.md` - Codex CLI用エージェント設定
|
|
150
|
+
- `.codex/prompts/` - Codex CLI専用プロンプト
|
|
151
|
+
- `confluence-sync.md` - Confluence同期プロンプト
|
|
152
|
+
|
|
153
|
+
### 利用可能なプロンプト
|
|
154
|
+
|
|
155
|
+
Codex CLIでは、以下のプロンプトが利用できます:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
# cc-sdd標準フロー
|
|
159
|
+
/kiro:spec-init FEATURE=calculator-app
|
|
160
|
+
/kiro:spec-requirements FEATURE=calculator-app
|
|
161
|
+
/kiro:spec-design FEATURE=calculator-app
|
|
162
|
+
/michi:spec-tasks FEATURE=calculator-app
|
|
163
|
+
/kiro:spec-impl FEATURE=calculator-app
|
|
164
|
+
|
|
165
|
+
# Michi拡張プロンプト
|
|
166
|
+
/prompts:confluence-sync FEATURE=calculator-app
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### 特徴
|
|
170
|
+
|
|
171
|
+
- エージェントベースのワークフロー
|
|
172
|
+
- Michi固有のテスト戦略(マスタテスト方式)
|
|
173
|
+
- 対応言語: Node.js、Java(Gradle)、PHP
|
|
174
|
+
|
|
175
|
+
### テスト戦略
|
|
176
|
+
|
|
177
|
+
Codex CLIでは、Michi固有のマスタテスト方式を採用しています。
|
|
178
|
+
|
|
179
|
+
**Phase A(PR時に自動実行)**:
|
|
180
|
+
- 単体テスト
|
|
181
|
+
- Lint
|
|
182
|
+
- ビルド
|
|
183
|
+
|
|
184
|
+
**Phase B(リリース前に手動実行)**:
|
|
185
|
+
- 統合テスト
|
|
186
|
+
- E2Eテスト
|
|
187
|
+
- パフォーマンステスト
|
|
188
|
+
- セキュリティテスト
|
|
189
|
+
|
|
190
|
+
詳細は [ワークフローガイド](workflow.md) を参照してください。
|
|
191
|
+
|
|
192
|
+
## Cline
|
|
193
|
+
|
|
194
|
+
### 概要
|
|
195
|
+
|
|
196
|
+
Clineは、VS Code拡張機能として動作するAIツールです。エディタ内でAIによるコード生成、リファクタリング、ドキュメント作成を行えます。
|
|
197
|
+
|
|
198
|
+
### セットアップ
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
# Cline固有の拡張をインストール
|
|
202
|
+
michi setup --cline
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
**生成されるファイル**:
|
|
206
|
+
- `.clinerules/rules/` - Cline固有ルール
|
|
207
|
+
- `michi-core.md` - Michi基本原則
|
|
208
|
+
- `atlassian-integration.md` - Atlassian統合ルール
|
|
209
|
+
|
|
210
|
+
### 利用可能な機能
|
|
211
|
+
|
|
212
|
+
Clineでは、以下の機能が利用できます:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
# cc-sdd標準コマンド
|
|
216
|
+
/kiro:spec-init "機能の説明"
|
|
217
|
+
/kiro:spec-requirements {feature}
|
|
218
|
+
/kiro:spec-design {feature}
|
|
219
|
+
/michi:spec-tasks {feature}
|
|
220
|
+
/kiro:spec-impl {feature}
|
|
221
|
+
|
|
222
|
+
# Michi拡張
|
|
223
|
+
# エディタ内でAtlassian統合を使用
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### 特徴
|
|
227
|
+
|
|
228
|
+
- VS Code拡張として動作
|
|
229
|
+
- エディタ内でのリアルタイムコード提案
|
|
230
|
+
- GitHub SSoT原則のサポート
|
|
231
|
+
- Multi-Project管理機能
|
|
232
|
+
|
|
233
|
+
## 共通注意事項
|
|
234
|
+
|
|
235
|
+
### ワークフローの一貫性
|
|
236
|
+
|
|
237
|
+
すべてのAIツールで、同じワークフロー(cc-sdd + Michi拡張)が利用できます。
|
|
238
|
+
|
|
239
|
+
**基本フロー**:
|
|
240
|
+
```
|
|
241
|
+
Phase 0.0 → 0.1 → 0.2 → 0.5 → Phase 2
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
**完全フロー(Michi拡張含む)**:
|
|
245
|
+
```
|
|
246
|
+
Phase 0.0 → 0.1 → 0.2 → [0.3-0.4] → 0.5 → 0.6-0.7
|
|
247
|
+
→ Phase 1 → Phase 2 → Phase A → Phase 3 → Phase B → Phase 4-5
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
詳細は [ワークフローガイド](workflow.md) を参照してください。
|
|
251
|
+
|
|
252
|
+
### GitHub SSoT原則
|
|
253
|
+
|
|
254
|
+
すべてのツールで、GitHub SSoT(Single Source of Truth)原則を遵守します。
|
|
255
|
+
|
|
256
|
+
**基本原則**:
|
|
257
|
+
- すべての仕様はGitHub(`.kiro/specs/`)で管理
|
|
258
|
+
- Confluenceは参照と承認のみ(編集はGitHubのみ)
|
|
259
|
+
- 重複管理を避ける
|
|
260
|
+
|
|
261
|
+
**データフロー**:
|
|
262
|
+
```
|
|
263
|
+
GitHub (.kiro/specs/) ← 真実の源(編集可能)
|
|
264
|
+
↓ 同期
|
|
265
|
+
Confluence ← 表示と承認(読み取り専用)
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
### Multi-Project管理
|
|
269
|
+
|
|
270
|
+
すべてのツールで、Multi-Project管理機能が利用できます。
|
|
271
|
+
|
|
272
|
+
**プロジェクトメタデータ**(`.kiro/project.json`):
|
|
273
|
+
```json
|
|
274
|
+
{
|
|
275
|
+
"projectId": "my-project",
|
|
276
|
+
"jiraProjectKey": "MYPROJ",
|
|
277
|
+
"confluenceSpaceKey": "MYSPACE",
|
|
278
|
+
"confluenceLabels": ["ai-development", "michi"]
|
|
279
|
+
}
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
詳細は [Multi-Repoガイド](multi-repo.md) を参照してください。
|
|
283
|
+
|
|
284
|
+
### コマンド実行方法の違い
|
|
285
|
+
|
|
286
|
+
| ツール | コマンド形式 | 実行場所 |
|
|
287
|
+
|--------|------------|---------|
|
|
288
|
+
| Claude Code | `/kiro:*`, `/michi:*` | CLI |
|
|
289
|
+
| Cursor | `/kiro:*`, `/michi:*` | エディタ内 |
|
|
290
|
+
| Gemini CLI | `/kiro:*`, `michi *` | CLI |
|
|
291
|
+
| Codex CLI | `/kiro:*`, `/prompts:*` | CLI |
|
|
292
|
+
| Cline | `/kiro:*`, `/michi:*` | VS Code拡張 |
|
|
293
|
+
|
|
294
|
+
## 推奨ツールの選び方
|
|
295
|
+
|
|
296
|
+
| 用途 | 推奨ツール | 理由 |
|
|
297
|
+
|------|-----------|------|
|
|
298
|
+
| メイン開発 | Claude Code | 最も完全な統合、サブエージェント機能 |
|
|
299
|
+
| コード編集 | Cursor | エディタ統合、リアルタイム提案 |
|
|
300
|
+
| Google AI活用 | Gemini CLI | Google AIの最新モデル |
|
|
301
|
+
| プロンプトベース | Codex CLI | エージェントベースワークフロー |
|
|
302
|
+
| VS Code統合 | Cline | VS Code拡張、エディタ内完結 |
|
|
303
|
+
|
|
304
|
+
## 関連ドキュメント
|
|
305
|
+
|
|
306
|
+
- [Claude Codeセットアップガイド](claude-code.md) - Claude Code固有のセットアップ
|
|
307
|
+
- [AIコマンドリファレンス](../reference/ai-commands.md) - すべてのコマンドの詳細
|
|
308
|
+
- [ワークフローガイド](workflow.md) - 開発ワークフロー全体像
|
|
309
|
+
- [Atlassian連携ガイド](atlassian-integration.md) - JIRA/Confluence連携の詳細
|
|
310
|
+
- [環境変数リファレンス](../reference/environment-variables.md) - 環境変数の詳細設定
|
|
311
|
+
- [トラブルシューティング](../troubleshooting.md) - よくある問題と解決策
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Atlassian連携ガイド
|
|
2
|
+
|
|
3
|
+
JIRA と Confluence との連携機能を説明します。
|
|
4
|
+
|
|
5
|
+
## 前提条件
|
|
6
|
+
|
|
7
|
+
### 環境変数の設定
|
|
8
|
+
|
|
9
|
+
以下の環境変数が必要です。
|
|
10
|
+
|
|
11
|
+
**必須**:
|
|
12
|
+
- `ATLASSIAN_URL` - Atlassianドメイン(例: `https://your-domain.atlassian.net`)
|
|
13
|
+
- `ATLASSIAN_EMAIL` - Atlassianアカウントのメールアドレス
|
|
14
|
+
- `ATLASSIAN_API_TOKEN` - Atlassian APIトークン
|
|
15
|
+
|
|
16
|
+
**オプション**:
|
|
17
|
+
- `CONFLUENCE_PRD_SPACE` - Confluenceスペースキー(デフォルト: PRD)
|
|
18
|
+
|
|
19
|
+
**APIトークン取得**: https://id.atlassian.com/manage-profile/security/api-tokens から取得します。
|
|
20
|
+
|
|
21
|
+
**設定方法**: `.env` または `~/.michi/.env` ファイルでの設定方法と優先順位については、[環境変数リファレンス](../reference/environment-variables.md) を参照してください。
|
|
22
|
+
|
|
23
|
+
## Confluence同期
|
|
24
|
+
|
|
25
|
+
### 基本的な使い方
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
michi confluence:sync my-feature # 要件定義
|
|
29
|
+
michi confluence:sync my-feature design # 設計書
|
|
30
|
+
michi confluence:sync my-feature tasks # タスク
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 設定
|
|
34
|
+
|
|
35
|
+
`.michi/config.json` でカスタマイズできます。
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"confluence": {
|
|
40
|
+
"spaces": {
|
|
41
|
+
"requirements": "PRD",
|
|
42
|
+
"design": "TECH"
|
|
43
|
+
},
|
|
44
|
+
"pageCreationGranularity": "hierarchical",
|
|
45
|
+
"autoLabels": ["{projectLabel}", "{docType}", "github-sync"]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**pageCreationGranularity**:
|
|
51
|
+
- `single`: 1ページ(デフォルト)
|
|
52
|
+
- `hierarchical`: 見出しごとに子ページ
|
|
53
|
+
|
|
54
|
+
### レートリミット
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
export ATLASSIAN_REQUEST_DELAY=1000 # ミリ秒
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## JIRA同期
|
|
61
|
+
|
|
62
|
+
### 基本的な使い方
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
michi jira:sync my-feature
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Story詳細設定
|
|
69
|
+
|
|
70
|
+
```markdown
|
|
71
|
+
### Story 1.1: ユーザー認証
|
|
72
|
+
|
|
73
|
+
**説明**: OAuth2認証の実装
|
|
74
|
+
**優先度**: High
|
|
75
|
+
**見積もり**: 5 SP
|
|
76
|
+
**期限**: 2025-01-15
|
|
77
|
+
|
|
78
|
+
**完了条件**:
|
|
79
|
+
- [ ] OAuth2認証フロー
|
|
80
|
+
- [ ] トークン管理
|
|
81
|
+
|
|
82
|
+
**依存関係**: DB設計完了
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### その他の操作
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
michi jira:transition PROJ-123 "In Progress"
|
|
89
|
+
michi jira:comment PROJ-123 "実装完了"
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## トラブルシューティング
|
|
93
|
+
|
|
94
|
+
### Epic Linkが設定されない
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
export JIRA_EPIC_LINK_FIELD=customfield_10014
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Story Pointsが設定されない
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
export JIRA_STORY_POINTS_FIELD=customfield_10016
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### APIレート制限エラー
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
export ATLASSIAN_REQUEST_DELAY=2000
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## 関連リンク
|
|
113
|
+
|
|
114
|
+
- [設定ガイド](configuration.md)
|
|
115
|
+
- [ワークフローガイド](workflow.md)
|
|
116
|
+
- [Multi-Repoガイド](multi-repo.md)
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# Claude Code セットアップガイド
|
|
2
|
+
|
|
3
|
+
Michiは、Claude Codeを第一級のAI開発ツールとしてサポートしています。このガイドでは、Claude CodeでMichiを使用するためのセットアップと基本的な使い方を説明します。
|
|
4
|
+
|
|
5
|
+
## Claude Codeとは
|
|
6
|
+
|
|
7
|
+
Claude Codeは、Anthropic社が提供する公式CLI(コマンドラインインターフェース)です。プロジェクトのコンテキストを理解し、コード生成、ドキュメント作成、テスト駆動開発をサポートします。
|
|
8
|
+
|
|
9
|
+
**主な特徴**:
|
|
10
|
+
- プロジェクト固有のルール(CLAUDE.md)による動作制御
|
|
11
|
+
- カスタムコマンド、スキル、サブエージェントの拡張機能
|
|
12
|
+
- cc-sdd(Spec-Driven Development Core)との統合
|
|
13
|
+
|
|
14
|
+
## セットアップ手順
|
|
15
|
+
|
|
16
|
+
### 1. cc-sddのインストール
|
|
17
|
+
|
|
18
|
+
Michiは、cc-sddを基盤フレームワークとして使用します。以下のコマンドでcc-sddをインストールしてください。
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx cc-sdd@latest --claude-agent --lang ja
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**生成されるファイル**:
|
|
25
|
+
- `.kiro/settings/` - cc-sdd標準のルール、テンプレート(`.gitignore`対象)
|
|
26
|
+
- `.kiro/steering/` - プロジェクト固有のコンテキスト
|
|
27
|
+
- `.kiro/specs/` - 機能仕様(Git管理)
|
|
28
|
+
|
|
29
|
+
### 2. Michi拡張のインストール
|
|
30
|
+
|
|
31
|
+
cc-sddをインストールした後、Michi固有の拡張機能を追加します。
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
michi setup --claude
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**生成されるファイル**:
|
|
38
|
+
- `.claude/commands/michi/` - Michi固有コマンド
|
|
39
|
+
- `.claude/rules/` - Michi固有ルール
|
|
40
|
+
- `.claude/agents/` - サブエージェント定義
|
|
41
|
+
- `.claude/skills/` - スキル定義
|
|
42
|
+
|
|
43
|
+
### 3. 環境変数の設定(オプション)
|
|
44
|
+
|
|
45
|
+
JIRA/Confluence連携を使用する場合、環境変数を設定してください。
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# .envファイルに以下を追加
|
|
49
|
+
ATLASSIAN_URL=https://your-domain.atlassian.net
|
|
50
|
+
ATLASSIAN_EMAIL=your-email@example.com
|
|
51
|
+
ATLASSIAN_API_TOKEN=your-api-token
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
詳細は [環境変数リファレンス](../reference/environment-variables.md) を参照してください。
|
|
55
|
+
|
|
56
|
+
## Michiとの統合
|
|
57
|
+
|
|
58
|
+
### 利用可能なコマンド
|
|
59
|
+
|
|
60
|
+
Claude Codeでは、以下のコマンドが利用できます。
|
|
61
|
+
|
|
62
|
+
#### cc-sdd標準コマンド
|
|
63
|
+
|
|
64
|
+
| コマンド | 機能説明 |
|
|
65
|
+
|---------|---------|
|
|
66
|
+
| `/kiro:spec-init` | 新規仕様を初期化 |
|
|
67
|
+
| `/kiro:spec-requirements` | 要件定義を作成 |
|
|
68
|
+
| `/kiro:spec-design` | 設計書を作成 |
|
|
69
|
+
| `/kiro:spec-tasks` | タスク分割とJIRA同期 |
|
|
70
|
+
| `/kiro:spec-impl` | TDD実装を実行 |
|
|
71
|
+
|
|
72
|
+
#### Michi拡張コマンド
|
|
73
|
+
|
|
74
|
+
| コマンド | 機能説明 | 備考 |
|
|
75
|
+
|---------|---------|------|
|
|
76
|
+
| `/michi:spec-design` | テスト計画統合設計書を作成 | Phase 0.3-0.4ガイダンス付き |
|
|
77
|
+
| `/michi:test-planning` | テスト計画を実行 | テストタイプ選択+仕様書作成 |
|
|
78
|
+
| `/michi:validate-design` | テスト計画レビュー | テスト計画完了確認付き |
|
|
79
|
+
| `/michi:spec-tasks` | タスク分割+JIRA同期確認 | JIRA連携オプション付き |
|
|
80
|
+
| `/michi:spec-impl` | TDD実装+品質自動化 | ライセンス/バージョン監査+レビュー |
|
|
81
|
+
| `/michi:confluence-sync` | Confluence同期 | 要件定義書/設計書を同期 |
|
|
82
|
+
|
|
83
|
+
### スキルとサブエージェント
|
|
84
|
+
|
|
85
|
+
Michiは、Claude Codeのスキルとサブエージェント機能を拡張します。
|
|
86
|
+
|
|
87
|
+
**利用可能なスキル**:
|
|
88
|
+
- `design-review`: UIデザインレビュー(アクセシビリティ、レスポンシブ、UXパターン、パフォーマンス)
|
|
89
|
+
- `e2e-first-planning`: E2Eテストファースト計画
|
|
90
|
+
- `oss-license`: OSSライセンスチェック
|
|
91
|
+
- `stable-version`: バージョン監査
|
|
92
|
+
|
|
93
|
+
**利用可能なサブエージェント**:
|
|
94
|
+
- `design-reviewer`: 設計レビュー担当
|
|
95
|
+
- `e2e-first-planner`: E2Eテスト計画担当
|
|
96
|
+
- `oss-license-checker`: OSSライセンスチェック担当
|
|
97
|
+
- `stable-version-auditor`: バージョン監査担当
|
|
98
|
+
|
|
99
|
+
## 基本的な使い方
|
|
100
|
+
|
|
101
|
+
### 新機能の開発フロー
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# 1. 仕様の初期化
|
|
105
|
+
/kiro:spec-init "計算機アプリケーション: 四則演算を行う"
|
|
106
|
+
|
|
107
|
+
# 2. 要件定義
|
|
108
|
+
/kiro:spec-requirements calculator-app
|
|
109
|
+
|
|
110
|
+
# 3. 設計(Michi推奨: テスト計画ガイダンス付き)
|
|
111
|
+
/michi:spec-design calculator-app
|
|
112
|
+
|
|
113
|
+
# 4. テスト計画(任意)
|
|
114
|
+
/michi:test-planning calculator-app
|
|
115
|
+
|
|
116
|
+
# 5. タスク分割(Michi推奨: JIRA同期確認付き)
|
|
117
|
+
/michi:spec-tasks calculator-app
|
|
118
|
+
|
|
119
|
+
# 6. TDD実装(Michi推奨: 品質自動化付き)
|
|
120
|
+
/michi:spec-impl calculator-app
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Multi-Repoプロジェクトの場合
|
|
124
|
+
|
|
125
|
+
Multi-Repoプロジェクトでは、以下のコマンドが利用できます。
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
# 1. プロジェクト初期化
|
|
129
|
+
/michi-multi-repo:spec-init
|
|
130
|
+
|
|
131
|
+
# 2. 要件定義
|
|
132
|
+
/michi-multi-repo:spec-requirements my-project
|
|
133
|
+
|
|
134
|
+
# 3. 設計
|
|
135
|
+
/michi-multi-repo:spec-design my-project
|
|
136
|
+
|
|
137
|
+
# 4. クロスリポジトリレビュー
|
|
138
|
+
/michi-multi-repo:spec-review my-project
|
|
139
|
+
|
|
140
|
+
# 5. 各リポジトリへ仕様展開
|
|
141
|
+
/michi-multi-repo:propagate-specs my-project
|
|
142
|
+
|
|
143
|
+
# 6. 全リポジトリで実装実行
|
|
144
|
+
/michi-multi-repo:impl-all my-project
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
詳細は [Multi-Repoガイド](multi-repo.md) を参照してください。
|
|
148
|
+
|
|
149
|
+
## 関連ドキュメント
|
|
150
|
+
|
|
151
|
+
- [AIコマンドリファレンス](../reference/ai-commands.md) - すべてのコマンドの詳細
|
|
152
|
+
- [ワークフローガイド](workflow.md) - 開発ワークフロー全体像
|
|
153
|
+
- [Atlassian連携ガイド](atlassian-integration.md) - JIRA/Confluence連携の詳細
|
|
154
|
+
- [環境変数リファレンス](../reference/environment-variables.md) - 環境変数の詳細設定
|
|
155
|
+
- [トラブルシューティング](../troubleshooting.md) - よくある問題と解決策
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Multi-Repoガイド
|
|
2
|
+
|
|
3
|
+
複数リポジトリにまたがるプロジェクトを一元管理します。
|
|
4
|
+
|
|
5
|
+
## Multi-Repoとは
|
|
6
|
+
|
|
7
|
+
**特徴**:
|
|
8
|
+
- 複数リポジトリの仕様書を一元管理
|
|
9
|
+
- CI/CD結果の集約表示
|
|
10
|
+
- クロスリポジトリのテスト実行
|
|
11
|
+
- Confluenceへの統合同期
|
|
12
|
+
|
|
13
|
+
## プロジェクト管理
|
|
14
|
+
|
|
15
|
+
### 初期化
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
michi multi-repo:init my-project --jira MYPROJ --confluence-space MYPROJ
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### リポジトリ追加
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
michi multi-repo:add-repo my-project \
|
|
25
|
+
--name frontend \
|
|
26
|
+
--url https://github.com/myorg/frontend.git \
|
|
27
|
+
--branch main
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### 一覧表示
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
michi multi-repo:list
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Confluence同期
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
michi multi-repo:sync my-project
|
|
40
|
+
michi multi-repo:confluence-sync my-project --doc-type requirements
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**ドキュメントタイプ**:
|
|
44
|
+
- requirements, architecture, sequence
|
|
45
|
+
- strategy, ci-status, release-notes
|
|
46
|
+
|
|
47
|
+
## CI結果の集約
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
michi multi-repo:ci-status my-project
|
|
51
|
+
michi multi-repo:ci-status my-project --diff
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## テスト実行
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
michi multi-repo:test my-project --type e2e
|
|
58
|
+
michi multi-repo:test my-project --type integration
|
|
59
|
+
michi multi-repo:test my-project --type performance
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## AIコマンド
|
|
63
|
+
|
|
64
|
+
Multi-Repo専用のAIコマンドが利用できます。
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
/michi-multi-repo:spec-init
|
|
68
|
+
/michi-multi-repo:spec-requirements my-project
|
|
69
|
+
/michi-multi-repo:spec-design my-project
|
|
70
|
+
/michi-multi-repo:spec-review my-project
|
|
71
|
+
/michi-multi-repo:propagate-specs my-project
|
|
72
|
+
/michi-multi-repo:impl-all my-project
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
各コマンドの詳細な機能説明とパラメータについては、[AIコマンドリファレンス](../reference/ai-commands.md#multi-repoコマンド) を参照してください。
|
|
76
|
+
|
|
77
|
+
## ベストプラクティス
|
|
78
|
+
|
|
79
|
+
**リポジトリ分割**:
|
|
80
|
+
- マイクロサービス単位で分割
|
|
81
|
+
- 独立デプロイ可能な単位で分割
|
|
82
|
+
- 過度に細かい分割は避ける
|
|
83
|
+
|
|
84
|
+
**CI/CD戦略**:
|
|
85
|
+
- 各リポジトリで独立パイプライン
|
|
86
|
+
- Multi-Repoレベルで統合テスト
|
|
87
|
+
- CI結果を定期的に集約
|
|
88
|
+
|
|
89
|
+
**バージョン管理**:
|
|
90
|
+
- セマンティックバージョニング統一
|
|
91
|
+
- 互換性を明記
|
|
92
|
+
- 依存関係を `multi-repo.md` に記載
|
|
93
|
+
|
|
94
|
+
## トラブルシューティング
|
|
95
|
+
|
|
96
|
+
### リポジトリが追加できない
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
michi multi-repo:list
|
|
100
|
+
cat .michi/config.json
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### CI結果が取得できない
|
|
104
|
+
|
|
105
|
+
- GitHub APIトークンに `repo` 権限が必要
|
|
106
|
+
- リポジトリURLを確認
|
|
107
|
+
|
|
108
|
+
### テスト実行が失敗
|
|
109
|
+
|
|
110
|
+
- `docs/michi/{project}/tests/scripts/` にスクリプト配置
|
|
111
|
+
- 実行権限を付与(`chmod +x`)
|
|
112
|
+
|
|
113
|
+
## 関連リンク
|
|
114
|
+
|
|
115
|
+
- [Atlassian連携ガイド](atlassian-integration.md)
|
|
116
|
+
- [ワークフローガイド](workflow.md)
|
|
117
|
+
- [AIコマンドリファレンス](../reference/ai-commands.md)
|