@ripla/godd-mcp 1.0.7-canary.8 → 1.0.7
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 +523 -124
- package/dist/godd.cjs +293 -244
- package/dist/godd.js +1005 -321
- package/dist/index.js +148 -119
- package/notes/app/DESIGN.md +5 -2
- package/notes/app/e2e/fixtures.ts +39 -0
- package/notes/app/e2e/ja-typography-visual.spec.ts +185 -0
- package/notes/app/e2e/ja-typography-visual.spec.ts-snapshots/ja-typography-desktop-1280-chromium-linux.png +0 -0
- package/notes/app/e2e/ja-typography-visual.spec.ts-snapshots/ja-typography-mobile-360-chromium-linux.png +0 -0
- package/notes/app/e2e/rtl-logical-properties.spec.ts +36 -0
- package/notes/app/package-lock.json +0 -8
- package/notes/app/package.json +0 -1
- package/notes/app/playwright.config.ts +7 -0
- package/notes/app/pnpm-lock.yaml +0 -8
- package/notes/app/src/components/BranchSelectorModal.tsx +8 -8
- package/notes/app/src/components/CommentPanel.tsx +5 -5
- package/notes/app/src/components/DiffPreview.tsx +4 -4
- package/notes/app/src/components/FileContentView.tsx +1 -1
- package/notes/app/src/components/FileContextMenu.tsx +1 -1
- package/notes/app/src/components/FileInfoPanel.branch-tab.test.tsx +3 -35
- package/notes/app/src/components/IssueCommentThread.test.tsx +40 -19
- package/notes/app/src/components/IssueDetailView.test.tsx +3 -40
- package/notes/app/src/components/IssueList.tsx +3 -3
- package/notes/app/src/components/LabelSelector.tsx +1 -1
- package/notes/app/src/components/MarkdownEditor.tsx +1 -1
- package/notes/app/src/components/Skeleton.tsx +2 -2
- package/notes/app/src/components/ToastContainer.tsx +1 -1
- package/notes/app/src/components/TreeNode.tsx +6 -6
- package/notes/app/src/contexts/ToastContext.tsx +1 -1
- package/notes/app/src/hooks/useComments.ts +1 -1
- package/notes/app/src/hooks/useEditSession.ts +1 -1
- package/notes/app/src/lib/api.ts +1 -13
- package/notes/app/src/lib/csv-utils.ts +1 -1
- package/notes/app/src/lib/postLoginRedirect.ts +1 -1
- package/notes/app/src/lib/rtl-logical-properties.test.ts +59 -0
- package/notes/app/src/lib/user-colors.ts +1 -1
- package/notes/app/src/pages/MainPage.tsx +2 -2
- package/notes/app/src/pages/SettingsPage.test.tsx +40 -10
- package/notes/app/src/pages/SettingsPage.tsx +1 -1
- package/notes/app/src/pages/UserManagementPage.tsx +7 -7
- package/notes/app/src/styles/globals.css +17 -0
- package/notes/app/src/test/mockPeriodicSync.ts +68 -0
- package/notes/app/src/test/mocks.ts +1 -1
- package/package.json +7 -3
- package/templates/feedback/feedback-lambda/index.mjs +342 -0
- package/templates/feedback/frontend/FeedbackWidget.tsx +574 -0
- package/templates/feedback/frontend/api.ts +38 -0
- package/templates/feedback/frontend/composePinImage.ts +80 -0
- package/templates/feedback/frontend/config.ts +14 -0
- package/templates/feedback/frontend/types.ts +41 -0
- package/templates/feedback/terraform/Makefile +43 -0
- package/templates/feedback/terraform/backend.tf +10 -0
- package/templates/feedback/terraform/lambda.tf +95 -0
- package/templates/feedback/terraform/local.tf +12 -0
- package/templates/feedback/terraform/output.tf +9 -0
- package/templates/feedback/terraform/provider.tf +24 -0
- package/templates/feedback/terraform/variables.tf +25 -0
- package/templates/github-actions/aws/deploy-notes.yml.hbs +193 -10
- package/templates/notes-docs/001_project/README.md +0 -2
- package/templates/notes-docs/002_business_flow/README.md +19 -0
- package/templates/notes-docs/003_requirements/README.md +20 -0
- package/templates/notes-docs/003_requirements/questions.csv +1 -0
- package/templates/notes-docs/003_requirements/spec/README.md +11 -0
- package/templates/notes-docs/004_pages/README.md +22 -0
- package/templates/notes-docs/005_architecture/README.md +20 -0
- package/templates/notes-docs/006_development_workflow/README.md +67 -0
- package/templates/notes-docs/006_development_workflow/daily_flow.template.md +303 -0
- package/templates/notes-docs/006_development_workflow/git.template.md +72 -20
- package/templates/notes-docs/006_development_workflow/judgment.template.md +182 -0
- package/templates/notes-docs/006_development_workflow/workflow.template.md +167 -192
- package/templates/notes-docs/007_guides/README.md +85 -0
- package/templates/notes-docs/007_guides/bot-token-setup.md +174 -0
- package/templates/notes-docs/007_guides/getting_started.md +112 -0
- package/templates/notes-docs/007_guides/glossary.md +145 -0
- package/templates/notes-docs/007_guides/godd_notes_features.md +105 -0
- package/templates/notes-docs/007_guides/godd_notes_usage.md +28 -19
- package/templates/notes-docs/007_guides/godd_tools.md +129 -0
- package/templates/notes-docs/007_guides/godd_usage.md +88 -95
- package/templates/notes-docs/007_guides/infra/README.md +57 -0
- package/templates/notes-docs/007_guides/{setup_aws_accounts.md → infra/setup_aws_accounts.md} +3 -2
- package/templates/notes-docs/007_guides/{setup_infra.template.md → infra/setup_infra.template.md} +15 -4
- package/templates/notes-docs/007_guides/setup_godd.md +73 -22
- package/templates/notes-docs/007_guides/setup_godd_notes.md +97 -42
- package/templates/notes-docs/007_guides/setup_godd_notes.md.styles.json +2 -2
- package/templates/notes-docs/007_guides/setup_local_environment.template.md +81 -20
- package/templates/notes-docs/007_guides/troubleshooting.md +225 -0
- package/templates/notes-docs/999_ref/README.md +23 -0
- package/templates/notes-docs/GENERATED.md +1 -1
- package/templates/notes-docs/README.md +64 -34
- package/templates/terraform/aws/iam.tf.hbs +361 -4
- /package/templates/notes-docs/007_guides/{setup_aws_cost_alert.md → infra/setup_aws_cost_alert.md} +0 -0
- /package/templates/notes-docs/007_guides/{setup_aws_guard_duty.md → infra/setup_aws_guard_duty.md} +0 -0
package/README.md
CHANGED
|
@@ -3,20 +3,349 @@
|
|
|
3
3
|
**GoDD(Governance-orchestrated Driven Development / 統治駆動開発)** の方法論を、Cursor IDE のチャット AI に注入する MCP サーバーです。
|
|
4
4
|
追加の API キーは不要です。Cursor 搭載の AI がそのまま処理します。
|
|
5
5
|
|
|
6
|
+
> **このページは3種類の読み手に向けて書かれています。** 該当するところだけ読めば足ります。
|
|
7
|
+
>
|
|
8
|
+
> - **GoDD 導入済みのプロジェクトに参加した方**(エンジニア経験は問いません)
|
|
9
|
+
> - **GoDD を自分のプロジェクトに導入する方**
|
|
10
|
+
> - **GoDD 自体をリリースする方**
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## どこから読むか
|
|
15
|
+
|
|
16
|
+
| あなたの状況 | 読むところ |
|
|
17
|
+
|---|---|
|
|
18
|
+
| **GoDD 導入済みのプロジェクトに参加した**(エンジニア経験は問いません) | **下の「はじめて参加した方へ」**。ここだけで環境構築が終わります |
|
|
19
|
+
| GoDD を自分のプロジェクトに導入する | 「必要なもの」以降 |
|
|
20
|
+
| GoDD 自体をリリースする | 「リリース(npm publish)」 |
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## はじめて参加した方へ
|
|
25
|
+
|
|
26
|
+
**このページだけで、開発を始められる状態まで進みます。** エンジニア経験は前提としません。上から順に、書いてあるとおりに実行してください。
|
|
27
|
+
|
|
28
|
+
| # | やること | 時間の目安 |
|
|
29
|
+
|---|---|---|
|
|
30
|
+
| 1 | 必要なものが揃っているか確かめる | 5分 |
|
|
31
|
+
| 2 | AI と話せるアプリを入れる | 10分 |
|
|
32
|
+
| 3 | 開発で使うファイルをパソコンにコピーする | 10分 |
|
|
33
|
+
| 4 | GoDD を入れる | 10分 |
|
|
34
|
+
| 5 | 「このプロジェクトで GoDD を使う」と設定する | 5分 |
|
|
35
|
+
| 6 | ちゃんと繋がったか確かめる | 5分 |
|
|
36
|
+
|
|
37
|
+
**合計 45分ほど**が目安です。1回で終わらなくても構いません。各 Step の最後に「**これができていれば OK**」があります。そこまで進んだら次へ移ってください。
|
|
38
|
+
|
|
39
|
+
> 所要時間は暫定の置き値です(実測ではありません)。実績が溜まったらチームで書き換えてください。
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
### Step 1. 必要なものが揃っているか確かめる
|
|
44
|
+
|
|
45
|
+
#### なぜやるの?
|
|
46
|
+
|
|
47
|
+
作業の途中で「あれが無い」と気づくと、届くまで手が止まります。**先に全部あるか見ておきます。**
|
|
48
|
+
|
|
49
|
+
#### もらうもの
|
|
50
|
+
|
|
51
|
+
**(このプロジェクトでは誰に頼むかを、参加時に書き足してください)**
|
|
52
|
+
|
|
53
|
+
| もらうもの | これは何? | 誰に頼む | いつ使う |
|
|
54
|
+
|---|---|---|---|
|
|
55
|
+
| **ライセンスキー** | GoDD を使ってよい人だと示す鍵。`godd-` で始まる長い文字列です | 管理者 | Step 5 |
|
|
56
|
+
| **Registry URL** | GoDD が設定を取りに行く先の住所。`https://` で始まります | 管理者 | Step 5 |
|
|
57
|
+
| **リポジトリの URL** | 開発で使うファイルの置き場所。`https://github.com/...` の形です | チーム | Step 3 |
|
|
58
|
+
| **リポジトリに入る権限** | その置き場所を開いてよい許可。**招待メールが届きます** | チーム | Step 3 |
|
|
59
|
+
| **GoDD の配布 ZIP** | GoDD 本体が入った圧縮ファイル | 管理者 | Step 4 |
|
|
60
|
+
|
|
61
|
+
> **リポジトリ** = 開発で使うファイルをまとめて置いてある場所のこと。GitHub の中にあります。
|
|
62
|
+
>
|
|
63
|
+
> GoDD Notes を自分のパソコンで動かす場合だけ、**GitHub App の3つの値**(App ID / Private Key / Installation ID)も管理者からもらいます。
|
|
64
|
+
|
|
65
|
+
#### やり方
|
|
66
|
+
|
|
67
|
+
1. 上の表を見て、手元に無いものを確かめる
|
|
68
|
+
2. **無いものがあったら、その場ですぐ頼む。** 「GoDD のライセンスキーと Registry URL をください」と伝えれば通じます
|
|
69
|
+
3. **届くのを待たずに、Step 2 と3 を先に進める**(この2つはもらったものが無くてもできます)
|
|
70
|
+
4. リポジトリの招待メールが来たら、中のボタンを押して参加する
|
|
71
|
+
|
|
72
|
+
#### これができていれば OK
|
|
73
|
+
|
|
74
|
+
表の5つが手元にある。
|
|
75
|
+
|
|
76
|
+
> **ライセンスキーと Private Key は、家の鍵と同じ**です。チャットに貼らない・ファイルに書いて渡さない・人に転送しない。**渡っただけで、他人がシステムに入れてしまいます。**
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
### Step 2. AI と話せるアプリを入れる
|
|
81
|
+
|
|
82
|
+
#### なぜやるの?
|
|
83
|
+
|
|
84
|
+
これから先の作業は、**全部このアプリの中のチャット欄に文字を打つだけ**です。まずそのアプリを入れます。
|
|
85
|
+
|
|
86
|
+
> **AI エディタ** = 文章を書くソフトに、AI と会話できるチャット欄が付いたもの。**Cursor / Claude Code / Codex** の3つが使えます。
|
|
87
|
+
|
|
88
|
+
#### やり方
|
|
89
|
+
|
|
90
|
+
**まず、どれを使うかチームに聞きます。** 「AI エディタは Cursor / Claude Code / Codex のどれを使いますか」と聞いてください。**決まっていなければ Cursor** を選べば大丈夫です(いちばん手数が少ないため)。
|
|
91
|
+
|
|
92
|
+
有料の場合、**アカウントの用意もチームに頼みます。** 自分で契約する必要はありません。
|
|
93
|
+
|
|
94
|
+
##### Cursor の場合
|
|
95
|
+
|
|
96
|
+
1. https://www.cursor.com/ を開く
|
|
97
|
+
2. 自分のパソコンに合う方(Mac か Windows)をダウンロードする
|
|
98
|
+
3. ダウンロードしたファイルを開いて、画面の案内どおりに進める
|
|
99
|
+
4. Cursor を起動し、案内に従ってログインする
|
|
100
|
+
|
|
101
|
+
##### Claude Code / Codex の場合
|
|
102
|
+
|
|
103
|
+
それぞれの公式の手順どおりに入れて、ログインまで済ませます。**入れ方が分からなければチームに聞いてください。** GoDD 用の設定はStep 5 で自動的に作られるので、ここでは何もしません。
|
|
104
|
+
|
|
105
|
+
#### これができていれば OK
|
|
106
|
+
|
|
107
|
+
アプリが起動して、チャット欄に文字を打てる。
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
### Step 3. 開発で使うファイルをパソコンにコピーする
|
|
112
|
+
|
|
113
|
+
#### なぜやるの?
|
|
114
|
+
|
|
115
|
+
開発で使うファイルは **GitHub** という場所に置いてあります。そのままでは編集できないので、**自分のパソコンにコピーを作ります。**
|
|
116
|
+
|
|
117
|
+
作業はこのコピーに対して行い、できあがったら GitHub に戻します。
|
|
118
|
+
|
|
119
|
+
> **GitHub(ギットハブ)** = ファイルをチームで共有し、誰がいつ何を直したかを記録しておく場所。
|
|
120
|
+
> **clone(クローン)** = GitHub にあるファイル一式を、自分のパソコンにコピーすること。
|
|
121
|
+
|
|
122
|
+
#### やり方
|
|
123
|
+
|
|
124
|
+
**先に、Step 1 でもらったリポジトリの URL を手元に用意します。** まだ無ければ「開発で使うリポジトリの URL を教えてください」とチームに聞いてください。
|
|
125
|
+
|
|
126
|
+
1. AI エディタを開く
|
|
127
|
+
2. チャット欄に、`<...>` の部分を**もらった URL に置き換えて**打つ
|
|
128
|
+
|
|
129
|
+
```text
|
|
130
|
+
https://github.com/<組織名>/<リポジトリ名> をこのパソコンに clone して
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
3. 「どこに保存しますか」と聞かれたら、**自分が分かる場所**を選ぶ(書類フォルダなどで構いません)
|
|
134
|
+
4. しばらく待つ。ファイルの数によっては数分かかります
|
|
135
|
+
|
|
136
|
+
#### これができていれば OK
|
|
137
|
+
|
|
138
|
+
アプリの左側にファイルの一覧が出ている。
|
|
139
|
+
|
|
140
|
+
#### うまくいかないとき
|
|
141
|
+
|
|
142
|
+
| こんなとき | どうする |
|
|
143
|
+
|---|---|
|
|
144
|
+
| `docs` というフォルダが見当たらない | そのプロジェクトではまだ説明書が作られていません。チームに確認する |
|
|
145
|
+
| 「権限がありません」と出る | まだ招待されていない可能性があります。チームに確認する |
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
### Step 4. GoDD を入れる
|
|
150
|
+
|
|
151
|
+
#### なぜやるの?
|
|
152
|
+
|
|
153
|
+
GoDD は、AI に「このチームのやり方」を教えるための道具です。**入れないと AI が普通の AI のままで、チームの決まりに沿って作ってくれません。**
|
|
154
|
+
|
|
155
|
+
> **ターミナル** = 文字でパソコンに命令する画面です。GoDD を入れるときだけ使います。
|
|
156
|
+
>
|
|
157
|
+
> **AI エディタの中で開けます。** 上部メニューの **Terminal → New Terminal**(Cursor / Claude Code)。画面の下側に文字を打てる欄が出れば成功です。別のアプリを探す必要はありません。
|
|
158
|
+
|
|
159
|
+
#### やり方
|
|
160
|
+
|
|
161
|
+
**Step 1 でもらった ZIP から入れます。** まだ無ければ「GoDD の配布 ZIP をください」と管理者に頼んでください。
|
|
162
|
+
|
|
163
|
+
> Node.js が既に入っている人は、代わりにターミナルで `npm install -g @ripla/godd-mcp` と打つ方法もあります。**分からなければ ZIP のほうを使ってください。**
|
|
164
|
+
|
|
165
|
+
1. 受け取った ZIP を展開する(ファイルをダブルクリック)
|
|
166
|
+
2. ターミナルを開き、展開したフォルダへ移動する
|
|
167
|
+
|
|
168
|
+
移動の仕方が分からなければ、チャットに「展開したフォルダをターミナルで開いて」と打つと AI がやってくれます。
|
|
169
|
+
|
|
170
|
+
3. ターミナルに次をそのまま打って Enter
|
|
171
|
+
|
|
172
|
+
**Windows:**
|
|
173
|
+
```powershell
|
|
174
|
+
.\godd.exe install
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**macOS / Linux:**
|
|
178
|
+
```bash
|
|
179
|
+
./godd install
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
4. **ターミナルを一度閉じて、開き直す**
|
|
183
|
+
|
|
184
|
+
> **必ずやってください。** 飛ばすと次の手順で「見つかりません」と言われます。入れたばかりの命令は、開き直さないと使えるようにならないためです。
|
|
185
|
+
|
|
186
|
+
> Mac で「開発元が確認できないため開けません」と出たら、ターミナルに `xattr -d com.apple.quarantine godd` と打ってから、もう一度 3 をやり直してください。
|
|
187
|
+
|
|
188
|
+
#### これができていれば OK
|
|
189
|
+
|
|
190
|
+
ターミナルにこう打って、
|
|
191
|
+
|
|
192
|
+
```bash
|
|
193
|
+
godd version
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
`GoDD CLI v1.0.7` のように表示される(数字は版によって変わります)。
|
|
197
|
+
|
|
198
|
+
**`command not found` と出たら**、Step 4-4(ターミナルを開き直す)を飛ばしていないか確かめてください。それでも直らなければ プロジェクトの `docs/007_guides/troubleshooting.md` を見ます。
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
### Step 5. 「このプロジェクトで GoDD を使う」と設定する
|
|
203
|
+
|
|
204
|
+
#### なぜやるの?
|
|
205
|
+
|
|
206
|
+
Step 4 で入れたのは道具そのものです。ここでは **「このプロジェクトでその道具を使います」と登録**します。鍵と接続先を1回だけ教える作業です。
|
|
207
|
+
|
|
208
|
+
#### 先に用意するもの
|
|
209
|
+
|
|
210
|
+
Step 1 でもらった**ライセンスキー**と **Registry URL** を、貼り付けられる状態にしておきます。
|
|
211
|
+
|
|
212
|
+
あわせて、**チームに「技術スタックは何を選べばいいですか」と先に聞いておいてください。**
|
|
213
|
+
|
|
214
|
+
> **技術スタック** = このプロジェクトで使っているプログラムの種類(例: React、Python)。GoDD がそれに合わせた作り方をするために聞かれます。
|
|
215
|
+
|
|
216
|
+
#### やり方
|
|
217
|
+
|
|
218
|
+
**Step 3 でコピーしたフォルダの中で**、ターミナルに打ちます。
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
godd init
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
> フォルダの中で打つ必要があります。**移動の仕方が分からなければ、チャットに「プロジェクトのフォルダをターミナルで開いて」と打つと AI がやってくれます。**
|
|
225
|
+
|
|
226
|
+
打つと、**画面が1つずつ質問してきます。** 上から順に答えて、そのつど Enter を押します。
|
|
227
|
+
|
|
228
|
+
| 聞かれること | どう答えるか |
|
|
229
|
+
|---|---|
|
|
230
|
+
| ライセンスキー | もらったキーを貼り付ける |
|
|
231
|
+
| 使用言語 | `ja` と打つ(何も打たずに Enter でも同じ) |
|
|
232
|
+
| プロジェクト URL | もらった **Registry URL** を貼り付ける |
|
|
233
|
+
| **技術スタック(5回に分かれます)** | **1回目の「プログラミング言語」だけは必ず選ぶ**(番号を打つ。複数なら `1,3`)。**2回目以降は何も打たずに Enter で飛ばしてよい** |
|
|
234
|
+
| `config.godd` の保存先 | 何も打たずに Enter |
|
|
235
|
+
| MCP 設定を生成するか | `Y` と打つ |
|
|
236
|
+
| Headroom / agent-browser / TypeUI | **3つとも `n` と打つ**(使いません) |
|
|
237
|
+
|
|
238
|
+
> **1回目の「プログラミング言語」で何も選ばずに Enter を押すと、そこで終了します。** 分からなければ、この手順を始める前にチームに聞いてください。
|
|
239
|
+
|
|
240
|
+
途中で「リポジトリを登録中」と出ますが、**ここは自動で進みます。** 何も打つ必要はありません。
|
|
241
|
+
|
|
242
|
+
終わると、使っているアプリに合わせた設定ファイルが自動で作られます。**中身を開く必要はありません。** 鍵が入ったファイルは、他の人に見えないよう自動で設定されます。
|
|
243
|
+
|
|
244
|
+
#### 途中で止まったとき
|
|
245
|
+
|
|
246
|
+
| 画面に出た言葉 | どうする |
|
|
247
|
+
|---|---|
|
|
248
|
+
| `エラー: Git リモート (origin) が見つかりません。` | Step 3 のコピーがうまくいっていません。**チームに「clone したのに origin が無いと言われる」と伝える** |
|
|
249
|
+
| `ライセンスキーが無効です。` | 貼り付けたキーの前後に余計な空白が入っていないか確かめる。それでも駄目なら**管理者にキーの再発行を頼む** |
|
|
250
|
+
| `リポジトリ数の上限に達しています。` | **管理者に「リポジトリ数の上限に達したので枠を増やしてください」と伝える**。自分では直せません |
|
|
251
|
+
|
|
252
|
+
#### これができていれば OK
|
|
253
|
+
|
|
254
|
+
フォルダの中に `config.godd` というファイルができている。
|
|
255
|
+
|
|
256
|
+
> **`config.godd`** = このプロジェクトで GoDD をどう使うかを書いた設定ファイル。**中を開いたり編集したりする必要はありません。** できていることだけ確かめてください。
|
|
257
|
+
|
|
258
|
+
うまくいかなかったときは プロジェクトの `docs/007_guides/troubleshooting.md` を見てください。
|
|
259
|
+
|
|
260
|
+
> **プロジェクトごとに1回ずつ必要**です。別のプロジェクトを担当するときは、そちらでももう一度やります。
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
### Step 6. ちゃんと繋がったか確かめる
|
|
265
|
+
|
|
266
|
+
#### なぜやるの?
|
|
267
|
+
|
|
268
|
+
Step 5 で作った設定は、**アプリを立ち上げ直さないと読み込まれません。** ここで繋がっていないと、この先の作業が全部動きません。
|
|
269
|
+
|
|
270
|
+
> **MCP(エムシーピー)** = AI エディタと GoDD をつなぐ仕組みの名前。画面にこの言葉が出てきますが、**意味を覚える必要はありません。** 「GoDD との接続」と読み替えてください。
|
|
271
|
+
|
|
272
|
+
#### やり方
|
|
273
|
+
|
|
274
|
+
1. **アプリを完全に終了して、もう一度開く**(閉じるボタンだけでなく、完全に終了させます)
|
|
275
|
+
2. Step 3 でコピーしたフォルダを開く
|
|
276
|
+
3. 下の表のとおり、繋がっているか見る
|
|
277
|
+
|
|
278
|
+
| 使っているアプリ | どこを見るか |
|
|
279
|
+
|---|---|
|
|
280
|
+
| Cursor | 設定(Settings)を開き、`MCP` の欄で `godd` が **緑色(Running)** になっている |
|
|
281
|
+
| Claude Code | 起動したとき「許可しますか」と聞かれるので **許可する**。その後ターミナルで `claude mcp list` と打つと一覧に出る |
|
|
282
|
+
| Codex | 使えるもの一覧に `$godd-dev` が出ている |
|
|
283
|
+
|
|
284
|
+
**緑にならないときは、まずアプリをもう一度完全に終了して開き直してください。** それでも駄目なら プロジェクトの `docs/007_guides/troubleshooting.md` の「GoDD を認識しない」を見ます。
|
|
285
|
+
|
|
286
|
+
#### 試しに話しかけてみる
|
|
287
|
+
|
|
288
|
+
チャット欄にこう打ってみます。
|
|
289
|
+
|
|
290
|
+
```text
|
|
291
|
+
このリポジトリの構造を教えて
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
#### これができていれば OK
|
|
295
|
+
|
|
296
|
+
返事が返ってくる。
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
### 環境構築が終わったら
|
|
304
|
+
|
|
305
|
+
**ここまでで準備は完了です。** 次は実際に1件やってみます。
|
|
306
|
+
|
|
307
|
+
プロジェクトの **`docs/007_guides/getting_started.md`** を開いてください。最初の作業から PR を出すまでが書かれています。
|
|
308
|
+
|
|
309
|
+
| 読む場所 | 開き方 |
|
|
310
|
+
|---|---|
|
|
311
|
+
| **エディタ** | 左のファイル一覧から `docs` → `007_guides` → `getting_started.md` |
|
|
312
|
+
| GitHub | リポジトリの画面で同じ場所 |
|
|
313
|
+
|
|
314
|
+
明日からの進め方は `docs/006_development_workflow/daily_flow.template.md` にあります。
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
### 途中で止まってしまったら
|
|
319
|
+
|
|
320
|
+
**20分やって進まなかったら、遠慮なく聞いてください。** 最初の準備はパソコンごとに違いが出やすく、**聞いたほうが速い**部分です。自分で解決する必要はありません。
|
|
321
|
+
|
|
322
|
+
聞くときに、この4つを伝えるとすぐ答えが返ってきます。
|
|
323
|
+
|
|
324
|
+
```text
|
|
325
|
+
1. どの手順で止まったか(例: Step 4 の godd install)
|
|
326
|
+
2. 何を打ったか
|
|
327
|
+
3. 画面に出た文字(そのままコピーして貼る。まとめない)
|
|
328
|
+
4. 使っているパソコン(Windows / Mac)
|
|
329
|
+
```
|
|
330
|
+
|
|
6
331
|
---
|
|
7
332
|
|
|
8
333
|
## 必要なもの
|
|
9
334
|
|
|
335
|
+
> **ここから先は、GoDD を自分のプロジェクトへ導入する担当者向けです。**
|
|
336
|
+
|
|
10
337
|
| 項目 | 備考 |
|
|
11
338
|
|------|------|
|
|
12
339
|
| Node.js 20 以上 | `node -v` で確認 |
|
|
13
340
|
| Cursor IDE | 最新版推奨 |
|
|
14
341
|
| ライセンスキー | 管理者から受領 |
|
|
15
|
-
| Registry URL |
|
|
342
|
+
| プロジェクトURL(Registry API URL) | GoDD Admin Console と連携してプロンプトを取得する接続先。管理者から受領 |
|
|
16
343
|
|
|
17
344
|
---
|
|
18
345
|
|
|
19
|
-
##
|
|
346
|
+
## セットアップ(導入担当向け)
|
|
347
|
+
|
|
348
|
+
> **「はじめて参加した方へ」を読んだ方は、この節は不要です。** ここは、GoDD を新しいプロジェクトへ導入する担当者が読む節です。
|
|
20
349
|
|
|
21
350
|
### Step 1: GoDD をインストールする
|
|
22
351
|
|
|
@@ -30,6 +359,8 @@ npm install -g @ripla/godd-mcp
|
|
|
30
359
|
godd version
|
|
31
360
|
```
|
|
32
361
|
|
|
362
|
+
**完了の目安**: `GoDD CLI v1.0.x` のようにバージョンが表示される。`command not found` と出た場合はターミナルを開き直してください(PATH の反映に再起動が必要です)。
|
|
363
|
+
|
|
33
364
|
> グローバルインストールしたくない場合は、以降のコマンドを `npx @ripla/godd-mcp <command>` で代替できます。
|
|
34
365
|
> 例: `npx @ripla/godd-mcp init`
|
|
35
366
|
|
|
@@ -37,66 +368,79 @@ godd version
|
|
|
37
368
|
|
|
38
369
|
### Step 2: プロジェクトをセットアップする
|
|
39
370
|
|
|
40
|
-
GoDD を使いたいプロジェクトのディレクトリに移動し、`godd init`
|
|
371
|
+
GoDD を使いたいプロジェクトのディレクトリに移動し、`godd init` を実行します。**対象のプロジェクトが手元にあり、`origin` の Git リモートが設定されていることが前提**です(無いとリポジトリ登録の段階で中断します)。
|
|
41
372
|
|
|
42
373
|
```bash
|
|
43
374
|
cd /path/to/your-project
|
|
44
375
|
godd init
|
|
45
376
|
```
|
|
46
377
|
|
|
47
|
-
|
|
378
|
+
実行前に、対話で聞かれる項目を準備しておきます:
|
|
48
379
|
|
|
49
|
-
1. **ライセンスキー** —
|
|
50
|
-
2.
|
|
51
|
-
3.
|
|
52
|
-
4.
|
|
380
|
+
1. **ライセンスキー** — 管理者から受領したキーを入力(必須)
|
|
381
|
+
2. **使用言語** — `ja` / `en` / `zh` / `ru` / `kz` / `tr` から選択(default: `ja`)
|
|
382
|
+
3. **プロジェクトURL(Registry API URL)** — GoDD Admin Console と連携してプロンプトを取得する接続先。何も入力せず Enter を押すと、表示されたデフォルト値(`https://dev.api.godd.ripla-inc.com`)を使用します。適用後は使用した URL が表示されます
|
|
383
|
+
4. **リポジトリ登録** — `origin` の Git リモート URL を Registry API に登録(`origin` がない場合は中断)
|
|
384
|
+
5. **技術スタック選択** — `1,3,5` で複数選択、`all` で全選択。Step 2 以降は Enter でスキップ可(Step 1 は不可)
|
|
385
|
+
6. **`config.godd` の保存先** — default はプロジェクトルートの `config.godd`
|
|
386
|
+
7. **対応媒体の MCP 設定生成** — `[Y/n]`(`Y` のとき `.cursor/mcp.json` / `.mcp.json` / `.codex/config.toml` と `/godd-dev` コマンドファイルを生成します)
|
|
387
|
+
8. **任意 MCP の追加登録** — 順番 7 で `Y` のときのみ、Headroom / agent-browser / TypeUI を個別に opt-in
|
|
53
388
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
【フロントエンド】
|
|
67
|
-
1. React
|
|
68
|
-
2. Next.js
|
|
69
|
-
...
|
|
70
|
-
選択 (例: 1): 1
|
|
71
|
-
|
|
72
|
-
【バックエンド】
|
|
73
|
-
1. FastAPI
|
|
74
|
-
2. Django
|
|
75
|
-
...
|
|
76
|
-
選択 (例: 1): 1
|
|
77
|
-
```
|
|
389
|
+
技術スタック選択は以下の 5 ステップで進みます。**Step 1(プログラミング言語)のみ Enter ではスキップできません**(1 言語以上必須。未選択だとエラーで終了)。Step 2 以降は Enter でスキップでき、選んだ言語に対応する技術だけが表示されます。設計パターン(`DDD / Clean Architecture`)は質問されず、自動設定されます。
|
|
390
|
+
|
|
391
|
+
| Step | 質問カテゴリ | 表示される選択肢 |
|
|
392
|
+
|------|--------------|------------------|
|
|
393
|
+
| 1 | プログラミング言語(必須・Enter スキップ不可) | `Python` / `TypeScript` / `JavaScript` / `Go` / `PHP` / `Ruby` / `C` / `HTML` / `CSS` |
|
|
394
|
+
| 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` |
|
|
395
|
+
| 3 | 関連ツール(CSS / ビルド / ORM / タスクキュー / ランタイム) | `Tailwind CSS` / `Sass` / `Vite` / `SQLAlchemy` / `Celery` / `Node.js` / `Agent Stdio` |
|
|
396
|
+
| 4 | データベース | `PostgreSQL` / `MySQL` / `MongoDB` / `Redis` |
|
|
397
|
+
| 5 | インフラ | `Docker` / `Terraform` |
|
|
398
|
+
|
|
399
|
+
順番 7 で `Y`(既定)を選んだ場合のみ、追加で以下を聞かれます(`n` だと `.cursor/mcp.json` / `.mcp.json` は生成されません):
|
|
78
400
|
|
|
79
|
-
|
|
401
|
+
| 質問 | 既定 | 前提 |
|
|
402
|
+
|------|------|------|
|
|
403
|
+
| Headroom(コンテキスト圧縮 MCP)も登録しますか? | `N` | 事前に `pip install "headroom-ai[mcp]"` が必要 |
|
|
404
|
+
| agent-browser(ブラウザ操作 MCP)も登録しますか? | `N` | 事前に `npm install -g agent-browser && agent-browser install` が必要。`core` profile には JavaScript 実行(eval)が含まれます |
|
|
405
|
+
| TypeUI(デザインスキル / UI プロンプト MCP)も登録しますか? | `N` | ホスト型サーバー(`https://mcp.typeui.sh`)。初回利用時に TypeUI アカウントのサインインが必要 |
|
|
406
|
+
| TypeUI Bearer トークン(TypeUI を `y` にしたときのみ) | 空 Enter | 通常は空 Enter で OAuth 対話サインイン。独自ホスト/トークン認証のときだけ入力 |
|
|
407
|
+
|
|
408
|
+
完了すると、以下のファイルが生成されます:
|
|
80
409
|
|
|
81
410
|
| ファイル | 内容 |
|
|
82
411
|
|---------|------|
|
|
83
|
-
| `config.godd` |
|
|
84
|
-
| `.env` |
|
|
85
|
-
| `.cursor/mcp.json` | Cursor IDE への MCP
|
|
86
|
-
|
|
87
|
-
|
|
412
|
+
| `config.godd` | 技術スタックコンポーネントの設定(常に生成) |
|
|
413
|
+
| `.env` | ライセンスキー・言語・プロジェクトURL(Registry API URL、GoDD 管理値。常に更新) |
|
|
414
|
+
| `.cursor/mcp.json` | Cursor IDE への MCP サーバー登録(順番 7 で `Y` を選んだ場合のみ) |
|
|
415
|
+
| `.mcp.json` | Claude Code への MCP サーバー登録(プロジェクトルート。順番 7 で `Y` を選んだ場合のみ、`.cursor/mcp.json` と同一構成。TypeUI 等の url エントリのみ `type: "http"` 付き) |
|
|
416
|
+
| `.codex/config.toml` | Codex のプロジェクト MCP 設定(順番 7 で `Y` を選んだ場合のみ・Git 管理外) |
|
|
417
|
+
| `.cursor/commands/godd-dev.md` / `.claude/commands/godd-dev.md` | Cursor / Claude Code 共通の直接コマンド `/godd-dev` |
|
|
418
|
+
| `.agents/skills/godd-dev/SKILL.md` | Codex が自動検出する GoDD スキル(`$godd-dev`) |
|
|
419
|
+
|
|
420
|
+
> **ライセンスキーは `.env`、`.cursor/mcp.json`、`.mcp.json`、`.codex/config.toml` で扱われます。`.gitignore` への除外は必須です。**
|
|
421
|
+
> `godd init` / `godd notes compose` が次を自動追記します(#1159 / #1216)。実行後は `git status` で除外を確認してください。
|
|
88
422
|
>
|
|
89
423
|
> ```gitignore
|
|
90
424
|
> .env
|
|
425
|
+
> .cursor/mcp.json
|
|
426
|
+
> .cursor/mcp.json.bak
|
|
427
|
+
> .mcp.json
|
|
428
|
+
> .mcp.json.bak
|
|
429
|
+
> .codex/config.toml
|
|
430
|
+
> .codex/config.toml.bak
|
|
91
431
|
> ```
|
|
432
|
+
>
|
|
433
|
+
> **`config.godd` は除外されません。** 使っている技術構成をチームで共有するファイルのため、コミットする前提です。旧形式で `license_key` を含めている場合のみ、その行を取り除いてからコミットしてください。
|
|
92
434
|
|
|
93
435
|
---
|
|
94
436
|
|
|
95
|
-
### Step 3:
|
|
437
|
+
### Step 3: IDE で MCP を有効化する
|
|
96
438
|
|
|
97
|
-
|
|
439
|
+
- **Cursor**: Cursor IDE を再起動してください。`.cursor/mcp.json` が読み込まれ、godd MCP ツールが利用可能になります
|
|
440
|
+
- **Claude Code**: 対象プロジェクトで `claude` を起動すると、プロジェクトスコープ MCP(`.mcp.json`)の**承認ダイアログ**が表示されるので godd を承認してください。**初回は承認するまで有効化されません**(ファイルを置いただけ・再起動しただけでは使えません)。承認状態は `claude mcp list` で確認できます(承認前は `⏸ Pending approval` と表示されます)
|
|
441
|
+
- **Codex**: `.codex/config.toml` を読み込んで再起動し、`/mcp` で godd が接続済みになっていることを確認してください。開発入口は `$godd-dev` です。
|
|
98
442
|
|
|
99
|
-
|
|
443
|
+
Cursor では再起動後、Settings > MCP で `godd` サーバーのステータスが **Running** になっていれば完了です。Claude Code では承認後に `claude mcp list` で `godd` が接続済みと表示されれば完了です。
|
|
100
444
|
|
|
101
445
|
---
|
|
102
446
|
|
|
@@ -106,9 +450,9 @@ Registry API URL (default: http://localhost:8100): https://godd-registry.example
|
|
|
106
450
|
|
|
107
451
|
### 技術スタックを変更したい場合
|
|
108
452
|
|
|
109
|
-
プロジェクトディレクトリで `godd init` を再実行してください。コンポーネントは `config.godd`
|
|
453
|
+
プロジェクトディレクトリで `godd init` を再実行してください。コンポーネントは `config.godd` を直接編集することもできます。ライセンスキー・言語・プロジェクトURL(Registry API URL)は `.env` の `GODD_LICENSE_KEY` / `GODD_LANGUAGE` / `GODD_REGISTRY_URL` を編集してください。Cursor のチャットで `godd-config` ツールを使って更新することもできます。変更後は Cursor IDE を再起動してください。
|
|
110
454
|
|
|
111
|
-
>
|
|
455
|
+
> **再実行時**: 既存の `config.godd` があると検出メッセージが表示され、ライセンスキー・使用言語・プロジェクトURL(Registry API URL)・保存先は Enter で既存値を保持できます。コンポーネントは「既存のコンポーネント設定を引き継ぎますか? `[Y/n]`」で引き継ぎ(既定 `Y`)か、ウィザードで再選択(`n`)を選べます。再選択時も Step 1(プログラミング言語)は 1 つ以上必須です。
|
|
112
456
|
|
|
113
457
|
### バイナリ(ZIP)でのインストール
|
|
114
458
|
|
|
@@ -141,7 +485,7 @@ chmod +x godd
|
|
|
141
485
|
| コマンド | 短縮形 | 説明 |
|
|
142
486
|
|---------|--------|------|
|
|
143
487
|
| `godd install` | `godd i` | GoDD をシステムにインストール |
|
|
144
|
-
| `godd init` | — | プロジェクトのセットアップ(config.godd + .cursor/mcp.json 生成) |
|
|
488
|
+
| `godd init` | — | プロジェクトのセットアップ(config.godd + .cursor/mcp.json + .mcp.json 生成) |
|
|
145
489
|
| `godd server` | `godd s` | MCP サーバーを起動(Cursor が自動実行) |
|
|
146
490
|
| `godd notes compose` | `godd n compose` | GoDD Notes をローカル Docker Compose で起動(`--auto` で自動実行) |
|
|
147
491
|
| `godd notes deploy` | `godd n deploy` | GoDD Notes をクラウドにデプロイ(infra の provider に従う、`-y` で確認スキップ) |
|
|
@@ -155,7 +499,7 @@ chmod +x godd
|
|
|
155
499
|
|
|
156
500
|
---
|
|
157
501
|
|
|
158
|
-
## 利用可能なツール(
|
|
502
|
+
## 利用可能なツール(34 件)
|
|
159
503
|
|
|
160
504
|
Cursor のチャットで以下のツールが使えます。ツール名を指定しなくても、AI が自動的に適切なツールを選択します。
|
|
161
505
|
全ツールの入力は optional — 引数なしで呼び出し可能で、Chat の文脈から AI が自動補完します。
|
|
@@ -166,60 +510,75 @@ Cursor のチャットで以下のツールが使えます。ツール名を指
|
|
|
166
510
|
|
|
167
511
|
| ツール | 説明 | 呼び出し例 |
|
|
168
512
|
|--------|------|-----------|
|
|
169
|
-
| `
|
|
170
|
-
| `
|
|
171
|
-
| `
|
|
172
|
-
| `
|
|
173
|
-
| `
|
|
174
|
-
| `
|
|
513
|
+
| `godd-dev` | 開発ワークフローのメインエントリ。**2モード制** — 受領資料や依頼を渡すと起票モード(仕様突合 → タスク分解 → 起票〔単一ユニットは実装Issue 1件のみ / 複数なら親Issue + 子Issue〕→ 質問投稿 → 実ファイル受領時のみ資料保管 → Issue を番号昇順に1件ずつ実装)、`#<Issue番号>` を渡すと実装モード(回答記録 → ATDD実装 → 品質ゲート → 責務別コミット、`feat/#<Issue>-...` ブランチを自動作成) | 「この議事録の内容で起票して」 / 「#1234 を実装して」 |
|
|
514
|
+
| `godd-review` | CTO レベルのコードレビュー。アーキテクチャ一貫性・スケーラビリティ・技術的負債・ビジネスインパクトの観点でフィードバック。重大度分類(CRITICAL/MAJOR/MINOR/SUGGESTION)付き | 「この PR をレビューして」 |
|
|
515
|
+
| `godd-check` | 品質チェック。Spec 整合・影響範囲・テスト計画・互換性・セキュリティの観点で提出前チェック | 「品質チェックして」 |
|
|
516
|
+
| `godd-commit` | 責務単位コミット。1 コミット = 1 責務で分割し、Conventional Commits 準拠のメッセージで実行 | 「コミットして」 |
|
|
517
|
+
| `godd-submit` | 提出一括実行。品質チェック → push → PR 作成を一括実行 | 「PR 出して」 |
|
|
518
|
+
| `godd-notes-deploy` | GoDD Notes のデプロイ案内(compose / deploy / infra) | 「Notes をデプロイして」 |
|
|
175
519
|
|
|
176
520
|
### サブコマンド — Git 系
|
|
177
521
|
|
|
178
522
|
| ツール | 説明 |
|
|
179
523
|
|--------|------|
|
|
180
|
-
| `
|
|
181
|
-
| `
|
|
182
|
-
| `
|
|
183
|
-
| `
|
|
184
|
-
| `
|
|
185
|
-
| `
|
|
524
|
+
| `godd-sync` | main ブランチの最新を取り込み。コンフリクトは SSOT 準拠側を優先 |
|
|
525
|
+
| `godd-new-branch` | 変更を退避し、最新 main からブランチ作成して復元 |
|
|
526
|
+
| `godd-git-workflow` | sync → new-branch → commit を一括実行 |
|
|
527
|
+
| `godd-push` | 提出前チェック。品質ゲート・Spec 整合・機密情報チェック |
|
|
528
|
+
| `godd-push-execute` | 提出前チェック後に git push 実行 |
|
|
529
|
+
| `godd-pr-create` | 変更分析と PR テンプレート準拠の本文生成、GitHub 上で PR 作成 |
|
|
186
530
|
|
|
187
531
|
### サブコマンド — 設計・仕様系
|
|
188
532
|
|
|
189
533
|
| ツール | 説明 |
|
|
190
534
|
|--------|------|
|
|
191
|
-
| `
|
|
192
|
-
| `
|
|
193
|
-
| `
|
|
194
|
-
| `
|
|
535
|
+
| `godd-requirements` | 要件定義ハーネス。議事録 / RFP / 生入力からフェーズ単位の対話ループで要件定義成果物(001_project 概要 / 002_business_flow / requirements-list.csv / questions.csv)を生成・更新 |
|
|
536
|
+
| `godd-spec` | 要求を仕様に変換。API/UI/DB/Feature/Usecase の粒度で Spec 化 |
|
|
537
|
+
| `godd-impact` | 影響分析。変更の影響範囲を洗い出し |
|
|
538
|
+
| `godd-test-plan` | テスト計画。unit/integration/e2e の必要性とテスト項目を策定 |
|
|
539
|
+
| `godd-adr` | ADR 作成。設計判断をトレードオフ・ロールバック含めて記録 |
|
|
195
540
|
|
|
196
541
|
### サブコマンド — ドキュメント系
|
|
197
542
|
|
|
198
543
|
| ツール | 説明 |
|
|
199
544
|
|--------|------|
|
|
200
|
-
| `
|
|
201
|
-
| `
|
|
202
|
-
| `
|
|
203
|
-
| `
|
|
545
|
+
| `godd-docs-init` | docs/ フォルダ構造をテンプレートから生成。既存 docs/ が旧構成の場合は最新構成へ再配置 |
|
|
546
|
+
| `godd-docs` | コード変更に合わせて docs/・README・設定・技術スタック・運用ドキュメントを同期・更新。`docs/` 未作成時は `godd-docs-init` を案内 |
|
|
547
|
+
| `godd-comment` | フィードバック機構(画面スクショ + ピン + コメント → GitHub Issue 自動起票)の導入。ウィジェット / Lambda / Terraform のテンプレートを展開(GoDD Notes 導入済みが前提) |
|
|
548
|
+
| `godd-release-notes` | リリースノート作成。変更点・互換性・既知の問題を整理 |
|
|
549
|
+
|
|
550
|
+
### サブコマンド — 連携系
|
|
551
|
+
|
|
552
|
+
| ツール | 説明 |
|
|
553
|
+
|--------|------|
|
|
554
|
+
| `godd-slack-question` | Issue の「# 質問内容」コメントから未質問の不明点を抽出し、不明点ごとに Slack スレッドを立てて質問を投稿(スレッド URL を Issue に記録)。事前レビュー済みの `config.godd.slack` を読み取り専用で参照 |
|
|
204
555
|
|
|
205
556
|
### サブコマンド — 分析・変換系
|
|
206
557
|
|
|
207
558
|
| ツール | 説明 |
|
|
208
559
|
|--------|------|
|
|
209
|
-
| `
|
|
210
|
-
| `
|
|
211
|
-
| `
|
|
212
|
-
| `
|
|
213
|
-
| `
|
|
560
|
+
| `godd-pr-analyze` | PR 分析。差分からレビュー観点・リスク・追加情報を整理 |
|
|
561
|
+
| `godd-report` | 完了報告。変更概要・影響範囲・検証結果・残リスクを整理 |
|
|
562
|
+
| `godd-req-to-flow` | 要求 → ビジネスフロー変換 |
|
|
563
|
+
| `godd-req-to-tickets` | 要求 → チケット分解 |
|
|
564
|
+
| `godd-spec-to-tickets` | 仕様 → チケット変換 |
|
|
214
565
|
|
|
215
566
|
### サブコマンド — 環境・セットアップ系
|
|
216
567
|
|
|
217
568
|
| ツール | 説明 |
|
|
218
569
|
|--------|------|
|
|
219
|
-
| `
|
|
220
|
-
| `
|
|
221
|
-
| `
|
|
222
|
-
| `
|
|
570
|
+
| `godd-setup` | 環境構築。config.godd / .env / .cursor/mcp.json 生成、依存導入 |
|
|
571
|
+
| `godd-config` | 設定の表示・更新(components は config.godd、license_key 等は .env) |
|
|
572
|
+
| `godd-install` | ツール/MCP サーバーインストール案内 |
|
|
573
|
+
| `godd-dev-workflow` | 開発ワークフロー全体。環境構築→実装→テスト→コミット→PR |
|
|
574
|
+
| `godd-notes-init` | GoDD Notes 用に docs/ の初期テンプレートを展開。バンドル済みテンプレートを docs/ にコピー |
|
|
575
|
+
| `godd-memory` | セッション間記憶。`remember` で保存、`recall` で検索、`consolidate` で整理(保存先 `.godd/memory/godd-memory.json`) |
|
|
576
|
+
|
|
577
|
+
### サブコマンド — ナレッジ
|
|
578
|
+
|
|
579
|
+
| ツール | 説明 |
|
|
580
|
+
|--------|------|
|
|
581
|
+
| `godd-knowledge-save` | 作業中に得た開発知見を GoDD Knowledge DB へ保存。**ユーザーから明示的に指示されたときだけ使われます** |
|
|
223
582
|
|
|
224
583
|
---
|
|
225
584
|
|
|
@@ -231,60 +590,67 @@ Cursor のチャットで `/` を入力すると、GoDD の MCP ツールをス
|
|
|
231
590
|
|
|
232
591
|
チャット入力欄で `/` を入力するとコマンド候補が表示されます。キーワードを続けて入力すると候補が絞り込まれます。
|
|
233
592
|
|
|
234
|
-
**コマンド形式**: `/{サーバー名}/{ツール名}
|
|
593
|
+
**コマンド形式**: `/{サーバー名}/{ツール名}`(クライアントによってはツール名だけを表示)
|
|
594
|
+
|
|
595
|
+
開発入口の正式なツール名は `godd-dev` です。`godd init` は Cursor / Claude Code 用のプロジェクトコマンド `.cursor/commands/godd-dev.md` / `.claude/commands/godd-dev.md` を生成するため、両媒体ではサーバー名に依存せず `/godd-dev` で呼び出せます。MCPツールを直接表示するクライアントでは、サーバーキーを付けた `/godd/godd-dev` や `/godd-a/godd-dev` になる場合があります。**コマンドファイルが生成されるのは `godd-dev` だけ**なので、他のツールはサーバー名を付けた形で呼びます(`godd` と二重に見えるのは、サーバー名とツール名の両方に `godd` が付くためです)。
|
|
235
596
|
|
|
236
|
-
|
|
597
|
+
Codex はリポジトリ内の `.agents/skills/godd-dev/SKILL.md` を自動検出し、`$godd-dev` で同じ開発フローを起動できます。Codex の公式なプロジェクト共有スキル経路は `$` メンションであり、MCP由来の `/godd-dev` を全クライアントで強制する仕組みではありません。
|
|
237
598
|
|
|
238
599
|
```
|
|
239
600
|
例 1: ツールを明示して依頼
|
|
240
601
|
|
|
241
|
-
/godd
|
|
602
|
+
/godd-dev ユーザー登録 API を実装して
|
|
242
603
|
|
|
243
604
|
例 2: 複数ツールの組み合わせ
|
|
244
605
|
|
|
245
|
-
/godd/spec この要件を仕様に変換して
|
|
606
|
+
/godd/godd-spec この要件を仕様に変換して
|
|
246
607
|
|
|
247
608
|
例 3: ツールを指定しなくても AI が自動選択
|
|
248
609
|
|
|
249
610
|
コミットメッセージを作って
|
|
250
|
-
→ AI が自動的に
|
|
611
|
+
→ AI が自動的に godd-commit を選択
|
|
251
612
|
```
|
|
252
613
|
|
|
253
614
|
> **ヒント**: ツールを明示しなくても AI が自動的に最適なツールを選びます。特定のツールを確実に使いたい場合にスラッシュコマンドを活用してください。
|
|
254
615
|
|
|
255
|
-
#### スラッシュコマンド一覧(
|
|
616
|
+
#### スラッシュコマンド一覧(34 件)
|
|
256
617
|
|
|
257
618
|
| コマンド(サーバー名 `godd` の場合) | 用途 |
|
|
258
619
|
|--------------------------------------|------|
|
|
259
|
-
| `/godd/dev` |
|
|
260
|
-
| `/godd/
|
|
261
|
-
| `/godd/
|
|
262
|
-
| `/godd/commit` | 責務分割コミット |
|
|
263
|
-
| `/godd/
|
|
264
|
-
| `/godd/
|
|
265
|
-
| `/godd/
|
|
266
|
-
| `/godd/
|
|
267
|
-
| `/godd/
|
|
268
|
-
| `/godd/
|
|
269
|
-
| `/godd/
|
|
270
|
-
| `/godd/
|
|
271
|
-
| `/godd/
|
|
272
|
-
| `/godd/
|
|
273
|
-
| `/godd/
|
|
274
|
-
| `/godd/
|
|
275
|
-
| `/godd/
|
|
276
|
-
| `/godd/
|
|
277
|
-
| `/godd/
|
|
278
|
-
| `/godd/
|
|
279
|
-
| `/godd/
|
|
280
|
-
| `/godd/
|
|
281
|
-
| `/godd/
|
|
282
|
-
| `/godd/
|
|
283
|
-
| `/godd/
|
|
284
|
-
| `/godd/
|
|
285
|
-
| `/godd/
|
|
286
|
-
| `/godd/
|
|
287
|
-
| `/godd/
|
|
620
|
+
| `/godd/godd-dev` | 開発ワークフロー(起票モード / 実装モード)。Cursor / Claude Code は生成コマンド `/godd-dev`、Codex は `$godd-dev` でも起動できる |
|
|
621
|
+
| `/godd/godd-check` | 品質チェック |
|
|
622
|
+
| `/godd/godd-review` | CTO レベルコードレビュー |
|
|
623
|
+
| `/godd/godd-commit` | 責務分割コミット |
|
|
624
|
+
| `/godd/godd-spec` | 要求→仕様変換 |
|
|
625
|
+
| `/godd/godd-requirements` | 要件定義ハーネス(対話ループで要件定義成果物を生成) |
|
|
626
|
+
| `/godd/godd-impact` | 影響分析 |
|
|
627
|
+
| `/godd/godd-test-plan` | テスト計画作成 |
|
|
628
|
+
| `/godd/godd-pr-analyze` | PR 分析 |
|
|
629
|
+
| `/godd/godd-setup` | 環境構築・設定変更 |
|
|
630
|
+
| `/godd/godd-release-notes` | リリースノート作成 |
|
|
631
|
+
| `/godd/godd-adr` | ADR(設計判断記録)作成 |
|
|
632
|
+
| `/godd/godd-sync` | デフォルトブランチ同期 |
|
|
633
|
+
| `/godd/godd-new-branch` | ブランチ作成 |
|
|
634
|
+
| `/godd/godd-git-workflow` | sync→branch→commit 一括 |
|
|
635
|
+
| `/godd/godd-push` | 提出前チェック |
|
|
636
|
+
| `/godd/godd-push-execute` | 提出前チェック+push 実行 |
|
|
637
|
+
| `/godd/godd-pr-create` | PR 作成 |
|
|
638
|
+
| `/godd/godd-submit` | 提出一括実行(品質チェック→push→PR 作成) |
|
|
639
|
+
| `/godd/godd-dev-workflow` | エージェント開発ワークフロー全体 |
|
|
640
|
+
| `/godd/godd-report` | 完了報告作成 |
|
|
641
|
+
| `/godd/godd-req-to-flow` | 要求→ビジネスフロー変換 |
|
|
642
|
+
| `/godd/godd-req-to-tickets` | 要求→チケット変換 |
|
|
643
|
+
| `/godd/godd-spec-to-tickets` | 仕様→チケット変換 |
|
|
644
|
+
| `/godd/godd-install` | ツール・ライブラリのインストール支援 |
|
|
645
|
+
| `/godd/godd-slack-question` | Issue の質問を Slack スレッドへ投稿 |
|
|
646
|
+
| `/godd/godd-docs-init` | docs/ フォルダ構造生成 |
|
|
647
|
+
| `/godd/godd-docs` | docs/ ドキュメント同期 |
|
|
648
|
+
| `/godd/godd-notes-init` | GoDD Notes 用の docs/ テンプレート展開 |
|
|
649
|
+
| `/godd/godd-notes-deploy` | Notes デプロイ案内 |
|
|
650
|
+
| `/godd/godd-memory` | セッション間記憶の保存・検索・整理 |
|
|
651
|
+
| `/godd/godd-config` | config.godd の表示・更新 |
|
|
652
|
+
| `/godd/godd-comment` | コメント(フィードバック)機構の導入 |
|
|
653
|
+
| `/godd/godd-knowledge-save` | 開発知見の保存 |
|
|
288
654
|
|
|
289
655
|
### エコシステムツールのガイダンス
|
|
290
656
|
|
|
@@ -387,12 +753,15 @@ Notes のクラウドデプロイで pnpm 10+ 関連のエラーが出る場合
|
|
|
387
753
|
|
|
388
754
|
## GoDD Notes ライフサイクル
|
|
389
755
|
|
|
390
|
-
GoDD Notes は GoDD のドキュメント閲覧・編集 Web
|
|
756
|
+
GoDD Notes は GoDD のドキュメント閲覧・編集 Web アプリです。初回オンボーディングでは、まずローカル Docker Compose で動かし、AWS などのクラウドインフラ構築は後から必要なタイミングで実行します。ローカル利用だけなら AWS アカウント設定は不要です。
|
|
757
|
+
|
|
758
|
+
> **初回の推奨順**: GoDD をインストール → プロジェクトで `godd init` → IDE で MCP 接続を確認 → `godd-docs-init` で `docs/` を初期化 → ローカルの `godd notes compose`(AWS 不要)→ 必要な場合のみ `godd notes infra` / `godd notes deploy`。
|
|
391
759
|
|
|
392
760
|
### 1. GoDD をインストール
|
|
393
761
|
|
|
394
762
|
```bash
|
|
395
763
|
npm install -g @ripla/godd-mcp
|
|
764
|
+
godd version
|
|
396
765
|
```
|
|
397
766
|
|
|
398
767
|
Notes をクラウドデプロイする場合(ローカルに pnpm 10+ がある環境)は、pnpm 10+ 向けの Notes App ビルド対応が `@latest` に含まれるまで canary の利用を推奨します:
|
|
@@ -409,9 +778,47 @@ cd /path/to/your-project
|
|
|
409
778
|
godd init
|
|
410
779
|
```
|
|
411
780
|
|
|
412
|
-
プロジェクトごとに実行が必要です(2
|
|
781
|
+
プロジェクトごとに実行が必要です(2人目以降のメンバーも各自実行)。`godd init` が生成した `.cursor/mcp.json` を Cursor に読み込ませるため、この後に Cursor IDE を再起動します。
|
|
782
|
+
|
|
783
|
+
### 3. MCP 接続を確認
|
|
784
|
+
|
|
785
|
+
1. Cursor IDE を再起動する
|
|
786
|
+
2. Settings > MCP で `godd` サーバーが **Running** であることを確認する(これが主確認)
|
|
787
|
+
3. 任意で、チャットから `godd-check` を呼ぶか、MCP ツール一覧に GoDD ツールが並ぶことを確認する
|
|
788
|
+
|
|
789
|
+
### 4. docs/ 構造を初期化
|
|
790
|
+
|
|
791
|
+
GoDD Notes は GitHub リポジトリの `docs/` を表示・編集対象にします。まだ `docs/` がないプロジェクトでは、Cursor のチャットから `godd-docs-init`(MCP ツールのサーバー名付き表示例: `/godd/godd-docs-init`)を実行して、標準のドキュメント構造を作成します。
|
|
792
|
+
|
|
793
|
+
```text
|
|
794
|
+
Cursor IDE で: godd-docs-init を使って docs/ を初期化して
|
|
795
|
+
```
|
|
796
|
+
|
|
797
|
+
### 5. ローカルで Notes を起動
|
|
413
798
|
|
|
414
|
-
|
|
799
|
+
前提: Docker Desktop が起動済みであること。加えて、GitHub App 用の以下3つの値をOrg管理者から事前に受け取っていること(AWS アカウントは不要でも、これらは必要です)。
|
|
800
|
+
- App ID
|
|
801
|
+
- Installation ID
|
|
802
|
+
- Private Key
|
|
803
|
+
|
|
804
|
+
```bash
|
|
805
|
+
godd notes compose --auto
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
Docker Compose でローカルに Notes 環境を立ち上げます。起動後は以下のエンドポイントを確認します。
|
|
809
|
+
|
|
810
|
+
| 種別 | URL |
|
|
811
|
+
|------|-----|
|
|
812
|
+
| API | `http://localhost:3100` |
|
|
813
|
+
| App | `http://localhost:5175` |
|
|
814
|
+
|
|
815
|
+
ポートは `godd notes compose` の対話で変更できます(既定値は上表のとおり)。
|
|
816
|
+
|
|
817
|
+
`--auto` を省略すると、AI による自動実行ではなく手動確認しながら進められます。ローカル利用の詳細は、`godd notes init` で展開される `docs/007_guides/` のガイドを参照してください。
|
|
818
|
+
|
|
819
|
+
### 6. 後でクラウドインフラを構築(必要な場合のみ)
|
|
820
|
+
|
|
821
|
+
本番 AWS などへデプロイする段階で、インフラ担当者が `godd notes infra` を実行します。ローカル利用だけならこの手順は不要です。
|
|
415
822
|
|
|
416
823
|
```bash
|
|
417
824
|
godd notes infra
|
|
@@ -428,7 +835,7 @@ godd notes infra
|
|
|
428
835
|
既存環境で旧ブランド名の出力先や設定ファイルを生成済みの場合は、
|
|
429
836
|
`godd notes infra` を再実行して `godd-notes/` と `.godd-notes-*.json` を再生成してください。
|
|
430
837
|
|
|
431
|
-
###
|
|
838
|
+
### 7. クラウドへデプロイ(必要な場合のみ)
|
|
432
839
|
|
|
433
840
|
```bash
|
|
434
841
|
godd notes deploy # 対話形式
|
|
@@ -442,9 +849,9 @@ godd notes deploy -y # 確認スキップ(CI 向け)
|
|
|
442
849
|
|
|
443
850
|
> `godd notes deploy` 実行時に `@ripla/godd-mcp` の新しいバージョンが利用可能な場合、警告が表示されます。
|
|
444
851
|
|
|
445
|
-
###
|
|
852
|
+
### 8. 既存環境を最新化する(CLI 更新の反映)
|
|
446
853
|
|
|
447
|
-
すでにデプロイ済みの環境に、新しい `@ripla/godd-mcp` バージョン(Terraform テンプレート変更を含む)を反映する場合の手順です。手順 1〜
|
|
854
|
+
すでにデプロイ済みの環境に、新しい `@ripla/godd-mcp` バージョン(Terraform テンプレート変更を含む)を反映する場合の手順です。手順 1〜7(新規オンボーディング)は不要です。
|
|
448
855
|
|
|
449
856
|
```bash
|
|
450
857
|
# 1. CLI を更新(インフラ変更を検証する場合は canary を明示。安定版のみなら不要)
|
|
@@ -489,18 +896,10 @@ pnpm 10+ で `[ERR_PNPM_IGNORED_BUILDS] Ignored build scripts: esbuild` や `pnp
|
|
|
489
896
|
2. `notes-app` を再 scaffold する: プロジェクトで `godd notes infra` を再実行(`pnpm-workspace.yaml` を含む同梱ソースで上書き更新)
|
|
490
897
|
3. 再デプロイする: `godd notes deploy -y`
|
|
491
898
|
|
|
492
|
-
Terraform テンプレートの変更も反映する必要がある場合は、上記「
|
|
899
|
+
Terraform テンプレートの変更も反映する必要がある場合は、上記「8. 既存環境を最新化する」の手順4(`terraform apply`)も実行してください。
|
|
493
900
|
|
|
494
901
|
ローカルで `notes-app` を直接ビルドする場合は、同梱の `notes-app/README.md` を参照してください。
|
|
495
902
|
|
|
496
|
-
### ローカル開発(Docker Compose)
|
|
497
|
-
|
|
498
|
-
```bash
|
|
499
|
-
godd notes compose
|
|
500
|
-
```
|
|
501
|
-
|
|
502
|
-
Docker Compose でローカルに Notes 環境を立ち上げます。
|
|
503
|
-
|
|
504
903
|
---
|
|
505
904
|
|
|
506
905
|
## リリース(npm publish)
|