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