Get started
シークレット用プレースホルダーの規則
シークレットのプレースホルダー規則
人が読んで理解しやすく、実際のシークレットには見えないプレースホルダーを使用してください。
推奨スタイル
example-openai-key-not-realやexample-discord-bot-tokenのような、内容が分かる値を推奨します。- シェルスニペットでは、トークンのような文字列を直接記述せず、
${OPENAI_API_KEY}を推奨します。 - 例は明らかに偽物と分かるものにし、用途(プロバイダー、チャンネル、認証タイプ)を明確に限定してください。
ドキュメントで避けるべきパターン
- PEM 秘密鍵のヘッダーまたはフッターのリテラルテキスト。
sk-...、xoxb-...、AKIA...など、実際の認証情報に似たプレフィックス。- ランタイムログからコピーした、実物らしく見えるベアラートークン。
例
# 良い例export OPENAI_API_KEY="example-openai-key-not-real" # より良い例(ドキュメントが環境変数の接続方法を扱う場合)export OPENAI_API_KEY="${OPENAI_API_KEY}"Was this useful?