Laravel Prompts

laravel/promptsパッケージを使ってArtisanコマンドに美しい対話型UIを追加する方法を解説します。テキスト入力・選択・検索・autocomplete・タスクログ・ストリーミング出力など多彩な関数を紹介します。

​

はじめに

Laravel Prompts は、コマンドラインアプリケーションに美しく使いやすい対話型フォームを追加するためのPHPパッケージです。 プレースホルダーテキストやバリデーションといったブラウザのフォームに近い体験を提供します。

Artisanコマンドのコード内で直接呼び出せるため、ユーザーへの問い合わせをシンプルかつ直感的に記述できます。

Laravel PromptsはmacOS・Linux・Windows(WSL)をサポートしています。 非対応環境では自動的にフォールバック動作に切り替わります。

​

インストール

Laravel PromptsはLaravel本体に同梱されているため、追加インストールは不要です。

他のPHPプロジェクトで使いたい場合はComposerでインストールします。

composer require laravel/prompts

​

基本的なプロンプト関数

​

text — テキスト入力

text() でユーザーに文字列入力を求めます。

use function Laravel\Prompts\text;

$name = text('What is your name?');

プレースホルダー・デフォルト値・ヒントを設定できます。

$name = text(
    label: 'What is your name?',
    placeholder: 'E.g. Taylor Otwell',
    default: $user?->name,
    hint: 'This will be displayed on your profile.'
);

required を指定すると入力を必須にできます。バリデーションメッセージも変更可能です。

$name = text(
    label: 'What is your name?',
    required: 'Your name is required.'
);

validate クロージャで追加のバリデーションを行えます。エラーメッセージを返すか、合格時に null を返します。

$name = text(
    label: 'What is your name?',
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'The name must be at least 3 characters.',
        strlen($value) > 255 => 'The name must not exceed 255 characters.',
        default => null
    }
);

Laravelのバリデーションルールを配列で指定することもできます。

$name = text(
    label: 'What is your name?',
    validate: ['name' => 'required|max:255|unique:users']
);

​

textarea — 複数行テキスト入力

textarea() で複数行の入力を受け付けます。

use function Laravel\Prompts\textarea;

$story = textarea('Tell me a story.');

​

number — 数値入力

number() で数値を受け付けます。上下矢印キーで値を増減できます。

use function Laravel\Prompts\number;

$copies = number(
    label: 'How many copies would you like?',
    default: 1,
    validate: ['copies' => 'required|integer|min:1|max:100']
);

​

password — パスワード入力

password() はテキスト入力と同様ですが、入力内容が画面に表示されません。

use function Laravel\Prompts\password;

$password = password('What is your password?');

$password = password(
    label: 'What is your password?',
    placeholder: 'password',
    hint: 'Minimum 8 characters.',
    validate: fn (string $value) => strlen($value) < 8
        ? 'The password must be at least 8 characters.'
        : null
);

​

confirm — Yes/No確認

confirm() でユーザーに二択の確認を求めます。true または false を返します。

use function Laravel\Prompts\confirm;

$confirmed = confirm('Do you accept the terms?');

デフォルト値やラベルテキストをカスタマイズできます。

$confirmed = confirm(
    label: 'Do you accept the terms?',
    default: false,
    yes: 'I accept',
    no: 'I decline',
    hint: 'The terms must be accepted to continue.'
);

​

select — 選択リスト

select() でユーザーに一覧から1つ選ばせます。

use function Laravel\Prompts\select;

$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner'],
    default: 'Owner'
);

連想配列を使うと、表示ラベルではなくキーを返り値にできます。

$role = select(
    label: 'What role should the user have?',
    options: [
        'member'      => 'Member',
        'contributor' => 'Contributor',
        'owner'       => 'Owner',
    ],
    default: 'owner'
);

scroll でスクロール前に表示する選択肢数を変更できます(デフォルト5件)。

$role = select(
    label: 'Which category would you like to assign?',
    options: Category::pluck('name', 'id'),
    scroll: 10
);

​

multiselect — 複数選択

multiselect() で複数の選択肢を同時に選ばせます。

use function Laravel\Prompts\multiselect;

$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: ['Read', 'Create', 'Update', 'Delete']
);

required を指定すると少なくとも1つの選択を必須にできます。

$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: ['Read', 'Create', 'Update', 'Delete'],
    required: 'At least one permission must be selected.'
);

​

suggest — オートコンプリート付き入力

