@sk8metal/michi-cli 0.19.0 → 0.22.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 +129 -0
- package/README.md +1 -1
- package/dist/scripts/multi-project-estimate.js +4 -4
- package/dist/scripts/multi-project-estimate.js.map +1 -1
- package/dist/scripts/phase-runner.js +16 -16
- package/dist/scripts/phase-runner.js.map +1 -1
- package/dist/scripts/pr-automation.js +2 -2
- package/dist/scripts/pr-automation.js.map +1 -1
- package/dist/scripts/pre-flight-check.js +4 -4
- package/dist/scripts/pre-flight-check.js.map +1 -1
- package/dist/scripts/spec-impl-workflow.js +4 -4
- package/dist/scripts/spec-impl-workflow.js.map +1 -1
- package/dist/scripts/template/multi-repo-renderer.js +1 -1
- package/dist/scripts/template/multi-repo-renderer.js.map +1 -1
- package/dist/scripts/template/renderer.d.ts +6 -6
- package/dist/scripts/template/renderer.js +7 -7
- package/dist/scripts/test-execution-generator.js +11 -11
- package/dist/scripts/test-execution-generator.js.map +1 -1
- package/dist/scripts/utils/config-loader.d.ts +1 -1
- package/dist/scripts/utils/config-loader.js +4 -4
- package/dist/scripts/utils/config-loader.js.map +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js.map +1 -1
- package/dist/scripts/utils/docker-requirement-detector.js +3 -3
- package/dist/scripts/utils/docker-requirement-detector.js.map +1 -1
- package/dist/scripts/utils/language-detector.js +2 -2
- package/dist/scripts/utils/language-detector.js.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.d.ts +1 -1
- package/dist/scripts/utils/multi-repo-validator.js +3 -3
- package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
- package/dist/scripts/utils/project-analyzer.d.ts +1 -1
- package/dist/scripts/utils/project-analyzer.js +2 -2
- package/dist/scripts/utils/project-analyzer.js.map +1 -1
- package/dist/scripts/utils/spec-archiver.d.ts +1 -1
- package/dist/scripts/utils/spec-archiver.js +5 -5
- package/dist/scripts/utils/spec-archiver.js.map +1 -1
- package/dist/scripts/utils/spec-updater.js +2 -2
- package/dist/scripts/utils/spec-updater.js.map +1 -1
- package/dist/scripts/utils/tasks-converter.js +2 -2
- package/dist/scripts/utils/tasks-converter.js.map +1 -1
- package/dist/scripts/utils/template-applier.js +1 -1
- package/dist/scripts/utils/template-applier.js.map +1 -1
- package/dist/scripts/validate-phase.js +4 -4
- package/dist/scripts/validate-phase.js.map +1 -1
- package/dist/src/application/use-cases/spec/archive-spec.js +1 -1
- package/dist/src/application/use-cases/spec/archive-spec.js.map +1 -1
- package/dist/src/application/use-cases/spec/generate-requirements.js +1 -1
- package/dist/src/application/use-cases/spec/generate-requirements.js.map +1 -1
- package/dist/src/application/use-cases/spec/init-spec.js +1 -1
- package/dist/src/application/use-cases/spec/init-spec.js.map +1 -1
- package/dist/src/commands/migrate.js +14 -14
- package/dist/src/commands/migrate.js.map +1 -1
- package/dist/src/infrastructure/external-apis/atlassian/confluence/hierarchy.js +1 -1
- package/dist/src/infrastructure/external-apis/atlassian/confluence/hierarchy.js.map +1 -1
- package/dist/src/infrastructure/external-apis/atlassian/confluence/sync-service.js +2 -2
- package/dist/src/infrastructure/external-apis/atlassian/confluence/sync-service.js.map +1 -1
- package/dist/src/infrastructure/external-apis/atlassian/jira/issue-builder.js +1 -1
- package/dist/src/infrastructure/external-apis/atlassian/jira/issue-builder.js.map +1 -1
- package/dist/src/infrastructure/external-apis/atlassian/jira/sync-service.js +3 -3
- package/dist/src/infrastructure/external-apis/atlassian/jira/sync-service.js.map +1 -1
- package/dist/src/infrastructure/filesystem/project-meta.d.ts +1 -1
- package/dist/src/infrastructure/filesystem/project-meta.js +2 -2
- package/dist/src/infrastructure/filesystem/project-meta.js.map +1 -1
- package/dist/src/presentation/commands/config/register.d.ts.map +1 -1
- package/dist/src/presentation/commands/config/register.js +54 -0
- package/dist/src/presentation/commands/config/register.js.map +1 -1
- package/dist/src/presentation/commands/init/handler.js +1 -1
- package/dist/src/presentation/commands/init/handler.js.map +1 -1
- package/dist/src/presentation/commands/init/register.js +2 -2
- package/dist/src/presentation/commands/init/register.js.map +1 -1
- package/dist/src/presentation/commands/init/setup.d.ts +1 -1
- package/dist/src/presentation/commands/init/setup.js +6 -6
- package/dist/src/presentation/commands/init/setup.js.map +1 -1
- package/dist/src/presentation/commands/init/templates.js +5 -5
- package/dist/src/presentation/commands/init/templates.js.map +1 -1
- package/dist/src/presentation/commands/workflow/orchestrator.js +2 -2
- package/dist/src/presentation/commands/workflow/orchestrator.js.map +1 -1
- package/dist/src/presentation/interactive/config/env-wizard.d.ts +9 -0
- package/dist/src/presentation/interactive/config/env-wizard.d.ts.map +1 -0
- package/dist/src/presentation/interactive/config/env-wizard.js +193 -0
- package/dist/src/presentation/interactive/config/env-wizard.js.map +1 -0
- package/dist/src/presentation/interactive/config/index.d.ts +5 -0
- package/dist/src/presentation/interactive/config/index.d.ts.map +1 -0
- package/dist/src/presentation/interactive/config/index.js +5 -0
- package/dist/src/presentation/interactive/config/index.js.map +1 -0
- package/dist/src/presentation/interactive/prompts.d.ts +2 -3
- package/dist/src/presentation/interactive/prompts.d.ts.map +1 -1
- package/dist/src/presentation/interactive/prompts.js +4 -6
- package/dist/src/presentation/interactive/prompts.js.map +1 -1
- package/docs/MIGRATION.md +2 -2
- package/docs/architecture.md +5 -5
- package/docs/getting-started/configuration.md +2 -2
- package/docs/guides/claude-code.md +10 -10
- package/docs/guides/comprehensive-verification-guide.md +29 -29
- package/docs/guides/interactive-config.md +285 -0
- package/docs/guides/workflow.md +25 -25
- package/docs/onion-architecture-phase0-complete.md +1 -1
- package/docs/reference/ai-commands.md +12 -12
- package/docs/reference/cli.md +4 -4
- package/docs/reference/environment-variables.md +1 -1
- package/docs/troubleshooting.md +6 -6
- package/package.json +1 -1
- package/scripts/README.md +2 -3
- package/scripts/__tests__/create-project.test.ts +6 -6
- package/scripts/__tests__/multi-project-estimate.test.ts +1 -1
- package/scripts/build/README.md +1 -1
- package/scripts/multi-project-estimate.ts +4 -4
- package/scripts/phase-runner.ts +16 -16
- package/scripts/pr-automation.ts +2 -2
- package/scripts/pre-flight-check.ts +4 -4
- package/scripts/spec-impl-workflow.ts +4 -4
- package/scripts/template/__tests__/renderer.test.ts +34 -34
- package/scripts/template/multi-repo-renderer.ts +1 -1
- package/scripts/template/renderer.ts +9 -9
- package/scripts/test-execution-generator.ts +11 -11
- package/scripts/utils/__tests__/config-loader.test.ts +14 -9
- package/scripts/utils/__tests__/config-validator.test.ts +8 -8
- package/scripts/utils/__tests__/multi-repo-validator.test.ts +17 -17
- package/scripts/utils/__tests__/project-analyzer.test.ts +28 -28
- package/scripts/utils/__tests__/project-meta.test.ts +22 -22
- package/scripts/utils/__tests__/spec-updater.test.ts +3 -3
- package/scripts/utils/config-loader.ts +6 -6
- package/scripts/utils/confluence-hierarchy.ts +1 -1
- package/scripts/utils/docker-requirement-detector.ts +3 -3
- package/scripts/utils/language-detector.ts +2 -2
- package/scripts/utils/multi-repo-validator.ts +3 -3
- package/scripts/utils/project-analyzer.ts +2 -2
- package/scripts/utils/spec-archiver.ts +5 -5
- package/scripts/utils/spec-updater.ts +2 -2
- package/scripts/utils/tasks-converter.ts +2 -2
- package/scripts/utils/template-applier.ts +1 -1
- package/scripts/validate-phase.ts +4 -4
- package/templates/claude-agent/README.md +1 -1
- package/templates/claude-agent/agents/designer.md +4 -4
- package/templates/claude-agent/agents/developer.md +2 -2
- package/templates/claude-agent/agents/doc-reviewer.md +4 -4
- package/templates/claude-agent/agents/manager-agent.md +3 -3
- package/templates/claude-agent/agents/repo-spec-executor.md +1 -1
- package/templates/claude-agent/agents/tester.md +3 -3
- package/templates/claude-agent/commands/kiro/kiro-spec-impl.md +6 -6
- package/templates/claude-agent/commands/kiro/kiro-spec-tasks.md +10 -10
- package/templates/claude-agent/rules/doc-review.md +1 -1
- package/templates/common/.kiro/project.json.template +0 -21
|
@@ -145,17 +145,17 @@ npx cc-sdd@latest --claude --lang ja
|
|
|
145
145
|
```text
|
|
146
146
|
✔ Claude Code detected
|
|
147
147
|
✔ Setting up cc-sdd for Claude...
|
|
148
|
-
✔ Created .
|
|
148
|
+
✔ Created .michi/ directory structure
|
|
149
149
|
✔ Installed kiro commands
|
|
150
150
|
✔ Setup complete!
|
|
151
151
|
|
|
152
152
|
Next steps:
|
|
153
153
|
1. Start Claude Code
|
|
154
|
-
2. Type /
|
|
154
|
+
2. Type /michi:spec-init "<feature-name>: <description>"
|
|
155
155
|
```
|
|
156
156
|
</details>
|
|
157
157
|
|
|
158
|
-
- [ ] **チェック**: cc-sddセットアップ完了、`.
|
|
158
|
+
- [ ] **チェック**: cc-sddセットアップ完了、`.michi/` ディレクトリ作成確認
|
|
159
159
|
|
|
160
160
|
### 2.2 Michiプラグインインストール
|
|
161
161
|
|
|
@@ -315,7 +315,7 @@ michi config:check-security # セキュリティチェック
|
|
|
315
315
|
|
|
316
316
|
**コマンド**:
|
|
317
317
|
```text
|
|
318
|
-
/
|
|
318
|
+
/michi:spec-init "test-feature: テスト用の新機能実装"
|
|
319
319
|
```
|
|
320
320
|
|
|
321
321
|
<details>
|
|
@@ -324,17 +324,17 @@ michi config:check-security # セキュリティチェック
|
|
|
324
324
|
```text
|
|
325
325
|
📋 仕様初期化: test-feature
|
|
326
326
|
|
|
327
|
-
✅ ディレクトリ作成: .
|
|
327
|
+
✅ ディレクトリ作成: .michi/specs/test-feature/
|
|
328
328
|
✅ spec.json作成
|
|
329
329
|
✅ requirements.mdテンプレート作成
|
|
330
330
|
|
|
331
331
|
次のステップ:
|
|
332
|
-
/
|
|
332
|
+
/michi:spec-requirements test-feature
|
|
333
333
|
```
|
|
334
334
|
</details>
|
|
335
335
|
|
|
336
336
|
**確認事項**:
|
|
337
|
-
- [ ] `.
|
|
337
|
+
- [ ] `.michi/specs/test-feature/` ディレクトリ作成確認
|
|
338
338
|
- [ ] `spec.json` 生成確認(language: ja, phase: requirements-pending)
|
|
339
339
|
- [ ] `requirements.md` テンプレート確認
|
|
340
340
|
|
|
@@ -342,7 +342,7 @@ michi config:check-security # セキュリティチェック
|
|
|
342
342
|
|
|
343
343
|
**コマンド**:
|
|
344
344
|
```text
|
|
345
|
-
/
|
|
345
|
+
/michi:spec-requirements test-feature
|
|
346
346
|
```
|
|
347
347
|
|
|
348
348
|
<details>
|
|
@@ -400,7 +400,7 @@ michi config:check-security # セキュリティチェック
|
|
|
400
400
|
- テスト計画: 42テストケース
|
|
401
401
|
|
|
402
402
|
次のステップ:
|
|
403
|
-
/
|
|
403
|
+
/michi:validate-design test-feature # オプション
|
|
404
404
|
/michi:spec-tasks test-feature
|
|
405
405
|
```
|
|
406
406
|
</details>
|
|
@@ -415,7 +415,7 @@ michi config:check-security # セキュリティチェック
|
|
|
415
415
|
|
|
416
416
|
**コマンド**:
|
|
417
417
|
```text
|
|
418
|
-
/
|
|
418
|
+
/michi:validate-design test-feature
|
|
419
419
|
```
|
|
420
420
|
|
|
421
421
|
<details>
|
|
@@ -641,7 +641,7 @@ michi phase:run test-feature environment-setup
|
|
|
641
641
|
- 全テストパス: 124/124
|
|
642
642
|
|
|
643
643
|
次のステップ:
|
|
644
|
-
/
|
|
644
|
+
/michi:validate-impl test-feature # オプション
|
|
645
645
|
git add . && git commit -m "feat: test-feature implementation"
|
|
646
646
|
```
|
|
647
647
|
</details>
|
|
@@ -657,7 +657,7 @@ michi phase:run test-feature environment-setup
|
|
|
657
657
|
|
|
658
658
|
**コマンド**:
|
|
659
659
|
```text
|
|
660
|
-
/
|
|
660
|
+
/michi:validate-impl test-feature
|
|
661
661
|
```
|
|
662
662
|
|
|
663
663
|
<details>
|
|
@@ -919,7 +919,7 @@ npm notice
|
|
|
919
919
|
|
|
920
920
|
**コマンド**:
|
|
921
921
|
```text
|
|
922
|
-
/
|
|
922
|
+
/michi:spec-archive test-feature
|
|
923
923
|
```
|
|
924
924
|
|
|
925
925
|
<details>
|
|
@@ -928,9 +928,9 @@ npm notice
|
|
|
928
928
|
```text
|
|
929
929
|
📦 仕様アーカイブ実行中...
|
|
930
930
|
|
|
931
|
-
✅ アーカイブ作成: .
|
|
931
|
+
✅ アーカイブ作成: .michi/specs/archived/test-feature-20260101/
|
|
932
932
|
✅ メタデータ更新: archived_at: 2026-01-01T12:00:00Z
|
|
933
|
-
✅ 元ディレクトリ削除: .
|
|
933
|
+
✅ 元ディレクトリ削除: .michi/specs/test-feature/
|
|
934
934
|
|
|
935
935
|
✅ アーカイブ完了
|
|
936
936
|
```
|
|
@@ -938,7 +938,7 @@ npm notice
|
|
|
938
938
|
|
|
939
939
|
**確認事項**:
|
|
940
940
|
- [ ] 仕様アーカイブ確認
|
|
941
|
-
- [ ] `.
|
|
941
|
+
- [ ] `.michi/specs/archived/` 移動確認
|
|
942
942
|
|
|
943
943
|
---
|
|
944
944
|
|
|
@@ -957,7 +957,7 @@ npm notice
|
|
|
957
957
|
```text
|
|
958
958
|
🚀 Multi-Repoプロジェクト初期化中...
|
|
959
959
|
|
|
960
|
-
✅ 親プロジェクト作成: .
|
|
960
|
+
✅ 親プロジェクト作成: .michi/multi-repo/multi-repo-test/
|
|
961
961
|
✅ metadata.json作成
|
|
962
962
|
✅ overview/ディレクトリ作成
|
|
963
963
|
✅ steering/ディレクトリ作成
|
|
@@ -975,7 +975,7 @@ npm notice
|
|
|
975
975
|
|
|
976
976
|
**確認事項**:
|
|
977
977
|
- [ ] 親プロジェクト作成確認
|
|
978
|
-
- [ ] メタデータ設定確認(.
|
|
978
|
+
- [ ] メタデータ設定確認(.michi/multi-repo/multi-repo-test/metadata.json)
|
|
979
979
|
|
|
980
980
|
### 4.2 リポジトリ追加
|
|
981
981
|
|
|
@@ -1531,8 +1531,8 @@ Info:
|
|
|
1531
1531
|
|
|
1532
1532
|
**コマンド**:
|
|
1533
1533
|
```text
|
|
1534
|
-
/
|
|
1535
|
-
/
|
|
1534
|
+
/michi:steering
|
|
1535
|
+
/michi:steering-custom
|
|
1536
1536
|
```
|
|
1537
1537
|
|
|
1538
1538
|
<details>
|
|
@@ -1541,12 +1541,12 @@ Info:
|
|
|
1541
1541
|
```text
|
|
1542
1542
|
📝 Steeringドキュメント管理
|
|
1543
1543
|
|
|
1544
|
-
/
|
|
1545
|
-
✅ .
|
|
1546
|
-
✅ .
|
|
1547
|
-
✅ .
|
|
1544
|
+
/michi:steering:
|
|
1545
|
+
✅ .michi/steering/product.md 作成
|
|
1546
|
+
✅ .michi/steering/tech.md 作成
|
|
1547
|
+
✅ .michi/steering/structure.md 作成
|
|
1548
1548
|
|
|
1549
|
-
/
|
|
1549
|
+
/michi:steering-custom:
|
|
1550
1550
|
選択したカスタムSteering:
|
|
1551
1551
|
✅ api-standards.md
|
|
1552
1552
|
✅ security.md
|
|
@@ -1557,7 +1557,7 @@ Info:
|
|
|
1557
1557
|
</details>
|
|
1558
1558
|
|
|
1559
1559
|
**確認事項**:
|
|
1560
|
-
- [ ] ステアリングドキュメント作成確認(.
|
|
1560
|
+
- [ ] ステアリングドキュメント作成確認(.michi/steering/)
|
|
1561
1561
|
- [ ] カスタムステアリング作成確認
|
|
1562
1562
|
|
|
1563
1563
|
### 7.2 ドキュメントレビュー
|
|
@@ -1601,7 +1601,7 @@ Info:
|
|
|
1601
1601
|
|
|
1602
1602
|
**コマンド**:
|
|
1603
1603
|
```text
|
|
1604
|
-
/
|
|
1604
|
+
/michi:spec-status test-feature
|
|
1605
1605
|
```
|
|
1606
1606
|
|
|
1607
1607
|
<details>
|
|
@@ -1750,7 +1750,7 @@ michi migrate --rollback /path/to/backup
|
|
|
1750
1750
|
|
|
1751
1751
|
1. **タスクステータス確認**:
|
|
1752
1752
|
```text
|
|
1753
|
-
/
|
|
1753
|
+
/michi:spec-status <feature>
|
|
1754
1754
|
```
|
|
1755
1755
|
|
|
1756
1756
|
2. **部分再実装**(特定タスクのみ):
|
|
@@ -1776,7 +1776,7 @@ michi migrate --rollback /path/to/backup
|
|
|
1776
1776
|
**対処手順**:
|
|
1777
1777
|
|
|
1778
1778
|
1. **チェックポイント確認**:
|
|
1779
|
-
- `.
|
|
1779
|
+
- `.michi/multi-repo/<project>/checkpoints/` を確認
|
|
1780
1780
|
|
|
1781
1781
|
2. **個別リポジトリで修正**:
|
|
1782
1782
|
- 失敗したリポジトリをクローン
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
# 対話的設定ガイド
|
|
2
|
+
|
|
3
|
+
このガイドでは、Michiの対話的設定機能を使って、各種設定ファイルを作成する方法を説明します。
|
|
4
|
+
|
|
5
|
+
## 目次
|
|
6
|
+
|
|
7
|
+
1. [コマンド一覧](#コマンド一覧)
|
|
8
|
+
2. [設定ファイルの種類](#設定ファイルの種類)
|
|
9
|
+
3. [使い方](#使い方)
|
|
10
|
+
4. [3層設定アーキテクチャ](#3層設定アーキテクチャ)
|
|
11
|
+
5. [セキュリティ](#セキュリティ)
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## コマンド一覧
|
|
16
|
+
|
|
17
|
+
| コマンド | 作成ファイル | 説明 |
|
|
18
|
+
|---------|-------------|------|
|
|
19
|
+
| `michi init` | `.michi/`, `.env`(テンプレート), `.michi/config.json` | プロジェクト全体の初期化 |
|
|
20
|
+
| `michi config:init` | すべての設定ファイル(`--all`オプション時) | 対話的に設定ファイルを作成 |
|
|
21
|
+
| `michi config:init --global` | `~/.michi/config.json` | グローバル設定を対話的に作成 |
|
|
22
|
+
| `michi config:init --global-env` | `~/.michi/.env` | グローバル.envを対話的に作成 |
|
|
23
|
+
| `michi config:init --project` | `.michi/config.json` | プロジェクト設定を対話的に作成 |
|
|
24
|
+
| `michi config:init --env` | `.env` | プロジェクト.envを対話的に作成 |
|
|
25
|
+
| `michi config:init --all` | 上記すべて | 全設定ファイルを作成 |
|
|
26
|
+
|
|
27
|
+
### michi init と michi config:init の違い
|
|
28
|
+
|
|
29
|
+
- **`michi init`**: プロジェクトの初期化(.michiディレクトリ構造、プロジェクトメタデータ作成)
|
|
30
|
+
- `.env`はテンプレートのみ(値の入力なし)
|
|
31
|
+
- `.michi/config.json`はグローバル設定をコピー、またはデフォルト値を使用
|
|
32
|
+
|
|
33
|
+
- **`michi config:init`**: 設定ファイルの対話的作成(値を入力)
|
|
34
|
+
- `.env`の各項目を対話的に入力(APIトークンはパスワード非表示)
|
|
35
|
+
- `.michi/config.json`も対話的に作成可能
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 設定ファイルの種類
|
|
40
|
+
|
|
41
|
+
### 1. グローバル設定 (`~/.michi/config.json`)
|
|
42
|
+
|
|
43
|
+
すべてのプロジェクトに適用される共通設定です。
|
|
44
|
+
|
|
45
|
+
**含まれる内容:**
|
|
46
|
+
- Confluence設定(ページ作成粒度)
|
|
47
|
+
- JIRA設定(Epic作成、ストーリー作成粒度、ストーリーポイント)
|
|
48
|
+
- ワークフロー設定(有効なフェーズ)
|
|
49
|
+
|
|
50
|
+
**作成方法:**
|
|
51
|
+
```bash
|
|
52
|
+
michi config:init --global
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 2. グローバル環境変数 (`~/.michi/.env`)
|
|
56
|
+
|
|
57
|
+
すべてのプロジェクトで使用する環境変数です(機密情報)。
|
|
58
|
+
|
|
59
|
+
**含まれる内容:**
|
|
60
|
+
- Atlassian連携(URL、Email、APIトークン)
|
|
61
|
+
- GitHub連携(Organization、Personalトークン)
|
|
62
|
+
- Confluence Space設定
|
|
63
|
+
- JIRAプロジェクトキー
|
|
64
|
+
|
|
65
|
+
**作成方法:**
|
|
66
|
+
```bash
|
|
67
|
+
michi config:init --global-env
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 3. プロジェクト設定 (`.michi/config.json`)
|
|
71
|
+
|
|
72
|
+
プロジェクト固有の設定です。グローバル設定を上書きできます。
|
|
73
|
+
|
|
74
|
+
**作成方法:**
|
|
75
|
+
```bash
|
|
76
|
+
michi config:init --project
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 4. プロジェクト環境変数 (`.env`)
|
|
80
|
+
|
|
81
|
+
プロジェクト固有の環境変数です。グローバル環境変数を上書きできます。
|
|
82
|
+
|
|
83
|
+
**作成方法:**
|
|
84
|
+
```bash
|
|
85
|
+
michi config:init --env
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 使い方
|
|
91
|
+
|
|
92
|
+
### 基本的な使い方
|
|
93
|
+
|
|
94
|
+
#### 1. プロジェクト初期化時
|
|
95
|
+
|
|
96
|
+
プロジェクト新規作成時は、まず `michi init` でプロジェクト構造を作成します。
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
cd your-project
|
|
100
|
+
michi init
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
`.env` と `.michi/config.json` はテンプレートまたはデフォルト値で作成されます。
|
|
104
|
+
|
|
105
|
+
#### 2. 機密情報を含む .env の作成
|
|
106
|
+
|
|
107
|
+
APIトークンなどの機密情報を対話的に入力して、`.env` を作成します。
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
michi config:init --env
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
**入力例:**
|
|
114
|
+
```
|
|
115
|
+
========================================
|
|
116
|
+
.env Interactive Setup
|
|
117
|
+
========================================
|
|
118
|
+
|
|
119
|
+
設定ファイル: /path/to/your-project/.env
|
|
120
|
+
|
|
121
|
+
=== Atlassian連携設定 ===
|
|
122
|
+
|
|
123
|
+
Atlassian URL (空白でスキップ): https://your-domain.atlassian.net
|
|
124
|
+
Atlassian Email: your-email@company.com
|
|
125
|
+
Atlassian API Token: ********** (入力は非表示)
|
|
126
|
+
|
|
127
|
+
=== Confluence Space設定 ===
|
|
128
|
+
|
|
129
|
+
PRD Space Key (空白でスキップ): PRD
|
|
130
|
+
QA Space Key (空白でスキップ): QA
|
|
131
|
+
Release Space Key (空白でスキップ): RELEASE
|
|
132
|
+
|
|
133
|
+
=== JIRA設定 ===
|
|
134
|
+
|
|
135
|
+
JIRA Project Keys (カンマ区切り、空白でスキップ): PROJ1,PROJ2
|
|
136
|
+
|
|
137
|
+
=== GitHub連携設定 ===
|
|
138
|
+
|
|
139
|
+
GitHub Organization (空白でスキップ): your-org
|
|
140
|
+
GitHub Personal Access Token: ********** (入力は非表示)
|
|
141
|
+
|
|
142
|
+
✅ .envファイルを作成しました:
|
|
143
|
+
/path/to/your-project/.env
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
#### 3. グローバル設定の作成
|
|
147
|
+
|
|
148
|
+
複数のプロジェクトで共通の設定を使う場合、グローバル設定を作成します。
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
michi config:init --global
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
#### 4. すべての設定ファイルを一度に作成
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
michi config:init --all
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
上記コマンドは、以下の順序で実行されます:
|
|
161
|
+
1. `~/.michi/.env` 作成
|
|
162
|
+
2. `.env` 作成
|
|
163
|
+
3. `~/.michi/config.json` 作成
|
|
164
|
+
4. `.michi/config.json` 作成
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## 3層設定アーキテクチャ
|
|
169
|
+
|
|
170
|
+
Michiは、3層の設定アーキテクチャを採用しています。
|
|
171
|
+
|
|
172
|
+
### 読み込み優先順位(低 → 高)
|
|
173
|
+
|
|
174
|
+
1. **デフォルト設定**(内蔵)
|
|
175
|
+
2. **グローバル設定** (`~/.michi/config.json`)
|
|
176
|
+
3. **グローバル環境変数** (`~/.michi/.env`)
|
|
177
|
+
4. **プロジェクト設定** (`.michi/config.json`)
|
|
178
|
+
5. **プロジェクト環境変数** (`.env`)
|
|
179
|
+
|
|
180
|
+
**例:**
|
|
181
|
+
- グローバル設定で `ATLASSIAN_URL=https://global.atlassian.net` を設定
|
|
182
|
+
- プロジェクト環境変数で `ATLASSIAN_URL=https://project.atlassian.net` を設定
|
|
183
|
+
- → プロジェクト環境変数の値 (`https://project.atlassian.net`) が使用される
|
|
184
|
+
|
|
185
|
+
### 設定の上書きルール
|
|
186
|
+
|
|
187
|
+
- 上位の設定(番号が大きい)が下位の設定を上書きします
|
|
188
|
+
- プロジェクト固有の設定が必要な場合は、プロジェクト設定/環境変数で上書き
|
|
189
|
+
- 共通設定はグローバル設定/環境変数で管理
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## セキュリティ
|
|
194
|
+
|
|
195
|
+
### .envファイルの機密情報入力
|
|
196
|
+
|
|
197
|
+
APIトークンなどの機密情報は、入力時に非表示になります(`@inquirer/prompts`使用)。
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
Atlassian API Token: ********** (入力は見えません)
|
|
201
|
+
GitHub Personal Access Token: ********** (入力は見えません)
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### ファイルパーミッション
|
|
205
|
+
|
|
206
|
+
`.env` ファイルは、セキュリティのため、所有者のみ読み書き可能な権限(`0o600`)で作成されます。
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
ls -la .env
|
|
210
|
+
-rw------- 1 user user 512 Jan 1 12:00 .env
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### .gitignore
|
|
214
|
+
|
|
215
|
+
`.env` ファイルは機密情報を含むため、必ず `.gitignore` に追加してください。
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
# .gitignore
|
|
219
|
+
.env
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
**注意:** `.env.example` はGitで管理しても問題ありませんが、実際の値は含めないでください。
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## 既存機能との関係
|
|
227
|
+
|
|
228
|
+
### `michi init` との使い分け
|
|
229
|
+
|
|
230
|
+
| タイミング | コマンド | 目的 |
|
|
231
|
+
|-----------|---------|------|
|
|
232
|
+
| プロジェクト新規作成時 | `michi init` | プロジェクト構造の初期化 |
|
|
233
|
+
| .envに値を入力したい | `michi config:init --env` | 機密情報を対話的に入力 |
|
|
234
|
+
| グローバル設定を作成 | `michi config:init --global` | 複数プロジェクトで共通設定 |
|
|
235
|
+
|
|
236
|
+
### 過去の `npm run config:global` との関係
|
|
237
|
+
|
|
238
|
+
以前は `npm run config:global` を使用していましたが、`michi config:init --global` に統合されました。
|
|
239
|
+
|
|
240
|
+
**移行方法:**
|
|
241
|
+
```bash
|
|
242
|
+
# 旧コマンド
|
|
243
|
+
npm run config:global
|
|
244
|
+
|
|
245
|
+
# 新コマンド
|
|
246
|
+
michi config:init --global
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
---
|
|
250
|
+
|
|
251
|
+
## トラブルシューティング
|
|
252
|
+
|
|
253
|
+
### Q1. `.env` ファイルが既に存在する場合は?
|
|
254
|
+
|
|
255
|
+
上書き確認が表示されます。
|
|
256
|
+
|
|
257
|
+
```
|
|
258
|
+
⚠️ 既存の.envファイルが見つかりました。上書きしますか? (y/N):
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
- `y` を入力すると上書き
|
|
262
|
+
- `N` または Enter で中止
|
|
263
|
+
|
|
264
|
+
### Q2. グローバル設定とプロジェクト設定の違いは?
|
|
265
|
+
|
|
266
|
+
- **グローバル設定** (`~/.michi/config.json`): すべてのプロジェクトに適用
|
|
267
|
+
- **プロジェクト設定** (`.michi/config.json`): プロジェクト固有の設定(グローバル設定を上書き)
|
|
268
|
+
|
|
269
|
+
### Q3. パスワード入力時、入力が見えない
|
|
270
|
+
|
|
271
|
+
セキュリティのため、APIトークンやパスワードは入力時に非表示になります。
|
|
272
|
+
|
|
273
|
+
入力後、Enterを押してください。
|
|
274
|
+
|
|
275
|
+
---
|
|
276
|
+
|
|
277
|
+
## 関連ドキュメント
|
|
278
|
+
|
|
279
|
+
- [Atlassian連携ガイド](./atlassian-integration.md)
|
|
280
|
+
- [アーキテクチャガイド](../architecture.md)
|
|
281
|
+
- [設定ファイルリファレンス](../reference/config.md)
|
|
282
|
+
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
**更新日:** 2026-01-04
|
package/docs/guides/workflow.md
CHANGED
|
@@ -12,11 +12,11 @@ Michiは、cc-sdd(Spec-Driven Development Core)を拡張し、テスト計
|
|
|
12
12
|
┌─────────────────────────────────────────────────────────────────┐
|
|
13
13
|
│ cc-sdd 標準フェーズ │
|
|
14
14
|
├─────────────────────────────────────────────────────────────────┤
|
|
15
|
-
│ Phase 0.0: 仕様初期化 (/
|
|
16
|
-
│ Phase 0.1: 要件定義 (/
|
|
17
|
-
│ Phase 0.2: 設計 (/
|
|
18
|
-
│ Phase 0.5: タスク分割 (/
|
|
19
|
-
│ Phase 2: TDD実装 (/
|
|
15
|
+
│ Phase 0.0: 仕様初期化 (/michi:spec-init) │
|
|
16
|
+
│ Phase 0.1: 要件定義 (/michi:spec-requirements) │
|
|
17
|
+
│ Phase 0.2: 設計 (/michi:spec-design) │
|
|
18
|
+
│ Phase 0.5: タスク分割 (/michi:spec-tasks) │
|
|
19
|
+
│ Phase 2: TDD実装 (/michi:spec-impl) │
|
|
20
20
|
└─────────────────────────────────────────────────────────────────┘
|
|
21
21
|
|
|
22
22
|
┌─────────────────────────────────────────────────────────────────┐
|
|
@@ -57,16 +57,16 @@ Phase 0.0 → 0.1 → 0.2 → [0.3-0.4] → 0.5 → 0.6-0.7
|
|
|
57
57
|
|
|
58
58
|
**実行コマンド**:
|
|
59
59
|
```bash
|
|
60
|
-
/
|
|
60
|
+
/michi:spec-init "機能の説明文"
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
**実行例**:
|
|
64
64
|
```bash
|
|
65
|
-
/
|
|
65
|
+
/michi:spec-init "計算機アプリケーション: 四則演算を行う"
|
|
66
66
|
```
|
|
67
67
|
|
|
68
68
|
**生成物**:
|
|
69
|
-
- `.
|
|
69
|
+
- `.michi/specs/{feature}/spec.json` - 仕様メタデータ
|
|
70
70
|
|
|
71
71
|
### Phase 0.1: 要件定義(必須)
|
|
72
72
|
|
|
@@ -74,7 +74,7 @@ Phase 0.0 → 0.1 → 0.2 → [0.3-0.4] → 0.5 → 0.6-0.7
|
|
|
74
74
|
|
|
75
75
|
**実行コマンド**:
|
|
76
76
|
```bash
|
|
77
|
-
/
|
|
77
|
+
/michi:spec-requirements {feature}
|
|
78
78
|
|
|
79
79
|
# または、CLIから実行(Confluence同期付き)
|
|
80
80
|
michi phase:run {feature} requirements
|
|
@@ -82,7 +82,7 @@ michi phase:run {feature} requirements
|
|
|
82
82
|
|
|
83
83
|
**実行例**:
|
|
84
84
|
```bash
|
|
85
|
-
/
|
|
85
|
+
/michi:spec-requirements calculator-app
|
|
86
86
|
|
|
87
87
|
# または、CLIから実行
|
|
88
88
|
michi phase:run calculator-app requirements
|
|
@@ -94,7 +94,7 @@ michi phase:run calculator-app requirements
|
|
|
94
94
|
3. バリデーション実行
|
|
95
95
|
|
|
96
96
|
**生成物**:
|
|
97
|
-
- `.
|
|
97
|
+
- `.michi/specs/{feature}/requirements.md` - 要件定義書
|
|
98
98
|
- Confluence: 要件定義ページ
|
|
99
99
|
|
|
100
100
|
**承認ゲート**: PM、部長による承認
|
|
@@ -109,7 +109,7 @@ michi phase:run calculator-app requirements
|
|
|
109
109
|
/michi:spec-design {feature}
|
|
110
110
|
|
|
111
111
|
# cc-sdd標準
|
|
112
|
-
/
|
|
112
|
+
/michi:spec-design {feature}
|
|
113
113
|
|
|
114
114
|
# または、CLIから実行(Confluence同期付き)
|
|
115
115
|
michi phase:run {feature} design
|
|
@@ -130,7 +130,7 @@ michi phase:run calculator-app design
|
|
|
130
130
|
4. (Michi版のみ)テスト計画ガイダンス
|
|
131
131
|
|
|
132
132
|
**生成物**:
|
|
133
|
-
- `.
|
|
133
|
+
- `.michi/specs/{feature}/design.md` - 設計書
|
|
134
134
|
- Confluence: 設計書ページ
|
|
135
135
|
|
|
136
136
|
**承認ゲート**: アーキテクト、部長による承認
|
|
@@ -154,10 +154,10 @@ michi phase:run calculator-app design
|
|
|
154
154
|
2. 選択されたテストタイプの仕様書を生成
|
|
155
155
|
|
|
156
156
|
**生成物**:
|
|
157
|
-
- `.
|
|
158
|
-
- `.
|
|
159
|
-
- `.
|
|
160
|
-
- `.
|
|
157
|
+
- `.michi/specs/{feature}/test-type-selection.json` - テストタイプ選択結果
|
|
158
|
+
- `.michi/specs/{feature}/test-specs/unit-test-spec.md` - 単体テスト仕様書
|
|
159
|
+
- `.michi/specs/{feature}/test-specs/integration-test-spec.md` - 統合テスト仕様書
|
|
160
|
+
- `.michi/specs/{feature}/test-specs/e2e-test-spec.md` - E2Eテスト仕様書
|
|
161
161
|
- (その他、選択されたテストタイプの仕様書)
|
|
162
162
|
|
|
163
163
|
### Phase 0.5: タスク分割(必須)
|
|
@@ -188,7 +188,7 @@ michi phase:run calculator-app tasks
|
|
|
188
188
|
5. バリデーション実行
|
|
189
189
|
|
|
190
190
|
**生成物**:
|
|
191
|
-
- `.
|
|
191
|
+
- `.michi/specs/{feature}/tasks.md` - タスク分割書
|
|
192
192
|
- JIRA: Epic、Story、Subtask
|
|
193
193
|
|
|
194
194
|
### Phase 0.6-0.7: JIRA/Confluence同期(Michi拡張、自動)
|
|
@@ -239,7 +239,7 @@ michi phase:run calculator-app environment-setup
|
|
|
239
239
|
/michi:spec-impl {feature} [tasks]
|
|
240
240
|
|
|
241
241
|
# cc-sdd標準
|
|
242
|
-
/
|
|
242
|
+
/michi:spec-impl {feature} [tasks]
|
|
243
243
|
```
|
|
244
244
|
|
|
245
245
|
**実行例**:
|
|
@@ -308,10 +308,10 @@ michi phase:run calculator-app phase-b
|
|
|
308
308
|
3. チェックリストを表示
|
|
309
309
|
|
|
310
310
|
**生成物**:
|
|
311
|
-
- `.
|
|
312
|
-
- `.
|
|
313
|
-
- `.
|
|
314
|
-
- `.
|
|
311
|
+
- `.michi/specs/{feature}/test-execution/integration/` - 統合テスト実行ファイル
|
|
312
|
+
- `.michi/specs/{feature}/test-execution/e2e/` - E2Eテスト実行ファイル
|
|
313
|
+
- `.michi/specs/{feature}/test-execution/performance/` - 性能テスト実行ファイル
|
|
314
|
+
- `.michi/specs/{feature}/test-execution/security/` - セキュリティテスト実行ファイル
|
|
315
315
|
|
|
316
316
|
**手動テストチェックリスト**:
|
|
317
317
|
- 性能テスト実行
|
|
@@ -331,8 +331,8 @@ michi phase:run calculator-app phase-b
|
|
|
331
331
|
|
|
332
332
|
| Phase | 必須/任意 | コマンド | 備考 |
|
|
333
333
|
|-------|----------|---------|------|
|
|
334
|
-
| 0.0 | 必須 | `/
|
|
335
|
-
| 0.1 | 必須 | `/
|
|
334
|
+
| 0.0 | 必須 | `/michi:spec-init "description"` | - |
|
|
335
|
+
| 0.1 | 必須 | `/michi:spec-requirements {feature}` | - |
|
|
336
336
|
| 0.2 | 必須 | `/michi:spec-design {feature}` | Michi推奨 |
|
|
337
337
|
| 0.3-0.4 | 任意 | `/michi:test-planning {feature}` | Michi拡張 |
|
|
338
338
|
| 0.5 | 必須 | `/michi:spec-tasks {feature}` | Michi推奨 |
|
|
@@ -6,7 +6,7 @@ AI駆動開発を支援するコマンドセットです。
|
|
|
6
6
|
|
|
7
7
|
| プレフィックス | 提供元 | 用途 |
|
|
8
8
|
|---------------|--------|------|
|
|
9
|
-
| `/
|
|
9
|
+
| `/michi:*` | cc-sdd | 基本ワークフロー |
|
|
10
10
|
| `/michi:*` | Michi | テスト計画、品質自動化 |
|
|
11
11
|
| `/michi-multi-repo:*` | Michi | Multi-Repo管理 |
|
|
12
12
|
|
|
@@ -16,21 +16,21 @@ AI駆動開発を支援するコマンドセットです。
|
|
|
16
16
|
|
|
17
17
|
| コマンド | 機能説明 | パラメータ |
|
|
18
18
|
|---------|---------|----------|
|
|
19
|
-
| `/
|
|
20
|
-
| `/
|
|
21
|
-
| `/
|
|
22
|
-
| `/
|
|
23
|
-
| `/
|
|
24
|
-
| `/
|
|
25
|
-
| `/
|
|
19
|
+
| `/michi:spec-init` | 新規仕様を初期化 | `"プロジェクト説明"` |
|
|
20
|
+
| `/michi:spec-requirements` | 要件定義を作成 | `{feature}` |
|
|
21
|
+
| `/michi:spec-design` | 設計書を作成 | `{feature}` |
|
|
22
|
+
| `/michi:spec-tasks` | タスク分割とJIRA同期 | `{feature}` |
|
|
23
|
+
| `/michi:spec-impl` | TDD実装を実行 | `{feature} [tasks]` |
|
|
24
|
+
| `/michi:spec-archive` | 仕様をアーカイブ | `{feature}` |
|
|
25
|
+
| `/michi:spec-status` | 仕様の状態を表示 | `{feature}` |
|
|
26
26
|
|
|
27
27
|
### 検証
|
|
28
28
|
|
|
29
29
|
| コマンド | 機能説明 | パラメータ |
|
|
30
30
|
|---------|---------|----------|
|
|
31
|
-
| `/
|
|
32
|
-
| `/
|
|
33
|
-
| `/
|
|
31
|
+
| `/michi:validate-gap` | 実装ギャップを分析 | `{feature}` |
|
|
32
|
+
| `/michi:validate-design` | 設計品質をレビュー | `{feature}` |
|
|
33
|
+
| `/michi:validate-impl` | 実装を検証 | `{feature}` |
|
|
34
34
|
|
|
35
35
|
## Michi拡張コマンド
|
|
36
36
|
|
|
@@ -72,7 +72,7 @@ AI駆動開発を支援するコマンドセットです。
|
|
|
72
72
|
### 通常プロジェクト
|
|
73
73
|
|
|
74
74
|
```
|
|
75
|
-
/
|
|
75
|
+
/michi:spec-init → /michi:spec-requirements → /michi:spec-design
|
|
76
76
|
→ /michi:test-planning → /michi:spec-tasks → /michi:spec-impl
|
|
77
77
|
→ /michi:confluence-sync
|
|
78
78
|
```
|