環境設定の確認

.env.example生成

既存の設定からテンプレートを作り、残す内容を確認してから書き出します。

.env.example生成

.envの入力

.env.exampleのプレビュー

ブラウザー内で処理します。入力はメモリ内のみで、URL・テレメトリー・ローカル履歴に保存しません。

テンプレートの設定

代入:5・置換:5・保持:0・重複:0・元のコメント:2

コメント、追加説明、保持した値には秘密情報が残る場合があります。出力を確認してください。コミットして安全だと判定する機能ではありません。

新しいメンバーに必要なのは変数の一覧であり、手元で使っている認証情報ではありません。.env.example生成は数値や真偽値も含めて空にするところから始まります。公開してよいサンプル値だけを、キー名で明示的に指定してください。

行単位の置換では、引用符で囲まれた値の2行目以降が残ることがあります。ここでは代入全体を解析してから値を置換します。構文を認識できない行はそのまま出力せず、処理を止めて位置を知らせます。

.env.example生成を使う理由

宣言を残して値を取り除く

.env.example生成はキーの順序と重複した宣言を維持します。引用符内の複数行も1つの値として空にします。元のコメントは既定で残るため、共有前に内容を確認するか、保持を無効にしてください。

同じキー記号とコメントの配置を保った2つの設定パネルで、右側の値欄だけが空になる図。

例外を説明と一緒に管理する

確認済みのPORTだけを保持し、それ以外を空にできます。KEY=説明で用途を追加すると、対応する宣言の前にコメントが入ります。保持数は実際の代入数を示し、数字だから安全だとは判断しません。

選択した1行だけ値を保ち、他の欄を空にして、それぞれの宣言の前に説明の帯を追加する図。

残す内容を先に決める

01

空欄と置換文字列を使い分ける

値を空にするモードではKEY=を残します。置換モードでは引用符付きの文字列を入れます。どちらも入力を変更しません。置換文字列は記入の目印であり、使える認証情報ではありません。

02

完全なキー名で指定する

保持リストは大文字と小文字を区別し、カンマや空白で区切ります。説明は1行にKEY=説明の形で書き、キーを重複させないでください。見つからない名前は別に表示されます。

03

変更するたびに確認する

自動生成は350ミリ秒待って更新します。無効にするとCtrl/Cmd + Enterで実行できます。入力や設定を変えると確認済み状態が解除され、最新の結果を確認するまで書き出せません。

引き継ぎに必要な情報を整理する

代入を丸ごと処理する

環境変数テンプレートではexport、引用符、空の代入も扱えます。同名キーを1つにまとめず、すべての出現に同じ処理を適用します。最後の値だけを消して以前の値が残る、という処理にはなりません。

置換する文字列を選べる

YOUR_VALUE_HEREのほか、任意の空でない1行を指定できます。引用符とバックスラッシュは値の文字として符号化します。改行や制御文字は受け付けず、別の代入として入り込むことを防ぎます。

コメントを選んで残す

既存の独立コメントと行末コメントをまとめて保持または削除できます。空行は残ります。新しい説明は常にコメントになり、元のコメントを消す設定でも追加できます。

共有前に確認する制限

秘密情報を検出する機能ではない
リストにない値は名前や型に関係なく置換します。数字にも暗証番号があり得ます。コメント、追加説明、保持した値は人が確認する必要があり、確認欄を選んでも安全性を保証するものではありません。
対応する構文には範囲がある
キーは英字、数字、アンダースコアで、数字からは始められません。単一引用符と二重引用符の複数行値に対応します。不正な代入、閉じていない引用符、NULや非対応構文はエラーになります。入出力は各1 MiB、入力は最大10,000代入です。
プロジェクトは読み取らない
.env.example生成はコードから必要な変数を探したり、他のテンプレートを結合したりしません。保持した${HOST}などは文字列のままで、展開や実行は行いません。パスワード生成、並べ替え、重複削除も行わず、改行はLFになります。
説明から変数は増えない
説明は一意の有効なキーごとに1物理行で指定し、コメントとして各宣言の直前に入ります。見つからないキーは通知するだけで、新しい代入を追加しません。説明の中にも実際の秘密情報を記入しないでください。

.env.example生成のよくある質問

引用符は必要?

値に空白やシャープ記号を含む場合は引用符が解釈を左右します。このツールでは対応する構文を解析し、通常は値全体を空にします。保持対象は元の引用符を残し、置換文字列は引用符付きで出力します。

.env.exampleには何を書く?

必要な変数名と、記入者が用途を理解できる説明を書きます。実際の認証情報は含めないでください。.env.example生成で値を消してもコメントや保持対象には情報が残るため、共有前に全体を確認します。

重複したキーはどう扱われる?

順序と出現回数を変えません。同じ名前が保持リストにあればすべての値を残し、なければすべてを置換します。最後の代入だけを処理したり、自動で重複を削除したりすることはありません。

PEM鍵の改行はどう表す?

引用符内の実際の改行と、対応する二重引用符のエスケープを解析できます。既定では鍵の複数行全体を空にします。保持すると元の値が残るので、公開するサンプルに秘密鍵を残さないよう注意してください。

入力は外部に送信される?

設定内容はブラウザーのメモリー内で処理し、サーバー送信や履歴保存は行いません。ただし入力欄とダウンロードしたファイルは実際の内容を含みます。画面共有やファイル共有の前にも確認してください。

値や規則に疑問がありますか?

記入してもらえるテンプレートへ

.env.example生成に戻り、必要な例外だけを選び、コメントと説明を含むプレビュー全体を確認してください。