@sk8metal/michi-cli 0.8.7 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/CHANGELOG.md +70 -1
  2. package/README.md +77 -847
  3. package/dist/scripts/config/config-schema.d.ts +3 -0
  4. package/dist/scripts/config/config-schema.d.ts.map +1 -1
  5. package/dist/scripts/config/config-schema.js +18 -0
  6. package/dist/scripts/config/config-schema.js.map +1 -1
  7. package/dist/scripts/phase-runner.js +1 -1
  8. package/dist/scripts/phase-runner.js.map +1 -1
  9. package/dist/scripts/utils/multi-repo-validator.d.ts +38 -1
  10. package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
  11. package/dist/scripts/utils/multi-repo-validator.js +166 -1
  12. package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
  13. package/dist/scripts/utils/tasks-format-validator.js +3 -3
  14. package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
  15. package/docs/README.md +20 -83
  16. package/docs/getting-started/configuration.md +379 -0
  17. package/docs/getting-started/installation.md +59 -0
  18. package/docs/getting-started/quick-start.md +76 -0
  19. package/docs/guides/ai-tools.md +311 -0
  20. package/docs/guides/atlassian-integration.md +116 -0
  21. package/docs/guides/claude-code.md +155 -0
  22. package/docs/guides/multi-repo.md +117 -0
  23. package/docs/guides/workflow.md +382 -0
  24. package/docs/reference/ai-commands.md +92 -0
  25. package/docs/reference/cli.md +756 -0
  26. package/docs/reference/environment-variables.md +192 -0
  27. package/docs/troubleshooting.md +543 -0
  28. package/package.json +1 -1
  29. package/scripts/__tests__/multi-repo-config-schema.test.ts +106 -0
  30. package/scripts/__tests__/multi-repo-validator.test.ts +229 -1
  31. package/scripts/config/config-schema.ts +20 -0
  32. package/scripts/phase-runner.ts +1 -1
  33. package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
  34. package/scripts/utils/multi-repo-validator.ts +210 -1
  35. package/scripts/utils/tasks-format-validator.ts +3 -3
  36. package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
  37. package/templates/claude/agents/mermaid-validator/AGENT.md +257 -0
  38. package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
  39. package/templates/claude/commands/michi/e2e-plan.md +1 -1
  40. package/templates/claude/commands/michi/spec-design.md +2 -2
  41. package/templates/claude/commands/michi/spec-tasks.md +156 -0
  42. package/templates/claude/commands/michi/test-planning.md +1 -1
  43. package/templates/claude/commands/michi/validate-design.md +3 -3
  44. package/templates/claude/commands/michi-multi-repo/impl-all.md +293 -0
  45. package/templates/claude/commands/michi-multi-repo/propagate-specs.md +284 -0
  46. package/templates/claude/commands/michi-multi-repo/spec-design.md +66 -3
  47. package/templates/claude/commands/michi-multi-repo/spec-review.md +261 -0
  48. package/templates/claude/skills/mermaid-validator/SKILL.md +261 -0
  49. package/templates/claude-agent/agents/cross-repo-reviewer.md +194 -0
  50. package/templates/claude-agent/agents/repo-spec-executor.md +113 -0
  51. package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
  52. package/templates/claude-agent/rules/code-size-monitor.md +26 -0
  53. package/templates/claude-agent/rules/code-size-rules.md +32 -0
  54. package/templates/codex/AGENTS.override.md +1 -1
  55. package/templates/codex/rules/README.md +2 -2
  56. package/templates/cursor/commands/michi/spec-tasks.md +117 -0
  57. package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
  58. package/docs/context.md +0 -59
  59. package/docs/michi-development/contributing/development.md +0 -341
  60. package/docs/michi-development/contributing/release.md +0 -365
  61. package/docs/michi-development/design/config-unification.md +0 -733
  62. package/docs/michi-development/design/design-config-current-state.md +0 -330
  63. package/docs/michi-development/design/design-config-implementation.md +0 -628
  64. package/docs/michi-development/design/design-config-migration.md +0 -952
  65. package/docs/michi-development/design/design-config-security.md +0 -771
  66. package/docs/michi-development/design/design-config-solution.md +0 -583
  67. package/docs/michi-development/design/design-config-testing.md +0 -892
  68. package/docs/michi-development/testing/manual-verification-flow.md +0 -871
  69. package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
  70. package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
  71. package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
  72. package/docs/michi-development/testing-strategy.md +0 -87
  73. package/docs/plan.md +0 -275
  74. package/docs/user-guide/getting-started/github-token-setup.md +0 -510
  75. package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
  76. package/docs/user-guide/getting-started/quick-start.md +0 -212
  77. package/docs/user-guide/getting-started/setup.md +0 -819
  78. package/docs/user-guide/guides/agent-skills-integration.md +0 -222
  79. package/docs/user-guide/guides/customization.md +0 -537
  80. package/docs/user-guide/guides/internationalization.md +0 -540
  81. package/docs/user-guide/guides/migration-guide.md +0 -138
  82. package/docs/user-guide/guides/multi-project.md +0 -368
  83. package/docs/user-guide/guides/multi-repo-guide.md +0 -1147
  84. package/docs/user-guide/guides/phase-automation.md +0 -419
  85. package/docs/user-guide/guides/workflow.md +0 -584
  86. package/docs/user-guide/hands-on/README.md +0 -142
  87. package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
  88. package/docs/user-guide/hands-on/claude-setup.md +0 -452
  89. package/docs/user-guide/hands-on/cursor-setup.md +0 -353
  90. package/docs/user-guide/hands-on/troubleshooting.md +0 -964
  91. package/docs/user-guide/hands-on/verification-checklist.md +0 -439
  92. package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -909
  93. package/docs/user-guide/reference/config.md +0 -589
  94. package/docs/user-guide/reference/multi-repo-api.md +0 -771
  95. package/docs/user-guide/reference/quick-reference.md +0 -297
  96. package/docs/user-guide/reference/security-test-payloads.md +0 -50
  97. package/docs/user-guide/reference/tasks-template.md +0 -550
  98. package/docs/user-guide/release/ci-setup-java.md +0 -114
  99. package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
  100. package/docs/user-guide/release/ci-setup-php.md +0 -102
  101. package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
  102. package/docs/user-guide/release/ci-setup.md +0 -188
  103. package/docs/user-guide/release/release-flow.md +0 -476
  104. package/docs/user-guide/templates/test-specs/README.md +0 -173
  105. package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
  106. package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
  107. package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
  108. package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
  109. package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
  110. package/docs/user-guide/testing/integration-tests.md +0 -312
  111. package/docs/user-guide/testing/tdd-cycle.md +0 -349
  112. package/docs/user-guide/testing/test-execution-flow.md +0 -396
  113. package/docs/user-guide/testing/test-failure-handling.md +0 -521
  114. package/docs/user-guide/testing/test-planning-flow.md +0 -185
  115. package/docs/user-guide/testing-strategy.md +0 -185
  116. package/docs/verification-guide.md +0 -518
