Skip to main content

シークレットのプレースホルダー規則

人が読めるが、実際のシークレットに似ていないプレースホルダーを使用します。

推奨スタイル

  • example-openai-key-not-realexample-discord-bot-token のような説明的な値を優先します。
  • シェルスニペットでは、インラインのトークン風文字列より ${OPENAI_API_KEY} を優先します。
  • 例は明らかに偽物で、用途(プロバイダー、チャンネル、認証タイプ)に限定します。

docs で避けるパターン

  • PEM 秘密鍵のヘッダーまたはフッターのリテラルテキスト。
  • 実際の認証情報に似たプレフィックス(例: sk-...xoxb-...AKIA...)。
  • ランタイムログからコピーされた、本物らしく見えるベアラートークン。

# 良い
export OPENAI_API_KEY="example-openai-key-not-real"

# より良い(ドキュメントが env 配線についての場合)
export OPENAI_API_KEY="${OPENAI_API_KEY}"