@ripla/godd-mcp 1.0.6 → 1.0.7-canary.10

package/README.md

@@ -44,50 +44,52 @@ cd /path/to/your-project
 godd init
 ```
 
-対話形式で以下を入力していきます:
-
-1. **ライセンスキー** — 管理者から受領したキーを入力
-2. **言語** — `ja`（日本語）など
-3. **Registry URL** — 管理者から指定された URL を入力
-4. **技術スタック** — 使用する言語・フレームワーク・DB を選択
-
-```
-ライセンスキーを入力してください: godd-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-使用言語を選択 [ja/en/zh/ru/kz/tr] (default: ja): ja
-Registry API URL (default: http://localhost:8100): https://godd-registry.example.com
-
-【言語】
-  1. Python
-  2. TypeScript
-  3. JavaScript
-  ...
-  選択 (例: 1,2): 1,2
-
-【フロントエンド】
-  1. React
-  2. Next.js
-  ...
-  選択 (例: 1): 1
-
-【バックエンド】
-  1. FastAPI
-  2. Django
-  ...
-  選択 (例: 1): 1
-```
-
-完了すると、以下の 3 ファイルが自動生成されます:
+実行前に、対話で聞かれる項目を準備しておきます:
+
+1. **ライセンスキー** — 管理者から受領したキーを入力（必須）
+2. **使用言語** — `ja` / `en` / `zh` / `ru` / `kz` / `tr` から選択（default: `ja`）
+3. **Registry API URL** — default は `https://dev.api.godd.ripla-inc.com`
+4. **リポジトリ登録** — `origin` の Git リモート URL を Registry API に登録（`origin` がない場合は中断）
+5. **技術スタック選択** — `1,3,5` で複数選択、`all` で全選択。Step 2 以降は Enter でスキップ可（Step 1 は不可）
+6. **`config.godd` の保存先** — default はプロジェクトルートの `config.godd`
+7. **`.cursor/mcp.json` 生成** — `[Y/n]`（`Y` のときのみ生成）
+8. **任意 MCP の追加登録** — 順番 7 で `Y` のときのみ、Headroom / agent-browser / TypeUI を個別に opt-in
+
+技術スタック選択は以下の 5 ステップで進みます。**Step 1（プログラミング言語）のみ Enter ではスキップできません**（1 言語以上必須。未選択だとエラーで終了）。Step 2 以降は Enter でスキップでき、選んだ言語に対応する技術だけが表示されます。設計パターン（`DDD / Clean Architecture`）は質問されず、自動設定されます。
+
+| Step | 質問カテゴリ | 表示される選択肢 |
+|------|--------------|------------------|
+| 1 | プログラミング言語（必須・Enter スキップ不可） | `Python` / `TypeScript` / `JavaScript` / `Go` / `PHP` / `Ruby` / `C` / `HTML` / `CSS` |
+| 2 | フレームワーク / ライブラリ | `React` / `Next.js` / `Vue.js` / `Angular` / `Svelte` / `Electron`、`FastAPI` / `Django` / `Flask` / `Express` / `Fastify` / `NestJS` / `Gin` / `Echo` / `Fiber` / `Laravel` / `Symfony` / `WordPress` / `Ruby on Rails` / `Sinatra` / `Koa` |
+| 3 | 関連ツール（CSS / ビルド / ORM / タスクキュー / ランタイム） | `Tailwind CSS` / `Sass` / `Vite` / `SQLAlchemy` / `Celery` / `Node.js` / `Agent Stdio` |
+| 4 | データベース | `PostgreSQL` / `MySQL` / `MongoDB` / `Redis` |
+| 5 | インフラ | `Docker` / `Terraform` |
+
+順番 7 で `Y`（既定）を選んだ場合のみ、追加で以下を聞かれます（`n` だと `.cursor/mcp.json` は生成されません）:
+
+| 質問 | 既定 | 前提 |
+|------|------|------|
+| Headroom（コンテキスト圧縮 MCP）も登録しますか？ | `N` | 事前に `pip install "headroom-ai[mcp]"` が必要 |
+| agent-browser（ブラウザ操作 MCP）も登録しますか？ | `N` | 事前に `npm install -g agent-browser && agent-browser install` が必要。`core` profile には JavaScript 実行（eval）が含まれます |
+| TypeUI（デザインスキル / UI プロンプト MCP）も登録しますか？ | `N` | ホスト型サーバー（`https://mcp.typeui.sh`）。初回利用時に TypeUI アカウントのサインインが必要 |
+| TypeUI Bearer トークン（TypeUI を `y` にしたときのみ） | 空 Enter | 通常は空 Enter で OAuth 対話サインイン。独自ホスト/トークン認証のときだけ入力 |
+
+完了すると、以下のファイルが生成されます:
 
 | ファイル | 内容 |
 |---------|------|
-| `config.godd` | 技術スタックコンポーネントの設定 |
-| `.env` | ライセンスキー・言語・Registry URL（GoDD 管理値） |
-| `.cursor/mcp.json` | Cursor IDE への MCP サーバー登録 |
+| `config.godd` | 技術スタックコンポーネントの設定（常に生成） |
+| `.env` | ライセンスキー・言語・Registry URL（GoDD 管理値。常に更新） |
+| `.cursor/mcp.json` | Cursor IDE への MCP サーバー登録（順番 7 で `Y` を選んだ場合のみ） |
 
-> **`.env` にはライセンスキーが含まれます。`.gitignore` に追加してください。**
+> **ライセンスキーは `config.godd`（手動設定・旧形式・互換読み込み）、`.env`、`.cursor/mcp.json` で扱われます。`.gitignore` への除外は必須です。**
+> `godd init` / `godd notes compose` による自動追記（#1159 / PR #1175）が利用可能になるまでは手動で追加し、実行後は `git status` で除外を確認してください（#1175 マージ後は自動追記。それまでは手動）。
 >
 > ```gitignore
+> config.godd
 > .env
+> .cursor/mcp.json
+> .cursor/mcp.json.bak
 > ```
 
 ---
@@ -108,7 +110,7 @@ Registry API URL (default: http://localhost:8100): https://godd-registry.example
 
 プロジェクトディレクトリで `godd init` を再実行してください。コンポーネントは `config.godd` を直接編集することもできます。ライセンスキー・言語・Registry URL は `.env` の `GODD_LICENSE_KEY` / `GODD_LANGUAGE` / `GODD_REGISTRY_URL` を編集してください。Cursor のチャットで `godd_config` ツールを使って更新することもできます。変更後は Cursor IDE を再起動してください。
 
-> **再実行時の既存設定保護**: `config.godd` や `.env` が既に存在する場合、`godd init` は現在の設定をデフォルト値として表示します。Enter を押すだけで既存設定を保持できます。コンポーネントを再選択したい場合は、コンポーネント引き継ぎの質問で `n` を入力してください。
+> **再実行時**: 既存の `config.godd` があると検出メッセージが表示され、ライセンスキー・使用言語・Registry URL・保存先は Enter で既存値を保持できます。コンポーネントは「既存のコンポーネント設定を引き継ぎますか？ `[Y/n]`」で引き継ぎ（既定 `Y`）か、ウィザードで再選択（`n`）を選べます。再選択時も Step 1（プログラミング言語）は 1 つ以上必須です。
 
 ### バイナリ（ZIP）でのインストール
 
@@ -387,12 +389,13 @@ Notes のクラウドデプロイで pnpm 10+ 関連のエラーが出る場合
 
 ## GoDD Notes ライフサイクル
 
-GoDD Notes は GoDD のドキュメント閲覧・編集 Web アプリです。以下のステップで構築・デプロイします。
+GoDD Notes は GoDD のドキュメント閲覧・編集 Web アプリです。初回オンボーディングでは、まずローカル Docker Compose で動かし、AWS などのクラウドインフラ構築は後から必要なタイミングで実行します。ローカル利用だけなら AWS アカウント設定は不要です。
 
 ### 1. GoDD をインストール
 
 ```bash
 npm install -g @ripla/godd-mcp
+godd version
 ```
 
 Notes をクラウドデプロイする場合（ローカルに pnpm 10+ がある環境）は、pnpm 10+ 向けの Notes App ビルド対応が `@latest` に含まれるまで canary の利用を推奨します:
@@ -409,9 +412,45 @@ cd /path/to/your-project
 godd init
 ```
 
-プロジェクトごとに実行が必要です（2人目以降のメンバーも各自実行）。
+プロジェクトごとに実行が必要です（2人目以降のメンバーも各自実行）。`godd init` が生成した `.cursor/mcp.json` を Cursor に読み込ませるため、この後に Cursor IDE を再起動します。
+
+### 3. MCP 接続を確認
+
+1. Cursor IDE を再起動する
+2. Settings > MCP で `godd` サーバーが **Running** であることを確認する（これが主確認）
+3. 任意で、チャットから `godd_check` を呼ぶか、MCP ツール一覧に GoDD ツールが並ぶことを確認する
+
+### 4. docs/ 構造を初期化
+
+GoDD Notes は GitHub リポジトリの `docs/` を表示・編集対象にします。まだ `docs/` がないプロジェクトでは、Cursor のチャットから `godd_docs_init`（または `/godd/docs_init`）を実行して、標準のドキュメント構造を作成します。
+
+```text
+Cursor IDE で: godd_docs_init を使って docs/ を初期化して
+```
+
+### 5. ローカルで Notes を起動
+
+前提: Docker Desktop が起動済みであること。加えて、GitHub App 用の以下3つの値をOrg管理者から事前に受け取っていること（AWS アカウントは不要でも、これらは必要です）。
+- App ID
+- Installation ID
+- Private Key
+
+```bash
+godd notes compose --auto
+```
+
+Docker Compose でローカルに Notes 環境を立ち上げます。起動後は以下のエンドポイントを確認します。
+
+| 種別 | URL |
+|------|-----|
+| API | `http://localhost:8000` |
+| App | `http://localhost:5173` |
+
+`--auto` を省略すると、AI による自動実行ではなく手動確認しながら進められます。ローカル利用の詳細は [GoDD Notes 使い始め方ガイド](../docs/007_guides/godd_notes_getting_started.md) を参照してください。
+
+### 6. 後でクラウドインフラを構築（必要な場合のみ）
 
-### 3. クラウドインフラ構築（初回のみ）
+本番 AWS などへデプロイする段階で、インフラ担当者が `godd notes infra` を実行します。ローカル利用だけならこの手順は不要です。
 
 ```bash
 godd notes infra
@@ -428,7 +467,7 @@ godd notes infra
 既存環境で旧ブランド名の出力先や設定ファイルを生成済みの場合は、
 `godd notes infra` を再実行して `godd-notes/` と `.godd-notes-*.json` を再生成してください。
 
-### 4. デプロイ
+### 7. クラウドへデプロイ（必要な場合のみ）
 
 ```bash
 godd notes deploy      # 対話形式
@@ -442,6 +481,45 @@ godd notes deploy -y   # 確認スキップ（CI 向け）
 
 > `godd notes deploy` 実行時に `@ripla/godd-mcp` の新しいバージョンが利用可能な場合、警告が表示されます。
 
+### 8. 既存環境を最新化する（CLI 更新の反映）
+
+すでにデプロイ済みの環境に、新しい `@ripla/godd-mcp` バージョン（Terraform テンプレート変更を含む）を反映する場合の手順です。手順 1〜7（新規オンボーディング）は不要です。
+
+```bash
+# 1. CLI を更新（インフラ変更を検証する場合は canary を明示。安定版のみなら不要）
+npm install -g @ripla/godd-mcp@canary
+godd version
+
+# 2. AWS CLI 認証を確認
+export AWS_PROFILE=<PROFILE>          # PowerShell: $env:AWS_PROFILE = "<PROFILE>"
+aws sts get-caller-identity
+
+# 3. Terraform ファイル・同梱ソースを最新テンプレートで再生成（保存済み設定を非対話で再利用）
+godd notes infra --yes
+
+# 4. Terraform テンプレートに変更がある場合のみ、{env}-iam → {env} の順で適用（apply 前に plan で差分確認）
+cd terraform/godd-notes/{env}-iam
+terraform init
+cd ../{env}
+terraform init
+
+cd ../{env}-iam
+terraform plan
+cd ../{env}
+terraform plan
+
+cd ../{env}-iam
+terraform apply
+cd ../{env}
+terraform apply
+
+# 5. アプリを再デプロイ
+cd /path/to/your-project
+godd notes deploy -y
+```
+
+> **`{env}-iam` を先に適用する**: `{env}` モジュール（ECS/RDS/ALB 等）は `{env}-iam` が作成する IAM ロール（ECS 実行ロール、GitHub Actions OIDC 等）を参照するため、`{env}-iam` → `{env}` の順を守ってください。`godd notes infra --yes` は `.tf` を毎回無条件で再生成しますが、**テンプレート自体に変更がある場合のみ** `terraform apply` の再適用が必要です（同梱ソース [`notes-api`/`notes-app`] の変更だけなら手順 4 は不要）。
+
 ### Notes デプロイで `esbuild` の build script が拒否される
 
 pnpm 10+ で `[ERR_PNPM_IGNORED_BUILDS] Ignored build scripts: esbuild` や `pnpm install` 失敗が出る場合:
@@ -450,15 +528,9 @@ pnpm 10+ で `[ERR_PNPM_IGNORED_BUILDS] Ignored build scripts: esbuild` や `pnp
 2. `notes-app` を再 scaffold する: プロジェクトで `godd notes infra` を再実行（`pnpm-workspace.yaml` を含む同梱ソースで上書き更新）
 3. 再デプロイする: `godd notes deploy -y`
 
-ローカルで `notes-app` を直接ビルドする場合は、同梱の `notes-app/README.md` を参照してください。
-
-### ローカル開発（Docker Compose）
+Terraform テンプレートの変更も反映する必要がある場合は、上記「8. 既存環境を最新化する」の手順4（`terraform apply`）も実行してください。
 
-```bash
-godd notes compose
-```
-
-Docker Compose でローカルに Notes 環境を立ち上げます。
+ローカルで `notes-app` を直接ビルドする場合は、同梱の `notes-app/README.md` を参照してください。
 
 ---