Skip to content

docs: .envrc.example と direnv + 1Password CLI 運用ドキュメントの追加 #26

Description

@shigel

Priority

MEDIUM

背景

ローカル開発における推奨パターンは direnv + 1Password CLI: `.envrc` に `op://vault/item/field` 参照のみを書き、値はディスクに残さず 1Password セッション中だけ環境変数に展開される。静的 `.env` ファイルをディスクに置く運用(AI コーディングエージェントによる誤 commit / 誤 upload リスク)を構造的に排除できる。

現状(未検証 — 実装着手前に要確認)

  • `.envrc.example` の有無 未検証
  • README のセットアップ手順で `.env` を直接書かせる記述があるか 未検証
  • `.gitignore` に `.envrc` が含まれるか 未検証(`.env*` は L8 に記載済み)

提案

  • `.envrc.example` を追加: 必要な環境変数名と `op://` 参照例のみ、値は一切書かない
    ```
    export ANTHROPIC_API_KEY=$(op read "op://Personal/autoforge/anthropic-key")
    export HF_TOKEN=$(op read "op://Personal/autoforge/hf-token")
    ```
  • `docs/setup-dev.md` に 1Password CLI / direnv のインストール手順、vault 構造の推奨
  • `.gitignore` に `.envrc` 追加(`.envrc.example` は commit 対象)
  • 1Password を使わない開発者向けに直接 export する fallback も記載(警告付き)

完了条件

  • `.envrc.example` 追加
  • `docs/setup-dev.md` 新設または README 加筆
  • `.gitignore` 更新
  • 未検証項目の現状確認を PR で記録

参考

Part of #17

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationsecurityセキュリティ関連の issue / PR

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions