@sk8metal/michi-cli 0.0.4 → 0.0.6

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 (53) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/README.md +66 -55
  3. package/dist/scripts/config-interactive.d.ts +1 -1
  4. package/dist/scripts/config-interactive.d.ts.map +1 -1
  5. package/dist/scripts/config-interactive.js +4 -4
  6. package/dist/scripts/config-interactive.js.map +1 -1
  7. package/dist/scripts/confluence-sync.js +2 -2
  8. package/dist/scripts/confluence-sync.js.map +1 -1
  9. package/dist/scripts/create-project.d.ts +2 -2
  10. package/dist/scripts/create-project.js +2 -2
  11. package/dist/scripts/jira-sync.js +3 -3
  12. package/dist/scripts/jira-sync.js.map +1 -1
  13. package/dist/scripts/utils/__tests__/config-loader.test.d.ts +5 -0
  14. package/dist/scripts/utils/__tests__/config-loader.test.d.ts.map +1 -0
  15. package/dist/scripts/utils/__tests__/config-loader.test.js +201 -0
  16. package/dist/scripts/utils/__tests__/config-loader.test.js.map +1 -0
  17. package/dist/scripts/utils/__tests__/config-validator.test.js +29 -16
  18. package/dist/scripts/utils/__tests__/config-validator.test.js.map +1 -1
  19. package/dist/scripts/utils/config-loader.d.ts +4 -0
  20. package/dist/scripts/utils/config-loader.d.ts.map +1 -1
  21. package/dist/scripts/utils/config-loader.js +24 -2
  22. package/dist/scripts/utils/config-loader.js.map +1 -1
  23. package/dist/scripts/utils/config-validator.js +8 -9
  24. package/dist/scripts/utils/config-validator.js.map +1 -1
  25. package/dist/src/cli.js +2 -2
  26. package/dist/src/cli.js.map +1 -1
  27. package/docs/README.md +93 -0
  28. package/docs/contributing/development.md +304 -0
  29. package/docs/{new-project-setup.md → getting-started/new-project-setup.md} +38 -38
  30. package/docs/getting-started/quick-start.md +145 -0
  31. package/docs/{setup.md → getting-started/setup.md} +63 -49
  32. package/docs/{customization-guide.md → guides/customization.md} +64 -12
  33. package/docs/guides/multi-project.md +365 -0
  34. package/docs/{config-reference.md → reference/config.md} +76 -197
  35. package/docs/{quick-reference.md → reference/quick-reference.md} +23 -20
  36. package/env.example +3 -1
  37. package/package.json +3 -1
  38. package/scripts/config-interactive.ts +4 -3
  39. package/scripts/confluence-sync.ts +2 -2
  40. package/scripts/create-project.ts +4 -4
  41. package/scripts/jira-sync.ts +3 -3
  42. package/scripts/set-permissions.js +29 -0
  43. package/scripts/setup-existing.sh +1 -1
  44. package/scripts/utils/__tests__/config-loader.test.ts +254 -0
  45. package/scripts/utils/__tests__/config-validator.test.ts +32 -16
  46. package/scripts/utils/config-loader.ts +30 -2
  47. package/scripts/utils/config-validator.ts +8 -8
  48. package/docs/multi-project.md +0 -233
  49. package/docs/testing.md +0 -202
  50. /package/docs/{release.md → contributing/release.md} +0 -0
  51. /package/docs/{phase-automation.md → guides/phase-automation.md} +0 -0
  52. /package/docs/{workflow.md → guides/workflow.md} +0 -0
  53. /package/docs/{tasks-template.md → reference/tasks-template.md} +0 -0
@@ -22,8 +22,8 @@ npm run create-project -- \
22
22
 
23
23
  # 具体例
24
24
  npm run create-project -- \
25
- --name "customer-a-service-1" \
26
- --project-name "A社 サービス1" \
25
+ --name "20240115-payment-api" \
26
+ --project-name "プロジェクトA" \
27
27
  --jira-key "PRJA"
28
28
  ```
29
29
 
@@ -91,24 +91,24 @@ cursor .
91
91
 
92
92
  ```bash
93
93
  # GitHub CLI で新規リポジトリ作成
94
- gh repo create your-org/customer-a-service-1 --private --description "A社 サービス1"
94
+ gh repo create your-org/20240115-payment-api --private --description "プロジェクトA"
95
95
 
