@sk8metal/michi-cli 0.10.1 → 0.12.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 (139) hide show
  1. package/README.md +71 -848
  2. package/dist/scripts/constants/environments.d.ts +1 -1
  3. package/dist/scripts/constants/environments.d.ts.map +1 -1
  4. package/dist/scripts/constants/environments.js +0 -20
  5. package/dist/scripts/constants/environments.js.map +1 -1
  6. package/dist/scripts/phase-runner.js +1 -1
  7. package/dist/scripts/phase-runner.js.map +1 -1
  8. package/dist/scripts/utils/multi-repo-validator.d.ts +18 -0
  9. package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
  10. package/dist/scripts/utils/multi-repo-validator.js +42 -0
  11. package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
  12. package/dist/scripts/utils/tasks-format-validator.js +3 -3
  13. package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
  14. package/dist/scripts/utils/template-finder.d.ts +2 -2
  15. package/dist/scripts/utils/template-finder.d.ts.map +1 -1
  16. package/dist/scripts/utils/template-finder.js +3 -8
  17. package/dist/scripts/utils/template-finder.js.map +1 -1
  18. package/dist/src/cli.d.ts.map +1 -1
  19. package/dist/src/cli.js +0 -8
  20. package/dist/src/cli.js.map +1 -1
  21. package/dist/src/commands/init.d.ts +0 -4
  22. package/dist/src/commands/init.d.ts.map +1 -1
  23. package/dist/src/commands/init.js +6 -30
  24. package/dist/src/commands/init.js.map +1 -1
  25. package/dist/src/commands/setup-existing.d.ts +2 -6
  26. package/dist/src/commands/setup-existing.d.ts.map +1 -1
  27. package/dist/src/commands/setup-existing.js +8 -142
  28. package/dist/src/commands/setup-existing.js.map +1 -1
  29. package/docs/README.md +20 -83
  30. package/docs/getting-started/configuration.md +350 -0
  31. package/docs/getting-started/installation.md +59 -0
  32. package/docs/getting-started/quick-start.md +76 -0
  33. package/docs/guides/atlassian-integration.md +116 -0
  34. package/docs/guides/claude-code.md +155 -0
  35. package/docs/guides/multi-repo.md +117 -0
  36. package/docs/guides/workflow.md +382 -0
  37. package/docs/reference/ai-commands.md +92 -0
  38. package/docs/reference/cli.md +752 -0
  39. package/docs/reference/environment-variables.md +192 -0
  40. package/docs/troubleshooting.md +498 -0
  41. package/package.json +1 -3
  42. package/scripts/__tests__/create-project.test.ts +12 -12
  43. package/scripts/__tests__/setup-existing-project.test.ts +22 -22
  44. package/scripts/constants/__tests__/environments.test.ts +7 -50
  45. package/scripts/constants/environments.ts +1 -27
  46. package/scripts/phase-runner.ts +1 -1
  47. package/scripts/template/__tests__/renderer.test.ts +21 -21
  48. package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
  49. package/scripts/utils/multi-repo-validator.ts +50 -0
  50. package/scripts/utils/tasks-format-validator.ts +3 -3
  51. package/scripts/utils/template-finder.ts +5 -11
  52. package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
  53. package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
  54. package/templates/claude/commands/michi/e2e-plan.md +1 -1
  55. package/templates/claude/commands/michi/spec-design.md +2 -2
  56. package/templates/claude/commands/michi/spec-tasks.md +156 -0
  57. package/templates/claude/commands/michi/test-planning.md +1 -1
  58. package/templates/claude/commands/michi/validate-design.md +3 -3
  59. package/templates/claude/commands/michi-multi-repo/impl-all.md +30 -1
  60. package/templates/claude/commands/michi-multi-repo/propagate-specs.md +14 -1
  61. package/templates/claude/commands/michi-multi-repo/spec-review.md +16 -2
  62. package/templates/claude-agent/agents/repo-spec-executor.md +1 -1
  63. package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
  64. package/templates/claude-agent/rules/code-size-monitor.md +26 -0
  65. package/templates/claude-agent/rules/code-size-rules.md +32 -0
  66. package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
  67. package/docs/context.md +0 -59
  68. package/docs/michi-development/contributing/development.md +0 -341
  69. package/docs/michi-development/contributing/release.md +0 -365
  70. package/docs/michi-development/design/config-unification.md +0 -733
  71. package/docs/michi-development/design/design-config-current-state.md +0 -330
  72. package/docs/michi-development/design/design-config-implementation.md +0 -628
  73. package/docs/michi-development/design/design-config-migration.md +0 -952
  74. package/docs/michi-development/design/design-config-security.md +0 -771
  75. package/docs/michi-development/design/design-config-solution.md +0 -583
  76. package/docs/michi-development/design/design-config-testing.md +0 -892
  77. package/docs/michi-development/testing/manual-verification-flow.md +0 -871
  78. package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
  79. package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
  80. package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
  81. package/docs/michi-development/testing-strategy.md +0 -87
  82. package/docs/plan.md +0 -275
  83. package/docs/user-guide/getting-started/github-token-setup.md +0 -510
  84. package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
  85. package/docs/user-guide/getting-started/quick-start.md +0 -212
  86. package/docs/user-guide/getting-started/setup.md +0 -819
  87. package/docs/user-guide/guides/agent-skills-integration.md +0 -222
  88. package/docs/user-guide/guides/customization.md +0 -537
  89. package/docs/user-guide/guides/internationalization.md +0 -540
  90. package/docs/user-guide/guides/migration-guide.md +0 -138
  91. package/docs/user-guide/guides/multi-project.md +0 -368
  92. package/docs/user-guide/guides/multi-repo-guide.md +0 -1590
  93. package/docs/user-guide/guides/phase-automation.md +0 -419
  94. package/docs/user-guide/guides/workflow.md +0 -574
  95. package/docs/user-guide/hands-on/README.md +0 -142
  96. package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
  97. package/docs/user-guide/hands-on/claude-setup.md +0 -452
  98. package/docs/user-guide/hands-on/cursor-setup.md +0 -353
  99. package/docs/user-guide/hands-on/troubleshooting.md +0 -964
  100. package/docs/user-guide/hands-on/verification-checklist.md +0 -439
  101. package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -1078
  102. package/docs/user-guide/reference/config.md +0 -589
  103. package/docs/user-guide/reference/multi-repo-api.md +0 -771
  104. package/docs/user-guide/reference/quick-reference.md +0 -297
  105. package/docs/user-guide/reference/security-test-payloads.md +0 -50
  106. package/docs/user-guide/reference/tasks-template.md +0 -550
  107. package/docs/user-guide/release/ci-setup-java.md +0 -114
  108. package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
  109. package/docs/user-guide/release/ci-setup-php.md +0 -102
  110. package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
  111. package/docs/user-guide/release/ci-setup.md +0 -188
  112. package/docs/user-guide/release/release-flow.md +0 -476
  113. package/docs/user-guide/templates/test-specs/README.md +0 -173
  114. package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
  115. package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
  116. package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
  117. package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
  118. package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
  119. package/docs/user-guide/testing/integration-tests.md +0 -312
  120. package/docs/user-guide/testing/tdd-cycle.md +0 -349
  121. package/docs/user-guide/testing/test-execution-flow.md +0 -396
  122. package/docs/user-guide/testing/test-failure-handling.md +0 -521
  123. package/docs/user-guide/testing/test-planning-flow.md +0 -185
  124. package/docs/user-guide/testing-strategy.md +0 -185
  125. package/docs/verification-guide.md +0 -518
  126. package/templates/cline/rules/atlassian-integration.md +0 -36
  127. package/templates/cline/rules/michi-core.md +0 -56
  128. package/templates/codex/AGENTS.override.md +0 -277
  129. package/templates/codex/prompts/confluence-sync.md +0 -177
  130. package/templates/codex/rules/README.md +0 -210
  131. package/templates/cursor/commands/kiro/kiro-spec-impl.md +0 -244
  132. package/templates/cursor/commands/kiro/kiro-spec-tasks.md +0 -354
  133. package/templates/cursor/commands/michi/confluence-sync.md +0 -76
  134. package/templates/cursor/commands/michi/project-switch.md +0 -69
  135. package/templates/cursor/rules/atlassian-mcp.mdc +0 -188
  136. package/templates/cursor/rules/github-ssot.mdc +0 -151
  137. package/templates/cursor/rules/multi-project.mdc +0 -81
  138. package/templates/gemini/commands/README.md +0 -41
  139. package/templates/gemini/rules/GEMINI.md +0 -80
