@sk8metal/michi-cli 0.11.0 → 0.13.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/CHANGELOG.md +10 -0
- package/README.md +3 -10
- package/dist/scripts/constants/environments.d.ts +1 -1
- package/dist/scripts/constants/environments.d.ts.map +1 -1
- package/dist/scripts/constants/environments.js +0 -20
- package/dist/scripts/constants/environments.js.map +1 -1
- package/dist/scripts/jira-sync.d.ts.map +1 -1
- package/dist/scripts/jira-sync.js +32 -2
- package/dist/scripts/jira-sync.js.map +1 -1
- package/dist/scripts/utils/template-finder.d.ts +2 -2
- package/dist/scripts/utils/template-finder.d.ts.map +1 -1
- package/dist/scripts/utils/template-finder.js +3 -8
- package/dist/scripts/utils/template-finder.js.map +1 -1
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +0 -8
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/init.d.ts +0 -4
- package/dist/src/commands/init.d.ts.map +1 -1
- package/dist/src/commands/init.js +6 -30
- package/dist/src/commands/init.js.map +1 -1
- package/dist/src/commands/setup-existing.d.ts +2 -6
- package/dist/src/commands/setup-existing.d.ts.map +1 -1
- package/dist/src/commands/setup-existing.js +8 -142
- package/dist/src/commands/setup-existing.js.map +1 -1
- package/docs/getting-started/configuration.md +0 -29
- package/docs/getting-started/quick-start.md +2 -2
- package/docs/guides/atlassian-integration.md +27 -0
- package/docs/guides/workflow.md +1 -1
- package/docs/reference/cli.md +0 -4
- package/docs/troubleshooting.md +0 -45
- package/package.json +1 -3
- package/scripts/__tests__/create-project.test.ts +12 -12
- package/scripts/__tests__/setup-existing-project.test.ts +22 -22
- package/scripts/constants/__tests__/environments.test.ts +7 -50
- package/scripts/constants/environments.ts +1 -27
- package/scripts/jira-sync.ts +36 -2
- package/scripts/template/__tests__/renderer.test.ts +21 -21
- package/scripts/utils/template-finder.ts +5 -11
- package/docs/guides/ai-tools.md +0 -311
- package/templates/cline/rules/atlassian-integration.md +0 -36
- package/templates/cline/rules/michi-core.md +0 -56
- package/templates/codex/AGENTS.override.md +0 -277
- package/templates/codex/prompts/confluence-sync.md +0 -177
- package/templates/codex/rules/README.md +0 -210
- package/templates/cursor/commands/kiro/kiro-spec-impl.md +0 -244
- package/templates/cursor/commands/kiro/kiro-spec-tasks.md +0 -354
- package/templates/cursor/commands/michi/confluence-sync.md +0 -76
- package/templates/cursor/commands/michi/project-switch.md +0 -69
- package/templates/cursor/commands/michi/spec-tasks.md +0 -117
- package/templates/cursor/rules/atlassian-mcp.mdc +0 -188
- package/templates/cursor/rules/github-ssot.mdc +0 -151
- package/templates/cursor/rules/multi-project.mdc +0 -81
- package/templates/gemini/commands/README.md +0 -41
- package/templates/gemini/rules/GEMINI.md +0 -80
package/docs/guides/ai-tools.md
DELETED
|
@@ -1,311 +0,0 @@
|
|
|
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) - よくある問題と解決策
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# Atlassian Integration Rules
|
|
2
|
-
|
|
3
|
-
## Confluence Integration
|
|
4
|
-
|
|
5
|
-
### Page Creation Format
|
|
6
|
-
- Title: `[{{PROJECT_ID}}] {document_type}`
|
|
7
|
-
- Labels: Use {{KIRO_DIR}}/project.json `confluenceLabels`
|
|
8
|
-
- Space: Reference environment variables (CONFLUENCE_PRD_SPACE, etc.)
|
|
9
|
-
|
|
10
|
-
### Content Sync
|
|
11
|
-
- Source: GitHub {{KIRO_DIR}}/specs/
|
|
12
|
-
- Destination: Confluence pages
|
|
13
|
-
- Sync tool: `npm run confluence:sync`
|
|
14
|
-
|
|
15
|
-
## JIRA Integration
|
|
16
|
-
|
|
17
|
-
### Issue Creation Format
|
|
18
|
-
- Summary: `[{{JIRA_KEY}}] {title}`
|
|
19
|
-
- Project Key: Use {{KIRO_DIR}}/project.json `jiraProjectKey`
|
|
20
|
-
- Labels: Derived from Confluence labels
|
|
21
|
-
|
|
22
|
-
### Workflow
|
|
23
|
-
1. Generate specs in GitHub
|
|
24
|
-
2. Create JIRA epics/stories
|
|
25
|
-
3. Link Confluence pages to JIRA issues
|
|
26
|
-
|
|
27
|
-
## Environment Variables
|
|
28
|
-
|
|
29
|
-
Required variables (from .env):
|
|
30
|
-
- `ATLASSIAN_URL`
|
|
31
|
-
- `ATLASSIAN_EMAIL`
|
|
32
|
-
- `ATLASSIAN_API_TOKEN`
|
|
33
|
-
- `JIRA_PROJECT_KEYS`
|
|
34
|
-
- `CONFLUENCE_PRD_SPACE`
|
|
35
|
-
- `CONFLUENCE_QA_SPACE`
|
|
36
|
-
- `CONFLUENCE_RELEASE_SPACE`
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
# Michi Core Principles
|
|
2
|
-
|
|
3
|
-
## Development Guidelines
|
|
4
|
-
{{DEV_GUIDELINES}}
|
|
5
|
-
|
|
6
|
-
## Language
|
|
7
|
-
All generated documents should be in: **{{LANG_CODE}}**
|
|
8
|
-
|
|
9
|
-
Reference the language field in {{KIRO_DIR}}/project.json.
|
|
10
|
-
|
|
11
|
-
## Single Source of Truth (SSoT)
|
|
12
|
-
|
|
13
|
-
### GitHub as SSoT
|
|
14
|
-
- **All specifications are managed in GitHub** ({{KIRO_DIR}}/specs/)
|
|
15
|
-
- Confluence is **reference and approval only** (editing is GitHub only)
|
|
16
|
-
- Avoid duplicate management
|
|
17
|
-
|
|
18
|
-
### Data Flow
|
|
19
|
-
```
|
|
20
|
-
GitHub ({{KIRO_DIR}}/specs/) ← Source of truth (editable)
|
|
21
|
-
↓ sync
|
|
22
|
-
Confluence ← Display and approval (read-only)
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Multi-Project Management
|
|
26
|
-
|
|
27
|
-
### Project Identification
|
|
28
|
-
- All operations reference {{KIRO_DIR}}/project.json
|
|
29
|
-
- Dynamically use project ID, JIRA key, Confluence labels
|
|
30
|
-
- Project ID: {{PROJECT_ID}}
|
|
31
|
-
|
|
32
|
-
### Naming Conventions
|
|
33
|
-
|
|
34
|
-
#### Confluence Pages
|
|
35
|
-
- Format: `[{projectName}] {document_type}`
|
|
36
|
-
- Example: `[{{PROJECT_ID}}] Requirements`
|
|
37
|
-
|
|
38
|
-
#### JIRA Epic/Story
|
|
39
|
-
- Format: `[{JIRA_KEY}] {title}`
|
|
40
|
-
- Use project metadata from {{KIRO_DIR}}/project.json
|
|
41
|
-
|
|
42
|
-
## Project Structure
|
|
43
|
-
|
|
44
|
-
- Project metadata: {{KIRO_DIR}}/project.json
|
|
45
|
-
- Specifications: {{KIRO_DIR}}/specs/
|
|
46
|
-
- Templates: {{KIRO_DIR}}/settings/templates/
|
|
47
|
-
- Steering: {{KIRO_DIR}}/steering/
|
|
48
|
-
- Rules: {{AGENT_DIR}}/rules/
|
|
49
|
-
|
|
50
|
-
## Best Practices
|
|
51
|
-
|
|
52
|
-
1. **Always reference project.json** for project-specific metadata
|
|
53
|
-
2. **Use SSoT principle** - Edit in GitHub, reference in Confluence
|
|
54
|
-
3. **Follow naming conventions** for consistency
|
|
55
|
-
4. **Generate specs incrementally** - Requirements → Design → Tasks
|
|
56
|
-
5. **Commit frequently** to GitHub
|
|
@@ -1,277 +0,0 @@
|
|
|
1
|
-
# AGENTS.override.md - Michi Project Extensions
|
|
2
|
-
|
|
3
|
-
このファイルはcc-sddのAGENTS.mdを拡張し、Michi固有のワークフローとルールを追加します。
|
|
4
|
-
|
|
5
|
-
## Michi Overview
|
|
6
|
-
|
|
7
|
-
**Michi**は、AI駆動開発を支援するプロジェクト管理・ドキュメント管理フレームワークです。Claude Code、Cursor、Codex CLI、Claude Agent SDKと統合し、効率的な開発フローを実現します。
|
|
8
|
-
|
|
9
|
-
- **Repository**: https://github.com/sk8metalme/michi
|
|
10
|
-
- **Documentation**: `docs/user-guide/`
|
|
11
|
-
- **License**: MIT
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## Michi-Specific Workflows
|
|
16
|
-
|
|
17
|
-
### 1. Confluence Integration
|
|
18
|
-
|
|
19
|
-
#### Confluence同期コマンド
|
|
20
|
-
```bash
|
|
21
|
-
/prompts:confluence-sync FEATURE=<機能名>
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
#### 必要な環境変数
|
|
25
|
-
```bash
|
|
26
|
-
ATLASSIAN_URL=https://your-domain.atlassian.net
|
|
27
|
-
ATLASSIAN_EMAIL=your-email@example.com
|
|
28
|
-
ATLASSIAN_API_TOKEN=your-api-token
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
#### プロジェクト設定
|
|
32
|
-
`.kiro/project.json`に以下を設定:
|
|
33
|
-
```json
|
|
34
|
-
{
|
|
35
|
-
"confluenceSpaceKey": "YOUR_SPACE",
|
|
36
|
-
"confluenceLabels": ["ai-development", "michi"]
|
|
37
|
-
}
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
#### 同期対象
|
|
41
|
-
- 要件定義書(requirements.md)→ Confluenceページ
|
|
42
|
-
- 設計書(design.md)→ Confluenceページ
|
|
43
|
-
- タスク一覧(tasks.md)→ Confluenceページ(オプション)
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
### 2. JIRA Integration
|
|
48
|
-
|
|
49
|
-
#### プロジェクトキー設定
|
|
50
|
-
`.kiro/project.json`の`jiraProjectKey`を使用してJIRAチケットを管理:
|
|
51
|
-
```json
|
|
52
|
-
{
|
|
53
|
-
"jiraProjectKey": "MYPROJ"
|
|
54
|
-
}
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
#### リリース管理
|
|
58
|
-
- JIRAでリリースバージョンを作成
|
|
59
|
-
- Confluenceでリリース手順書を管理
|
|
60
|
-
- GitHub Releasesと連携
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
### 3. Multi-Language Support
|
|
65
|
-
|
|
66
|
-
Michiは以下の言語とビルドツールをサポート:
|
|
67
|
-
|
|
68
|
-
| 言語 | ビルドツール | テストコマンド |
|
|
69
|
-
|------|------------|---------------|
|
|
70
|
-
| Node.js/TypeScript | npm | `npm test` |
|
|
71
|
-
| Java | **Gradle のみ** | `./gradlew test` |
|
|
72
|
-
| PHP | Composer | `composer test` |
|
|
73
|
-
|
|
74
|
-
**重要:** Javaプロジェクトでは**Gradleのみ**を使用してください。Mavenは使用しません。
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
### 4. Test Strategy - Master Test Approach
|
|
79
|
-
|
|
80
|
-
Michiは**マスタテスト方式**を採用しています:
|
|
81
|
-
|
|
82
|
-
#### 基本原則
|
|
83
|
-
- テストは常に最新の仕様を反映(phase-0、phase-1のような履歴管理はしない)
|
|
84
|
-
- 仕様変更時は既存のテストファイルを更新
|
|
85
|
-
- テスト実行時間を一定に保つ
|
|
86
|
-
|
|
87
|
-
#### Phase構成
|
|
88
|
-
- **Phase A**: PR時に自動実行
|
|
89
|
-
- Unit tests
|
|
90
|
-
- Lint
|
|
91
|
-
- Build
|
|
92
|
-
- **Phase B**: リリース前に手動実行
|
|
93
|
-
- Integration tests
|
|
94
|
-
- E2E tests
|
|
95
|
-
- Performance tests
|
|
96
|
-
- Security tests
|
|
97
|
-
|
|
98
|
-
#### テストカバレッジ
|
|
99
|
-
- 目標: **95%以上**
|
|
100
|
-
- テストは仕様として扱う
|
|
101
|
-
- 実装に合わせてテストを変更しない(仕様通りでない場合のみ修正)
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
### 5. CI/CD Integration
|
|
106
|
-
|
|
107
|
-
#### サポート対象
|
|
108
|
-
- **GitHub Actions**
|
|
109
|
-
- **Screwdriver**
|
|
110
|
-
|
|
111
|
-
#### 推奨ワークフロー
|
|
112
|
-
```yaml
|
|
113
|
-
# .github/workflows/ci.yml
|
|
114
|
-
name: CI
|
|
115
|
-
on: [pull_request]
|
|
116
|
-
jobs:
|
|
117
|
-
test:
|
|
118
|
-
runs-on: ubuntu-latest
|
|
119
|
-
steps:
|
|
120
|
-
- uses: actions/checkout@v3
|
|
121
|
-
- name: Run Phase A Tests
|
|
122
|
-
run: |
|
|
123
|
-
npm install
|
|
124
|
-
npm run test:unit
|
|
125
|
-
npm run lint
|
|
126
|
-
npm run build
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
### 6. Release Flow
|
|
132
|
-
|
|
133
|
-
#### セマンティックバージョニング
|
|
134
|
-
```
|
|
135
|
-
v<major>.<minor>.<patch>
|
|
136
|
-
例: v1.2.3
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
#### リリース手順
|
|
140
|
-
1. **Confluenceでリリース手順書作成**
|
|
141
|
-
- テンプレート: `.kiro/templates/release-procedure.md`
|
|
142
|
-
2. **JIRAでリリースチケット起票**
|
|
143
|
-
- チケットタイプ: Release
|
|
144
|
-
- バージョン: 自動生成
|
|
145
|
-
3. **GitHub Releaseの作成**
|
|
146
|
-
- リリースノート自動生成
|
|
147
|
-
- タグ付け
|
|
148
|
-
|
|
149
|
-
---
|
|
150
|
-
|
|
151
|
-
## Coding Standards
|
|
152
|
-
|
|
153
|
-
### TypeScript/Node.js
|
|
154
|
-
- **Style Guide**: Airbnb JavaScript Style Guide準拠
|
|
155
|
-
- **Linter**: ESLint
|
|
156
|
-
- **Formatter**: Prettier
|
|
157
|
-
- **Type Checking**: `tsc --noEmit`
|
|
158
|
-
|
|
159
|
-
### Java (Gradle)
|
|
160
|
-
- **Style Guide**: Google Java Style Guide
|
|
161
|
-
- **Build Tool**: Gradle 8.x
|
|
162
|
-
- **Test Framework**: JUnit 5
|
|
163
|
-
- **Coverage**: JaCoCo
|
|
164
|
-
|
|
165
|
-
### PHP
|
|
166
|
-
- **Style Guide**: PSR-12
|
|
167
|
-
- **Build Tool**: Composer
|
|
168
|
-
- **Test Framework**: PHPUnit
|
|
169
|
-
- **Static Analysis**: PHPStan
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
## File Structure Standards
|
|
174
|
-
|
|
175
|
-
### .kiro/ Directory
|
|
176
|
-
```
|
|
177
|
-
.kiro/
|
|
178
|
-
├── project.json # プロジェクトメタデータ
|
|
179
|
-
├── specs/ # 機能仕様(cc-sdd管理)
|
|
180
|
-
│ └── {feature}/
|
|
181
|
-
│ ├── requirements.md
|
|
182
|
-
│ ├── design.md
|
|
183
|
-
│ ├── tasks.md
|
|
184
|
-
│ └── spec.json
|
|
185
|
-
├── steering/ # AI指導ルール(cc-sdd管理)
|
|
186
|
-
│ ├── structure.md
|
|
187
|
-
│ ├── tech.md
|
|
188
|
-
│ └── product.md
|
|
189
|
-
└── settings/ # 共通ルール(cc-sdd管理)
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
### Michi Extensions
|
|
193
|
-
```
|
|
194
|
-
.kiro/
|
|
195
|
-
├── project.json # ⭐ Michi固有
|
|
196
|
-
└── templates/ # ⭐ Michi固有
|
|
197
|
-
├── confluence-page.md
|
|
198
|
-
├── jira-ticket.md
|
|
199
|
-
└── release-procedure.md
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
---
|
|
203
|
-
|
|
204
|
-
## Security Policy
|
|
205
|
-
|
|
206
|
-
### 環境変数管理
|
|
207
|
-
- **絶対禁止**: APIキー、トークンのハードコード
|
|
208
|
-
- **推奨**: `.env`ファイル + `.gitignore`
|
|
209
|
-
- **CI/CD**: GitHub Secrets / Screwdriver Secrets
|
|
210
|
-
|
|
211
|
-
### 依存関係管理
|
|
212
|
-
- 定期的な脆弱性スキャン(`npm audit`, `snyk`)
|
|
213
|
-
- 依存ライブラリの最小化
|
|
214
|
-
- 信頼できるソースからのみダウンロード
|
|
215
|
-
|
|
216
|
-
---
|
|
217
|
-
|
|
218
|
-
## Workflow Integration
|
|
219
|
-
|
|
220
|
-
### cc-sdd + Michi 連携フロー
|
|
221
|
-
|
|
222
|
-
1. **プロジェクト初期化**
|
|
223
|
-
```bash
|
|
224
|
-
# cc-sddインストール
|
|
225
|
-
npx cc-sdd@latest --codex --lang ja
|
|
226
|
-
|
|
227
|
-
# Michi拡張インストール
|
|
228
|
-
npx michi setup --codex
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
2. **仕様作成(cc-sdd)**
|
|
232
|
-
```bash
|
|
233
|
-
/kiro:spec-init FEATURE=user-auth
|
|
234
|
-
/kiro:spec-requirements FEATURE=user-auth
|
|
235
|
-
/kiro:spec-design FEATURE=user-auth
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
3. **Confluence同期(Michi)**
|
|
239
|
-
```bash
|
|
240
|
-
/prompts:confluence-sync FEATURE=user-auth
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
4. **実装とテスト(cc-sdd + TDD)**
|
|
244
|
-
```bash
|
|
245
|
-
/michi:spec-tasks FEATURE=user-auth
|
|
246
|
-
/kiro:spec-impl FEATURE=user-auth
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
5. **検証(cc-sdd)**
|
|
250
|
-
```bash
|
|
251
|
-
/kiro:validate-impl FEATURE=user-auth
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
---
|
|
255
|
-
|
|
256
|
-
## Communication Guidelines
|
|
257
|
-
|
|
258
|
-
### 日本語優先
|
|
259
|
-
- コミュニケーションは日本語を基本とする
|
|
260
|
-
- 技術用語は適切に英語/日本語を使い分ける
|
|
261
|
-
|
|
262
|
-
### 質問と確認
|
|
263
|
-
- 不明な点は必ず質問し精度を高めることを最優先する
|
|
264
|
-
- AskUserQuestionツールを積極的に活用
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
## Reference Links
|
|
269
|
-
|
|
270
|
-
- [Michi Documentation](https://github.com/sk8metalme/michi/tree/main/docs)
|
|
271
|
-
- [cc-sdd Documentation](https://github.com/gotalab/cc-sdd)
|
|
272
|
-
- [Confluence API](https://developer.atlassian.com/cloud/confluence/rest/v2/)
|
|
273
|
-
- [JIRA API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/)
|
|
274
|
-
|
|
275
|
-
---
|
|
276
|
-
|
|
277
|
-
**Note**: このファイルはCodex CLIの`AGENTS.md`を上書き(override)するものではなく、cc-sddの基本ルールに**追加**される形で適用されます。
|