96
96
  # ローカルにクローン
97
97
  cd ~/work/projects
98
- jj git clone https://github.com/your-org/customer-a-service-1
99
- cd customer-a-service-1
98
+ jj git clone https://github.com/your-org/20240115-payment-api
99
+ cd 20240115-payment-api
100
100
  ```
101
101
 
102
102
  #### Git を使用する場合
103
103
 
104
104
  ```bash
105
105
  # GitHub CLI で新規リポジトリ作成
106
- gh repo create your-org/customer-a-service-1 --private --description "A社 サービス1"
106
+ gh repo create your-org/20240115-payment-api --private --description "プロジェクトA"
107
107
 
108
108
  # ローカルにクローン
109
109
  cd ~/work/projects
110
- git clone https://github.com/your-org/customer-a-service-1
111
- cd customer-a-service-1
110
+ git clone https://github.com/your-org/20240115-payment-api
111
+ cd 20240115-payment-api
112
112
  ```
113
113
 
114
114
  ### Step 2: cc-sdd 導入
@@ -128,15 +128,15 @@ npx cc-sdd@latest --cursor --lang ja --yes
128
128
 
129
129
  ```json
130
130
  {
131
- "projectId": "customer-a-service-1",
132
- "projectName": "A社 サービス1",
131
+ "projectId": "20240115-payment-api",
132
+ "projectName": "プロジェクトA",
133
133
  "jiraProjectKey": "PRJA",
134
- "confluenceLabels": ["project:customer-a-service-1", "service:s1"],
134
+ "confluenceLabels": ["project:20240115-payment-api", "service:payment"],
135
135
  "status": "active",
136
136
  "team": ["@dev1", "@dev2"],
137
137
  "stakeholders": ["@企画", "@部長"],
138
- "repository": "https://github.com/your-org/customer-a-service-1",
139
- "description": "A社向けサービス1の開発"
138
+ "repository": "https://github.com/your-org/20240115-payment-api",
139
+ "description": "プロジェクトA向け決済APIの開発"
140
140
  }
141
141
  ```
142
142
 
@@ -152,12 +152,12 @@ npx cc-sdd@latest --cursor --lang ja --yes
152
152
  - **プロジェクトラベル**: `project:{projectId}` を常に生成
153
153
  - **サービスラベル**: ハイフン(`-`)が含まれる場合のみ生成
154
154
  - ハイフンがない場合: `project:michi` のみ(サービスラベルなし)
155
- - ハイフンがある場合: `project:customer-a-service-1, service:s1`
155
+ - ハイフンがある場合: `project:20240115-payment-api, service:payment`
156
156
  - 重複防止: サービスラベルがプロジェクトラベルと同一の場合は追加しない
157
157
 
158
158
  **動作例**:
159
159
  - `projectId: 'michi'` → `['project:michi']`(サービスラベルなし)
160
- - `projectId: 'customer-a-service-1'` → `['project:customer-a-service-1', 'service:s1']`
160
+ - `projectId: '20240115-payment-api'` → `['project:20240115-payment-api', 'service:payment']`
161
161
  - `projectId: 'michi-service'` → `['project:michi-service']`(サービスラベルがプロジェクトラベルと同一のため追加しない)
162
162
  ### Step 4: Michiから共通設定をコピー
163
163
 
@@ -198,7 +198,7 @@ ATLASSIAN_API_TOKEN=your-token-here
198
198
  # GitHub設定
199
199
  GITHUB_ORG=your-org
200
200
  GITHUB_TOKEN=ghp_xxx
201
- GITHUB_REPO=your-org/customer-a-service-1
201
+ GITHUB_REPO=your-org/20240115-payment-api
202
202
 
203
203
  # Confluence共有スペース
204
204
  CONFLUENCE_PRD_SPACE=PRD
@@ -248,7 +248,7 @@ npm run type-check
248
248
  # Git初期化(まだの場合)
249
249
  git init
250
250
  git branch -M main
251
- git remote add origin https://github.com/your-org/customer-a-service-1.git
251
+ git remote add origin https://github.com/your-org/20240115-payment-api.git
252
252
  ```
253
253
 
254
254
  ### Step 8: 初期コミット