@@ -1,212 +0,0 @@
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
- cc-sddは、Michiの仕様駆動開発ワークフローのコアフレームワークです。
26
-
27
- ### 推奨ワークフロー(cc-sdd準拠)
28
-
29
- 既存リポジトリにMichiを導入する標準的な3ステップ:
30
-
31
- ```bash
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(推奨)
47
- npx cc-sdd@latest --lang ja --cursor
48
-
49
- # Claude Code
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
60
- ```
61
-
62
- **重要**: Step 2で `npx @sk8metal/michi-cli setup-existing` を実行すると、テンプレートがNPMパッケージから自動的にコピーされます。git clone不要です。
63
-
64
- 詳細な手順は [セットアップガイド](./setup.md#step-25-推奨ワークフローcc-sdd--michi) を参照してください。
65
-
66
- ## 3. 環境変数を設定
67
-
68
- 最小限の設定で始める場合:
69
-
70
- ```bash
71
- # プロジェクトディレクトリに移動
72
- cd your-project
73
-
74
- # .envファイルを作成
75
- cat > .env <<EOF
76
- # GitHub設定(必須)
77
- GITHUB_TOKEN=your-github-token
78
- GITHUB_ORG=your-org
79
- # Note: リポジトリ情報は .kiro/project.json の repository フィールドで管理されます
80
-
81
- # JIRA設定(オプション)
82
- ATLASSIAN_URL=https://your-domain.atlassian.net
83
- ATLASSIAN_EMAIL=your-email@company.com
84
- ATLASSIAN_API_TOKEN=your-token
85
- JIRA_PROJECT_KEYS=YOUR_PROJECT
86
-
87
- # JIRA Issue Type IDs(JIRAインスタンス固有 - 必須)
88
- JIRA_ISSUE_TYPE_STORY=10036
89
- JIRA_ISSUE_TYPE_SUBTASK=10037
90
- EOF
91
- ```
92
-
93
- 詳細な設定方法は、[セットアップガイド](./setup.md#3-環境変数の設定)を参照してください。
94
-
95
- ## 4. 最初の機能を作成
96
-
97
- Cursor/VS CodeでAIコマンドを実行:
98
-
99
- ```
100
- /kiro:spec-init ユーザー認証機能
101
- ```
102
-
103
- これにより、`.kiro/specs/user-authentication/`ディレクトリが作成され、以下が自動生成されます:
104
-
105
- - `requirements.md`: 要件定義
106
- - `spec.json`: 機能メタデータ
107
-
108
- ## 5. 設計を作成
109
-
110
- ```
111
- /kiro:spec-design user-authentication
112
- ```
113
-
114
- これにより、`design.md`が生成されます。
115
-
116
- ## 6. タスクを作成
117
-
118
- ```
119
- /kiro:spec-tasks user-authentication
120
- ```
121
-
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
- このコマンドにより、以下が自動実行されます:
131
-
132
- - Confluenceページの自動作成(要件・設計)
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
- ```
147
-
148
- ## 7. 実装を開始
149
-
150
- ```
151
- /kiro:spec-impl user-authentication task-1
152
- ```
153
-
154
- TDD(テスト駆動開発)で実装が進められます。
155
-
156
- ## 8. テストを作成(オプション)
157
-
158
- Phase Bテスト(手動回帰、負荷、セキュリティ)を対話的に作成できます:
159
-
160
- ```bash
161
- npm run test:interactive
162
- ```
163
-
164
- 対話的に以下の情報を入力すると、テストファイルが自動生成されます:
165
- - テストタイプ(手動回帰/負荷/セキュリティ)
166
- - 対象エンドポイント
167
- - 期待するレスポンス
168
- - テスト条件
169
-
170
- 詳細は [テスト計画フロー](../testing/test-planning-flow.md) を参照してください。
171
-
172
- ## 次のステップ
173
-
174
- ### より詳しく学ぶ
175
-
176
- - [ワークフローガイド](../guides/workflow.md) - AI開発フローの詳細
177
- - [フェーズ自動化ガイド](../guides/phase-automation.md) - Confluence/JIRA自動化
178
- - [クイックリファレンス](../reference/quick-reference.md) - コマンド一覧
179
-
180
- ### 高度な設定
181
-
182
- - [カスタマイズガイド](../guides/customization.md) - Confluence/JIRA階層のカスタマイズ
183
- - [設定値リファレンス](../reference/config.md) - `.michi/config.json`の全設定値
184
-
185
- ### 複数プロジェクトの管理
186
-
187
- - [マルチプロジェクト管理](../guides/multi-project.md) - 3-5プロジェクトの同時管理
188
-
189
- ## トラブルシューティング
190
-
191
- ### GitHub Tokenが無効
192
-
193
- ```bash
194
- gh auth login
195
- gh auth token
196
- ```
197
-
198
- ### JIRA Issue Type IDが不明
199
-
200
- ```bash
201
- # REST APIで確認
202
- curl -u your-email@company.com:your-token \
203
- https://your-domain.atlassian.net/rest/api/3/issuetype
204
- ```
205
-
206
- ### コマンドが見つからない
207
-
208
- Cursor/VS Codeを再起動してください。
209
-
210
- ## ヘルプ
211
-
212
- 質問がある場合は、[issue](https://github.com/sk8metalme/michi/issues)を作成してください。