Laravel11 envコマンド

この記事は Laravel11にあるartisanコマンドを全部調べる Advent Calendar 2024 9日目の記事です。

今回はenvコマンドについて調べました。

環境

• PHP 8.4.1
• laravel/laravel 11.3.3
• laravel/framework 11.33.2

env

環境を表示する。

php artisan env

実行すると環境ファイル（.env）のAPP_ENVの値を表示します。

advent-calendar-2024 % php artisan env   

   INFO  The application environment is [local].

env:encrypt

環境ファイル（.env）を暗号化する。

php artisan env:encrypt

実行すると使用する暗号化キーを選択ができます。

選択すると環境ファイル（.env）は暗号化されます。
暗号化された内容は.env.encryptedファイルに出力されます。

オプション	説明
--key[=KEY]	暗号化キーを指定
--cipher[=CIPHER]	暗号化方式を指定
--env[=ENV]	コマンド実行時の環境を指定
--prune	元になった環境ファイルを削除
--force	暗号化された環境ファイルが存在しても上書き

• --keyを使えば暗号化キーを指定できます
  • 指定した場合は最初の選択肢は表示せず環境ファイルの暗号化が動きます
• --cipherを使えば暗号化方式を指定できます（デフォルトはAES-256-CBC）
• .env以外に.env.stagingなど複数の環境ファイルを使用している場合、--envを使えば暗号化する環境ファイルを指定できます

php artisan env:encrypt --env=staging

• --pruneを付けると暗号化後に元になった環境ファイルを削除します
• --forceを付けると暗号化された環境ファイルを上書きします

env:decrypt

環境ファイル（.env）を複合化する。

php artisan env:decrypt

実行すると暗号化キーの入力を求められます。
もしくは、暗号化キーを環境変数のLARAVEL_ENV_ENCRYPTION_KEYに設定しておくとこちらから取得します。

入力（取得）後、環境ファイルは複合化します。

オプション	説明
--key[=KEY]	暗号化キーを指定
--cipher[=CIPHER]	暗号化方式を指定
--env[=ENV]	コマンド実行時の環境を指定
--force	既存の環境ファイルを上書き
--path[=PATH]	複合化するファイルのパスを指定
--filename[=FILENAME]	複合化するファイルの名前を指定

• --keyを使えば暗号化キーを指定できます
  • 指定すると最初の入力は無しで環境ファイルの複合化が動きます
• --cipherを使えば暗号化方式を指定できます（デフォルトはAES-256-CBC）
• .env以外に.env.stagingなど複数の環境ファイルを使用している場合、--envを使えば複合化する環境ファイルを指定できます
  複合化で--envを使う場合は--envを使って暗号化する必要があります
• --forceを付けると既存の環境ファイルを上書きします
• --pathを使えば複合化した環境ファイルの出力する先を指定できます
• --filenameを使えば複合化した環境ファイルのファイル名を指定できます