@@ -344,9 +344,9 @@ gh pr create --head <project-id>/feature/<feature> --base main
344
344
  # 具体例
345
345
  /kiro:spec-impl user-auth FE-1,BE-1
346
346
  jj commit -m "feat: 実装 [PRJA-123]"
347
- jj bookmark create customer-a-service-1/feature/user-auth -r '@-'
348
- jj git push --bookmark customer-a-service-1/feature/user-auth --allow-new
349
- gh pr create --head customer-a-service-1/feature/user-auth --base main
347
+ jj bookmark create 20240115-payment-api/feature/user-auth -r '@-'
348
+ jj git push --bookmark 20240115-payment-api/feature/user-auth --allow-new
349
+ gh pr create --head 20240115-payment-api/feature/user-auth --base main
350
350
  ```
351
351
 
352
352
  #### Git を使用する場合
@@ -410,11 +410,11 @@ gh pr create --head <project-id>/feature/<feature> --base main
410
410
 
411
411
  # 具体例
412
412
  /kiro:spec-impl user-auth FE-1,BE-1
413
- git checkout -b customer-a-service-1/feature/user-auth
413
+ git checkout -b 20240115-payment-api/feature/user-auth
414
414
  git add .
415
415
  git commit -m "feat: 実装 [PRJA-123]"
416
- git push -u origin customer-a-service-1/feature/user-auth
417
- gh pr create --head customer-a-service-1/feature/user-auth --base main
416
+ git push -u origin 20240115-payment-api/feature/user-auth
417
+ gh pr create --head 20240115-payment-api/feature/user-auth --base main
418
418
  ```
419
419
 
420
420
  ## プロジェクト間の切り替え
@@ -422,17 +422,17 @@ gh pr create --head customer-a-service-1/feature/user-auth --base main
422
422
  ### Cursor で切り替え
423
423
 
424
424
  ```text
425
- /kiro:project-switch customer-a-service-1
425
+ /kiro:project-switch 20240115-payment-api
426
426
  ```
427
427
 
428
428
  ### ターミナルで切り替え
429
429
 
430
430
  ```bash
431
431
  # プロジェクトAに切り替え
432
- cd ~/work/projects/customer-a-service-1
432
+ cd ~/work/projects/20240115-payment-api
433
433
 
434
434
  # プロジェクトBに切り替え
435
- cd ~/work/projects/customer-b-api
435
+ cd ~/work/projects/20240201-user-management
436
436
 
437
437
  # Michiハブに戻る
438
438
  cd ~/work/projects/michi
@@ -455,8 +455,8 @@ npm run project:list
455
455
  | プロジェクト | ID | ステータス | JIRA | チーム |
456
456
  |------------|-------|----------|------|--------|
457
457
  | Michi | michi | active | MICHI | @developer1 |
458
- | A サービス1 | customer-a-service-1 | active | PRJA | @dev1, @dev2 |
459
- | B社 API | customer-b-api | active | PRJB | @dev3 |
458
+ | プロジェクトA | 20240115-payment-api | active | PRJA | @dev1, @dev2 |
459
+ | プロジェクトC | 20240310-analytics-api | active | PRJB | @dev3 |
460
460
  ```
461
461
 
462
462
  ## トラブルシューティング
@@ -483,17 +483,17 @@ npx cc-sdd@latest --cursor --lang ja --yes
483
483
 
484
484
  ### プロジェクト命名規則
485
485
 
486
- **リポジトリ名**: `customer-{id}-{service}`
487
- - 例: `customer-a-service-1`, `customer-b-api`, `customer-c-poc`
486
+ **リポジトリ名**: `{YYYYMMDD}-{PJ名}`
487
+ - 例: `20240115-payment-api`, `20240201-user-management`, `20240310-analytics-api`
488
488
 
489
489
  **プロジェクトID**: リポジトリ名と同じ
490
- - 例: `customer-a-service-1`
490
+ - 例: `20240115-payment-api`
491
491
 
492
492
  **JIRA プロジェクトキー**: 3-4文字、一意
493
493
  - 例: `PRJA`, `PRJB`, `PRJC`
494
494
 
495
495
  **Confluenceラベル**: `project:{projectId}, service:{service}`