suggest() は候補を提示しながら自由入力も受け付けます。

use function Laravel\Prompts\suggest;

$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle']
);

クロージャを渡すと、入力内容に応じて動的に候補を絞り込めます。

$name = suggest(
    label: 'What is your name?',
    options: fn (string $value) => collect(['Taylor', 'Tobi', 'Dries'])
        ->filter(fn ($name) => str_starts_with($name, $value))
        ->values()
        ->all()
);

​

search — 動的検索

search() は入力するたびに候補リストを更新します。クロージャが返す配列が候補になります。

use function Laravel\Prompts\search;

$userId = search(
    label: 'Search for the user that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : []
);

​

multisearch — 動的複数選択

multisearch() は動的検索で複数選択ができます。

use function Laravel\Prompts\multisearch;

$userIds = multisearch(
    label: 'Search for the users that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : []
);

​

pause — 一時停止

pause() でユーザーにEnterキーの押下を促して処理を一時停止できます。

use function Laravel\Prompts\pause;

pause('Press ENTER to continue.');

​

autocomplete — インライン補完

autocomplete() はゴーストテキストとして候補を表示するインライン補完関数です。suggest() と異なり、ユーザーが入力するたびに一致する候補がゴーストテキストとして表示され、Tab キーまたは右矢印キーで補完を確定できます。

use function Laravel\Prompts\autocomplete;

$name = autocomplete(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle', 'Jess', 'Nuno', 'Tim']
);

プレースホルダー・デフォルト値・ヒントを設定できます。

$name = autocomplete(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle', 'Jess', 'Nuno', 'Tim'],
    placeholder: 'E.g. Taylor',
    default: $user?->name,
    hint: 'Use Tab to accept, up/down to cycle.'
);

クロージャを渡すと入力内容に応じて動的に候補を生成できます。

$file = autocomplete(
    label: 'Which file?',
    options: fn (string $value) => collect($files)
        ->filter(fn ($file) => str_starts_with(strtolower($file), strtolower($value)))
        ->values()
        ->all(),
);

​

バリデーション

すべてのプロンプト関数は validate 引数でバリデーションを設定できます。

$name = text(
    label: 'What is your name?',
    validate: fn (string $value) => match (true) {
        strlen($value) < 3  => 'The name must be at least 3 characters.',
        strlen($value) > 255 => 'The name must not exceed 255 characters.',
        default => null
    }
);

クロージャが文字列を返すとエラーとして表示し、再入力を促します。null を返すとバリデーション成功です。

Laravelのバリデーションルールを配列形式で使うこともできます。

$name = text(
    label: 'What is your name?',
    validate: ['name' => 'required|max:255|unique:users']
);

入力をバリデーション前に変換するには transform 引数を使います。

$name = text(
    label: 'What is your name?',
    transform: fn (string $value) => trim($value),
    validate: fn (string $value) => match (true) {
        strlen($value) === 0 => 'The name must not be empty.',
        default => null
    }
);

​

フォーム

form() を使うと複数のプロンプトをひとまとめにして、完了前にまとめてキャンセルすることができます。

use function Laravel\Prompts\form;

$responses = form()
    ->text('What is your name?', required: true, name: 'name')
    ->password('What is your password?', validate: ['password' => 'min:8'], name: 'password')
    ->confirm('Do you accept the terms?')
    ->submit();

$name     = $responses['name'];
$password = $responses['password'];
$confirmed = $responses[2];

​

情報出力

テキストメッセージをスタイル付きで出力する関数が用意されています。

use function Laravel\Prompts\info;
use function Laravel\Prompts\warning;
use function Laravel\Prompts\error;
use function Laravel\Prompts\alert;
use function Laravel\Prompts\note;

note('Prepare for launch.');
info('User created successfully.');
warning('This action cannot be undone.');
error('Something went wrong.');
alert('Critical failure detected!');

​

コールアウト

callout() はラベルとコンテンツを枠で囲んで表示します。デプロイサマリー・エラー詳細・ステータス更新など、重要な情報を目立たせるのに適しています。

use function Laravel\Prompts\callout;

callout(
    label: 'Environment Configured',
    content: 'Your application is running in production mode with 4 workers.',
);

type 引数に 'warning' または 'error' を指定すると、ビジュアルスタイルを変更できます。

callout(
    label: 'Deprecation Notice',
    content: 'The `--prefer-stable` flag will be removed in v4.0.',
    type: 'warning',
);

