@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.
- package/CHANGELOG.md +70 -1
- package/README.md +77 -847
- package/dist/scripts/config/config-schema.d.ts +3 -0
- package/dist/scripts/config/config-schema.d.ts.map +1 -1
- package/dist/scripts/config/config-schema.js +18 -0
- package/dist/scripts/config/config-schema.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 +38 -1
- package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.js +166 -1
- 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/docs/README.md +20 -83
- package/docs/getting-started/configuration.md +379 -0
- package/docs/getting-started/installation.md +59 -0
- package/docs/getting-started/quick-start.md +76 -0
- package/docs/guides/ai-tools.md +311 -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 +756 -0
- package/docs/reference/environment-variables.md +192 -0
- package/docs/troubleshooting.md +543 -0
- package/package.json +1 -1
- package/scripts/__tests__/multi-repo-config-schema.test.ts +106 -0
- package/scripts/__tests__/multi-repo-validator.test.ts +229 -1
- package/scripts/config/config-schema.ts +20 -0
- package/scripts/phase-runner.ts +1 -1
- package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
- package/scripts/utils/multi-repo-validator.ts +210 -1
- package/scripts/utils/tasks-format-validator.ts +3 -3
- package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
- package/templates/claude/agents/mermaid-validator/AGENT.md +257 -0
- 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 +293 -0
- package/templates/claude/commands/michi-multi-repo/propagate-specs.md +284 -0
- package/templates/claude/commands/michi-multi-repo/spec-design.md +66 -3
- package/templates/claude/commands/michi-multi-repo/spec-review.md +261 -0
- package/templates/claude/skills/mermaid-validator/SKILL.md +261 -0
- package/templates/claude-agent/agents/cross-repo-reviewer.md +194 -0
- package/templates/claude-agent/agents/repo-spec-executor.md +113 -0
- 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/codex/AGENTS.override.md +1 -1
- package/templates/codex/rules/README.md +2 -2
- package/templates/cursor/commands/michi/spec-tasks.md +117 -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 -1147
- package/docs/user-guide/guides/phase-automation.md +0 -419
- package/docs/user-guide/guides/workflow.md +0 -584
- 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 -909
- 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
|
@@ -1,142 +0,0 @@
|
|
|
1
|
-
# Michiハンズオンガイド
|
|
2
|
-
|
|
3
|
-
Michiを実際に使って、セットアップから実装・PR作成まで全ワークフローを体験するハンズオンガイドです。
|
|
4
|
-
|
|
5
|
-
## 🎯 このガイドの目的
|
|
6
|
-
|
|
7
|
-
- Michiの全ワークフローを実際に体験する
|
|
8
|
-
- cc-sddとMichiの統合方法を理解する
|
|
9
|
-
- Confluence/JIRA連携の動作を確認する
|
|
10
|
-
- 実際のプロジェクトで使えるスキルを習得する
|
|
11
|
-
|
|
12
|
-
## 📚 ガイドの構成
|
|
13
|
-
|
|
14
|
-
### 1. 環境別セットアップガイド
|
|
15
|
-
|
|
16
|
-
ご利用の環境に応じて、以下のいずれかを選択してください:
|
|
17
|
-
|
|
18
|
-
- **[Cursor IDEセットアップガイド](./cursor-setup.md)** (推奨)
|
|
19
|
-
- Cursor IDEを使用している場合
|
|
20
|
-
- GUI操作が中心で、初心者にも優しい
|
|
21
|
-
|
|
22
|
-
- **[Claude Codeセットアップガイド](./claude-setup.md)**
|
|
23
|
-
- Claude Codeを使用している場合
|
|
24
|
-
- コマンドライン操作が中心
|
|
25
|
-
|
|
26
|
-
- **[Claude Subagentsセットアップガイド](./claude-agent-setup.md)**
|
|
27
|
-
- Claude Subagentsを使用している場合
|
|
28
|
-
- マルチエージェント開発環境
|
|
29
|
-
|
|
30
|
-
### 2. ワークフロー体験ガイド
|
|
31
|
-
|
|
32
|
-
環境のセットアップが完了したら、こちらで実際の開発フローを体験してください:
|
|
33
|
-
|
|
34
|
-
- **[ワークフロー体験ガイド](./workflow-walkthrough.md)** ⭐
|
|
35
|
-
- サンプル機能(`health-check-endpoint`)を使った実践
|
|
36
|
-
- spec-init → requirements → design → tasks → 実装の流れ
|
|
37
|
-
- Confluence/JIRA連携の確認
|
|
38
|
-
|
|
39
|
-
### 3. 検証・トラブルシューティング
|
|
40
|
-
|
|
41
|
-
作業中の確認や問題解決に使用してください:
|
|
42
|
-
|
|
43
|
-
- **[検証チェックリスト](./verification-checklist.md)**
|
|
44
|
-
- 各ステップの成功確認項目
|
|
45
|
-
- 生成物の確認方法
|
|
46
|
-
|
|
47
|
-
- **[トラブルシューティング](./troubleshooting.md)**
|
|
48
|
-
- よくある問題と解決策
|
|
49
|
-
- エラーメッセージの対処法
|
|
50
|
-
|
|
51
|
-
## ⏱️ 所要時間
|
|
52
|
-
|
|
53
|
-
- **セットアップ**: 15-20分
|
|
54
|
-
- **ワークフロー体験**: 30-40分
|
|
55
|
-
- **合計**: 約1時間
|
|
56
|
-
|
|
57
|
-
## 📋 前提条件
|
|
58
|
-
|
|
59
|
-
以下がインストール済みであることを確認してください:
|
|
60
|
-
|
|
61
|
-
- Node.js 20.x以上
|
|
62
|
-
- npm 10.x以上
|
|
63
|
-
- Git(または Jujutsu (jj))
|
|
64
|
-
- GitHub CLI (gh)
|
|
65
|
-
- Cursor IDE / VS Code / Claude Code(いずれか)
|
|
66
|
-
|
|
67
|
-
## 🚀 始め方
|
|
68
|
-
|
|
69
|
-
### Step 1: 環境を選択
|
|
70
|
-
|
|
71
|
-
使用するIDE/ツールに応じたセットアップガイドを選択してください:
|
|
72
|
-
|
|
73
|
-
- [Cursor IDE](./cursor-setup.md) 👈 初めての方におすすめ
|
|
74
|
-
- [Claude Code](./claude-setup.md)
|
|
75
|
-
- [Claude Subagents](./claude-agent-setup.md)
|
|
76
|
-
|
|
77
|
-
### Step 2: ワークフロー体験
|
|
78
|
-
|
|
79
|
-
セットアップが完了したら、[ワークフロー体験ガイド](./workflow-walkthrough.md)に進んでください。
|
|
80
|
-
|
|
81
|
-
### Step 3: 実践
|
|
82
|
-
|
|
83
|
-
ハンズオンで学んだ内容を実際のプロジェクトで応用してください。
|
|
84
|
-
|
|
85
|
-
## 💡 サンプル機能について
|
|
86
|
-
|
|
87
|
-
このハンズオンでは、`health-check-endpoint`という機能を例に使用します。
|
|
88
|
-
|
|
89
|
-
**機能概要**: アプリケーションの稼働状況を確認するHTTPエンドポイント
|
|
90
|
-
|
|
91
|
-
**選定理由**:
|
|
92
|
-
- シンプルで理解しやすい
|
|
93
|
-
- 実装が少ない(検証が容易)
|
|
94
|
-
- 実際のプロジェクトでもよく使われる機能
|
|
95
|
-
|
|
96
|
-
## 📖 関連ドキュメント
|
|
97
|
-
|
|
98
|
-
ハンズオン完了後、さらに詳しく学びたい方は以下をご覧ください:
|
|
99
|
-
|
|
100
|
-
### 基礎ガイド
|
|
101
|
-
- [クイックスタート](../getting-started/quick-start.md) - 5分で始める
|
|
102
|
-
- [セットアップガイド](../getting-started/setup.md) - 詳細なインストール手順
|
|
103
|
-
|
|
104
|
-
### 実践ガイド
|
|
105
|
-
- [ワークフローガイド](../guides/workflow.md) - 全フェーズの詳細解説
|
|
106
|
-
- [フェーズ自動化ガイド](../guides/phase-automation.md) - Confluence/JIRA自動化
|
|
107
|
-
- [マルチプロジェクト管理](../guides/multi-project.md) - 複数プロジェクトの同時管理
|
|
108
|
-
|
|
109
|
-
### リファレンス
|
|
110
|
-
- [クイックリファレンス](../reference/quick-reference.md) - コマンド一覧
|
|
111
|
-
- [設定値リファレンス](../reference/config.md) - `.michi/config.json`の全設定
|
|
112
|
-
|
|
113
|
-
## 🆘 サポート
|
|
114
|
-
|
|
115
|
-
質問や問題がある場合は、以下をご利用ください:
|
|
116
|
-
|
|
117
|
-
- [トラブルシューティングガイド](./troubleshooting.md)
|
|
118
|
-
- [GitHubイシュー](https://github.com/sk8metalme/michi/issues)
|
|
119
|
-
- [メインREADME](../../README.md)
|
|
120
|
-
|
|
121
|
-
## 🎓 学習の進め方
|
|
122
|
-
|
|
123
|
-
1. **まずはセットアップ**: 環境別ガイドを1つ選んで完了させる
|
|
124
|
-
2. **ワークフロー体験**: サンプル機能で全体の流れを理解
|
|
125
|
-
3. **検証チェック**: 各ステップで正しく動作しているか確認
|
|
126
|
-
4. **実践**: 実際のプロジェクトで適用
|
|
127
|
-
|
|
128
|
-
## ✨ このガイドで学べること
|
|
129
|
-
|
|
130
|
-
- ✅ Michiの基本的なセットアップ方法
|
|
131
|
-
- ✅ cc-sddとMichiの連携方法
|
|
132
|
-
- ✅ AI駆動開発ワークフローの全体像
|
|
133
|
-
- ✅ Confluence/JIRA自動連携の仕組み
|
|
134
|
-
- ✅ phase:runコマンドの使い方
|
|
135
|
-
- ✅ 実際のプロジェクトへの適用方法
|
|
136
|
-
|
|
137
|
-
それでは、始めましょう! 🚀
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|