496
- - 例: `["project:customer-a-service-1", "service:s1"]`
496
+ - 例: `["project:20240115-payment-api", "service:payment"]`
497
497
 
498
498
  ### チーム構成
499
499
 
@@ -522,10 +522,10 @@ npx cc-sdd@latest --cursor --lang ja --yes
522
522
 
523
523
  ```bash
524
524
  # ターミナル1: プロジェクトA
525
- cd ~/work/projects/customer-a-service-1
525
+ cd ~/work/projects/20240115-payment-api
526
526
 
527
527
  # ターミナル2: プロジェクトB
528
- cd ~/work/projects/customer-b-api
528
+ cd ~/work/projects/20240201-user-management
529
529
 
530
530
  # ターミナル3: Michiハブ(横断操作用)
531
531
  cd ~/work/projects/michi
@@ -539,8 +539,8 @@ cd ~/work/projects/michi
539
539
  {
540
540
  "folders": [
541
541
  { "path": "../michi" },
542
- { "path": "../customer-a-service-1" },
543
- { "path": "../customer-b-api" }
542
+ { "path": "../20240115-payment-api" },
543
+ { "path": "../20240201-user-management" }
544
544
  ],
545
545
  "settings": {
546
546
  "files.associations": {
@@ -571,6 +571,6 @@ npm run multi-estimate
571
571
  ## 参考ドキュメント
572
572
 
573
573
  - [セットアップガイド](./setup.md)
574
- - [ワークフローガイド](./workflow.md)
575
- - [マルチプロジェクト管理](./multi-project.md)
574
+ - [ワークフローガイド](../guides/workflow.md)
575
+ - [マルチプロジェクト管理](../guides/multi-project.md)
576
576
 
@@ -0,0 +1,145 @@
1
+ # Michi クイックスタート
2
+
3
+ このガイドでは、Michiを5分で始める方法を説明します。
4
+
5
+ ## 前提条件
6
+
7
+ - Node.js 20.x以上
8
+ - Cursor IDE または VS Code
9
+
10
+ ## 1. Michiをインストール
11
+
12
+ ```bash
13
+ # NPMパッケージからインストール(推奨)
14
+ npm install -g @sk8metal/michi-cli
15
+
16
+ # インストール確認
17
+ michi --version
18
+ michi --help
19
+ ```
20
+
21
+ **注意**: 初回実行時は依存関係のダウンロードに時間がかかる場合があります。
22
+
23
+ ## 2. cc-sddをインストール
24
+
25
+ ```bash
26
+ # Cursor IDE を使用する場合
27
+ npx cc-sdd@latest --lang ja --cursor
28
+
29
+ # Claude Code を使用する場合
30
+ npx cc-sdd@latest --lang ja --claude
31
+ ```
32
+
33
+ cc-sddは、Michiの仕様駆動開発ワークフローのコアフレームワークです。
34
+
35
+ ## 3. 環境変数を設定
36
+
37
+ 最小限の設定で始める場合:
38
+
39
+ ```bash
40
+ # プロジェクトディレクトリに移動
41
+ cd your-project
42
+
43
+ # .envファイルを作成
44
+ cat > .env <<EOF
45
+ # GitHub設定(必須)
46
+ GITHUB_TOKEN=your-github-token
47
+ GITHUB_ORG=your-org
48
+ GITHUB_REPO=your-org/your-repo
49
+
50
+ # JIRA設定(オプション)
51
+ ATLASSIAN_URL=https://your-domain.atlassian.net
52
+ ATLASSIAN_EMAIL=your-email@company.com
53
+ ATLASSIAN_API_TOKEN=your-token
54
+ JIRA_PROJECT_KEYS=YOUR_PROJECT
55
+
56
+ # JIRA Issue Type IDs(JIRAインスタンス固有 - 必須)
57
+ JIRA_ISSUE_TYPE_STORY=10036
58
+ JIRA_ISSUE_TYPE_SUBTASK=10037
59
+ EOF
60
+ ```
61
+
62
+ 詳細な設定方法は、[セットアップガイド](./setup.md#3-環境変数の設定)を参照してください。
63
+
64
+ ## 4. 最初の機能を作成
65
+
66
+ Cursor/VS CodeでAIコマンドを実行:
67
+
68
+ ```
69
+ /kiro:spec-init ユーザー認証機能
70
+ ```
71
+
72
+ これにより、`.kiro/specs/user-authentication/`ディレクトリが作成され、以下が自動生成されます:
73
+
74
+ - `requirements.md`: 要件定義
75
+ - `spec.json`: 機能メタデータ
76
+
77
+ ## 5. 設計を作成
78
+
79
+ ```
80
+ /kiro:spec-design user-authentication
81
+ ```
82
+
83
+ これにより、`design.md`が生成されます。
84
+
85
+ ## 6. タスクを作成
86
+
87
+ ```
88
+ /kiro:spec-tasks user-authentication
89
+ ```
90
+
91
+ これにより、以下が自動実行されます:
92
+
93
+ - `tasks.md`の生成
94
+ - Confluenceページの自動作成(要件・設計)
95
+ - JIRA Epicとストーリーの自動作成
96
+
97
+ ## 7. 実装を開始
98
+
99
+ ```
100
+ /kiro:spec-impl user-authentication task-1
101
+ ```
102
+
103
+ TDD(テスト駆動開発)で実装が進められます。
104
+
105
+ ## 次のステップ
106
+
107
+ ### より詳しく学ぶ
108
+
109
+ - [ワークフローガイド](../guides/workflow.md) - AI開発フローの詳細
110
+ - [フェーズ自動化ガイド](../guides/phase-automation.md) - Confluence/JIRA自動化
111
+ - [クイックリファレンス](../reference/quick-reference.md) - コマンド一覧
112
+
113
+ ### 高度な設定
114
+
115
+ - [カスタマイズガイド](../guides/customization.md) - Confluence/JIRA階層のカスタマイズ
116
+ - [設定値リファレンス](../reference/config.md) - `.michi/config.json`の全設定値
117
+
118
+ ### 複数プロジェクトの管理
119
+
120
+ - [マルチプロジェクト管理](../guides/multi-project.md) - 3-5プロジェクトの同時管理
121
+
122
+ ## トラブルシューティング
123
+
124
+ ### GitHub Tokenが無効
125
+
126
+ ```bash
127
+ gh auth login
128
+ gh auth token
129
+ ```
130
+
131
+ ### JIRA Issue Type IDが不明
132
+
133
+ ```bash
134
+ # REST APIで確認
135
+ curl -u your-email@company.com:your-token \
136
+ https://your-domain.atlassian.net/rest/api/3/issuetype
137
+ ```
138
+
139
+ ### コマンドが見つからない
140
+
141
+ Cursor/VS Codeを再起動してください。
142
+
143
+ ## ヘルプ
144
+
145
+ 質問がある場合は、[issue](https://github.com/sk8metalme/michi/issues)を作成してください。
@@ -9,18 +9,45 @@
9
9
  - GitHub CLI (gh) - PR作成時に使用
10
10
  - **cc-sdd**: AI駆動開発ワークフローのコアフレームワーク
11
11
 
12
- ## 1. リポジトリのクローン
12
+ ## 1. Michiのインストール
13
+
14
+ ### 方法1: NPMパッケージとしてインストール(推奨)
13
15
 
14
16
  ```bash
15
- # Gitを使う場合(一般的)
17
+ # グローバルインストール
18
+ npm install -g @sk8metal/michi-cli
19
+
20
+ # インストール確認
21
+ michi --version
22
+ michi --help
23
+ ```
24
+
25
+ **注意**: 初回実行時は依存関係のダウンロードに時間がかかる場合があります。
26
+
27
+ ### 方法2: リポジトリから使用(開発者向け)
28
+
29
+ Michiの開発に貢献したい場合や、最新の開発版を使用したい場合:
30
+
31
+ ```bash
32
+ # リポジトリをクローン
16
33
  git clone https://github.com/sk8metalme/michi
17
34
  cd michi
18
35
 
19
- # Jujutsu (jj) を使う場合
20
- # jj git clone https://github.com/sk8metalme/michi
21
- # cd michi
36
+ # 依存関係をインストール
37
+ npm install
38
+
39
+ # ビルド
40
+ npm run build
41
+
42
+ # グローバルコマンドとしてリンク
43
+ npm link
44
+
45
+ # 使用
46
+ michi --help
22
47
  ```
23
48
 
49
+ 詳細は [開発環境セットアップガイド](../contributing/development.md)を参照してください。
50
+
24
51
  ## 2. cc-sddのインストール
25
52
 
26
53
  cc-sddは、Michiの仕様駆動開発ワークフローのコアフレームワークです。
@@ -52,22 +79,16 @@ npx cc-sdd@next --lang ja --windsurf
52
79
 
53
80
  詳細: [cc-sdd公式ドキュメント](https://github.com/gotalab/cc-sdd/blob/main/tools/cc-sdd/README_ja.md)
54
81
 
55
- ## 3. 依存関係のインストール
82
+ ## 3. 環境変数の設定
56
83
 
57
- ```bash
58
- npm install
59
- ```
60
-
61
- ## 4. 環境変数の設定
62
-
63
- ### 4-1. .env ファイルの作成
84
+ ### 3-1. .env ファイルの作成
64
85
 
65
86
  ```bash