callout(
    label: 'Database Connection Failed',
    content: 'Could not connect to MySQL on 127.0.0.1:3306.',
    type: 'error',
);

info 引数でフッター行を追加できます。IDやタイムスタンプなどのメタデータ表示に便利です。

callout(
    label: 'Deployment Summary',
    content: 'Your application was deployed to production.',
    info: 'deploy-id: d4f8a2c',
);

​

リッチコンテンツ

文字列の代わりに配列を渡すと、構造化されたリッチなコールアウトを作れます。Element クラスには見出し・箇条書きリスト・番号付きリスト・キーバリューリスト・リンクを作るファクトリーメソッドがあります。

use Laravel\Prompts\Elements\Element;
use function Laravel\Prompts\callout;

callout('Deployment Summary', [
    'Your application was deployed to production at 2024-03-15 14:32 UTC.',
    Element::heading('What Changed'),
    Element::bulletedList([
        'Migrated 3 pending database migrations',
        'Cleared and rebuilt route cache',
        'Restarted 4 queue workers',
    ]),
    Element::heading('Next Steps'),
    Element::numberedList([
        'Verify the health check endpoint at /up',
        'Monitor error rates for the next 15 minutes',
        'Confirm background jobs are processing',
    ]),
]);

Element::keyValueList でラベル付きデータを表示できます。

callout('Database Connection Failed', [
    'Could not connect to the database server.',
    Element::keyValueList([
        'Host'     => '127.0.0.1',
        'Port'     => '3306',
        'Database' => 'forge',
        'Status'   => 'Connection refused',
    ]),
], type: 'error');

Element::link は OSC 8 に対応したターミナルでクリック可能なハイパーリンクを生成します。URL のみ、または URL とカスタムラベルを渡せます。

callout('Server Health Check', [
    'Multiple services are reporting degraded performance.',
    Element::heading('Affected Services'),
    'Look here: '.Element::link('https://example.com/health', 'Health Dashboard'),
    Element::link('https://example.com/health'),
]);

ラベルを省略した場合は、URL がリンクテキストとして表示されます。

​

テーブル表示

table() でデータをテーブル形式で表示できます。

use function Laravel\Prompts\table;

table(
    headers: ['Name', 'Email'],
    rows: User::all(['name', 'email'])->toArray()
);

​

スピン(ローディング表示)

spin() はクロージャの実行中にローディングインジケーターを表示します。

use function Laravel\Prompts\spin;

$response = spin(
    message: 'Fetching response...',
    callback: fn () => Http::get('http://example.com')
);

spin() を使うには pcntl PHP拡張が必要です。使用できない環境ではスピナーは表示されません。

​

進捗バー

progress() で繰り返し処理の進捗を視覚的に表示できます。

use function Laravel\Prompts\progress;

$users = progress(
    label: 'Updating users',
    steps: User::all(),
    callback: fn ($user) => $this->performTask($user),
    hint: 'This may take some time.'
);

手動で進捗バーを制御することもできます。

$progress = progress(label: 'Uploading files', steps: count($files));

$progress->start();

foreach ($files as $file) {
    $this->uploadFile($file);
    $progress->advance();
}

$progress->finish();

​

タスク

task() はコールバック実行中にスピナーとスクロール可能なライブ出力エリアを表示します。依存関係のインストールやデプロイスクリプトなど長時間実行するプロセスをラップするのに最適で、何が起きているかリアルタイムで確認できます。

use function Laravel\Prompts\task;

task(
    label: 'Installing dependencies',
    callback: function ($logger) {
        // 長時間実行する処理...
    }
);

コールバックは Logger インスタンスを受け取り、ログ行やステータスメッセージをリアルタイムで表示できます。

task() を使うには pcntl PHP拡張が必要です。使用できない環境ではスタティック表示にフォールバックします。

​

ログ行の出力

line メソッドでスクロール出力エリアに1行ずつログを書き込みます。

task(
    label: 'Installing dependencies',
    callback: function ($logger) {
        $logger->line('Resolving packages...');
        $logger->line('Downloading laravel/framework');
    }
);

​

ステータスメッセージ

success・warning・error を使うと、スクロールログエリアの上部に固定されたハイライト付きメッセージを表示できます。

