@k2works/claude-code-booster 1.9.0 → 1.10.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.
Files changed (94) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +42 -42
  3. package/bin/claude-code-booster +79 -79
  4. package/lib/assets/.claude/README.md +162 -162
  5. package/lib/assets/.claude/SKILLS_TEMPLATE.md +100 -100
  6. package/lib/assets/.claude/scripts/generate-inception-deck.mjs +911 -1024
  7. package/lib/assets/.claude/settings.json +11 -11
  8. package/lib/assets/.claude/skills/ai-agent-guidelines/SKILL.md +119 -119
  9. package/lib/assets/.claude/skills/analyzing-architecture/SKILL.md +87 -87
  10. package/lib/assets/.claude/skills/analyzing-business/SKILL.md +117 -117
  11. package/lib/assets/.claude/skills/analyzing-data-model/SKILL.md +80 -80
  12. package/lib/assets/.claude/skills/analyzing-domain-model/SKILL.md +88 -88
  13. package/lib/assets/.claude/skills/analyzing-inception-deck/SKILL.md +137 -137
  14. package/lib/assets/.claude/skills/analyzing-non-functional/SKILL.md +91 -91
  15. package/lib/assets/.claude/skills/analyzing-operation/SKILL.md +91 -91
  16. package/lib/assets/.claude/skills/analyzing-requirements/SKILL.md +87 -87
  17. package/lib/assets/.claude/skills/analyzing-tech-stack/SKILL.md +102 -102
  18. package/lib/assets/.claude/skills/analyzing-test-strategy/SKILL.md +87 -87
  19. package/lib/assets/.claude/skills/analyzing-ui-design/SKILL.md +86 -86
  20. package/lib/assets/.claude/skills/analyzing-usecases/SKILL.md +87 -87
  21. package/lib/assets/.claude/skills/creating-adr/SKILL.md +115 -115
  22. package/lib/assets/.claude/skills/developing-backend/SKILL.md +106 -106
  23. package/lib/assets/.claude/skills/developing-frontend/SKILL.md +96 -96
  24. package/lib/assets/.claude/skills/developing-release/SKILL.md +154 -154
  25. package/lib/assets/.claude/skills/generating-slides/SKILL.md +136 -106
  26. package/lib/assets/.claude/skills/git-commit/SKILL.md +106 -106
  27. package/lib/assets/.claude/skills/killing-processes/SKILL.md +98 -98
  28. package/lib/assets/.claude/skills/managing-docs/SKILL.md +200 -200
  29. package/lib/assets/.claude/skills/managing-operations/DEPLOY.md +77 -77
  30. package/lib/assets/.claude/skills/managing-operations/SETUP_CSHARP.md +80 -80
  31. package/lib/assets/.claude/skills/managing-operations/SETUP_FRONTEND.md +84 -84
  32. package/lib/assets/.claude/skills/managing-operations/SETUP_JAVA.md +75 -75
  33. package/lib/assets/.claude/skills/managing-operations/SKILL.md +156 -156
  34. package/lib/assets/.claude/skills/orchestrating-analysis/SKILL.md +134 -134
  35. package/lib/assets/.claude/skills/orchestrating-development/SKILL.md +243 -243
  36. package/lib/assets/.claude/skills/orchestrating-project/SKILL.md +193 -193
  37. package/lib/assets/.claude/skills/planning-releases/SKILL.md +222 -222
  38. package/lib/assets/.claude/skills/syncing-github-project/SKILL.md +181 -69
  39. package/lib/assets/.claude/skills/tracking-progress/SKILL.md +164 -164
  40. package/lib/assets/.devcontainer/devcontainer.json +34 -34
  41. package/lib/assets/.env.example +17 -17
  42. package/lib/assets/.gitattributes +4 -4
  43. package/lib/assets/.github/workflows/docker-publish.yml +77 -77
  44. package/lib/assets/.github/workflows/mkdocs.yml +39 -39
  45. package/lib/assets/AGENTS.md +94 -94
  46. package/lib/assets/CLAUDE.md +162 -162
  47. package/lib/assets/README.md +269 -269
  48. package/lib/assets/docker-compose.yml +33 -33
  49. package/lib/assets/docs/assets/css/extra.css +29 -29
  50. package/lib/assets/docs/assets/js/extra.js +44 -44
  51. package/lib/assets/docs/index.md +14 -14
  52. package/lib/assets/docs/reference/CodexCLIMCP/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/351/226/213/347/231/272/343/203/225/343/203/255/343/203/274.md +532 -532
  53. package/lib/assets/docs/reference/CodexCLIMCP/343/202/265/343/203/274/343/203/220/343/203/274/350/250/255/345/256/232/346/211/213/351/240/206.md +341 -341
  54. package/lib/assets/docs/reference/Java/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +578 -578
  55. package/lib/assets/docs/reference/TypeScript/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +465 -465
  56. package/lib/assets/docs/reference/UI/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +448 -448
  57. package/lib/assets/docs/reference//343/202/210/343/201/204/343/202/275/343/203/225/343/203/210/343/202/246/343/202/247/343/202/242/343/201/250/343/201/257.md +242 -242
  58. package/lib/assets/docs/reference//343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +2216 -2216
  59. package/lib/assets/docs/reference//343/202/244/343/203/263/343/203/225/343/203/251/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +1878 -1878
  60. package/lib/assets/docs/reference//343/202/250/343/202/257/343/202/271/343/203/210/343/203/252/343/203/274/343/203/240/343/203/227/343/203/255/343/202/260/343/203/251/343/203/237/343/203/263/343/202/260.md +554 -554
  61. package/lib/assets/docs/reference//343/202/263/343/203/274/343/203/207/343/202/243/343/203/263/343/202/260/343/201/250/343/203/206/343/202/271/343/203/210/343/202/254/343/202/244/343/203/211.md +705 -705
  62. package/lib/assets/docs/reference//343/203/206/343/202/271/343/203/210/346/210/246/347/225/245/343/202/254/343/202/244/343/203/211.md +1313 -1313
  63. package/lib/assets/docs/reference//343/203/207/343/203/274/343/202/277/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +311 -311
  64. package/lib/assets/docs/reference//343/203/211/343/203/241/343/202/244/343/203/263/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +599 -599
  65. package/lib/assets/docs/reference//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/345/210/206/346/236/220/343/202/254/343/202/244/343/203/211.md +528 -528
  66. package/lib/assets/docs/reference//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/275/234/346/210/220/343/202/254/343/202/244/343/203/211.md +682 -682
  67. package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/202/254/343/202/244/343/203/211.md +442 -442
  68. package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/203/273/343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/350/250/210/347/224/273/343/202/254/343/202/244/343/203/211.md +558 -558
  69. package/lib/assets/docs/reference//347/222/260/345/242/203/345/244/211/346/225/260/347/256/241/347/220/206/343/202/254/343/202/244/343/203/211.md +663 -663
  70. package/lib/assets/docs/reference//350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1248 -1248
  71. package/lib/assets/docs/reference//351/201/213/347/224/250/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +392 -392
  72. package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +235 -235
  73. package/lib/assets/docs/reference//351/235/236/346/251/237/350/203/275/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1236 -1236
  74. package/lib/assets/docs/template/ADR.md +30 -30
  75. package/lib/assets/docs/template/README.md +50 -50
  76. package/lib/assets/docs/template//343/201/276/343/201/232/343/201/223/343/202/214/343/202/222/350/252/255/343/202/202/343/201/206/343/203/252/343/202/271/343/203/210.md +12 -12
  77. package/lib/assets/docs/template//343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/345/256/214/344/272/206/345/240/261/345/221/212/346/233/270.md +58 -58
  78. package/lib/assets/docs/template//343/202/244/343/203/263/343/202/273/343/203/227/343/202/267/343/203/247/343/203/263/343/203/207/343/203/203/343/202/255.md +13 -13
  79. package/lib/assets/docs/template//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243.md +379 -379
  80. package/lib/assets/docs/template//345/256/214/345/205/250/345/275/242/345/274/217/343/201/256/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271.md +68 -68
  81. package/lib/assets/docs/template//350/246/201/344/273/266/345/256/232/347/276/251.md +669 -669
  82. package/lib/assets/docs/template//350/250/255/350/250/210.md +163 -163
  83. package/lib/assets/gulpfile.js +23 -23
  84. package/lib/assets/mkdocs.yml +65 -65
  85. package/lib/assets/ops/docker/mkdoc/Dockerfile +19 -19
  86. package/lib/assets/ops/scripts/journal.js +180 -180
  87. package/lib/assets/ops/scripts/mkdocs.js +82 -82
  88. package/lib/assets/ops/scripts/release.js +431 -431
  89. package/lib/assets/ops/scripts/ssh.js +190 -190
  90. package/lib/assets/ops/scripts/vault.js +299 -299
  91. package/lib/assets/package-lock.json +1653 -1653
  92. package/lib/assets/package.json +40 -40
  93. package/lib/gulpfile.js +37 -37
  94. package/package.json +41 -41