66
87
  # テンプレートファイルをコピー
67
88
  cp env.example .env
68
89
  ```
69
90
 
70
- ### 4-2. 認証情報の設定
91
+ ### 3-2. 認証情報の設定
71
92
 
72
93
  `.env` ファイルを編集して、実際の認証情報を設定します:
73
94
 
@@ -111,7 +132,7 @@ APPROVAL_GATES_DESIGN=architect,director
111
132
  APPROVAL_GATES_RELEASE=sm,director
112
133
  ```
113
134
 
114
- ### 4-3. ワークフロー承認ゲートの設定(オプション)
135
+ ### 3-3. ワークフロー承認ゲートの設定(オプション)
115
136
 
116
137
  ワークフロー実行時(`michi workflow:run`)の承認ゲートで使用するロール名を設定できます。
117
138
 
@@ -168,7 +189,7 @@ APPROVAL_GATES_RELEASE=リリースマネージャー,QAリード,部長
168
189
  - 空のロール名は無視されます
169
190
  - 環境変数が未設定の場合は、デフォルト値が使用されます
170
191
 
171
- ### 4-4. 認証トークンの取得方法
192
+ ### 3-4. 認証トークンの取得方法
172
193
 
173
194
  #### Atlassian API Token
174
195
  1. https://id.atlassian.com/manage-profile/security/api-tokens にアクセス
@@ -190,9 +211,9 @@ gh auth token
190
211
  3. Incoming Webhooks を有効化
191
212
  4. Webhook URL を生成して `.env` に設定
192
213
 
193
- ## 5. Atlassian MCP サーバーの設定
214
+ ## 4. Atlassian MCP サーバーの設定
194
215
 
195
- ### 5-1. MCP設定ファイルの作成
216
+ ### 4-1. MCP設定ファイルの作成
196
217
 
197
218
  プロジェクトルートの `mcp.json.example` を参考に、ホームディレクトリに `~/.cursor/mcp.json` を作成:
198
219
 
@@ -202,7 +223,7 @@ mkdir -p ~/.cursor
202
223
  cp mcp.json.example ~/.cursor/mcp.json
203
224
  ```
204
225
 
205
- ### 5-2. 実際の認証情報に置き換え
226
+ ### 4-2. 実際の認証情報に置き換え
206
227
 
207
228
  `~/.cursor/mcp.json` を編集して、`.env` と同じ認証情報を設定:
208
229
 
@@ -222,7 +243,7 @@ cp mcp.json.example ~/.cursor/mcp.json
222
243
  }
223
244
  ```
224
245
 
225
- ## 6. プロジェクトメタデータの確認
246
+ ## 5. プロジェクトメタデータの確認
226
247
 
227
248
  `.kiro/project.json` を確認・編集:
228
249
 
@@ -238,13 +259,15 @@ cp mcp.json.example ~/.cursor/mcp.json
238
259
  }
239
260
  ```
240
261
 
241
- ## 6-2. プロジェクト固有設定ファイル(オプション)
262
+ ## 5-2. プロジェクト固有設定ファイル(オプション)
242
263
 
243
- `.kiro/config.json` を作成することで、Confluence/JIRAの動作をカスタマイズできます。
264
+ `.michi/config.json` を作成することで、Confluence/JIRAの動作をカスタマイズできます。
244
265
 
245
266
  ### 設定ファイルの作成
246
267
 
247
- プロジェクトルートに `.kiro/config.json` を作成:
268
+ プロジェクトルートに `.michi/config.json` を作成:
269
+
270
+ **注意**: 以前は `.kiro/config.json` を使用していましたが、Michi専用の設定ファイルとして `.michi/config.json` に変更されました。
248
271
 
249
272
  ```json
