help — コマンドのヘルプを表示する

• カテゴリ: artisan
• 掲載バージョン: Laravel 12・PHP 8.4
• 名前空間 / FQCN / コマンド: php artisan help
• 関連: list, schedule:run, list, --help
• 変更履歴: なし

要点（TL;DR）

• コマンドの使い方やオプションを表示する。
• php artisan help
• php artisan help <command> で対象コマンドの詳細を確認できる。

概要

php artisan help は Artisan コマンドのヘルプを出力します。
引数なしで実行すると全コマンドの一覧と簡易説明が表示され、
<command> を指定するとそのコマンドのオプション・引数・使用例を詳細に示します。

構文 / シグネチャ

php artisan help [command]

引数

戻り値

• 文字列を標準出力に出力し、終了コード 0 を返す。
• 返り値はスクリプトから取得しない想定。

例外/副作用

• InvalidArgumentException：指定したコマンドが存在しない場合。
• ファイルやデータベースへの書き込みは行わない。

使用例

最小例

php artisan help

実務例

php artisan help migrate

よくある落とし穴・注意

• コマンド名の綴りミスで InvalidArgumentException が投げられる。
• php artisan help だけでなく php artisan --help も同様にヘルプを表示できる。
• 大量のコマンドがある場合、全一覧がスクロールで見切れることがある。

代替・関連APIとの比較

テスト例（Pest）

it('shows help for migrate command', function () {
    $output = Artisan::call('help', ['command' => 'migrate']);
    expect($output)->toBe(0);
    $content = Artisan::output();
    expect($content)->toContain('migrate');
    expect($content)->toContain('Create a migration to add a new table');
});

トラブルシュート（エラー別）

参考リンク

• Laravel 12 – Artisan Commands
• Laravel 12 – Artisan Command Reference