🍐

Laravel11 installコマンド

2024/12/12に公開

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

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

環境

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

install:api

apiルートファイルの作成し、Laravel SanctumまたはLaravel Passportをインストールする。

php artisan install:api

実行すると下記のスタブファイルをコピーしてapiルートファイル(routes/api.php)が作成します。
https://github.com/laravel/framework/blob/v11.33.2/src/Illuminate/Foundation/Console/stubs/api-routes.stub

さらにLaravel Sanctum(laravel/sanctum)をインストールします。
最後にLaravel Sanctumで使用するテーブル(personal_access_tokens)のマイグレーションを実行します。(実行する/しないの確認は行われます。)

オプション 説明
--composer[=COMPOSER] Composerバイナリのパスを指定
--force 既存のapiルートファイルを上書き
--passport Laravel Passportをインストール
--without-migration-prompt マイグレーション実行しない
  • --composerはComposerバイナリのパスを指定できます(デフォルトはglobal)
  • --forceを付けるとすでに作成されてるapiルートファイル(routes/api.php)をスタブの内容で上書きます
  • --passportを付けるとLaravel Sanctumの代わりにLaravel Passport(laravel/passport)をインストールします
  • --without-migration-promptを付けるとLaravel Sanctumで使用するテーブルのマイグレーションは実行せずにコマンドは終了します

install:broadcasting

ブロードキャスト機能を有効にする。

php artisan install:broadcasting

実行すると下記のスタブファイルをコピーしてchannelルートファイル(routes/channels.php)が作成します。
https://github.com/laravel/framework/blob/v11.33.2/src/Illuminate/Foundation/Console/stubs/broadcasting-routes.stub

一緒に設定ファイル(config/broadcasting.php)も作成されます。

さらにLaravel Reverb(laravel/reverb)をインストールします。(インストールする/しないの確認は行われます。)
最後にNodeの依存パッケージ(laravel-echo、pusher-js)をインストールします。(インストールする/しないの確認は行われます。)

オプション 説明
--composer[=COMPOSER] Composerバイナリのパスを指定
--force 既存のchannelルートファイルを上書き
--without-reverb Laravel Reverbをインストールしない
--without-node Nodeの依存パッケージをインストールしない
  • --composerはComposerバイナリのパスを指定できます(デフォルトはglobal)
  • --forceを付けるとすでに作成されてるchannelsルートファイル(routes/channels.php)をスタブの内容で上書きます
  • --without-reverbを付けるとLaravel Reverbはインストールしないです
  • --without-nodeを付けるとNodeの依存パッケージはインストールしないです
GitHubで編集を提案

Discussion