【Laravel】artisanのkey:generateコマンドを解説

Laravel 10.xのartisanの「key:generate」コマンドと、そのオプションを解説します。

Description
Usage
Options
Example
Source
1. 10.x
2. 11.x

Description

アプリケーションキーの設定をします。
これを最初に行わないと、以下のエラーが出てしまうので、インストール後に必ず実施しましょう。

No application encryption key has been specified.

Your app key is missing
Generate your application encryption key using php artisan key:generate.

Plaintext

環境に合わせた.envファイルのAPP_KEYの項目が変更されます。
この値は暗号化に利用されるので、不用意に変更すると、DBなどに保存されたパスワードの照合などができなくなってしまうので、サービス稼働後に変更をすることは基本的にできません。

Usage

php artisan key:generate [--show] [--force]

Bash

Options

オプション	省略形	必須	説明
show	-	-	ファイルを修正する代わりにキーを表示
force	-	-	本番環境でオペレーションを強制的に実行させる

Example

no options

php artisan key:generate

Bash

Output

INFO  Application key set successfully.

.env

:
APP_KEY=base64:e+OcEutwDViyXWDigNJhlLT8jVLQYqCV/s+SxDh6pSM=
:

show

現在設定されているキーをそのまま表示します。用途は不明。

php artisan key:generate --show

Bash

Output

base64:kJ8uM5NsBXjvUBLkDpooAZlEPfE9ZDY3npH9ioU+nJw=

force

APP_ENV=productionの場合は更新する際に以下の確認メッセージが出て入力が必要になります。
このオプションは、この入力をしないようにするためのオプションです。

Output

                                                                   APPLICATION IN PRODUCTION.

  Do you really wish to run this command? (yes/no) [no]
❯

Source

10.x

framework/src/Illuminate/Foundation/Console/KeyGenerateCommand.php at 11.x · laravel/framework

The Laravel Framework. Contribute to laravel/framework development by creating an account on GitHub.

11.x

framework/src/Illuminate/Foundation/Console/KeyGenerateCommand.php at 11.x · laravel/framework

The Laravel Framework. Contribute to laravel/framework development by creating an account on GitHub.