【Laravel】artisanのroute:listコマンドを解説

Laravel 10.xのartisanの「route:list」コマンドを解説します。

Description
Usage
Options
Example

Description

登録されているすべてのルートを一覧表示します。
出力は「メソッド」「URI」「名前」「アクション」の順に表示されます。
オプションによってフィルターやソートもできますが、アクションでのフィルターはできないので、grepコマンドなどを利用して検索する必要があります。

route()で利用したいがname()で付けた名前を忘れた、resources()を利用たりgroup()などを利用して階層が深くなったりして名前が分からない場合によく利用します。

Usage

php artisan route:list [--json] [--method [METHOD]] [--name [NAME]] [--domain [DOMAIN]] [--path [PATH]] [--except-path [EXCEPT-PATH]] [-r|--reverse] [--sort [SORT]] [--except-vendor] [--only-vendor]

Bash

Options

オプション	省略形	必須	説明
json	-	-	JSON形式で出力
method	-	-	メソッドでフィルタ
name	-	-	名前でフィルタ
domain	-	-	ドメインでフィルタ
path	-	-	指定したパスのパターンにマッチしたもののみ表示
except-path	-	-	指定したパスのパターンにマッチしたものは非表示
reverse	r	-	逆順で表示
sort	-	-	特定のキー(domain, method, uri, name, action, middleware)でソート
except-vendor	-	-	vendorパッケージで定義されているルーツは非表示
only-vendor	-	-	vendorパッケージで定義されているルーツのみ表示

Example

no options

php artisan route:list

Bash

  GET|HEAD  / .................................................................................................................... top › IndexController@index
  POST      _ignition/execute-solution ......................................... ignition.executeSolution › Spatie\LaravelIgnition › ExecuteSolutionController
  GET|HEAD  _ignition/health-check ..................................................... ignition.healthCheck › Spatie\LaravelIgnition › HealthCheckController
  POST      _ignition/update-config .................................................. ignition.updateConfig › Spatie\LaravelIgnition › UpdateConfigController
  :
  :

Plaintext

json

php artisan route:list --json

Bash

[{"domain":null,"method":"GET|HEAD","uri":"\/","name":"healthCheck","action":"App\\Http\\Controllers\\HealthCheckController@index","middleware":["api"]},{"domain":null,"method":"POST","uri":"_ignition\/execute-solution","name":"ignition.executeSolution","action":"Spatie\\LaravelIgnition\\Http\\Controllers\\ExecuteSolutionController","middleware":["Spatie\\LaravelIgnition\\Http\\Middleware\\RunnableSolutionsEnabled"]},{"domain":null,"method":"GET|HEAD","uri":"_ignition\/health-check","name":"ignition.healthCheck","action":"Spatie\\LaravelIgnition\\Http\\Controllers\\HealthCheckController","middleware":["Spatie\\LaravelIgnition\\Http\\Middleware\\RunnableSolutionsEnabled"]},{"domain":null,"method":"POST","uri":"_ignition\/update-config","name":"ignition.updateConfig","action":"Spatie\\LaravelIgnition\\Http\\Controllers\\UpdateConfigController",

JSON

only-vendor

php artisan route:list --only-vendor

Bash

  POST      _ignition/execute-solution ignition.executeSolution › Spatie\LaravelIgnition › ExecuteSolutionController
  GET|HEAD  _ignition/health-check ........... ignition.healthCheck › Spatie\LaravelIgnition › HealthCheckController
  POST      _ignition/update-config ........ ignition.updateConfig › Spatie\LaravelIgnition › UpdateConfigController
:
:

Plaintext

Follow me!