@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.
- package/README.md +71 -848
- package/dist/scripts/constants/environments.d.ts +1 -1
- package/dist/scripts/constants/environments.d.ts.map +1 -1
- package/dist/scripts/constants/environments.js +0 -20
- package/dist/scripts/constants/environments.js.map +1 -1
- package/dist/scripts/phase-runner.js +1 -1
- package/dist/scripts/phase-runner.js.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.d.ts +18 -0
- package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.js +42 -0
- package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
- package/dist/scripts/utils/tasks-format-validator.js +3 -3
- package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
- package/dist/scripts/utils/template-finder.d.ts +2 -2
- package/dist/scripts/utils/template-finder.d.ts.map +1 -1
- package/dist/scripts/utils/template-finder.js +3 -8
- package/dist/scripts/utils/template-finder.js.map +1 -1
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +0 -8
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/init.d.ts +0 -4
- package/dist/src/commands/init.d.ts.map +1 -1
- package/dist/src/commands/init.js +6 -30
- package/dist/src/commands/init.js.map +1 -1
- package/dist/src/commands/setup-existing.d.ts +2 -6
- package/dist/src/commands/setup-existing.d.ts.map +1 -1
- package/dist/src/commands/setup-existing.js +8 -142
- package/dist/src/commands/setup-existing.js.map +1 -1
- package/docs/README.md +20 -83
- package/docs/getting-started/configuration.md +350 -0
- package/docs/getting-started/installation.md +59 -0
- package/docs/getting-started/quick-start.md +76 -0
- package/docs/guides/atlassian-integration.md +116 -0
- package/docs/guides/claude-code.md +155 -0
- package/docs/guides/multi-repo.md +117 -0
- package/docs/guides/workflow.md +382 -0
- package/docs/reference/ai-commands.md +92 -0
- package/docs/reference/cli.md +752 -0
- package/docs/reference/environment-variables.md +192 -0
- package/docs/troubleshooting.md +498 -0
- package/package.json +1 -3
- package/scripts/__tests__/create-project.test.ts +12 -12
- package/scripts/__tests__/setup-existing-project.test.ts +22 -22
- package/scripts/constants/__tests__/environments.test.ts +7 -50
- package/scripts/constants/environments.ts +1 -27
- package/scripts/phase-runner.ts +1 -1
- package/scripts/template/__tests__/renderer.test.ts +21 -21
- package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
- package/scripts/utils/multi-repo-validator.ts +50 -0
- package/scripts/utils/tasks-format-validator.ts +3 -3
- package/scripts/utils/template-finder.ts +5 -11
- package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
- package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
- package/templates/claude/commands/michi/e2e-plan.md +1 -1
- package/templates/claude/commands/michi/spec-design.md +2 -2
- package/templates/claude/commands/michi/spec-tasks.md +156 -0
- package/templates/claude/commands/michi/test-planning.md +1 -1
- package/templates/claude/commands/michi/validate-design.md +3 -3
- package/templates/claude/commands/michi-multi-repo/impl-all.md +30 -1
- package/templates/claude/commands/michi-multi-repo/propagate-specs.md +14 -1
- package/templates/claude/commands/michi-multi-repo/spec-review.md +16 -2
- package/templates/claude-agent/agents/repo-spec-executor.md +1 -1
- package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
- package/templates/claude-agent/rules/code-size-monitor.md +26 -0
- package/templates/claude-agent/rules/code-size-rules.md +32 -0
- package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
- package/docs/context.md +0 -59
- package/docs/michi-development/contributing/development.md +0 -341
- package/docs/michi-development/contributing/release.md +0 -365
- package/docs/michi-development/design/config-unification.md +0 -733
- package/docs/michi-development/design/design-config-current-state.md +0 -330
- package/docs/michi-development/design/design-config-implementation.md +0 -628
- package/docs/michi-development/design/design-config-migration.md +0 -952
- package/docs/michi-development/design/design-config-security.md +0 -771
- package/docs/michi-development/design/design-config-solution.md +0 -583
- package/docs/michi-development/design/design-config-testing.md +0 -892
- package/docs/michi-development/testing/manual-verification-flow.md +0 -871
- package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
- package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
- package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
- package/docs/michi-development/testing-strategy.md +0 -87
- package/docs/plan.md +0 -275
- package/docs/user-guide/getting-started/github-token-setup.md +0 -510
- package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
- package/docs/user-guide/getting-started/quick-start.md +0 -212
- package/docs/user-guide/getting-started/setup.md +0 -819
- package/docs/user-guide/guides/agent-skills-integration.md +0 -222
- package/docs/user-guide/guides/customization.md +0 -537
- package/docs/user-guide/guides/internationalization.md +0 -540
- package/docs/user-guide/guides/migration-guide.md +0 -138
- package/docs/user-guide/guides/multi-project.md +0 -368
- package/docs/user-guide/guides/multi-repo-guide.md +0 -1590
- package/docs/user-guide/guides/phase-automation.md +0 -419
- package/docs/user-guide/guides/workflow.md +0 -574
- package/docs/user-guide/hands-on/README.md +0 -142
- package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
- package/docs/user-guide/hands-on/claude-setup.md +0 -452
- package/docs/user-guide/hands-on/cursor-setup.md +0 -353
- package/docs/user-guide/hands-on/troubleshooting.md +0 -964
- package/docs/user-guide/hands-on/verification-checklist.md +0 -439
- package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -1078
- package/docs/user-guide/reference/config.md +0 -589
- package/docs/user-guide/reference/multi-repo-api.md +0 -771
- package/docs/user-guide/reference/quick-reference.md +0 -297
- package/docs/user-guide/reference/security-test-payloads.md +0 -50
- package/docs/user-guide/reference/tasks-template.md +0 -550
- package/docs/user-guide/release/ci-setup-java.md +0 -114
- package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
- package/docs/user-guide/release/ci-setup-php.md +0 -102
- package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
- package/docs/user-guide/release/ci-setup.md +0 -188
- package/docs/user-guide/release/release-flow.md +0 -476
- package/docs/user-guide/templates/test-specs/README.md +0 -173
- package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
- package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
- package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
- package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
- package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
- package/docs/user-guide/testing/integration-tests.md +0 -312
- package/docs/user-guide/testing/tdd-cycle.md +0 -349
- package/docs/user-guide/testing/test-execution-flow.md +0 -396
- package/docs/user-guide/testing/test-failure-handling.md +0 -521
- package/docs/user-guide/testing/test-planning-flow.md +0 -185
- package/docs/user-guide/testing-strategy.md +0 -185
- package/docs/verification-guide.md +0 -518
- package/templates/cline/rules/atlassian-integration.md +0 -36
- package/templates/cline/rules/michi-core.md +0 -56
- package/templates/codex/AGENTS.override.md +0 -277
- package/templates/codex/prompts/confluence-sync.md +0 -177
- package/templates/codex/rules/README.md +0 -210
- package/templates/cursor/commands/kiro/kiro-spec-impl.md +0 -244
- package/templates/cursor/commands/kiro/kiro-spec-tasks.md +0 -354
- package/templates/cursor/commands/michi/confluence-sync.md +0 -76
- package/templates/cursor/commands/michi/project-switch.md +0 -69
- package/templates/cursor/rules/atlassian-mcp.mdc +0 -188
- package/templates/cursor/rules/github-ssot.mdc +0 -151
- package/templates/cursor/rules/multi-project.mdc +0 -81
- package/templates/gemini/commands/README.md +0 -41
- package/templates/gemini/rules/GEMINI.md +0 -80
|
@@ -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)を作成してください。
|