@@ -1,297 +0,0 @@
1
- # クイックリファレンス
2
-
3
- > **凡例について**: `<feature>` などの記号の意味は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
4
-
5
- ## 新規プロジェクト作成
6
-
7
- ### 推奨: `michi init` コマンド(最も簡単 ⭐)
8
-
9
- ```bash
10
- # 既存リポジトリに移動
11
- cd /path/to/existing-repo
12
-
13
- # 1コマンドで初期設定完了
14
- michi init --michi-path /path/to/michi
15
- ```
16
-
17
- このコマンドが自動的に:
18
-
19
- - プロジェクトメタデータ(`.kiro/project.json`)を作成
20
- - 環境変数テンプレート(`.env`)を作成
21
- - 共通ルール・コマンドをコピー(`--michi-path` 指定時)
22
- - Steeringテンプレート(`.kiro/steering/`)をコピー
23
- - Specテンプレート(`.kiro/settings/templates/`)をコピー
24
- - ワークフロー設定(`.michi/config.json`)を作成
25
- - グローバル設定(`~/.michi/config.json`)があればコピー
26
- - なければ対話的に設定
27
-
28
- **オプション**:
29
-
30
- ```bash
31
- # 非対話モード(プロジェクト名とJIRAキーを指定)
32
- michi init \
33
- --name "project-id" \
34
- --project-name "プロジェクト名" \
35
- --jira-key "PRJA" \
36
- --michi-path /path/to/michi \
37
- -y
38
-
39
- # ワークフロー設定をスキップ
40
- michi init --michi-path /path/to/michi --skip-config
41
-
42
- # 環境を指定(デフォルト: Cursor)
43
- michi init --michi-path /path/to/michi --cursor
44
- michi init --michi-path /path/to/michi --claude
45
- ```
46
-
47
- **次のステップ**:
48
-
49
- 1. `.env` ファイルの内容を確認・編集
50
- 2. `.michi/config.json` の内容を確認(必要に応じて編集)
51
- 3. 開発開始: `/kiro:spec-init <機能説明>`
52
-
53
- ### 代替: 個別セットアップ
54
-
55
- グローバル設定を先に作成する場合:
56
-
57
- ```bash
58
- # 1. グローバル設定を作成(組織で一度だけ)
59
- michi config:global
60
-
61
- # 2. プロジェクト初期設定
62
- cd /path/to/project
63
- michi init --michi-path /path/to/michi
64
-
65
- # グローバル設定が自動的にコピーされます
66
- ```
67
-
68
- 詳細: [新規リポジトリセットアップガイド](../getting-started/new-repository-setup.md)
69
-
70
- ## 開発フロー
71
-
72
- 詳細なワークフローは [AI開発ワークフローガイド](./workflow.md) を参照してください。
73
-
74
- ### クイックコマンド一覧
75
-
76
- **要件定義**:
77
-
78
- ```bash
79
- /kiro:spec-init <機能説明>
80
- /kiro:spec-requirements <feature>
81
- jj commit -m "docs: 要件定義" && jj git push
82
- npx @sk8metal/michi-cli phase:run <feature> requirements
83
- ```
84
-
85
- **設計**:
86
-
87
- ```bash
88
- /kiro:spec-design <feature>
89
- jj commit -m "docs: 設計" && jj git push
90
- npx @sk8metal/michi-cli phase:run <feature> design
91
- ```
92
-
93
- **タスク分割**:
94
-
95
- ```bash
96
- /kiro:spec-tasks <feature>
97
- jj commit -m "docs: タスク分割" && jj git push
98
- npx @sk8metal/michi-cli phase:run <feature> tasks
99
- ```
100
-
101
- **実装**:
102
-
103
- ```bash
104
- /kiro:spec-impl <feature> <tasks>
105
- jj commit -m "feat: 実装 [<jira-key>-XXX]"
106
- jj bookmark create <project-id>/feature/<feature> -r '@-'
107
- jj git push --bookmark <project-id>/feature/<feature> --allow-new
108
- gh pr create --head <project-id>/feature/<feature> --base main
109
- ```
110
-
111
- ## コマンド一覧
112
-
113
- ### cc-sdd 標準コマンド
114
-
115
- | コマンド | 説明 |
116
- | ---------------------------------------- | -------------------------- |
117
- | `/kiro:spec-init <description>` | 仕様初期化 |
118
- | `/kiro:spec-requirements <feature>` | 要件定義生成 |
119
- | `/kiro:spec-design <feature>` | 設計生成(cc-sdd標準版) |
120
- | `/kiro:spec-tasks <feature>` | タスク分割 |
121
- | `/kiro:spec-impl <feature> <tasks>` | TDD実装 |
122
- | `/kiro:spec-status <feature>` | 進捗確認 |
123
- | `/kiro:steering` | Steering作成/更新 |
124
- | `/kiro:steering-custom` | カスタムSteering作成 |
125
- | `/kiro:validate-gap <feature>` | 既存コードと要件の差異分析 |
126
- | `/kiro:validate-design <feature>` | 設計の品質レビューと検証 |
127
-
128
- ### Michi 拡張コマンド
129
-
130
- > **注**: これらのコマンドは Michi 独自の拡張機能です。cc-sdd 標準には含まれません。
131
-
132
- | コマンド | 説明 |
133
- | ---------------------------------------- | ---------------------------------------------- |
134
- | `/michi:spec-design <feature>` | 設計生成(Phase 0.3-0.4 ガイダンス付き)⭐推奨 |
135
- | `/michi:validate-design <feature>` | 設計レビュー(テスト計画完了確認付き) |
136
- | `/michi:confluence-sync <feature> [type]` | Confluence同期 |
137
-
138
- ## Michi CLIコマンド一覧
139
-
140
- **使用方法**: `npx @sk8metal/michi-cli <command>` または `michi <command>`(グローバルインストール後)
141
-
142
- | コマンド | 説明 |
143
- | ------------------------------------------- | ------------------------------------------------- |
144
- | `michi init` | プロジェクト初期設定(推奨)⭐ |
145
- | `michi config:global` | グローバル設定作成(~/.michi/config.json) |
146
- | `michi jira:sync <feature>` | JIRA連携(tasks.md → Epic/Stories) |
147
- | `michi confluence:sync <feature> [type]` | Confluence同期(requirements/design) |
148
- | `michi phase:run <feature> <phase>` | フェーズ実行(requirements/design/tasks) |
149
- | `michi validate:phase <feature> <phase>` | フェーズ完了バリデーション |
150
- | `michi preflight [phase]` | プリフライトチェック |
151
- | `michi spec:list [--all]` | 仕様書一覧(--allでアーカイブも表示) |
152
- | `michi spec:archive <feature> [--reason]` | 完了した仕様書をアーカイブ |
153
- | `michi workflow:run --feature <name>` | 統合ワークフロー実行 |
154
- | `michi config:validate` | 設定ファイルのバリデーション |
155
- | `michi tasks:convert <feature>` | AI-DLC形式のtasks.mdをMichiワークフロー形式に変換 |
156
- | `michi jira:transition <issueKey> <status>` | JIRAチケットのステータス変更 |
157
- | `michi jira:comment <issueKey> <comment>` | JIRAチケットにコメント追加 |
158
- | `michi --help` | ヘルプ表示 |
159
- | `michi --version` | バージョン表示 |
160
-
161
- **インストール方法**:
162
-
163
- - **npx実行(推奨)**: `npx @sk8metal/michi-cli <command>` - 常に最新版を使用
164
- - **グローバルインストール**: `npm install -g @sk8metal/michi-cli` 後、`michi <command>`
165
- - **ローカル開発**: `npm run michi <command>` または `npx tsx src/cli.ts <command>`
166
-
167
- ## npmスクリプト一覧(michiリポジトリ内)
168
-
169
- | コマンド | 説明 |
170
- | ------------------- | --------------------- |
171
- | `npm run setup:env` | .env テンプレート作成 |
172
- | `npm run michi` | ローカルCLIツール実行 |
173
-
174
- ## 仕様書管理
175
-
176
- ### 仕様書一覧の確認
177
-
178
- ```bash
179
- # アクティブな仕様書のみ
180
- npx @sk8metal/michi-cli spec:list
181
-
182
- # アーカイブ済みも含む
183
- npx @sk8metal/michi-cli spec:list --all
184
- ```
185
-
186
- ### 完了した仕様書のアーカイブ
187
-
188
- ```bash
189
- # 基本的な使い方
190
- npx @sk8metal/michi-cli spec:archive <feature>
191
-
192
- # 理由を付けてアーカイブ
193
- npx @sk8metal/michi-cli spec:archive <feature> --reason "v1.0.0としてリリース済み"
194
- ```
195
-
196
- **アーカイブ条件**:
197
- - Phase が `implementation-complete`
198
- - `release-notes-*.md` ファイルが存在する
199
- - まだアーカイブされていない
200
-
201
- ## Git/Jujutsuコマンド
202
-
203
- ### 基本フロー
204
-
205
- ```bash
206
- # 作業開始
207
- jj new main
208
-
209
- # コミット
210
- jj commit -m "message"
211
-
212
- # ブックマーク作成(PR用)
213
- jj bookmark create <project-id>/feature/<name> -r '@-'
214
-
215
- # プッシュ
216
- jj git push --bookmark <project-id>/feature/<name> --allow-new
217
-
218
- # PR作成
219
- gh pr create --head <bookmark> --base main
220
- ```
221
-
222
- ### ブランチ命名規則
223
-
224
- ```
225
- <project-id>/feature/<feature-name>
226
- ```
227
-
228
- 例:
229
-
230
- - `michi/feature/user-auth`
231
- - `20240115-payment-api/feature/payment`
232
- - `20240310-analytics-api/feature/user-endpoint`
233
-
234
- ## トラブルシューティング
235
-
236
- ### GitHub認証エラー
237
-
238
- ```bash
239
- gh auth status
240
- gh auth login
241
- gh auth setup-git
242
- ```
243
-
244
- ### Confluence/JIRA認証エラー
245
-
246
- `.env` の認証情報を確認:
247
-
248
- ```bash
249
- cat .env | grep ATLASSIAN
250
- ```
251
-
252
- ### MCP接続エラー
253
-
254
- 1. Cursor 再起動
255
- 2. `~/.cursor/mcp.json` 確認
256
- 3. Atlassian API Token 再生成
257
-
258
- ### npm installエラー
259
-
260
- ```bash
261
- npm cache clean --force
262
- rm -rf node_modules package-lock.json
263
- npm install
264
- ```
265
-
266
- ## ファイルパス
267
-
268
- ### プロジェクトメタデータ
269
-
270
- - `.kiro/project.json`
271
-
272
- ### テンプレート
273
-
274
- - `.kiro/settings/templates/requirements.md`
275
- - `.kiro/settings/templates/design.md`
276
- - `.kiro/settings/templates/tasks.md`
277
-
278
- ### 仕様書(GitHub SSoT)
279
-
280
- - `.kiro/specs/<feature>/requirements.md`
281
- - `.kiro/specs/<feature>/design.md`
282
- - `.kiro/specs/<feature>/tasks.md`
283
-
284
- ### Steering
285
-
286
- **注意**: `/kiro:steering`コマンドで作成(セットアップ時には自動生成されません)
287
-
288
- - `.kiro/steering/product.md`
289
- - `.kiro/steering/tech.md`
290
- - `.kiro/steering/structure.md`
291
-
292
- ## 参考リンク
293
-
294
- - [セットアップガイド](./setup.md)
295
- - [新規リポジトリセットアップ](../getting-started/new-repository-setup.md)
296
- - [ワークフローガイド](./workflow.md)
297
- - [テスト・検証](./testing.md)
@@ -1,50 +0,0 @@
1
- # セキュリティテスト - 一般的な攻撃ペイロード
2
-
3
- **親ドキュメント**: [../templates/test-specs/security-test-spec-template.md](../templates/test-specs/security-test-spec-template.md)
4
-
5
- このドキュメントでは、セキュリティテストで使用される一般的な攻撃ペイロードの例を示します。
6
-
7
- ---
8
-
9
- ## Appendix B: Common Attack Payloads
10
-
11
- ### SQL Injection Payloads
12
-
13
- ```sql
14
- ' OR '1'='1' --
15
- ' OR '1'='1' /*
16
- admin' --
17
- admin' #
18
- ' UNION SELECT NULL, username, password FROM users --
19
- 1'; DROP TABLE users; --
20
- ```
21
-
22
- ### XSS Payloads
23
-
24
- ```html
25
- <script>alert('XSS')</script>
26
- <img src=x onerror=alert('XSS')>
27
- <svg onload=alert('XSS')>
28
- <iframe src="javascript:alert('XSS')">
29
- <body onload=alert('XSS')>
30
- ```
31
-
32
- ### Path Traversal Payloads
33
-
34
- ```text
35
- ../../etc/passwd
36
- ....//....//etc/passwd
37
- ..%2F..%2Fetc%2Fpasswd
38
- ..%252F..%252Fetc%252Fpasswd
39
- ```
40
-
41
- ### LDAP Injection Payloads
42
-
43
- ```text
44
- *)(uid=*))(|(uid=*
45
- admin)(&(password=*))
46
- *)(objectClass=*)
47
- ```
48
-
49
- ---
50
-