🍋
Laravel11 completionコマンド/helpコマンド/listコマンド
この記事は Laravel11にあるArtisanコマンドを全部調べる Advent Calendar 2024 5日目の記事です。
今回はcompletionコマンド/helpコマンド/listコマンドについて調べました。
環境
- PHP 8.4.1
- laravel/laravel 11.3.3
- laravel/framework 11.33.2
- symfony/console 7.1.8
completion
シェルの補完スクリプトを出力する。
php artisan completion [<shell>]
実行するとArtisanコマンドの補完スクリプトを出力します。
出力する内容は下記にあるシェルになります。どれを出力するかは利用しているシェル次第です。
| 引数 | 説明 |
|---|---|
shell |
シェルの種類を指定 |
-
shellには"bash", "fish", "zsh"が指定できる
未指定の場合は環境変数"$SHELL"の値が使われる
php artisan completion zsh
| オプション | 説明 |
|---|---|
--debug |
デバックログ |
-
--debugを付けると補完のログが確認できるようになる
が、実際に試した時にはログに何も出てこないのでまた今度調べることにする☂️
help
コマンドのヘルプを表示する。
php artisan help [<command_name>]
実行するとコマンドのヘルプが表示します。デフォルトはhelpコマンドのヘルプです。
| 引数 | 説明 |
|---|---|
command_name |
コマンド名を指定 |
-
command_nameに指定したコマンドのヘルプが表示します
- 曖昧な指定の場合は該当しそうなコマンドの候補を出してくれます
| オプション | 説明 |
|---|---|
--format=FORMAT |
表示するフォーマットを指定 |
--raw |
シンプルな形式で出力 |
-
--formatで指定できるのは"txt", "xml", "json", "md"です（デフォルトは"txt"） -
--rawを付けると装飾しないでヘルプが表示します（色がつかない）
装飾されるのは"txt"だけなので実質"txt"専用のオプションです
list
コマンドの一覧を表示する。
php artisan list [<namespace>]
実行すると利用できるコマンドの一覧が表示します。
※長いの出力結果は先頭部分だけです。
| 引数 | 説明 |
|---|---|
namespace |
コマンドのネームスペースを指定 |
-
namespaceはコマンド名が"aaa:bbb"の"aaa"の部分を指定できます
例：auth:clear-resetsならauthを指定する
php artisan list auth
| オプション | 説明 |
|---|---|
--raw |
シンプルな形式で出力 |
--format=FORMAT |
表示するフォーマットを指定 |
--short |
引数の説明を非表示 |
-
--rawを付けると装飾しないでコマンドの一覧を表示します（コマンドの一覧のみ表示します）
装飾されるのは"txt"だけなので実質"txt"専用のオプションです -
--formatで指定できるのは"txt", "xml", "json", "md"です（デフォルトは"txt"） -
--shortを付けると引数の説明が非表示になります
非表示になるのは"txt"以外です
Discussion