【Laravel】artisanのdocsコマンドを解説

チートシート

Laravel 10.x以降のartisanの「docs」コマンドを解説します。

Description

Laravelの公式ドキュメント(英語)のURLを表示します。

Usage

php artisan docs [<page> [<section>]]

Arguments

オプション省略形必須説明
page開くべきドキュメントページ
section開くべきページのセクション

Example

no options

php artisan docs
  Which page would you like to open? [Installation]
  Release Notes ...................................................................................................................... release notes  
  Upgrade Guide ...................................................................................................................... upgrade guide  
  Contribution Guide ............................................................................................................ contribution guide  
  Installation ........................................................................................................................ installation  
  Configuration ...................................................................................................................... configuration  
  :
  :
>

最後にプロンプトが出るので、見たいページを入力します。

page

php artisan docs installation
   INFO  Opening the docs to: https://laravel.com/docs/10.x/installation.  

   WARN  Unable to open the URL on your system. You will need to open it yourself or create a custom opener for your system.  

コマンドラインからなのでURLが開けないと怒られてますが、URLは表示されているのでブラウザにコピペしてアクセスが可能です。

また、ページ名の一部の文字でも大丈夫です。

php artisan docs va
   INFO  Opening the docs to: https://laravel.com/docs/10.x/validation.  

   WARN  Unable to open the URL on your system. You will need to open it yourself or create a custom opener for your system.  

Source

著者

Webエンジニア歴30年、フリーランスバックエンドエンジニア。

PHP歴約30年(Laravel 7年・FuelPHP 5年・CakePHP・自作FW)、
JavaScript歴約20年(React・Vue各4年)。
AWS(EC2 / CloudFront / RDS / API Gateway など)・
GCP(BigQuery)を使ったバックエンド開発を中心に、
複数の事業会社・受託案件でシステム設計から実装・運用まで担当しています。

PHPがバージョン4の時代から書いており、
Laravelが普及する前のフレームワーク乱立期も経験しています。
「昔はこう書いていたが今はこう」という変遷を肌で知っているエンジニアとして、
単なるコマンドの使い方だけでなく、なぜそうするのかの背景まで伝えることを意識して書いています。

このブログでは、実務で実際に詰まった箇所・調べたこと・気づいたことを
そのまま記事にしています。誰かの「詰まり」が解決するきっかけになれば幸いです。

千原 耕司をフォローする

役にたったと思ったら応援をお願いします m(._.)m

チートシート
スポンサーリンク
シェアする
千原 耕司をフォローする
タイトルとURLをコピーしました