@@ -1,663 +1,663 @@
1
- # 環境変数管理ガイド
2
-
3
- このドキュメントでは、プロジェクトで使用する環境変数について説明します。
4
-
5
- ## dotenv とは
6
-
7
- ### 概要
8
-
9
- **dotenv** は、環境変数を `.env` ファイルから読み込むためのライブラリです。アプリケーションの設定値をソースコードから分離し、環境ごとに異なる設定を簡単に管理できます。
10
-
11
- ### なぜ dotenv を使うのか
12
-
13
- 1. **セキュリティ**: パスワードや API キーをソースコードにハードコーディングせず、Git 管理外のファイルで管理
14
- 2. **環境の分離**: 開発・ステージング・本番環境で異なる設定を簡単に切り替え
15
- 3. **チーム開発**: 各開発者が自分の環境に合わせた設定を使用可能
16
- 4. **12-Factor App**: [The Twelve-Factor App](https://12factor.net/ja/config) の設定管理ベストプラクティスに準拠
17
-
18
- ### 仕組み
19
-
20
- ```plantuml
21
- @startuml
22
- title dotenv による環境変数読み込みの流れ
23
-
24
- skinparam rectangle {
25
- BackgroundColor #f5f5f5
26
- BorderColor #333333
27
- }
28
-
29
- rectangle ".env ファイル" as env
30
- rectangle "process.env (Node.js)" as process
31
- rectangle "アプリケーションコード" as app
32
-
33
- env -down-> process : dotenv が読み込み
34
- process -down-> app : アプリケーションで使用
35
-
36
- note right of env
37
- MKDOCS_PORT=8000
38
- DOCKER_HOST=npipe:////./pipe/docker_engine
39
- end note
40
-
41
- note right of process
42
- process.env.MKDOCS_PORT
43
- process.env.DOCKER_HOST
44
- end note
45
-
46
- note right of app
47
- const port = process.env.MKDOCS_PORT;
48
- end note
49
-
50
- @enduml
51
- ```
52
-
53
- ## セットアップ方法
54
-
55
- ### 1. パッケージのインストール
56
-
57
- ```bash
58
- npm install dotenv
59
- ```
60
-
61
- ### 2. .env ファイルの作成
62
-
63
- ```bash
64
- # テンプレートからコピー
65
- cp .env.example .env
66
-
67
- # または新規作成
68
- touch .env
69
- ```
70
-
71
- ### 3. .env ファイルの編集
72
-
73
- ```bash
74
- # プロジェクトルート/.env
75
- MKDOCS_PORT=8000
76
- ```
77
-
78
- ### 4. アプリケーションでの読み込み
79
-
80
- ```javascript
81
- // 方法1: エントリーポイントの先頭でインポート(推奨)
82
- import 'dotenv/config';
83
-
84
- // 方法2: 明示的に config() を呼び出し
85
- import * as dotenv from 'dotenv';
86
- dotenv.config();
87
-
88
- // 環境変数を使用
89
- const port = process.env.MKDOCS_PORT || 8000;
90
- ```
91
-
92
- ### 5. .gitignore に追加
93
-
94
- ```gitignore
95
- # .gitignore
96
- .env
97
- .env.local
98
- .env.*.local
99
- ```
100
-
101
- ## 環境変数ファイル一覧
102
-
103
- | ファイル | 用途 | Git 管理 |
104
- |---------|------|----------|
105
- | `.env` | ローカル開発用設定 | ✗ |
106
- | `.env.example` | 設定テンプレート | ✓ |
107
-
108
- ## プロジェクト環境変数
109
-
110
- ### Docker 設定
111
-
112
- | 変数名 | 説明 | デフォルト値 |
113
- |--------|------|-------------|
114
- | `DOCKER_HOST` | Docker デーモンへの接続先 | (システム依存) |
115
-
116
- ### MkDocs 設定
117
-
118
- | 変数名 | 説明 | デフォルト値 |
119
- |--------|------|-------------|
120
- | `MKDOCS_PORT` | MkDocs サーバーのポート番号 | `8000` |
121
-
122
- ## 重要な注意事項
123
-
124
- ### DOCKER_HOST 環境変数について
125
-
126
- Docker Desktop 使用時に `DOCKER_HOST` 環境変数が不正に設定されていると接続エラーが発生します。
127
-
128
- ```
129
- ERROR: error during connect: Head "http://.%2Fpipe%2Fdocker_engine/_ping":
130
- open ./pipe/docker_engine: The system cannot find the path specified.
131
- ```
132
-
133
- **Windows 環境での正しい設定:**
134
-
135
- ```bash
136
- # 正しい形式
137
- DOCKER_HOST=npipe:////./pipe/docker_engine
138
-
139
- # 誤った形式(エラーになる)
140
- DOCKER_HOST=npipe://./pipe/docker_engine
141
- ```
142
-
143
- **解決方法:**
144
-
145
- ```bash
146
- # 環境変数を削除(Docker Desktop が自動設定する)
147
- unset DOCKER_HOST
148
- ```
149
-
150
- > **注意**: 本プロジェクトの gulp タスクは Windows 環境で自動的に `DOCKER_HOST` を正規化します。
151
-
152
- ### セキュリティに関する注意
153
-
154
- - `.env` ファイルは Git にコミットしないでください
155
- - 機密情報(API キー、パスワード等)は `.env` ファイルで管理してください
156
- - 本番環境では環境変数を直接設定することを推奨します
157
-
158
- ## .env ファイルの読み込み優先順位
159
-
160
- ```plantuml
161
- @startuml
162
- title Node.js (dotenv) 読み込み優先順位
163
-
164
- skinparam defaultTextAlignment center
165
-
166
- rectangle "1. シェル環境変数\n(最優先)" as shell #ff9999
167
- rectangle "2. .env.local\n(Git 管理外)" as local #ffcc99
168
- rectangle "3. .env\n(ローカル設定)" as env #99ff99
169
-
170
- shell -[hidden]down-> local
171
- local -[hidden]down-> env
172
-
173
- note right of shell : 既存の環境変数は上書きされない
174
- note right of local : ローカル固有の設定
175
- note right of env : デフォルト値
176
-
177
- @enduml
178
- ```
179
-
180
- ## .env ファイルの書き方
181
-
182
- ```bash
183
- # コメントは # で始める
184
-
185
- # 基本的な書き方
186
- KEY=value
187
-
188
- # 値にスペースを含む場合はクォートで囲む
189
- MESSAGE="Hello World"
190
-
191
- # 変数の展開(dotenv-expand が必要)
192
- BASE_URL=http://localhost
193
- API_URL=${BASE_URL}/api
194
- ```
195
-
196
- ## ベストプラクティス
197
-
198
- | Do | Don't |
199
- |----|-------|
200
- | `.env.example` をテンプレートとして Git 管理 | `.env` を Git にコミット |
201
- | 本番環境では環境変数を直接設定 | 本番環境で `.env` ファイルを使用 |
202
- | 変数名は `SCREAMING_SNAKE_CASE` を使用 | 小文字や camelCase を使用 |
203
- | デフォルト値をコードで設定 | `.env` ファイルのみに依存 |
204
-
205
- ```javascript
206
- // デフォルト値の設定例
207
- const port = process.env.MKDOCS_PORT || 8000;
208
- const nodeEnv = process.env.NODE_ENV || 'development';
209
- ```
210
-
211
- ## Vault(暗号化・復号化)
212
-
213
- ### 概要
214
-
215
- Vault は `.env` ファイルを安全に暗号化・復号化するためのツールです。暗号化されたファイル(`.env.vault`)は Git にコミットでき、チームメンバー間で安全に環境変数を共有できます。
216
-
217
- ### なぜ Vault を使うのか
218
-
219
- 1. **チーム間での秘密情報共有**: `.env` を直接共有せず、暗号化して Git 管理
220
- 2. **環境の再現性**: 新しいメンバーがすぐに開発環境を構築可能
221
- 3. **セキュリティ**: AES-256-GCM による強力な暗号化
222
- 4. **シンプルさ**: 外部サービス不要、パスワードのみで運用
223
-
224
- ### 暗号化仕様
225
-
226
- ```plantuml
227
- @startuml
228
- title Vault 暗号化の仕組み
229
-
230
- skinparam rectangle {
231
- BackgroundColor #f5f5f5
232
- BorderColor #333333
233
- }
234
-
235
- rectangle "パスワード" as password
236
- rectangle "ソルト\n(32バイト乱数)" as salt
237
- rectangle "PBKDF2\n(SHA-512, 100,000回)" as pbkdf2
238
- rectangle "暗号化キー\n(256ビット)" as key
239
- rectangle "IV\n(16バイト乱数)" as iv
240
- rectangle "AES-256-GCM" as aes
241
- rectangle ".env\n(平文)" as plaintext
242
- rectangle ".env.vault\n(暗号文)" as ciphertext
243
-
244
- password -down-> pbkdf2
245
- salt -down-> pbkdf2
246
- pbkdf2 -down-> key
247
- key -down-> aes
248
- iv -down-> aes
249
- plaintext -right-> aes
250
- aes -down-> ciphertext
251
-
252
- note right of pbkdf2
253
- 100,000回のイテレーションで
254
- ブルートフォース攻撃を困難に
255
- end note
256
-
257
- note right of aes
258
- 認証付き暗号(AEAD)
259
- 改ざん検知機能付き
260
- end note
261
-
262
- @enduml
263
- ```
264
-
265
- | 項目 | 値 |
266
- |------|-----|
267
- | 暗号化アルゴリズム | AES-256-GCM(認証付き暗号) |
268
- | 鍵導出関数 | PBKDF2-SHA512 |
269
- | イテレーション回数 | 100,000 回 |
270
- | ソルト長 | 32 バイト(毎回ランダム生成) |
271
- | IV(初期化ベクトル)長 | 16 バイト(毎回ランダム生成) |
272
- | 認証タグ長 | 16 バイト |
273
-
274
- ### .env.vault ファイル形式
275
-
276
- 暗号化されたファイルはバイナリ形式で、以下の構造を持ちます:
277
-
278
- ```
279
- +------------------+
280
- | Salt (32 bytes) |
281
- +------------------+
282
- | IV (16 bytes) |
283
- +------------------+
284
- | AuthTag (16 bytes)|
285
- +------------------+
286
- | Ciphertext |
287
- | (可変長) |
288
- +------------------+
289
- ```
290
-
291
- ### コマンド詳細
292
-
293
- #### vault:encrypt
294
-
295
- `.env` ファイルを暗号化して `.env.vault` を作成します。
296
-
297
- ```bash
298
- npm run vault:encrypt
299
- ```
300
-
301
- **動作フロー:**
302
-
303
- ```plantuml
304
- @startuml
305
- title vault:encrypt の動作フロー
306
-
307
- start
308
- :.env ファイルの存在確認;
309
-
310
- if (.env が存在する?) then (yes)
311
- :パスワード入力を要求;
312
- :パスワード確認入力を要求;
313
-
314
- if (パスワードが一致?) then (yes)
315
- if (8文字以上?) then (yes)
316
- :ソルトを生成(32バイト乱数);
317
- :PBKDF2で暗号化キーを導出;
318
- :IVを生成(16バイト乱数);
319
- :AES-256-GCMで暗号化;
320
- :.env.vault を出力;
321
- :成功メッセージを表示;
322
- else (no)
323
- :エラー: パスワードが短すぎる;
324
- stop
325
- endif
326
- else (no)
327
- :エラー: パスワードが一致しない;
328
- stop
329
- endif
330
- else (no)
331
- :エラー: .env が見つからない;
332
- stop
333
- endif
334
-
335
- stop
336
- @enduml
337
- ```
338
-
339
- **オプション:**
340
-
341
- | 環境変数 | 説明 |
342
- |---------|------|
343
- | `VAULT_PASSWORD` | パスワードを事前に指定(対話入力をスキップ) |
344
-
345
- **例:**
346
-
347
- ```bash
348
- # 対話的にパスワードを入力
349
- npm run vault:encrypt
350
-
351
- # 環境変数でパスワードを指定(CI/CD 用)
352
- VAULT_PASSWORD=my-secret-password npm run vault:encrypt
353
- ```
354
-
355
- ---
356
-
357
- #### vault:decrypt
358
-
359
- `.env.vault` ファイルを復号化して `.env` を復元します。
360
-
361
- ```bash
362
- npm run vault:decrypt
363
- ```
364
-
365
- **動作フロー:**
366
-
367
- ```plantuml
368
- @startuml
369
- title vault:decrypt の動作フロー
370
-
371
- start
372
- :.env.vault ファイルの存在確認;
373
-
374
- if (.env.vault が存在する?) then (yes)
375
- if (.env が既に存在する?) then (yes)
376
- :上書き確認を表示;
377
- if (上書きを許可?) then (yes)
378
- else (no)
379
- :処理を中止;
380
- stop
381
- endif
382
- endif
383
-
384
- :パスワード入力を要求;
385
- :暗号化ファイルを読み込み;
386
- :ソルト・IV・認証タグを抽出;
387
- :PBKDF2で暗号化キーを導出;
388
-
389
- if (復号化成功?) then (yes)
390
- :.env を出力;
391
- :成功メッセージを表示;
392
- else (no)
393
- :エラー: パスワードが正しくない;
394
- stop
395
- endif
396
- else (no)
397
- :エラー: .env.vault が見つからない;
398
- stop
399
- endif
400
-
401
- stop
402
- @enduml
403
- ```
404
-
405
- **例:**
406
-
407
- ```bash
408
- # 対話的にパスワードを入力
409
- npm run vault:decrypt
410
-
411
- # 環境変数でパスワードを指定
412
- VAULT_PASSWORD=my-secret-password npm run vault:decrypt
413
- ```
414
-
415
- ---
416
-
417
- #### vault:view
418
-
419
- `.env.vault` の内容を復号化して表示します。ファイルは作成されません。
420
-
421
- ```bash
422
- npm run vault:view
423
- ```
424
-
425
- **用途:**
426
-
427
- - 暗号化された内容を確認したいが、`.env` ファイルを作成したくない場合
428
- - CI/CD パイプラインでのデバッグ
429
- - 復号化前の内容確認
430
-
431
- **例:**
432
-
433
- ```bash
434
- # 内容を確認
435
- npm run vault:view
436
-
437
- # 出力例:
438
- # --- .env.vault contents ---
439
- #
440
- # DATABASE_URL=mysql://user:pass@localhost:3306/mydb
441
- # API_KEY=sk-xxxxxxxxxxxx
442
- #
443
- # --- end ---
444
- ```
445
-
446
- ---
447
-
448
- #### vault:rekey
449
-
450
- 現在のパスワードで復号化し、新しいパスワードで再暗号化します。
451
-
452
- ```bash
453
- npm run vault:rekey
454
- ```
455
-
456
- **動作フロー:**
457
-
458
- ```plantuml
459
- @startuml
460
- title vault:rekey の動作フロー
461
-
462
- start
463
- :.env.vault ファイルの存在確認;
464
-
465
- if (.env.vault が存在する?) then (yes)
466
- :現在のパスワード入力を要求;
467
-
468
- if (復号化成功?) then (yes)
469
- :新しいパスワード入力を要求;
470
- :新しいパスワード確認入力を要求;
471
-
472
- if (パスワードが一致 & 8文字以上?) then (yes)
473
- :新しいソルト・IVを生成;
474
- :新しいパスワードで再暗号化;
475
- :.env.vault を上書き;
476
- :成功メッセージを表示;
477
- else (no)
478
- :エラー: パスワード要件を満たさない;
479
- stop
480
- endif
481
- else (no)
482
- :エラー: 現在のパスワードが正しくない;
483
- stop
484
- endif
485
- else (no)
486
- :エラー: .env.vault が見つからない;
487
- stop
488
- endif
489
-
490
- stop
491
- @enduml
492
- ```
493
-
494
- **用途:**
495
-
496
- - 定期的なパスワードローテーション
497
- - チームメンバーの退職時
498
- - パスワード漏洩の疑いがある場合
499
-
500
- ### 使い方
501
-
502
- #### 初回セットアップ(暗号化)
503
-
504
- ```bash
505
- # 1. .env ファイルを作成・編集
506
- cp .env.example .env
507
- vim .env
508
-
509
- # 2. 暗号化(パスワード入力を求められる)
510
- npm run vault:encrypt
511
- # New vault password: ********
512
- # Confirm vault password: ********
513
- # Encrypted .env -> .env.vault
514
-
515
- # 3. 暗号化ファイルをコミット
516
- git add .env.vault
517
- git commit -m "Add encrypted environment file"
518
- ```
519
-
520
- #### 別の環境での復元(復号化)
521
-
522
- ```bash
523
- # 1. リポジトリをクローン
524
- git clone <repository>
525
- cd <project>
526
-
527
- # 2. 依存関係をインストール
528
- npm install
529
-
530
- # 3. 暗号化ファイルを復号化(パスワード入力を求められる)
531
- npm run vault:decrypt
532
- # Vault password: ********
533
- # Decrypted .env.vault -> .env
534
- ```
535
-
536
- #### CI/CD での使用
537
-
538
- ```yaml
539
- # GitHub Actions の例
540
- jobs:
541
- deploy:
542
- runs-on: ubuntu-latest
543
- steps:
544
- - uses: actions/checkout@v4
545
- - uses: actions/setup-node@v4
546
- with:
547
- node-version: '20'
548
- - run: npm install
549
- - run: npm run vault:decrypt
550
- env:
551
- VAULT_PASSWORD: ${{ secrets.VAULT_PASSWORD }}
552
- - run: npm run deploy
553
- ```
554
-
555
- #### パスワードの変更
556
-
557
- ```bash
558
- # 現在のパスワードと新しいパスワードを入力
559
- npm run vault:rekey
560
- # Enter current password:
561
- # Current vault password: ********
562
- #
563
- # Enter new password:
564
- # New vault password: ********
565
- # Confirm vault password: ********
566
- # Re-encrypted .env.vault with new password.
567
- ```
568
-
569
- ### ワークフロー
570
-
571
- ```plantuml
572
- @startuml
573
- title Vault ワークフロー
574
-
575
- actor 開発者A as devA
576
- actor 開発者B as devB
577
- database Git as git
578
-
579
- devA -> devA: .env を編集
580
- devA -> devA: npm run vault:encrypt
581
- devA -> git: .env.vault をコミット
582
-
583
- git -> devB: git pull
584
- devB -> devB: npm run vault:decrypt
585
- devB -> devB: .env が復元される
586
-
587
- note right of devA
588
- パスワードは安全な方法で
589
- チームに共有
590
- end note
591
-
592
- @enduml
593
- ```
594
-
595
- ### セキュリティのベストプラクティス
596
-
597
- | Do | Don't |
598
- |----|-------|
599
- | 8 文字以上の強力なパスワードを使用 | 短い・推測しやすいパスワードを使用 |
600
- | パスワードを安全な方法で共有(1Password など) | パスワードを Slack やメールで送信 |
601
- | `.env.vault` を Git にコミット | `.env` を Git にコミット |
602
- | 定期的にパスワードを変更(vault:rekey) | 同じパスワードを長期間使用 |
603
- | CI/CD では Secrets 機能を使用 | CI/CD ログにパスワードを出力 |
604
-
605
- ### 注意事項
606
-
607
- - パスワードを忘れると復号化できなくなります(復旧不可)
608
- - `.env.vault` を Git に追加しても `.env` は `.gitignore` で除外されています
609
- - CI/CD 環境では `VAULT_PASSWORD` 環境変数を使用してください
610
- - 同じ内容でも暗号化するたびに異なる出力になります(ソルトとIVがランダム)
611
-
612
- ### Vault トラブルシューティング
613
-
614
- #### 復号化に失敗する
615
-
616
- ```
617
- Error: Invalid password
618
- ```
619
-
620
- **原因:** パスワードが正しくない
621
-
622
- **解決策:**
623
- 1. パスワードを再確認
624
- 2. Caps Lock がオフになっているか確認
625
- 3. パスワードマネージャーから正しいパスワードをコピー
626
-
627
- #### .env.vault が見つからない
628
-
629
- ```
630
- Error: .env.vault not found
631
- ```
632
-
633
- **原因:** 暗号化ファイルが存在しない
634
-
635
- **解決策:**
636
- 1. `git pull` で最新を取得
637
- 2. `.env.vault` がコミットされているか確認
638
- 3. まだ暗号化されていない場合は `vault:encrypt` を実行
639
-
640
- #### パスワードが短すぎる
641
-
642
- ```
643
- Error: Password must be at least 8 characters
644
- ```
645
-
646
- **原因:** 8 文字未満のパスワードを入力
647
-
648
- **解決策:**
649
- 8 文字以上のパスワードを使用してください。推奨は 12 文字以上。
650
-
651
- ## トラブルシューティング
652
-
653
- ### 環境変数が読み込まれない
654
-
655
- 1. `.env` ファイルがプロジェクトルートにあるか確認
656
- 2. `dotenv/config` がエントリーポイントの先頭でインポートされているか確認
657
- 3. 変数名にタイポがないか確認
658
-
659
- ### Docker 接続エラー
660
-
661
- 1. Docker Desktop が起動しているか確認
662
- 2. `DOCKER_HOST` 環境変数が正しく設定されているか確認
663
- 3. 必要に応じて `unset DOCKER_HOST` を実行
1
+ # 環境変数管理ガイド
2
+
3
+ このドキュメントでは、プロジェクトで使用する環境変数について説明します。
4
+
5
+ ## dotenv とは
6
+
7
+ ### 概要
8
+
9
+ **dotenv** は、環境変数を `.env` ファイルから読み込むためのライブラリです。アプリケーションの設定値をソースコードから分離し、環境ごとに異なる設定を簡単に管理できます。
10
+
11
+ ### なぜ dotenv を使うのか
12
+
13
+ 1. **セキュリティ**: パスワードや API キーをソースコードにハードコーディングせず、Git 管理外のファイルで管理
14
+ 2. **環境の分離**: 開発・ステージング・本番環境で異なる設定を簡単に切り替え
15
+ 3. **チーム開発**: 各開発者が自分の環境に合わせた設定を使用可能
16
+ 4. **12-Factor App**: [The Twelve-Factor App](https://12factor.net/ja/config) の設定管理ベストプラクティスに準拠
17
+
18
+ ### 仕組み
19
+
20
+ ```plantuml
21
+ @startuml
22
+ title dotenv による環境変数読み込みの流れ
23
+
24
+ skinparam rectangle {
25
+ BackgroundColor #f5f5f5
26
+ BorderColor #333333
27
+ }
28
+
29
+ rectangle ".env ファイル" as env
30
+ rectangle "process.env (Node.js)" as process
31
+ rectangle "アプリケーションコード" as app
32
+
33
+ env -down-> process : dotenv が読み込み
34
+ process -down-> app : アプリケーションで使用
35
+
36
+ note right of env
37
+ MKDOCS_PORT=8000
38
+ DOCKER_HOST=npipe:////./pipe/docker_engine
39
+ end note
40
+
41
+ note right of process
42
+ process.env.MKDOCS_PORT
43
+ process.env.DOCKER_HOST
44
+ end note
45
+
46
+ note right of app
47
+ const port = process.env.MKDOCS_PORT;
48
+ end note
49
+
50
+ @enduml
51
+ ```
52
+
53
+ ## セットアップ方法
54
+
55
+ ### 1. パッケージのインストール
56
+
57
+ ```bash
58
+ npm install dotenv
59
+ ```
60
+
61
+ ### 2. .env ファイルの作成
62
+
63
+ ```bash
64
+ # テンプレートからコピー
65
+ cp .env.example .env
66
+
67
+ # または新規作成
68
+ touch .env
69
+ ```
70
+
71
+ ### 3. .env ファイルの編集
72
+
73
+ ```bash
74
+ # プロジェクトルート/.env
75
+ MKDOCS_PORT=8000
76
+ ```
77
+
78
+ ### 4. アプリケーションでの読み込み
79
+
80
+ ```javascript
81
+ // 方法1: エントリーポイントの先頭でインポート(推奨)
82
+ import 'dotenv/config';
83
+
84
+ // 方法2: 明示的に config() を呼び出し
85
+ import * as dotenv from 'dotenv';
86
+ dotenv.config();
87
+
88
+ // 環境変数を使用
89
+ const port = process.env.MKDOCS_PORT || 8000;
90
+ ```
91
+
92
+ ### 5. .gitignore に追加
93
+
94
+ ```gitignore
95
+ # .gitignore
96
+ .env
97
+ .env.local
98
+ .env.*.local
99
+ ```
100
+
101
+ ## 環境変数ファイル一覧
102
+
103
+ | ファイル | 用途 | Git 管理 |
104
+ |---------|------|----------|
105
+ | `.env` | ローカル開発用設定 | ✗ |
106
+ | `.env.example` | 設定テンプレート | ✓ |
107
+
108
+ ## プロジェクト環境変数
109
+
110
+ ### Docker 設定
111
+
112
+ | 変数名 | 説明 | デフォルト値 |
113
+ |--------|------|-------------|
114
+ | `DOCKER_HOST` | Docker デーモンへの接続先 | (システム依存) |
115
+
116
+ ### MkDocs 設定
117
+
118
+ | 変数名 | 説明 | デフォルト値 |
119
+ |--------|------|-------------|
120
+ | `MKDOCS_PORT` | MkDocs サーバーのポート番号 | `8000` |
121
+
122
+ ## 重要な注意事項
123
+
124
+ ### DOCKER_HOST 環境変数について
125
+
126
+ Docker Desktop 使用時に `DOCKER_HOST` 環境変数が不正に設定されていると接続エラーが発生します。
127
+
128
+ ```
129
+ ERROR: error during connect: Head "http://.%2Fpipe%2Fdocker_engine/_ping":
130
+ open ./pipe/docker_engine: The system cannot find the path specified.
131
+ ```
132
+
133
+ **Windows 環境での正しい設定:**
134
+
135
+ ```bash
136
+ # 正しい形式
137
+ DOCKER_HOST=npipe:////./pipe/docker_engine
138
+
139
+ # 誤った形式(エラーになる)
140
+ DOCKER_HOST=npipe://./pipe/docker_engine
141
+ ```
142
+
143
+ **解決方法:**
144
+
145
+ ```bash
146
+ # 環境変数を削除(Docker Desktop が自動設定する)
147
+ unset DOCKER_HOST
148
+ ```
149
+
150
+ > **注意**: 本プロジェクトの gulp タスクは Windows 環境で自動的に `DOCKER_HOST` を正規化します。
151
+
152
+ ### セキュリティに関する注意
153
+
154
+ - `.env` ファイルは Git にコミットしないでください
155
+ - 機密情報(API キー、パスワード等)は `.env` ファイルで管理してください
156
+ - 本番環境では環境変数を直接設定することを推奨します
157
+
158
+ ## .env ファイルの読み込み優先順位
159
+
160
+ ```plantuml
161
+ @startuml
162
+ title Node.js (dotenv) 読み込み優先順位
163
+
164
+ skinparam defaultTextAlignment center
165
+
166
+ rectangle "1. シェル環境変数\n(最優先)" as shell #ff9999
167
+ rectangle "2. .env.local\n(Git 管理外)" as local #ffcc99
168
+ rectangle "3. .env\n(ローカル設定)" as env #99ff99
169
+
170
+ shell -[hidden]down-> local
171
+ local -[hidden]down-> env
172
+
173
+ note right of shell : 既存の環境変数は上書きされない
174
+ note right of local : ローカル固有の設定
175
+ note right of env : デフォルト値
176
+
177
+ @enduml
178
+ ```
179
+
180
+ ## .env ファイルの書き方
181
+
182
+ ```bash
183
+ # コメントは # で始める
184
+
185
+ # 基本的な書き方
186
+ KEY=value
187
+
188
+ # 値にスペースを含む場合はクォートで囲む
189
+ MESSAGE="Hello World"
190
+
191
+ # 変数の展開(dotenv-expand が必要)
192
+ BASE_URL=http://localhost
193
+ API_URL=${BASE_URL}/api
194
+ ```
195
+
196
+ ## ベストプラクティス
197
+
198
+ | Do | Don't |
199
+ |----|-------|
200
+ | `.env.example` をテンプレートとして Git 管理 | `.env` を Git にコミット |
201
+ | 本番環境では環境変数を直接設定 | 本番環境で `.env` ファイルを使用 |
202
+ | 変数名は `SCREAMING_SNAKE_CASE` を使用 | 小文字や camelCase を使用 |
203
+ | デフォルト値をコードで設定 | `.env` ファイルのみに依存 |
204
+
205
+ ```javascript
206
+ // デフォルト値の設定例
207
+ const port = process.env.MKDOCS_PORT || 8000;
208
+ const nodeEnv = process.env.NODE_ENV || 'development';
209
+ ```
210
+
211
+ ## Vault(暗号化・復号化)
212
+
213
+ ### 概要
214
+
215
+ Vault は `.env` ファイルを安全に暗号化・復号化するためのツールです。暗号化されたファイル(`.env.vault`)は Git にコミットでき、チームメンバー間で安全に環境変数を共有できます。
216
+
217
+ ### なぜ Vault を使うのか
218
+
219
+ 1. **チーム間での秘密情報共有**: `.env` を直接共有せず、暗号化して Git 管理
220
+ 2. **環境の再現性**: 新しいメンバーがすぐに開発環境を構築可能
221
+ 3. **セキュリティ**: AES-256-GCM による強力な暗号化
222
+ 4. **シンプルさ**: 外部サービス不要、パスワードのみで運用
223
+
224
+ ### 暗号化仕様
225
+
226
+ ```plantuml
227
+ @startuml
228
+ title Vault 暗号化の仕組み
229
+
230
+ skinparam rectangle {
231
+ BackgroundColor #f5f5f5
232
+ BorderColor #333333
233
+ }
234
+
235
+ rectangle "パスワード" as password
236
+ rectangle "ソルト\n(32バイト乱数)" as salt
237
+ rectangle "PBKDF2\n(SHA-512, 100,000回)" as pbkdf2
238
+ rectangle "暗号化キー\n(256ビット)" as key
239
+ rectangle "IV\n(16バイト乱数)" as iv
240
+ rectangle "AES-256-GCM" as aes
241
+ rectangle ".env\n(平文)" as plaintext
242
+ rectangle ".env.vault\n(暗号文)" as ciphertext
243
+
244
+ password -down-> pbkdf2
245
+ salt -down-> pbkdf2
246
+ pbkdf2 -down-> key
247
+ key -down-> aes
248
+ iv -down-> aes
249
+ plaintext -right-> aes
250
+ aes -down-> ciphertext
251
+
252
+ note right of pbkdf2
253
+ 100,000回のイテレーションで
254
+ ブルートフォース攻撃を困難に
255
+ end note
256
+
257
+ note right of aes
258
+ 認証付き暗号(AEAD)
259
+ 改ざん検知機能付き
260
+ end note
261
+
262
+ @enduml
263
+ ```
264
+
265
+ | 項目 | 値 |
266
+ |------|-----|
267
+ | 暗号化アルゴリズム | AES-256-GCM(認証付き暗号) |
268
+ | 鍵導出関数 | PBKDF2-SHA512 |
269
+ | イテレーション回数 | 100,000 回 |
270
+ | ソルト長 | 32 バイト(毎回ランダム生成) |
271
+ | IV(初期化ベクトル)長 | 16 バイト(毎回ランダム生成) |
272
+ | 認証タグ長 | 16 バイト |
273
+
274
+ ### .env.vault ファイル形式
275
+
276
+ 暗号化されたファイルはバイナリ形式で、以下の構造を持ちます:
277
+
278
+ ```
279
+ +------------------+
280
+ | Salt (32 bytes) |
281
+ +------------------+
282
+ | IV (16 bytes) |
283
+ +------------------+
284
+ | AuthTag (16 bytes)|
285
+ +------------------+
286
+ | Ciphertext |
287
+ | (可変長) |
288
+ +------------------+
289
+ ```
290
+
291
+ ### コマンド詳細
292
+
293
+ #### vault:encrypt
294
+
295
+ `.env` ファイルを暗号化して `.env.vault` を作成します。
296
+
297
+ ```bash
298
+ npm run vault:encrypt
299
+ ```
300
+
301
+ **動作フロー:**
302
+
303
+ ```plantuml
304
+ @startuml
305
+ title vault:encrypt の動作フロー
306
+
307
+ start
308
+ :.env ファイルの存在確認;
309
+
310
+ if (.env が存在する?) then (yes)
311
+ :パスワード入力を要求;
312
+ :パスワード確認入力を要求;
313
+
314
+ if (パスワードが一致?) then (yes)
315
+ if (8文字以上?) then (yes)
316
+ :ソルトを生成(32バイト乱数);
317
+ :PBKDF2で暗号化キーを導出;
318
+ :IVを生成(16バイト乱数);
319
+ :AES-256-GCMで暗号化;
320
+ :.env.vault を出力;
321
+ :成功メッセージを表示;
322
+ else (no)
323
+ :エラー: パスワードが短すぎる;
324
+ stop
325
+ endif
326
+ else (no)
327
+ :エラー: パスワードが一致しない;
328
+ stop
329
+ endif
330
+ else (no)
331
+ :エラー: .env が見つからない;
332
+ stop
333
+ endif
334
+
335
+ stop
336
+ @enduml
337
+ ```
338
+
339
+ **オプション:**
340
+
341
+ | 環境変数 | 説明 |
342
+ |---------|------|
343
+ | `VAULT_PASSWORD` | パスワードを事前に指定(対話入力をスキップ) |
344
+
345
+ **例:**
346
+
347
+ ```bash
348
+ # 対話的にパスワードを入力
349
+ npm run vault:encrypt
350
+
351
+ # 環境変数でパスワードを指定(CI/CD 用)
352
+ VAULT_PASSWORD=my-secret-password npm run vault:encrypt
353
+ ```
354
+
355
+ ---
356
+
357
+ #### vault:decrypt
358
+
359
+ `.env.vault` ファイルを復号化して `.env` を復元します。
360
+
361
+ ```bash
362
+ npm run vault:decrypt
363
+ ```
364
+
365
+ **動作フロー:**
366
+
367
+ ```plantuml
368
+ @startuml
369
+ title vault:decrypt の動作フロー
370
+
371
+ start
372
+ :.env.vault ファイルの存在確認;
373
+
374
+ if (.env.vault が存在する?) then (yes)
375
+ if (.env が既に存在する?) then (yes)
376
+ :上書き確認を表示;
377
+ if (上書きを許可?) then (yes)
378
+ else (no)
379
+ :処理を中止;
380
+ stop
381
+ endif
382
+ endif
383
+
384
+ :パスワード入力を要求;
385
+ :暗号化ファイルを読み込み;
386
+ :ソルト・IV・認証タグを抽出;
387
+ :PBKDF2で暗号化キーを導出;
388
+
389
+ if (復号化成功?) then (yes)
390
+ :.env を出力;
391
+ :成功メッセージを表示;
392
+ else (no)
393
+ :エラー: パスワードが正しくない;
394
+ stop
395
+ endif
396
+ else (no)
397
+ :エラー: .env.vault が見つからない;
398
+ stop
399
+ endif
400
+
401
+ stop
402
+ @enduml
403
+ ```
404
+
405
+ **例:**
406
+
407
+ ```bash
408
+ # 対話的にパスワードを入力
409
+ npm run vault:decrypt
410
+
411
+ # 環境変数でパスワードを指定
412
+ VAULT_PASSWORD=my-secret-password npm run vault:decrypt
413
+ ```
414
+
415
+ ---
416
+
417
+ #### vault:view
418
+
419
+ `.env.vault` の内容を復号化して表示します。ファイルは作成されません。
420
+
421
+ ```bash
422
+ npm run vault:view
423
+ ```
424
+
425
+ **用途:**
426
+
427
+ - 暗号化された内容を確認したいが、`.env` ファイルを作成したくない場合
428
+ - CI/CD パイプラインでのデバッグ
429
+ - 復号化前の内容確認
430
+
431
+ **例:**
432
+
433
+ ```bash
434
+ # 内容を確認
435
+ npm run vault:view
436
+
437
+ # 出力例:
438
+ # --- .env.vault contents ---
439
+ #
440
+ # DATABASE_URL=mysql://user:pass@localhost:3306/mydb
441
+ # API_KEY=sk-xxxxxxxxxxxx
442
+ #
443
+ # --- end ---
444
+ ```
445
+
446
+ ---
447
+
448
+ #### vault:rekey
449
+
450
+ 現在のパスワードで復号化し、新しいパスワードで再暗号化します。
451
+
452
+ ```bash
453
+ npm run vault:rekey
454
+ ```
455
+
456
+ **動作フロー:**
457
+
458
+ ```plantuml
459
+ @startuml
460
+ title vault:rekey の動作フロー
461
+
462
+ start
463
+ :.env.vault ファイルの存在確認;
464
+
465
+ if (.env.vault が存在する?) then (yes)
466
+ :現在のパスワード入力を要求;
467
+
468
+ if (復号化成功?) then (yes)
469
+ :新しいパスワード入力を要求;
470
+ :新しいパスワード確認入力を要求;
471
+
472
+ if (パスワードが一致 & 8文字以上?) then (yes)
473
+ :新しいソルト・IVを生成;
474
+ :新しいパスワードで再暗号化;
475
+ :.env.vault を上書き;
476
+ :成功メッセージを表示;
477
+ else (no)
478
+ :エラー: パスワード要件を満たさない;
479
+ stop
480
+ endif
481
+ else (no)
482
+ :エラー: 現在のパスワードが正しくない;
483
+ stop
484
+ endif
485
+ else (no)
486
+ :エラー: .env.vault が見つからない;
487
+ stop
488
+ endif
489
+
490
+ stop
491
+ @enduml
492
+ ```
493
+
494
+ **用途:**
495
+
496
+ - 定期的なパスワードローテーション
497
+ - チームメンバーの退職時
498
+ - パスワード漏洩の疑いがある場合
499
+
500
+ ### 使い方
501
+
502
+ #### 初回セットアップ(暗号化)
503
+
504
+ ```bash
505
+ # 1. .env ファイルを作成・編集
506
+ cp .env.example .env
507
+ vim .env
508
+
509
+ # 2. 暗号化(パスワード入力を求められる)
510
+ npm run vault:encrypt
511
+ # New vault password: ********
512
+ # Confirm vault password: ********
513
+ # Encrypted .env -> .env.vault
514
+
515
+ # 3. 暗号化ファイルをコミット
516
+ git add .env.vault
517
+ git commit -m "Add encrypted environment file"
518
+ ```
519
+
520
+ #### 別の環境での復元(復号化)
521
+
522
+ ```bash
523
+ # 1. リポジトリをクローン
524
+ git clone <repository>
525
+ cd <project>
526
+
527
+ # 2. 依存関係をインストール
528
+ npm install
529
+
530
+ # 3. 暗号化ファイルを復号化(パスワード入力を求められる)
531
+ npm run vault:decrypt
532
+ # Vault password: ********
533
+ # Decrypted .env.vault -> .env
534
+ ```
535
+
536
+ #### CI/CD での使用
537
+
538
+ ```yaml
539
+ # GitHub Actions の例
540
+ jobs:
541
+ deploy:
542
+ runs-on: ubuntu-latest
543
+ steps:
544
+ - uses: actions/checkout@v4
545
+ - uses: actions/setup-node@v4
546
+ with:
547
+ node-version: '20'
548
+ - run: npm install
549
+ - run: npm run vault:decrypt
550
+ env:
551
+ VAULT_PASSWORD: ${{ secrets.VAULT_PASSWORD }}
552
+ - run: npm run deploy
553
+ ```
554
+
555
+ #### パスワードの変更
556
+
557
+ ```bash
558
+ # 現在のパスワードと新しいパスワードを入力
559
+ npm run vault:rekey
560
+ # Enter current password:
561
+ # Current vault password: ********
562
+ #
563
+ # Enter new password:
564
+ # New vault password: ********
565
+ # Confirm vault password: ********
566
+ # Re-encrypted .env.vault with new password.
567
+ ```
568
+
569
+ ### ワークフロー
570
+
571
+ ```plantuml
572
+ @startuml
573
+ title Vault ワークフロー
574
+
575
+ actor 開発者A as devA
576
+ actor 開発者B as devB
577
+ database Git as git
578
+
579
+ devA -> devA: .env を編集
580
+ devA -> devA: npm run vault:encrypt
581
+ devA -> git: .env.vault をコミット
582
+
583
+ git -> devB: git pull
584
+ devB -> devB: npm run vault:decrypt
585
+ devB -> devB: .env が復元される
586
+
587
+ note right of devA
588
+ パスワードは安全な方法で
589
+ チームに共有
590
+ end note
591
+
592
+ @enduml
593
+ ```
594
+
595
+ ### セキュリティのベストプラクティス
596
+
597
+ | Do | Don't |
598
+ |----|-------|
599
+ | 8 文字以上の強力なパスワードを使用 | 短い・推測しやすいパスワードを使用 |
600
+ | パスワードを安全な方法で共有(1Password など) | パスワードを Slack やメールで送信 |
601
+ | `.env.vault` を Git にコミット | `.env` を Git にコミット |
602
+ | 定期的にパスワードを変更(vault:rekey) | 同じパスワードを長期間使用 |
603
+ | CI/CD では Secrets 機能を使用 | CI/CD ログにパスワードを出力 |
604
+
605
+ ### 注意事項
606
+
607
+ - パスワードを忘れると復号化できなくなります(復旧不可)
608
+ - `.env.vault` を Git に追加しても `.env` は `.gitignore` で除外されています
609
+ - CI/CD 環境では `VAULT_PASSWORD` 環境変数を使用してください
610
+ - 同じ内容でも暗号化するたびに異なる出力になります(ソルトとIVがランダム)
611
+
612
+ ### Vault トラブルシューティング
613
+
614
+ #### 復号化に失敗する
615
+
616
+ ```
617
+ Error: Invalid password
618
+ ```
619
+
620
+ **原因:** パスワードが正しくない
621
+
622
+ **解決策:**
623
+ 1. パスワードを再確認
624
+ 2. Caps Lock がオフになっているか確認
625
+ 3. パスワードマネージャーから正しいパスワードをコピー
626
+
627
+ #### .env.vault が見つからない
628
+
629
+ ```
630
+ Error: .env.vault not found
631
+ ```
632
+
633
+ **原因:** 暗号化ファイルが存在しない
634
+
635
+ **解決策:**
636
+ 1. `git pull` で最新を取得
637
+ 2. `.env.vault` がコミットされているか確認
638
+ 3. まだ暗号化されていない場合は `vault:encrypt` を実行
639
+
640
+ #### パスワードが短すぎる
641
+
642
+ ```
643
+ Error: Password must be at least 8 characters
644
+ ```
645
+
646
+ **原因:** 8 文字未満のパスワードを入力
647
+
648
+ **解決策:**
649
+ 8 文字以上のパスワードを使用してください。推奨は 12 文字以上。
650
+
651
+ ## トラブルシューティング
652
+
653
+ ### 環境変数が読み込まれない
654
+
655
+ 1. `.env` ファイルがプロジェクトルートにあるか確認
656
+ 2. `dotenv/config` がエントリーポイントの先頭でインポートされているか確認
657
+ 3. 変数名にタイポがないか確認
658
+
659
+ ### Docker 接続エラー
660
+
661
+ 1. Docker Desktop が起動しているか確認
662
+ 2. `DOCKER_HOST` 環境変数が正しく設定されているか確認
663
+ 3. 必要に応じて `unset DOCKER_HOST` を実行