@sk8metal/michi-cli 0.0.7 → 0.0.9
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 +55 -0
- package/README.md +205 -11
- package/dist/scripts/__tests__/create-project.test.d.ts +2 -0
- package/dist/scripts/__tests__/create-project.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/create-project.test.js +247 -0
- package/dist/scripts/__tests__/create-project.test.js.map +1 -0
- package/dist/scripts/__tests__/multi-project-estimate.test.d.ts +2 -0
- package/dist/scripts/__tests__/multi-project-estimate.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/multi-project-estimate.test.js +119 -0
- package/dist/scripts/__tests__/multi-project-estimate.test.js.map +1 -0
- package/dist/scripts/__tests__/setup-existing-project.test.d.ts +2 -0
- package/dist/scripts/__tests__/setup-existing-project.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/setup-existing-project.test.js +129 -0
- package/dist/scripts/__tests__/setup-existing-project.test.js.map +1 -0
- package/dist/scripts/__tests__/setup-interactive.test.d.ts +2 -0
- package/dist/scripts/__tests__/setup-interactive.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/setup-interactive.test.js +160 -0
- package/dist/scripts/__tests__/setup-interactive.test.js.map +1 -0
- package/dist/scripts/config/default-config.json +57 -0
- package/dist/scripts/confluence-sync.d.ts +4 -0
- package/dist/scripts/confluence-sync.d.ts.map +1 -1
- package/dist/scripts/confluence-sync.js +12 -23
- package/dist/scripts/confluence-sync.js.map +1 -1
- package/dist/scripts/constants/__tests__/environments.test.d.ts +2 -0
- package/dist/scripts/constants/__tests__/environments.test.d.ts.map +1 -0
- package/dist/scripts/constants/__tests__/environments.test.js +91 -0
- package/dist/scripts/constants/__tests__/environments.test.js.map +1 -0
- package/dist/scripts/constants/__tests__/languages.test.d.ts +2 -0
- package/dist/scripts/constants/__tests__/languages.test.d.ts.map +1 -0
- package/dist/scripts/constants/__tests__/languages.test.js +82 -0
- package/dist/scripts/constants/__tests__/languages.test.js.map +1 -0
- package/dist/scripts/constants/environments.d.ts +33 -0
- package/dist/scripts/constants/environments.d.ts.map +1 -0
- package/dist/scripts/constants/environments.js +49 -0
- package/dist/scripts/constants/environments.js.map +1 -0
- package/dist/scripts/constants/languages.d.ts +23 -0
- package/dist/scripts/constants/languages.d.ts.map +1 -0
- package/dist/scripts/constants/languages.js +53 -0
- package/dist/scripts/constants/languages.js.map +1 -0
- package/dist/scripts/create-project.d.ts +4 -0
- package/dist/scripts/create-project.d.ts.map +1 -1
- package/dist/scripts/create-project.js +227 -137
- package/dist/scripts/create-project.js.map +1 -1
- package/dist/scripts/jira-sync.d.ts.map +1 -1
- package/dist/scripts/jira-sync.js +15 -0
- package/dist/scripts/jira-sync.js.map +1 -1
- package/dist/scripts/list-projects.d.ts.map +1 -1
- package/dist/scripts/list-projects.js +42 -15
- package/dist/scripts/list-projects.js.map +1 -1
- package/dist/scripts/multi-project-estimate.d.ts.map +1 -1
- package/dist/scripts/multi-project-estimate.js +56 -21
- package/dist/scripts/multi-project-estimate.js.map +1 -1
- package/dist/scripts/resource-dashboard.d.ts.map +1 -1
- package/dist/scripts/resource-dashboard.js +74 -17
- package/dist/scripts/resource-dashboard.js.map +1 -1
- package/dist/scripts/setup-existing-project.d.ts +3 -1
- package/dist/scripts/setup-existing-project.d.ts.map +1 -1
- package/dist/scripts/setup-existing-project.js +306 -217
- package/dist/scripts/setup-existing-project.js.map +1 -1
- package/dist/scripts/setup-interactive.d.ts +10 -0
- package/dist/scripts/setup-interactive.d.ts.map +1 -0
- package/dist/scripts/setup-interactive.js +413 -0
- package/dist/scripts/setup-interactive.js.map +1 -0
- package/dist/scripts/template/__tests__/renderer.test.d.ts +2 -0
- package/dist/scripts/template/__tests__/renderer.test.d.ts.map +1 -0
- package/dist/scripts/template/__tests__/renderer.test.js +165 -0
- package/dist/scripts/template/__tests__/renderer.test.js.map +1 -0
- package/dist/scripts/template/renderer.d.ts +70 -0
- package/dist/scripts/template/renderer.d.ts.map +1 -0
- package/dist/scripts/template/renderer.js +99 -0
- package/dist/scripts/template/renderer.js.map +1 -0
- package/dist/scripts/utils/__tests__/config-validator.test.js +5 -0
- package/dist/scripts/utils/__tests__/config-validator.test.js.map +1 -1
- package/dist/scripts/utils/__tests__/spec-updater.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/spec-updater.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/spec-updater.test.js +158 -0
- package/dist/scripts/utils/__tests__/spec-updater.test.js.map +1 -0
- package/dist/scripts/utils/confluence-hierarchy.d.ts +2 -1
- package/dist/scripts/utils/confluence-hierarchy.d.ts.map +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js +5 -0
- package/dist/scripts/utils/confluence-hierarchy.js.map +1 -1
- package/dist/scripts/utils/project-finder.d.ts +30 -0
- package/dist/scripts/utils/project-finder.d.ts.map +1 -0
- package/dist/scripts/utils/project-finder.js +147 -0
- package/dist/scripts/utils/project-finder.js.map +1 -0
- package/dist/scripts/utils/spec-updater.d.ts +72 -0
- package/dist/scripts/utils/spec-updater.d.ts.map +1 -0
- package/dist/scripts/utils/spec-updater.js +141 -0
- package/dist/scripts/utils/spec-updater.js.map +1 -0
- package/dist/scripts/utils/template-finder.d.ts +37 -0
- package/dist/scripts/utils/template-finder.d.ts.map +1 -0
- package/dist/scripts/utils/template-finder.js +63 -0
- package/dist/scripts/utils/template-finder.js.map +1 -0
- package/dist/src/__tests__/integration/setup/claude-agent.test.d.ts +5 -0
- package/dist/src/__tests__/integration/setup/claude-agent.test.d.ts.map +1 -0
- package/dist/src/__tests__/integration/setup/claude-agent.test.js +125 -0
- package/dist/src/__tests__/integration/setup/claude-agent.test.js.map +1 -0
- package/dist/src/__tests__/integration/setup/claude.test.d.ts +5 -0
- package/dist/src/__tests__/integration/setup/claude.test.d.ts.map +1 -0
- package/dist/src/__tests__/integration/setup/claude.test.js +111 -0
- package/dist/src/__tests__/integration/setup/claude.test.js.map +1 -0
- package/dist/src/__tests__/integration/setup/cursor.test.d.ts +5 -0
- package/dist/src/__tests__/integration/setup/cursor.test.d.ts.map +1 -0
- package/dist/src/__tests__/integration/setup/cursor.test.js +162 -0
- package/dist/src/__tests__/integration/setup/cursor.test.js.map +1 -0
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.d.ts +32 -0
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.d.ts.map +1 -0
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.js +72 -0
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.js.map +1 -0
- package/dist/src/__tests__/integration/setup/helpers/test-project.d.ts +38 -0
- package/dist/src/__tests__/integration/setup/helpers/test-project.d.ts.map +1 -0
- package/dist/src/__tests__/integration/setup/helpers/test-project.js +83 -0
- package/dist/src/__tests__/integration/setup/helpers/test-project.js.map +1 -0
- package/dist/src/__tests__/integration/setup/validation.test.d.ts +5 -0
- package/dist/src/__tests__/integration/setup/validation.test.d.ts.map +1 -0
- package/dist/src/__tests__/integration/setup/validation.test.js +318 -0
- package/dist/src/__tests__/integration/setup/validation.test.js.map +1 -0
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +20 -0
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/setup-existing.d.ts +22 -0
- package/dist/src/commands/setup-existing.d.ts.map +1 -0
- package/dist/src/commands/setup-existing.js +408 -0
- package/dist/src/commands/setup-existing.js.map +1 -0
- package/dist/vitest.config.d.ts.map +1 -1
- package/dist/vitest.config.js +9 -6
- package/dist/vitest.config.js.map +1 -1
- package/docs/README.md +2 -2
- package/docs/contributing/development.md +37 -0
- package/docs/getting-started/{new-project-setup.md → new-repository-setup.md} +165 -38
- package/docs/getting-started/quick-start.md +57 -6
- package/docs/getting-started/setup.md +551 -180
- package/docs/guides/customization.md +4 -4
- package/docs/guides/multi-project.md +12 -9
- package/docs/reference/quick-reference.md +27 -18
- package/docs/testing/integration-tests.md +297 -0
- package/docs/testing-strategy.md +87 -0
- package/package.json +23 -6
- package/scripts/__tests__/create-project.test.ts +292 -0
- package/scripts/__tests__/multi-project-estimate.test.ts +145 -0
- package/scripts/__tests__/setup-existing-project.test.ts +147 -0
- package/scripts/__tests__/setup-interactive.test.ts +199 -0
- package/scripts/confluence-sync.ts +17 -29
- package/scripts/constants/__tests__/environments.test.ts +110 -0
- package/scripts/constants/__tests__/languages.test.ts +100 -0
- package/scripts/constants/environments.ts +61 -0
- package/scripts/constants/languages.ts +70 -0
- package/scripts/copy-static-assets.js +50 -0
- package/scripts/create-project.ts +251 -158
- package/scripts/jira-sync.ts +16 -1
- package/scripts/list-projects.ts +51 -24
- package/scripts/multi-project-estimate.ts +58 -22
- package/scripts/resource-dashboard.ts +91 -26
- package/scripts/setup-existing-project.ts +350 -230
- package/scripts/setup-existing.sh +159 -25
- package/scripts/setup-interactive.ts +565 -0
- package/scripts/template/__tests__/renderer.test.ts +207 -0
- package/scripts/template/renderer.ts +133 -0
- package/scripts/utils/__tests__/config-validator.test.ts +6 -0
- package/scripts/utils/__tests__/spec-updater.test.ts +220 -0
- package/scripts/utils/confluence-hierarchy.ts +7 -1
- package/scripts/utils/project-finder.ts +184 -0
- package/scripts/utils/spec-updater.ts +212 -0
- package/scripts/utils/template-finder.ts +75 -0
- package/templates/claude/commands/michi/confluence-sync.md +38 -0
- package/templates/claude/commands/michi/project-switch.md +36 -0
- package/templates/claude/rules/atlassian-integration.md +35 -0
- package/templates/claude/rules/michi-core.md +54 -0
- package/templates/claude-agent/README.md +25 -0
- package/templates/cursor/commands/michi/confluence-sync.md +76 -0
- package/templates/cursor/commands/michi/project-switch.md +69 -0
- package/templates/cursor/rules/atlassian-mcp.mdc +188 -0
- package/templates/cursor/rules/github-ssot.mdc +151 -0
- package/templates/cursor/rules/multi-project.mdc +81 -0
- package/scripts/setup-env.sh +0 -52
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 新規リポジトリセットアップガイド
|
|
2
2
|
|
|
3
3
|
> **凡例について**: `<feature>` などの記号の意味は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
新規リポジトリを作成してMichiを使い始める手順です。
|
|
6
6
|
|
|
7
7
|
## クイックスタート
|
|
8
8
|
|
|
@@ -29,32 +29,119 @@ npm run create-project -- \
|
|
|
29
29
|
|
|
30
30
|
スクリプトが自動的に:
|
|
31
31
|
1. GitHub リポジトリ作成
|
|
32
|
-
2.
|
|
33
|
-
3.
|
|
34
|
-
4.
|
|
35
|
-
5.
|
|
36
|
-
6.
|
|
37
|
-
7.
|
|
32
|
+
2. `projects/{project-id}/`ディレクトリ作成
|
|
33
|
+
3. cc-sdd 導入
|
|
34
|
+
4. `projects/{project-id}/.kiro/project.json` 作成
|
|
35
|
+
5. 共通ファイルコピー
|
|
36
|
+
6. `projects/{project-id}/.env` テンプレート作成
|
|
37
|
+
7. npm install(リポジトリルートで実行)
|
|
38
|
+
8. 初期コミット(`main`ブランチ作成)
|
|
38
39
|
|
|
39
|
-
|
|
40
|
+
**注意**: プッシュは手動で実行する必要があります。スクリプト完了後、以下のコマンドを実行してください:
|
|
40
41
|
|
|
41
|
-
|
|
42
|
+
```bash
|
|
43
|
+
# Jujutsu (jj) を使用する場合
|
|
44
|
+
jj git push --bookmark main --allow-new
|
|
45
|
+
|
|
46
|
+
# Git を使用する場合
|
|
47
|
+
git push -u origin main
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**重要**: すべてのプロジェクトは`projects/{project-id}/`配下に配置されます。
|
|
51
|
+
|
|
52
|
+
### 方法2: 既存プロジェクトにMichi共通ルール・コマンドを追加(推奨 - 既存リポジトリ)
|
|
53
|
+
|
|
54
|
+
既存のリポジトリにMichiを導入する推奨ワークフロー:
|
|
55
|
+
|
|
56
|
+
#### cc-sdd準拠の3ステップ
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Step 1: cc-sddで標準ファイル生成
|
|
60
|
+
npx cc-sdd@latest --cursor --lang ja
|
|
61
|
+
|
|
62
|
+
# Step 2: Michi固有ファイルを追加
|
|
63
|
+
npx @sk8metal/michi-cli setup-existing --cursor --lang ja
|
|
64
|
+
# または npm run michi:setup:cursor
|
|
65
|
+
|
|
66
|
+
# Step 3: 環境設定
|
|
67
|
+
npm run setup:interactive
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### IDE別実行例
|
|
71
|
+
|
|
72
|
+
**Cursor IDE(推奨)**:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# 既存プロジェクトのディレクトリに移動
|
|
76
|
+
cd /path/to/existing-repo
|
|
77
|
+
|
|
78
|
+
# Step 1: cc-sdd導入
|
|
79
|
+
npx cc-sdd@latest --cursor --lang ja
|
|
80
|
+
|
|
81
|
+
# Step 2: Michi固有ファイル追加
|
|
82
|
+
npx @sk8metal/michi-cli setup-existing --cursor --lang ja
|
|
83
|
+
# または npm run michi:setup:cursor
|
|
84
|
+
|
|
85
|
+
# Step 3: 環境設定
|
|
86
|
+
npm run setup:interactive
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Claude Code**:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
# 既存プロジェクトのディレクトリに移動
|
|
93
|
+
cd /path/to/existing-repo
|
|
94
|
+
|
|
95
|
+
# Step 1: cc-sdd導入
|
|
96
|
+
npx cc-sdd@latest --claude --lang ja
|
|
97
|
+
|
|
98
|
+
# Step 2: Michi固有ファイル追加
|
|
99
|
+
npx @sk8metal/michi-cli setup-existing --claude --lang ja
|
|
100
|
+
# または npm run michi:setup:claude
|
|
101
|
+
|
|
102
|
+
# Step 3: 環境設定
|
|
103
|
+
npm run setup:interactive
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
**その他のIDE(Gemini, Codex, Windsurf)**:
|
|
42
107
|
|
|
43
108
|
```bash
|
|
44
109
|
# 既存プロジェクトのディレクトリに移動
|
|
45
110
|
cd /path/to/existing-repo
|
|
46
111
|
|
|
47
|
-
#
|
|
48
|
-
|
|
112
|
+
# Step 1: cc-sdd導入(IDE別)
|
|
113
|
+
npx cc-sdd@latest --gemini --lang ja # Gemini CLI
|
|
114
|
+
npx cc-sdd@next --codex --lang ja # Codex CLI
|
|
115
|
+
npx cc-sdd@next --windsurf --lang ja # Windsurf IDE
|
|
116
|
+
|
|
117
|
+
# Step 2: Michi固有ファイル追加(Cursor互換モード)
|
|
118
|
+
npx @sk8metal/michi-cli setup-existing --cursor --lang ja
|
|
119
|
+
|
|
120
|
+
# Step 3: 環境設定
|
|
121
|
+
npm run setup:interactive
|
|
49
122
|
```
|
|
50
123
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
124
|
+
#### 自動的に追加されるもの
|
|
125
|
+
|
|
126
|
+
このワークフローにより以下が自動的に追加されます:
|
|
127
|
+
|
|
128
|
+
1. **cc-sdd導入(Step 1)**:
|
|
129
|
+
- `.kiro/settings/` - テンプレート設定
|
|
130
|
+
- `.cursor/commands/kiro/` または `.claude/commands/kiro/` - 11のスラッシュコマンド
|
|
131
|
+
- `AGENTS.md` または `CLAUDE.md` - プロジェクト設定
|
|
132
|
+
|
|
133
|
+
2. **Michi固有ファイル追加(Step 2)**:
|
|
134
|
+
- 共通ルール(`.cursor/rules/` または `.claude/rules/`)
|
|
135
|
+
- Michi専用コマンド(`.cursor/commands/michi/` または `.claude/commands/michi/`)
|
|
136
|
+
- Steeringテンプレート(`.kiro/steering/`)
|
|
137
|
+
- Specテンプレート(`.kiro/settings/templates/`)
|
|
138
|
+
- プロジェクトメタデータ(`.kiro/project.json`)
|
|
139
|
+
- 環境変数テンプレート(`.env`)
|
|
140
|
+
|
|
141
|
+
3. **環境設定(Step 3)**:
|
|
142
|
+
- 対話的に `project.json` と `.env` を設定
|
|
143
|
+
|
|
144
|
+
**重要**: すべてのプロジェクトは`projects/{project-id}/`配下に配置されます。
|
|
58
145
|
|
|
59
146
|
**完了後**:
|
|
60
147
|
```bash
|
|
@@ -159,7 +246,7 @@ npx cc-sdd@latest --cursor --lang ja --yes
|
|
|
159
246
|
- `projectId: 'michi'` → `['project:michi']`(サービスラベルなし)
|
|
160
247
|
- `projectId: '20240115-payment-api'` → `['project:20240115-payment-api', 'service:payment']`
|
|
161
248
|
- `projectId: 'michi-service'` → `['project:michi-service']`(サービスラベルがプロジェクトラベルと同一のため追加しない)
|
|
162
|
-
### Step
|
|
249
|
+
### Step 5: Michiから共通設定をコピー
|
|
163
250
|
|
|
164
251
|
Michiリポジトリから必要なファイルをコピー:
|
|
165
252
|
|
|
@@ -185,9 +272,40 @@ cp $MICHI_PATH/.kiro/steering/*.md .kiro/steering/
|
|
|
185
272
|
cp $MICHI_PATH/tsconfig.json .
|
|
186
273
|
```
|
|
187
274
|
|
|
188
|
-
### Step
|
|
275
|
+
### Step 6: 環境変数設定
|
|
276
|
+
|
|
277
|
+
**重要**: `.env`ファイルは`projects/{project-id}/`配下に作成します。
|
|
278
|
+
|
|
279
|
+
#### 方法A: 対話的設定ツールを使用(推奨)
|
|
280
|
+
|
|
281
|
+
対話的設定ツールを使用すると、`project.json`と`.env`を一度に設定できます:
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
# リポジトリルートから実行
|
|
285
|
+
cd /path/to/repository
|
|
286
|
+
npm run setup:interactive
|
|
287
|
+
|
|
288
|
+
# または直接実行
|
|
289
|
+
npx tsx /path/to/michi/scripts/setup-interactive.ts
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
**機能**:
|
|
293
|
+
- `project.json`と`.env`を対話的に設定
|
|
294
|
+
- 既存の設定値を読み込んで編集可能
|
|
295
|
+
- 複数プロジェクトが存在する場合、プロジェクトを選択可能
|
|
296
|
+
- 必須項目のバリデーション
|
|
297
|
+
- 新規プロジェクトの場合、`projects/{project-id}/`配下に自動作成
|
|
298
|
+
|
|
299
|
+
詳細は [セットアップガイド](./setup.md#対話的設定ツール) を参照してください。
|
|
300
|
+
|
|
301
|
+
#### 方法B: 手動で.envファイルを作成
|
|
302
|
+
|
|
303
|
+
対話的設定ツールを使用しない場合は、手動で`.env`ファイルを作成します:
|
|
189
304
|
|
|
190
305
|
```bash
|
|
306
|
+
# プロジェクトディレクトリに移動
|
|
307
|
+
cd projects/20240115-payment-api
|
|
308
|
+
|
|
191
309
|
# .env テンプレート作成
|
|
192
310
|
cat > .env << 'EOF'
|
|
193
311
|
# Atlassian設定(MCP + REST API共通)
|
|
@@ -213,17 +331,26 @@ EOF
|
|
|
213
331
|
# .env ファイルを編集してください
|
|
214
332
|
```
|
|
215
333
|
|
|
216
|
-
### Step
|
|
334
|
+
### Step 7: 依存関係インストール
|
|
335
|
+
|
|
336
|
+
**重要**: `package.json`と`tsconfig.json`はリポジトリルートに配置します。`npm install`はリポジトリルートで実行してください。
|
|
217
337
|
|
|
218
338
|
```bash
|
|
339
|
+
# リポジトリルートに移動
|
|
340
|
+
cd /path/to/repository
|
|
341
|
+
|
|
342
|
+
# 依存関係をインストール
|
|
219
343
|
npm install
|
|
220
344
|
```
|
|
221
345
|
|
|
222
|
-
### Step
|
|
346
|
+
### Step 8: 動作確認
|
|
223
347
|
|
|
224
348
|
#### Jujutsu (jj) を使用する場合
|
|
225
349
|
|
|
226
350
|
```bash
|
|
351
|
+
# プロジェクトディレクトリに移動
|
|
352
|
+
cd projects/20240115-payment-api
|
|
353
|
+
|
|
227
354
|
# プロジェクト情報を表示
|
|
228
355
|
cat .kiro/project.json
|
|
229
356
|
|
|
@@ -251,7 +378,7 @@ git branch -M main
|
|
|
251
378
|
git remote add origin https://github.com/your-org/20240115-payment-api.git
|
|
252
379
|
```
|
|
253
380
|
|
|
254
|
-
### Step
|
|
381
|
+
### Step 9: 初期コミット
|
|
255
382
|
|
|
256
383
|
#### Jujutsu (jj) を使用する場合
|
|
257
384
|
|
|
@@ -298,40 +425,40 @@ git push -u origin main
|
|
|
298
425
|
/kiro:spec-requirements <feature>
|
|
299
426
|
jj commit -m "docs: 要件定義追加"
|
|
300
427
|
jj git push
|
|
301
|
-
npx @michi
|
|
428
|
+
npx @sk8metal/michi-cli phase:run <feature> requirements
|
|
302
429
|
|
|
303
430
|
# 具体例
|
|
304
431
|
/kiro:spec-init ユーザー認証機能
|
|
305
432
|
/kiro:spec-requirements user-auth
|
|
306
433
|
jj commit -m "docs: 要件定義追加"
|
|
307
434
|
jj git push
|
|
308
|
-
npx @michi
|
|
435
|
+
npx @sk8metal/michi-cli phase:run user-auth requirements
|
|
309
436
|
|
|
310
437
|
# 2. 設計
|
|
311
438
|
# 凡例
|
|
312
439
|
/kiro:spec-design <feature>
|
|
313
440
|
jj commit -m "docs: 設計追加"
|
|
314
441
|
jj git push
|
|
315
|
-
npx @michi
|
|
442
|
+
npx @sk8metal/michi-cli phase:run <feature> design
|
|
316
443
|
|
|
317
444
|
# 具体例
|
|
318
445
|
/kiro:spec-design user-auth
|
|
319
446
|
jj commit -m "docs: 設計追加"
|
|
320
447
|
jj git push
|
|
321
|
-
npx @michi
|
|
448
|
+
npx @sk8metal/michi-cli phase:run user-auth design
|
|
322
449
|
|
|
323
450
|
# 3. タスク分割
|
|
324
451
|
# 凡例
|
|
325
452
|
/kiro:spec-tasks <feature>
|
|
326
453
|
jj commit -m "docs: タスク分割追加"
|
|
327
454
|
jj git push
|
|
328
|
-
npx @michi
|
|
455
|
+
npx @sk8metal/michi-cli phase:run <feature> tasks
|
|
329
456
|
|
|
330
457
|
# 具体例
|
|
331
458
|
/kiro:spec-tasks user-auth
|
|
332
459
|
jj commit -m "docs: タスク分割追加"
|
|
333
460
|
jj git push
|
|
334
|
-
npx @michi
|
|
461
|
+
npx @sk8metal/michi-cli phase:run user-auth tasks
|
|
335
462
|
|
|
336
463
|
# 4. 実装
|
|
337
464
|
# 凡例
|
|
@@ -359,7 +486,7 @@ gh pr create --head 20240115-payment-api/feature/user-auth --base main
|
|
|
359
486
|
git add .
|
|
360
487
|
git commit -m "docs: 要件定義追加"
|
|
361
488
|
git push
|
|
362
|
-
npx @michi
|
|
489
|
+
npx @sk8metal/michi-cli phase:run <feature> requirements
|
|
363
490
|
|
|
364
491
|
# 具体例
|
|
365
492
|
/kiro:spec-init ユーザー認証機能
|
|
@@ -367,7 +494,7 @@ npx @michi/cli phase:run <feature> requirements
|
|
|
367
494
|
git add .
|
|
368
495
|
git commit -m "docs: 要件定義追加"
|
|
369
496
|
git push
|
|
370
|
-
npx @michi
|
|
497
|
+
npx @sk8metal/michi-cli phase:run user-auth requirements
|
|
371
498
|
|
|
372
499
|
# 2. 設計
|
|
373
500
|
# 凡例
|
|
@@ -375,14 +502,14 @@ npx @michi/cli phase:run user-auth requirements
|
|
|
375
502
|
git add .
|
|
376
503
|
git commit -m "docs: 設計追加"
|
|
377
504
|
git push
|
|
378
|
-
npx @michi
|
|
505
|
+
npx @sk8metal/michi-cli phase:run <feature> design
|
|
379
506
|
|
|
380
507
|
# 具体例
|
|
381
508
|
/kiro:spec-design user-auth
|
|
382
509
|
git add .
|
|
383
510
|
git commit -m "docs: 設計追加"
|
|
384
511
|
git push
|
|
385
|
-
npx @michi
|
|
512
|
+
npx @sk8metal/michi-cli phase:run user-auth design
|
|
386
513
|
|
|
387
514
|
# 3. タスク分割
|
|
388
515
|
# 凡例
|
|
@@ -390,14 +517,14 @@ npx @michi/cli phase:run user-auth design
|
|
|
390
517
|
git add .
|
|
391
518
|
git commit -m "docs: タスク分割追加"
|
|
392
519
|
git push
|
|
393
|
-
npx @michi
|
|
520
|
+
npx @sk8metal/michi-cli phase:run <feature> tasks
|
|
394
521
|
|
|
395
522
|
# 具体例
|
|
396
523
|
/kiro:spec-tasks user-auth
|
|
397
524
|
git add .
|
|
398
525
|
git commit -m "docs: タスク分割追加"
|
|
399
526
|
git push
|
|
400
|
-
npx @michi
|
|
527
|
+
npx @sk8metal/michi-cli phase:run user-auth tasks
|
|
401
528
|
|
|
402
529
|
# 4. 実装
|
|
403
530
|
# 凡例
|
|
@@ -555,8 +682,8 @@ cd ~/work/projects/michi
|
|
|
555
682
|
```bash
|
|
556
683
|
# Michiから全プロジェクトの状況を確認
|
|
557
684
|
cd /path/to/michi
|
|
558
|
-
npx @michi
|
|
559
|
-
npx @michi
|
|
685
|
+
npx @sk8metal/michi-cli project:list
|
|
686
|
+
npx @sk8metal/michi-cli project:dashboard
|
|
560
687
|
npm run multi-estimate
|
|
561
688
|
```
|
|
562
689
|
|
|
@@ -22,15 +22,46 @@ michi --help
|
|
|
22
22
|
|
|
23
23
|
## 2. cc-sddをインストール
|
|
24
24
|
|
|
25
|
+
cc-sddは、Michiの仕様駆動開発ワークフローのコアフレームワークです。
|
|
26
|
+
|
|
27
|
+
### 推奨ワークフロー(cc-sdd準拠)
|
|
28
|
+
|
|
29
|
+
既存リポジトリにMichiを導入する標準的な3ステップ:
|
|
30
|
+
|
|
25
31
|
```bash
|
|
26
|
-
#
|
|
32
|
+
# Step 1: cc-sddで標準ファイル生成
|
|
33
|
+
npx cc-sdd@latest --cursor --lang ja
|
|
34
|
+
|
|
35
|
+
# Step 2: Michi固有ファイルを追加
|
|
36
|
+
npx @sk8metal/michi-cli setup-existing --cursor --lang ja
|
|
37
|
+
# または npm run michi:setup:cursor
|
|
38
|
+
|
|
39
|
+
# Step 3: 環境設定(後述)
|
|
40
|
+
npm run setup:interactive
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### IDE別インストール例
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Cursor IDE(推奨)
|
|
27
47
|
npx cc-sdd@latest --lang ja --cursor
|
|
28
48
|
|
|
29
|
-
# Claude Code
|
|
49
|
+
# Claude Code
|
|
30
50
|
npx cc-sdd@latest --lang ja --claude
|
|
51
|
+
|
|
52
|
+
# Gemini CLI
|
|
53
|
+
npx cc-sdd@latest --lang ja --gemini
|
|
54
|
+
|
|
55
|
+
# Codex CLI
|
|
56
|
+
npx cc-sdd@next --lang ja --codex
|
|
57
|
+
|
|
58
|
+
# Windsurf IDE
|
|
59
|
+
npx cc-sdd@next --lang ja --windsurf
|
|
31
60
|
```
|
|
32
61
|
|
|
33
|
-
|
|
62
|
+
**重要**: Step 2で `npx @sk8metal/michi-cli setup-existing` を実行すると、テンプレートがNPMパッケージから自動的にコピーされます。git clone不要です。
|
|
63
|
+
|
|
64
|
+
詳細な手順は [セットアップガイド](./setup.md#step-25-推奨ワークフローcc-sdd--michi) を参照してください。
|
|
34
65
|
|
|
35
66
|
## 3. 環境変数を設定
|
|
36
67
|
|
|
@@ -88,11 +119,31 @@ Cursor/VS CodeでAIコマンドを実行:
|
|
|
88
119
|
/kiro:spec-tasks user-authentication
|
|
89
120
|
```
|
|
90
121
|
|
|
91
|
-
|
|
122
|
+
これにより、`tasks.md`が生成されます。
|
|
123
|
+
|
|
124
|
+
**重要**: `/kiro:spec-tasks` はローカルで `tasks.md` を生成するだけです。Confluence/JIRAに同期するには、以下のCLIコマンドを実行する必要があります:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
npx @sk8metal/michi-cli phase:run user-authentication tasks
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
このコマンドにより、以下が自動実行されます:
|
|
92
131
|
|
|
93
|
-
- `tasks.md`の生成
|
|
94
132
|
- Confluenceページの自動作成(要件・設計)
|
|
95
|
-
- JIRA Epic
|
|
133
|
+
- JIRA Epicとストーリーの自動作成(全6フェーズ)
|
|
134
|
+
- バリデーション実行
|
|
135
|
+
|
|
136
|
+
**注意**: 要件定義・設計フェーズでも同様に、`/kiro:spec-requirements` や `/kiro:spec-design` の後に `phase:run` を実行する必要があります:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
# 要件定義フェーズ
|
|
140
|
+
/kiro:spec-requirements user-authentication
|
|
141
|
+
npx @sk8metal/michi-cli phase:run user-authentication requirements
|
|
142
|
+
|
|
143
|
+
# 設計フェーズ
|
|
144
|
+
/kiro:spec-design user-authentication
|
|
145
|
+
npx @sk8metal/michi-cli phase:run user-authentication design
|
|
146
|
+
```
|
|
96
147
|
|
|
97
148
|
## 7. 実装を開始
|
|
98
149
|
|