250
273
  {
@@ -282,14 +305,14 @@ cp mcp.json.example ~/.cursor/mcp.json
282
305
 
283
306
  ### 設定値の詳細
284
307
 
285
- すべての設定値の詳細は [設定値リファレンス](./config-reference.md) を参照してください。
308
+ すべての設定値の詳細は [設定値リファレンス](../reference/config.md) を参照してください。
286
309
 
287
310
  ### 設定の優先順位
288
311
 
289
312
  設定値は以下の優先順位で決定されます:
290
313
 
291
314
  1. **`spec.json`**: 機能固有の設定(最優先)
292
- 2. **`.kiro/config.json`**: プロジェクト固有の設定
315
+ 2. **`.michi/config.json`**: プロジェクト固有の設定
293
316
  3. **環境変数**: システム環境変数または`.env`ファイル
294
317
  4. **デフォルト値**: スキーマで定義されたデフォルト値
295
318
 
@@ -307,17 +330,17 @@ npx tsx /path/to/michi/scripts/utils/config-validator.ts /path/to/project
307
330
 
308
331
  ### よくある設定パターン
309
332
 
310
- 詳細は [カスタマイズガイド](./customization-guide.md) を参照してください。
333
+ 詳細は [カスタマイズガイド](../guides/customization.md) を参照してください。
311
334
 
312
- ## 7. Cursor IDE の設定
335
+ ## 6. Cursor IDE の設定
313
336
 
314
- ### 7-1. Cursor でプロジェクトを開く
337
+ ### 6-1. Cursor でプロジェクトを開く
315
338
 
316
339
  ```bash
317
340
  cursor .
318
341
  ```
319
342
 
320
- ### 7-2. 利用可能なコマンドの確認
343
+ ### 6-2. 利用可能なコマンドの確認
321
344
 
322
345
  Cursor のコマンドパネル(Cmd+Shift+P)で `/kiro:` と入力すると、以下のコマンドが表示されます:
323
346
 
@@ -330,32 +353,23 @@ Cursor のコマンドパネル(Cmd+Shift+P)で `/kiro:` と入力すると
330
353
 
331
354
  凡例の詳細は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
332
355
 
333
- ## 8. 動作確認
356
+ ## 7. 動作確認
334
357
 
335
- ### 8-1. TypeScript コンパイル確認
358
+ ### 7-1. 基本的な動作確認
336
359
 
337
360
  ```bash
338
- npm run type-check
339
- ```
361
+ # Michiコマンドが利用可能か確認
362
+ michi --version
340
363
 
341
- ### 8-2. スクリプトの動作確認
364
+ # ヘルプを表示
365
+ michi --help
342
366
 
343
- ```bash
344
- # プロジェクト一覧の表示(準備中)
345
- npm run project:list
367
+ # 利用可能なコマンド一覧
368
+ michi help
346
369
  ```
347
370
 
348
371
  ## トラブルシューティング
349
372
 
350
- ### npm install でエラーが出る
351
-
352
- キャッシュをクリア:
353
- ```bash
354
- npm cache clean --force
355
- rm -rf node_modules package-lock.json
356
- npm install
357
- ```
358
-
359
373
  ### MCP サーバーが動作しない
360
374
 
361
375
  1. Cursor を再起動
@@ -374,9 +388,9 @@ gh auth setup-git
374
388
 
375
389
  セットアップが完了したら、以下のドキュメントを参照:
376
390
 
377
- - [ワークフローガイド](./workflow.md) - AI開発フロー
378
- - [マルチプロジェクト管理](./multi-project.md) - 複数プロジェクト管理
379
- - [API仕様](./api.md) - スクリプトAPI仕様
391
+ - [クイックスタート](./quick-start.md) - 5分で始める
392
+ - [ワークフローガイド](../guides/workflow.md) - AI開発フロー
393
+ - [マルチプロジェクト管理](../guides/multi-project.md) - 複数プロジェクト管理
380
394
 
381
395
  ## 参考リンク
382
396