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