🍇
Laravel11 aboutコマンド/docsコマンド
この記事は Laravel11にあるArtisanコマンドを全部調べる Advent Calendar 2024 1日目の記事です。
今回はaboutコマンド/docsコマンドについて調べました。
環境
- PHP 8.4.1
- laravel/laravel 11.3.3
- laravel/framework 11.33.2
about
アプリケーションに関する基本情報を表示する。
php artisan about
実行するとEnvironment、Cache、Driversの3つのセクションの内容を表示します。
| オプション | 説明 |
|---|---|
--only[=ONLY] |
指定したセクションを表示 |
--json |
JSON形式で表示 |
-
--onlyは大文字小文字関係なくセクションを指定できます
カンマ区切りで複数のセクションを指定することも可能です
php artisan about --only=Environment
php artisan about --only=environment,Cache
-
--jsonを使うことでJSON形式で表示します、--onlyオプションも一緒に指定も可能です
php artisan about --json
php artisan about --only=Environment --json
docs
Laravelのドキュメントを表示する。
php artisan docs [<page> [<section>]]
実行すると表示したいドキュメントを選択するリストが出てきます。
選択すると、ドキュメントのURLが表示します。
また、実行した環境次第では選択したドキュメントをブラウザで開きます。
| 引数 | 説明 |
|---|---|
page |
開くドキュメントを指定 |
section |
開くドキュメントのセクションを指定 |
-
pageだけ、もしくはpageとsectionの両方を指定してドキュメントを開くことができます - 文字は一部だけでも指定できます、その場合は最初に見つかったドキュメントを開きます
php artisan docs providers
php artisan docs database database-transactions
php artisan docs vi
Discussion