@sk8metal/michi-cli 0.10.1 → 0.12.0

package/docs/getting-started/quick-start.md

@@ -0,0 +1,76 @@
+# 5分で始めるMichi
+
+Michiをインストールして、最初のプロジェクトを初期化するまでの最短ガイドです。
+
+## 前提条件
+
+- Node.js 20以上
+- npm 10以上
+- AIツール（Claude Code）
+
+## インストール
+
+```bash
+npm install -g @sk8metal/michi-cli
+```
+
+## グローバル設定（推奨）
+
+新しいプロジェクトで作業を開始する前に、グローバル設定を行うことを推奨します。
+
+グローバル設定ディレクトリを作成します：
+
+```bash
+mkdir -p ~/.michi
+```
+
+その後、`~/.michi/config.json` と `~/.michi/.env` を手動で作成し、共通設定を記述します。
+
+**メリット**: すべてのプロジェクトで共通の設定を一度だけ定義でき、新しいプロジェクトでも即座に利用可能になります。
+
+詳細は [環境設定ガイド - グローバル設定](configuration.md#グローバル設定michichconfigjson) を参照してください。
+
+## プロジェクト初期化
+
+### 新規プロジェクトの場合
+
+```bash
+michi init --claude-agent
+```
+
+### 既存プロジェクトの場合
+
+プロジェクトディレクトリで実行：
+
+```bash
+michi init --existing --claude-agent
+```
+
+**注**: `--claude-agent` は環境オプションです（推奨）。他に `--claude` も選択可能です。
+
+## 環境設定
+
+プロジェクトの `.env` ファイルを編集して、認証情報を設定します：
+
+```bash
+ATLASSIAN_URL=https://your-domain.atlassian.net
+ATLASSIAN_EMAIL=your-email@company.com
+ATLASSIAN_API_TOKEN=your-token-here
+```
+
+**ヒント**: 複数プロジェクトで共通の認証情報を使う場合は、グローバル環境変数（`~/.michi/.env`）の利用も検討してください。
+
+詳細は [環境設定ガイド](configuration.md) を参照してください。
+
+## 初回確認
+
+事前チェックを実行して、設定が正しいことを確認します：
+
+```bash
+michi preflight
+```
+
+## 次のステップ
+
+- [環境設定の詳細](configuration.md) - JIRA Issue Type IDなどの詳細設定
+- [CLIコマンドリファレンス](../reference/cli.md) - 使用可能なコマンド一覧

package/docs/guides/atlassian-integration.md

@@ -0,0 +1,116 @@
+# Atlassian連携ガイド
+
+JIRA と Confluence との連携機能を説明します。
+
+## 前提条件
+
+### 環境変数の設定
+
+以下の環境変数が必要です。
+
+**必須**:
+- `ATLASSIAN_URL` - Atlassianドメイン（例: `https://your-domain.atlassian.net`）
+- `ATLASSIAN_EMAIL` - Atlassianアカウントのメールアドレス
+- `ATLASSIAN_API_TOKEN` - Atlassian APIトークン
+
+**オプション**:
+- `CONFLUENCE_PRD_SPACE` - Confluenceスペースキー（デフォルト: PRD）
+
+**APIトークン取得**: https://id.atlassian.com/manage-profile/security/api-tokens から取得します。
+
+**設定方法**: `.env` または `~/.michi/.env` ファイルでの設定方法と優先順位については、[環境変数リファレンス](../reference/environment-variables.md) を参照してください。
+
+## Confluence同期
+
+### 基本的な使い方
+
+```bash
+michi confluence:sync my-feature              # 要件定義
+michi confluence:sync my-feature design       # 設計書
+michi confluence:sync my-feature tasks        # タスク
+```
+
+### 設定
+
+`.michi/config.json` でカスタマイズできます。
+
+```json
+{
+  "confluence": {
+    "spaces": {
+      "requirements": "PRD",
+      "design": "TECH"
+    },
+    "pageCreationGranularity": "hierarchical",
+    "autoLabels": ["{projectLabel}", "{docType}", "github-sync"]
+  }
+}
+```
+
+**pageCreationGranularity**:
+- `single`: 1ページ（デフォルト）
+- `hierarchical`: 見出しごとに子ページ
+
+### レートリミット
+
+```bash
+export ATLASSIAN_REQUEST_DELAY=1000  # ミリ秒
+```
+
+## JIRA同期
+
+### 基本的な使い方
+
+```bash
+michi jira:sync my-feature
+```
+
+### Story詳細設定
+
+```markdown
+### Story 1.1: ユーザー認証
+
+**説明**: OAuth2認証の実装
+**優先度**: High
+**見積もり**: 5 SP
+**期限**: 2025-01-15
+
+**完了条件**:
+- [ ] OAuth2認証フロー
+- [ ] トークン管理
+
+**依存関係**: DB設計完了
+```
+
+### その他の操作
+
+```bash
+michi jira:transition PROJ-123 "In Progress"
+michi jira:comment PROJ-123 "実装完了"
+```
+
+## トラブルシューティング
+
+### Epic Linkが設定されない
+
+```bash
+export JIRA_EPIC_LINK_FIELD=customfield_10014
+```
+
+### Story Pointsが設定されない
+
+```bash
+export JIRA_STORY_POINTS_FIELD=customfield_10016
+```
+
+### APIレート制限エラー
+
+```bash
+export ATLASSIAN_REQUEST_DELAY=2000
+```
+
+## 関連リンク
+
+- [設定ガイド](configuration.md)
+- [ワークフローガイド](workflow.md)
+- [Multi-Repoガイド](multi-repo.md)

package/docs/guides/claude-code.md

@@ -0,0 +1,155 @@
+# Claude Code セットアップガイド
+
+Michiは、Claude Codeを第一級のAI開発ツールとしてサポートしています。このガイドでは、Claude CodeでMichiを使用するためのセットアップと基本的な使い方を説明します。
+
+## Claude Codeとは
+
+Claude Codeは、Anthropic社が提供する公式CLI（コマンドラインインターフェース）です。プロジェクトのコンテキストを理解し、コード生成、ドキュメント作成、テスト駆動開発をサポートします。
+
+**主な特徴**:
+- プロジェクト固有のルール（CLAUDE.md）による動作制御
+- カスタムコマンド、スキル、サブエージェントの拡張機能
+- cc-sdd（Spec-Driven Development Core）との統合
+
+## セットアップ手順
+
+### 1. cc-sddのインストール
+
+Michiは、cc-sddを基盤フレームワークとして使用します。以下のコマンドでcc-sddをインストールしてください。
+
+```bash
+npx cc-sdd@latest --claude-agent --lang ja
+```
+
+**生成されるファイル**:
+- `.kiro/settings/` - cc-sdd標準のルール、テンプレート（`.gitignore`対象）
+- `.kiro/steering/` - プロジェクト固有のコンテキスト
+- `.kiro/specs/` - 機能仕様（Git管理）
+
+### 2. Michi拡張のインストール
+
+cc-sddをインストールした後、Michi固有の拡張機能を追加します。
+
+```bash
+michi setup --claude
+```
+
+**生成されるファイル**:
+- `.claude/commands/michi/` - Michi固有コマンド
+- `.claude/rules/` - Michi固有ルール
+- `.claude/agents/` - サブエージェント定義
+- `.claude/skills/` - スキル定義
+
+### 3. 環境変数の設定（オプション）
+
+JIRA/Confluence連携を使用する場合、環境変数を設定してください。
+
+```bash
+# .envファイルに以下を追加
+ATLASSIAN_URL=https://your-domain.atlassian.net
+ATLASSIAN_EMAIL=your-email@example.com
+ATLASSIAN_API_TOKEN=your-api-token
+```
+
+詳細は [環境変数リファレンス](../reference/environment-variables.md) を参照してください。
+
+## Michiとの統合
+
+### 利用可能なコマンド
+
+Claude Codeでは、以下のコマンドが利用できます。
+
+#### cc-sdd標準コマンド
+
+| コマンド | 機能説明 |
+|---------|---------|
+| `/kiro:spec-init` | 新規仕様を初期化 |
+| `/kiro:spec-requirements` | 要件定義を作成 |
+| `/kiro:spec-design` | 設計書を作成 |
+| `/kiro:spec-tasks` | タスク分割とJIRA同期 |
+| `/kiro:spec-impl` | TDD実装を実行 |
+
+#### Michi拡張コマンド
+
+| コマンド | 機能説明 | 備考 |
+|---------|---------|------|
+| `/michi:spec-design` | テスト計画統合設計書を作成 | Phase 0.3-0.4ガイダンス付き |
+| `/michi:test-planning` | テスト計画を実行 | テストタイプ選択+仕様書作成 |
+| `/michi:validate-design` | テスト計画レビュー | テスト計画完了確認付き |
+| `/michi:spec-tasks` | タスク分割+JIRA同期確認 | JIRA連携オプション付き |
+| `/michi:spec-impl` | TDD実装+品質自動化 | ライセンス/バージョン監査+レビュー |
+| `/michi:confluence-sync` | Confluence同期 | 要件定義書/設計書を同期 |
+
+### スキルとサブエージェント
+
+Michiは、Claude Codeのスキルとサブエージェント機能を拡張します。
+
+**利用可能なスキル**:
+- `design-review`: UIデザインレビュー（アクセシビリティ、レスポンシブ、UXパターン、パフォーマンス）
+- `e2e-first-planning`: E2Eテストファースト計画
+- `oss-license`: OSSライセンスチェック
+- `stable-version`: バージョン監査
+
+**利用可能なサブエージェント**:
+- `design-reviewer`: 設計レビュー担当
+- `e2e-first-planner`: E2Eテスト計画担当
+- `oss-license-checker`: OSSライセンスチェック担当
+- `stable-version-auditor`: バージョン監査担当
+
+## 基本的な使い方
+
+### 新機能の開発フロー
+
+```bash
+# 1. 仕様の初期化
+/kiro:spec-init "計算機アプリケーション: 四則演算を行う"
+
+# 2. 要件定義
+/kiro:spec-requirements calculator-app
+
+# 3. 設計（Michi推奨: テスト計画ガイダンス付き）
+/michi:spec-design calculator-app
+
+# 4. テスト計画（任意）
+/michi:test-planning calculator-app
+
+# 5. タスク分割（Michi推奨: JIRA同期確認付き）
+/michi:spec-tasks calculator-app
+
+# 6. TDD実装（Michi推奨: 品質自動化付き）
+/michi:spec-impl calculator-app
+```
+
+### Multi-Repoプロジェクトの場合
+
+Multi-Repoプロジェクトでは、以下のコマンドが利用できます。
+
+```bash
+# 1. プロジェクト初期化
+/michi-multi-repo:spec-init
+
+# 2. 要件定義
+/michi-multi-repo:spec-requirements my-project
+
+# 3. 設計
+/michi-multi-repo:spec-design my-project
+
+# 4. クロスリポジトリレビュー
+/michi-multi-repo:spec-review my-project
+
+# 5. 各リポジトリへ仕様展開
+/michi-multi-repo:propagate-specs my-project
+
+# 6. 全リポジトリで実装実行
+/michi-multi-repo:impl-all my-project
+```
+
+詳細は [Multi-Repoガイド](multi-repo.md) を参照してください。
+
+## 関連ドキュメント
+
+- [AIコマンドリファレンス](../reference/ai-commands.md) - すべてのコマンドの詳細
+- [ワークフローガイド](workflow.md) - 開発ワークフロー全体像
+- [Atlassian連携ガイド](atlassian-integration.md) - JIRA/Confluence連携の詳細
+- [環境変数リファレンス](../reference/environment-variables.md) - 環境変数の詳細設定
+- [トラブルシューティング](../troubleshooting.md) - よくある問題と解決策

package/docs/guides/multi-repo.md

@@ -0,0 +1,117 @@
+# Multi-Repoガイド
+
+複数リポジトリにまたがるプロジェクトを一元管理します。
+
+## Multi-Repoとは
+
+**特徴**:
+- 複数リポジトリの仕様書を一元管理
+- CI/CD結果の集約表示
+- クロスリポジトリのテスト実行
+- Confluenceへの統合同期
+
+## プロジェクト管理
+
+### 初期化
+
+```bash
+michi multi-repo:init my-project --jira MYPROJ --confluence-space MYPROJ
+```
+
+### リポジトリ追加
+
+```bash
+michi multi-repo:add-repo my-project \
+  --name frontend \
+  --url https://github.com/myorg/frontend.git \
+  --branch main
+```
+
+### 一覧表示
+
+```bash
+michi multi-repo:list
+```
+
+## Confluence同期
+
+```bash
+michi multi-repo:sync my-project
+michi multi-repo:confluence-sync my-project --doc-type requirements
+```
+
+**ドキュメントタイプ**:
+- requirements, architecture, sequence
+- strategy, ci-status, release-notes
+
+## CI結果の集約
+
+```bash
+michi multi-repo:ci-status my-project
+michi multi-repo:ci-status my-project --diff
+```
+
+## テスト実行
+
+```bash
+michi multi-repo:test my-project --type e2e
+michi multi-repo:test my-project --type integration
+michi multi-repo:test my-project --type performance
+```
+
+## AIコマンド
+
+Multi-Repo専用のAIコマンドが利用できます。
+
+```
+/michi-multi-repo:spec-init
+/michi-multi-repo:spec-requirements my-project
+/michi-multi-repo:spec-design my-project
+/michi-multi-repo:spec-review my-project
+/michi-multi-repo:propagate-specs my-project
+/michi-multi-repo:impl-all my-project
+```
+
+各コマンドの詳細な機能説明とパラメータについては、[AIコマンドリファレンス](../reference/ai-commands.md#multi-repoコマンド) を参照してください。
+
+## ベストプラクティス
+
+**リポジトリ分割**:
+- マイクロサービス単位で分割
+- 独立デプロイ可能な単位で分割
+- 過度に細かい分割は避ける
+
+**CI/CD戦略**:
+- 各リポジトリで独立パイプライン
+- Multi-Repoレベルで統合テスト
+- CI結果を定期的に集約
+
+**バージョン管理**:
+- セマンティックバージョニング統一
+- 互換性を明記
+- 依存関係を `multi-repo.md` に記載
+
+## トラブルシューティング
+
+### リポジトリが追加できない
+
+```bash
+michi multi-repo:list
+cat .michi/config.json
+```
+
+### CI結果が取得できない
+
+- GitHub APIトークンに `repo` 権限が必要
+- リポジトリURLを確認
+
+### テスト実行が失敗
+
+- `docs/michi/{project}/tests/scripts/` にスクリプト配置
+- 実行権限を付与（`chmod +x`）
+
+## 関連リンク
+
+- [Atlassian連携ガイド](atlassian-integration.md)
+- [ワークフローガイド](workflow.md)
+- [AIコマンドリファレンス](../reference/ai-commands.md)