task(
    label: 'Deploying application',
    callback: function ($logger) {
        $logger->line('Pulling latest changes...');
        $logger->success('Changes pulled!');

        $logger->line('Running migrations...');
        $logger->warning('No new migrations to run.');

        $logger->line('Clearing cache...');
        $logger->success('Cache cleared!');
    }
);

​

ラベルの更新

label メソッドで実行中にタスクのラベルを更新できます。subLabel メソッドはラベルの下に薄く表示されるサブラベルを設定します。空文字列を渡すとサブラベルを消去できます。subLabel 引数で初期サブラベルを指定することもできます。

task(
    label: 'Deploying',
    callback: function ($logger) {
        $logger->subLabel('Building assets...');
        // ...
        $logger->subLabel('Running migrations...');
        // ...
        $logger->subLabel('');
    },
    subLabel: 'Preparing...'
);

​

テキストのストリーミング

AIが生成するレスポンスのように段階的に出力が生成される処理では、partial メソッドでテキストをひとつひとつストリーミングできます。ストリームが完了したら commitPartial を呼んで確定します。

task(
    label: 'Generating response...',
    callback: function ($logger) {
        foreach ($words as $word) {
            $logger->partial($word . ' ');
        }

        $logger->commitPartial();
    }
);

​

出力上限とサマリーの保持

デフォルトでは最大10行のスクロール出力を表示します。limit 引数でカスタマイズできます。タスク完了後もステータスメッセージを画面に残したい場合は keepSummary: true を渡します。

task(
    label: 'Deploying',
    callback: function ($logger) {
        $logger->success('Assets built');
        $logger->success('Migrations complete');
    },
    limit: 20,
    keepSummary: true,
);

​

ストリーム

stream() はテキストを段階的にターミナルに表示します。AIが生成するコンテンツやチャンクで届くデータの表示に最適です。

use function Laravel\Prompts\stream;

$stream = stream();

foreach ($words as $word) {
    $stream->append($word . ' ');
    usleep(25_000); // チャンク間の遅延をシミュレート...
}

$stream->close();

append メソッドはフェードインエフェクトでテキストをストリームに追加します。すべてのコンテンツをストリームし終えたら close を呼んで出力を確定しカーソルを復元します。

​

ターミナル操作

​

ターミナルタイトルの設定

use function Laravel\Prompts\title;

title('My Application');

空文字列を渡すとデフォルトのタイトルにリセットできます。

title('');

​

ターミナルのクリア

use function Laravel\Prompts\clear;

clear();

​

ターミナルの考慮事項

ターミナル幅: ラベル・選択肢・バリデーションメッセージがターミナルの列数を超える場合、自動的に切り詰められます。80列のターミナルを想定する場合、最大74文字を目安にしてください。

ターミナルの高さ: scroll 引数を受け付けるプロンプトでは、バリデーションメッセージ用のスペースを含めてターミナルの高さに収まるよう自動的に値が調整されます。

​

フォールバック

非対応の環境(Windows non-WSLなど)では自動的にフォールバックします。 デフォルトではLaravelの $this->ask() や $this->choice() などの組み込みメソッドが代わりに使われます。

​

テスト

Laravel PromptsはPestやPHPUnitのテストと連携できます。

use Laravel\Prompts\Prompt;

Prompt::fake(['Taylor', true]);

$name      = text('What is your name?');
$confirmed = confirm('Do you accept the terms?');

Prompt::assertOutputContains('What is your name?');

LaravelのArtisanテストヘルパーを使うと、情報出力関数に対してもアサーションを記述できます。

// Pest
test('report generation', function () {
    $this->artisan('report:generate')
        ->expectsPromptsInfo('Welcome to the application!')
        ->expectsPromptsWarning('This action cannot be undone')
        ->expectsPromptsError('Something went wrong')
        ->expectsPromptsAlert('Important notice!')
        ->expectsPromptsTable(
            headers: ['Name', 'Email'],
            rows: [
                ['Taylor Otwell', '[e-mail]'],
            ]
        )
        ->assertExitCode(0);
});

// PHPUnit
public function test_report_generation(): void
{
    $this->artisan('report:generate')
        ->expectsPromptsInfo('Welcome to the application!')
        ->expectsPromptsWarning('This action cannot be undone')
        ->expectsPromptsTable(
            headers: ['Name', 'Email'],
            rows: [['Taylor Otwell', '[e-mail]']]
        )
        ->assertExitCode(0);
}

​

関連ページ

Artisanコンソール

Artisanコマンド内でPromptsを活用する