Artisan 控制台

简介
- Tinker (REPL)
编写命令
定义输入期望
命令 I/O
注册命令
以编程方式执行命令
- 从其他命令调用命令
信号处理
Dev 命令
- 自定义 Dev 进程
- 过滤 Dev 进程
模板定制
事件

简介

Artisan 是 Laravel 附带的命令行界面。Artisan 以 artisan 脚本的形式存在于应用程序的根目录中，并提供许多有用的命令，可以在构建应用程序时为你提供帮助。要查看所有可用 Artisan 命令的列表，你可以使用 list 命令：

shell

php artisan list

每个命令还包含一个"帮助"屏幕，显示并描述命令的可用参数和选项。要查看帮助屏幕，请在命令名称前加上 help：

shell

php artisan help migrate

Laravel Sail

如果你使用 Laravel Sail 作为本地开发环境，请记得使用 sail 命令行来调用 Artisan 命令。Sail 将在应用程序的 Docker 容器中执行你的 Artisan 命令：

shell

./vendor/bin/sail artisan list

Tinker (REPL)

Laravel Tinker 是一个由 PsySH 包驱动的 Laravel 框架的强大 REPL。

安装

默认情况下，所有 Laravel 应用都包含 Tinker。但是，如果你之前将其从应用程序中移除，可以使用 Composer 安装 Tinker：

shell

composer require laravel/tinker

NOTE

想要在与 Laravel 应用程序交互时实现热重载、多行代码编辑和自动补全？试试 Tinkerwell！

用法

Tinker 允许你在命令行中与整个 Laravel 应用程序交互，包括你的 Eloquent 模型、任务、事件等。要进入 Tinker 环境，请运行 tinker Artisan 命令：

shell

php artisan tinker

你可以使用 vendor:publish 命令发布 Tinker 的配置文件：

shell

php artisan vendor:publish --provider="Laravel\Tinker\TinkerServiceProvider"

WARNING

dispatch 辅助函数和 Dispatchable 类上的 dispatch 方法依赖垃圾回收来将任务放入队列。因此，在使用 Tinker 时，你应该使用 Bus::dispatch 或 Queue::push 来分派任务。

命令允许列表

Tinker 使用一个"允许"列表来确定哪些 Artisan 命令可以在其 shell 中运行。默认情况下，你可以运行 clear-compiled、down、env、inspire、migrate、migrate:install、up 和 optimize 命令。如果你希望允许更多命令，可以将它们添加到 tinker.php 配置文件中的 commands 数组中：

php

'commands' => [
    // App\Console\Commands\ExampleCommand::class,
],

不应别名的类

通常，Tinker 会在你与 Tinker 中的类交互时自动为它们创建别名。但是，你可能希望某些类永远不被别名化。你可以通过在 tinker.php 配置文件的 dont_alias 数组中列出这些类来实现：

php

'dont_alias' => [
    App\Models\User::class,
],

编写命令

除了 Artisan 提供的命令外，你还可以构建自己的自定义命令。命令通常存储在 app/Console/Commands 目录中；但是，你可以自由选择自己的存储位置，只要你指示 Laravel 扫描其他目录以查找 Artisan 命令。

生成命令

要创建新命令，你可以使用 make:command Artisan 命令。此命令将在 app/Console/Commands 目录中创建一个新的命令类。如果此目录在你的应用程序中不存在，不用担心——它将在你首次运行 make:command Artisan 命令时创建：

shell

php artisan make:command SendEmails

命令结构

生成命令后，你应该使用 Signature 和 Description 属性定义命令的签名和描述。Signature 属性还允许你定义命令的输入期望。当命令执行时，将调用 handle 方法。你可以在此方法中放置命令逻辑。

让我们看一个示例命令。注意，我们可以通过命令的 handle 方法请求任何需要的依赖。Laravel 服务容器将自动注入在此方法签名中进行类型提示的所有依赖：

php

<?php

namespace App\Console\Commands;

use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Console\Attributes\Description;
use Illuminate\Console\Attributes\Signature;
use Illuminate\Console\Command;

#[Signature('mail:send {user}')]
#[Description('Send a marketing email to a user')]
class SendEmails extends Command
{
    /**
     * Execute the console command.
     */
    public function handle(DripEmailer $drip): void
    {
        $drip->send(User::find($this->argument('user')));
    }
}

NOTE

为了提高代码复用性，最好保持控制台命令轻量，并让它们委托给应用程序服务来完成其任务。在上面的示例中，注意我们注入了服务类来执行发送电子邮件的"繁重工作"。

退出码

如果 handle 方法没有返回任何内容且命令成功执行，则命令将以 0 退出码退出，表示成功。但是，handle 方法可以选择返回一个整数来手动指定命令的退出码：

php

$this->error('Something went wrong.');

return 1;

如果你希望从命令中的任何方法"使"命令"失败"，你可以使用 fail 方法。fail 方法将立即终止命令的执行并返回退出码 1：

php

$this->fail('Something went wrong.');

闭包命令

基于闭包的命令提供了将控制台命令定义为类的替代方案。就像路由闭包是控制器的替代方案一样，将命令闭包视为命令类的替代方案。

尽管 routes/console.php 文件不定义 HTTP 路由，但它定义了应用程序的基于控制台的入口点（路由）。在此文件中，你可以使用 Artisan::command 方法定义所有基于闭包的控制台命令。command 方法接受两个参数：命令签名和一个接收命令参数和选项的闭包：

php

Artisan::command('mail:send {user}', function (string $user) {
    $this->info("Sending email to: {$user}!");
});

闭包绑定到底层命令实例，因此你可以完全访问通常可以在完整命令类上访问的所有辅助方法。

类型提示依赖

除了接收命令的参数和选项，命令闭包还可以对希望你从服务容器中解析的额外依赖进行类型提示：

php

use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Support\Facades\Artisan;

Artisan::command('mail:send {user}', function (DripEmailer $drip, string $user) {
    $drip->send(User::find($user));
});

闭包命令描述

当定义基于闭包的命令时，你可以使用 purpose 方法为命令添加描述。该描述将在你运行 php artisan list 或 php artisan help 命令时显示：

php

Artisan::command('mail:send {user}', function (string $user) {
    // ...
})->purpose('Send a marketing email to a user');

可隔离命令

WARNING

要使用此功能，你的应用程序必须使用 memcached、redis、dynamodb、database、file 或 array 缓存驱动作为应用程序的默认缓存驱动。此外，所有服务器必须与同一中央缓存服务器通信。

有时你可能希望确保一次只能运行一个命令实例。为此，你可以在命令类上实现 Illuminate\Contracts\Console\Isolatable 接口：

php

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\Isolatable;

class SendEmails extends Command implements Isolatable
{
    // ...
}

当你将命令标记为 Isolatable 时，Laravel 会自动使 --isolated 选项可用于该命令，而无需在其选项中显式定义它。当使用该选项调用命令时，Laravel 将确保没有其他该命令的实例正在运行。Laravel 通过尝试使用应用程序的默认缓存驱动获取原子锁来实现这一点。如果其他命令实例正在运行，该命令将不会执行；但是，该命令仍将以成功的退出状态码退出：

shell

php artisan mail:send 1 --isolated

如果你希望指定命令在无法执行时应返回的退出状态码，你可以通过 isolated 选项提供所需的状态码：

shell

php artisan mail:send 1 --isolated=12

锁 ID

默认情况下，Laravel 将使用命令的名称来生成用于在应用程序缓存中获取原子锁的字符串键。但是，你可以通过在 Artisan 命令类上定义 isolatableId 方法来自定义此键，从而将命令的参数或选项集成到键中：

php

/**
 * Get the isolatable ID for the command.
 */
public function isolatableId(): string
{
    return $this->argument('user');
}

锁过期时间

默认情况下，隔离锁在命令完成后过期。或者，如果命令被中断而无法完成，锁将在一小时后过期。但是，你可以通过在命令上定义 isolationLockExpiresAt 方法来调整锁过期时间：

php

use DateTimeInterface;
use DateInterval;

/**
 * Determine when an isolation lock expires for the command.
 */
public function isolationLockExpiresAt(): DateTimeInterface|DateInterval
{
    return now()->plus(minutes: 5);
}

定义输入期望

在编写控制台命令时，通常通过参数或选项从用户收集输入。Laravel 使用命令上的 signature 属性非常方便地定义你期望从用户获取的输入。signature 属性允许你以单一、富有表现力、类似路由的语法定义命令的名称、参数和选项。

参数

所有用户提供的参数和选项都括在花括号中。在以下示例中，该命令定义了一个必需参数：user：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user}';

你也可以使参数可选或为参数定义默认值：

php

// Optional argument...
'mail:send {user?}'

// Optional argument with default value...
'mail:send {user=foo}'

选项

选项与参数一样，是用户输入的另一种形式。当通过命令行提供选项时，选项以两个连字符（--）为前缀。有两种类型的选项：接收值的和不接收值的。不接收值的选项充当布尔"开关"。让我们看一个这种类型的选项示例：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue}';

在此示例中，--queue 开关可以在调用 Artisan 命令时指定。如果传递了 --queue 开关，则选项的值为 true。否则，值为 false：

shell

php artisan mail:send 1 --queue

带值的选项

接下来，让我们看一个期望值的选项。如果用户必须为选项指定一个值，你应该在选项名称后添加一个 = 符号：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue=}';

在此示例中，用户可以像这样为选项传递一个值。如果在调用命令时未指定该选项，其值将为 null：

shell

php artisan mail:send 1 --queue=default

你可以通过在选项名称后指定默认值来为选项分配默认值。如果用户未传递选项值，将使用默认值：

php

'mail:send {user} {--queue=default}'

选项快捷方式

要在定义选项时分配快捷方式，可以在选项名称之前指定它，并使用 | 字符作为分隔符将快捷方式与完整选项名称分开：

php

'mail:send {user} {--Q|queue=}'

在终端上调用命令时，选项快捷方式应以单个连字符为前缀，并且在为选项指定值时不应包含 = 字符：

shell

php artisan mail:send 1 -Qdefault

输入数组

如果你希望定义期望多个输入值的参数或选项，可以使用 * 字符。首先，让我们看一个指定此类参数的示例：

php

'mail:send {user*}'

运行此命令时，可以按顺序向命令行传递 user 参数。例如，以下命令会将 user 的值设置为一个以 1 和 2 为值的数组：

shell

php artisan mail:send 1 2

此 * 字符可以与可选参数定义结合使用，以允许零个或多个参数实例：

php

'mail:send {user?*}'

选项数组

当定义期望多个输入值的选项时，传递给命令的每个选项值都应以选项名称为前缀：

php

'mail:send {--id=*}'

可以通过传递多个 --id 参数来调用此类命令：

shell

php artisan mail:send --id=1 --id=2

输入描述

你可以通过使用冒号将参数名称与描述分开来为输入参数和选项分配描述。如果你需要更多空间来定义命令，可以随时将定义分散到多行：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send
                        {user : The ID of the user}
                        {--queue : Whether the job should be queued}';

提示缺失输入

如果你的命令包含必需参数，当用户未提供这些参数时将收到错误消息。或者，你可以通过实现 PromptsForMissingInput 接口来配置命令，在缺少必需参数时自动提示用户：

php

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\PromptsForMissingInput;

class SendEmails extends Command implements PromptsForMissingInput
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';

    // ...
}

如果 Laravel 需要从用户收集必需的参数，它将通过智能地使用参数名称或描述来询问用户。如果你希望自定义用于收集必需参数的问题，可以实现 promptForMissingArgumentsUsing 方法，返回一个以参数名称为键的问题数组：

php

/**
 * Prompt for missing input arguments using the returned questions.
 *
 * @return array<string, string>
 */
protected function promptForMissingArgumentsUsing(): array
{
    return [
        'user' => 'Which user ID should receive the mail?',
    ];
}

你也可以通过使用包含问题和占位符的元组来提供占位符文本：

php

return [
    'user' => ['Which user ID should receive the mail?', 'E.g. 123'],
];

如果你希望完全控制提示，可以提供应提示用户并返回其答案的闭包：

php

use App\Models\User;
use function Laravel\Prompts\search;

// ...

return [
    'user' => fn () => search(
        label: 'Search for a user:',
        placeholder: 'E.g. Taylor Otwell',
        options: fn ($value) => strlen($value) > 0
            ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
            : []
    ),
];

NOTE

全面的 Laravel Prompts 文档包含了有关可用提示及其用法的更多信息。

如果你希望提示用户选择或输入选项，可以在命令的 handle 方法中包含提示。但是，如果你只希望在用户也被自动提示缺少参数时提示他们，那么你可以实现 afterPromptingForMissingArguments 方法：

php

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use function Laravel\Prompts\confirm;

// ...

/**
 * Perform actions after the user was prompted for missing arguments.
 */
protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output): void
{
    $input->setOption('queue', confirm(
        label: 'Would you like to queue the mail?',
        default: $this->option('queue')
    ));
}

命令 I/O

检索输入

在命令执行期间，你可能需要访问命令接受的参数和选项的值。为此，你可以使用 argument 和 option 方法。如果参数或选项不存在，将返回 null：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $userId = $this->argument('user');
}

如果需要将所有参数检索为 array，请调用 arguments 方法：

php

$arguments = $this->arguments();

选项可以像参数一样通过 option 方法轻松检索。要检索所有选项为数组，请调用 options 方法：

php

// Retrieve a specific option...
$queueName = $this->option('queue');

// Retrieve all options as an array...
$options = $this->options();

你可以使用 input 方法将命令的参数和选项检索为 Illuminate\Console\CommandInput 实例，该实例提供与 HTTP 请求和其他数据容器上可用的相同类型访问器：

php

use App\Enums\ReportType;

/**
 * Execute the console command.
 */
public function handle(): void
{
    $input = $this->input()->date('from');

    // ...
}

input 方法也可用于从参数或选项中检索单个输入值：

php

$queue = $this->input('queue', 'default');

提示输入

NOTE

Laravel Prompts 是一个 PHP 包，用于为你的命令行应用程序添加美观且用户友好的表单，具有占位符文本和验证等浏览器类似功能。

除了显示输出外，你还可以在命令执行期间要求用户提供输入。ask 方法将使用给定的问题提示用户，接受他们的输入，然后将用户的输入返回给你的命令：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $name = $this->ask('What is your name?');

    // ...
}

ask 方法也接受一个可选的第二个参数，用于指定如果未提供用户输入时应返回的默认值：

php

$name = $this->ask('What is your name?', 'Taylor');

secret 方法与 ask 类似，但用户在控制台中输入时其输入不可见。此方法在询问敏感信息（如密码）时很有用：

php

$password = $this->secret('What is the password?');

请求确认

如果你需要向用户询问简单的"是或否"确认，可以使用 confirm 方法。默认情况下，此方法将返回 false。但是，如果用户在提示中输入 y 或 yes，该方法将返回 true。

php

if ($this->confirm('Do you wish to continue?')) {
    // ...
}

如有必要，你可以通过向 confirm 方法传递 true 作为第二个参数来指定确认提示默认返回 true：

php

if ($this->confirm('Do you wish to continue?', true)) {
    // ...
}

自动补全

anticipate 方法可用于为可能的选择提供自动补全。用户仍然可以提供任何答案，无论自动补全提示如何：

php

$name = $this->anticipate('What is your name?', ['Taylor', 'Dayle']);

或者，你可以向 anticipate 方法传递一个闭包作为第二个参数。每次用户输入一个字符时都会调用该闭包。该闭包应接受一个包含用户当前输入的字符串参数，并返回一个用于自动补全的选项数组：

php

use App\Models\Address;

$name = $this->anticipate('What is your address?', function (string $input) {
    return Address::whereLike('name', "{$input}%")
        ->limit(5)
        ->pluck('name')
        ->all();
});

多项选择题

如果你需要在提问时给用户一组预定义的选项，可以使用 choice 方法。你可以通过将索引作为第三个参数传递给方法来设置默认值的数组索引，如果没有选择任何选项则返回该默认值：

php

$name = $this->choice(
    'What is your name?',
    ['Taylor', 'Dayle'],
    $defaultIndex
);

此外，choice 方法接受可选的第四和第五个参数，用于确定选择有效响应的最大尝试次数以及是否允许多选：

php

$name = $this->choice(
    'What is your name?',
    ['Taylor', 'Dayle'],
    $defaultIndex,
    $maxAttempts = null,
    $allowMultipleSelections = false
);

写入输出

要向控制台发送输出，你可以使用 line、newLine、info、comment、question、warn、alert 和 error 方法。这些方法中的每一个都将为其用途使用适当的 ANSI 颜色。例如，让我们向用户显示一些一般信息。通常，info 方法将在控制台中显示为绿色文本：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    // ...

    $this->info('The command was successful!');
}

要显示错误消息，请使用 error 方法。错误消息文本通常以红色显示：

php

$this->error('Something went wrong!');

你可以使用 line 方法显示纯文本，不带颜色：

php

$this->line('Display this on the screen');

你可以使用 newLine 方法显示一个空行：

php

// Write a single blank line...
$this->newLine();

// Write three blank lines...
$this->newLine(3);

表格

table 方法可以轻松格式化多行/多列数据。你只需要提供列名和表格的数据，Laravel 将自动为你计算表格的适当宽度和高度：

php

use App\Models\User;

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

进度条

对于长时间运行的任务，显示一个进度条来告知用户任务的完成程度会很有帮助。使用 withProgressBar 方法，Laravel 将显示一个进度条，并为每次遍历给定的可迭代值推进进度：

php

use App\Models\User;

$users = $this->withProgressBar(User::all(), function (User $user) {
    $this->performTask($user);
});

有时，你可能需要更手动地控制进度条的推进方式。首先，定义流程将迭代的总步数。然后，在处理每个项目后推进进度条：

php

$users = App\Models\User::all();

$bar = $this->output->createProgressBar(count($users));

$bar->start();

foreach ($users as $user) {
    $this->performTask($user);

    $bar->advance();
}

$bar->finish();

NOTE

有关更高级的选项，请查看 Symfony Progress Bar 组件文档。

注册命令

默认情况下，Laravel 会自动注册 app/Console/Commands 目录中的所有命令。但是，你可以通过在应用程序的 bootstrap/app.php 文件中使用 withCommands 方法来指示 Laravel 扫描其他目录以查找 Artisan 命令：

php

->withCommands([
    __DIR__.'/../app/Domain/Orders/Commands',
])

如有必要，你也可以通过向 withCommands 方法提供命令的类名来手动注册命令：

php

use App\Domain\Orders\Commands\SendEmails;

->withCommands([
    SendEmails::class,
])

当 Artisan 启动时，应用程序中的所有命令将由服务容器解析并注册到 Artisan 中。

以编程方式执行命令

有时你可能希望在 CLI 之外执行 Artisan 命令。例如，你可能希望从路由或控制器执行 Artisan 命令。你可以使用 Artisan 门面上的 call 方法来实现这一点。call 方法接受命令的签名名称或类名作为第一个参数，命令参数数组作为第二个参数。将返回退出码：

php

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;

Route::post('/user/{user}/mail', function (string $user) {
    $exitCode = Artisan::call('mail:send', [
        'user' => $user, '--queue' => 'default'
    ]);

    // ...
});

或者，你可以将整个 Artisan 命令作为字符串传递给 call 方法：

php

Artisan::call('mail:send 1 --queue=default');

传递数组值

如果你的命令定义了一个接受数组的选项，你可以向该选项传递一个数组值：

php

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;

Route::post('/mail', function () {
    $exitCode = Artisan::call('mail:send', [
        '--id' => [5, 13]
    ]);
});

传递布尔值

如果你需要指定一个不接受字符串值的选项的值，例如 migrate:refresh 命令的 --force 标志，你应该传递 true 或 false 作为选项的值：

php

$exitCode = Artisan::call('migrate:refresh', [
    '--force' => true,
]);

队列化 Artisan 命令

使用 Artisan 门面上的 queue 方法，你甚至可以将 Artisan 命令排队，以便它们在后台由你的队列工作进程处理。在使用此方法之前，请确保你已经配置了队列并正在运行队列监听器：

php

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;

Route::post('/user/{user}/mail', function (string $user) {
    Artisan::queue('mail:send', [
        'user' => $user, '--queue' => 'default'
    ]);

    // ...
});

使用 onConnection 和 onQueue 方法，你可以指定 Artisan 命令应分派到的连接或队列：

php

Artisan::queue('mail:send', [
    'user' => 1, '--queue' => 'default'
])->onConnection('redis')->onQueue('commands');

从其他命令调用命令

有时你可能希望从现有的 Artisan 命令中调用其他命令。你可以使用 call 方法来实现。此 call 方法接受命令名称和命令参数/选项的数组：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $this->call('mail:send', [
        'user' => 1, '--queue' => 'default'
    ]);

    // ...
}

如果你希望调用另一个控制台命令并抑制其所有输出，可以使用 callSilently 方法。callSilently 方法与 call 方法具有相同的签名：

php

$this->callSilently('mail:send', [
    'user' => 1, '--queue' => 'default'
]);

信号处理

你可能知道，操作系统可以向正在运行的进程发送信号。例如，SIGTERM 信号是操作系统请求程序优雅终止的方式。如果你希望在 Artisan 控制台命令中监听信号并在信号发生时执行代码，可以使用 trap 方法：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $this->trap(SIGTERM, fn () => $this->shouldKeepRunning = false);

    while ($this->shouldKeepRunning) {
        // ...
    }
}

要一次监听多个信号，你可以向 trap 方法提供一个信号数组：

php

$this->trap([SIGTERM, SIGQUIT], function (int $signal) {
    $this->shouldKeepRunning = false;

    dump($signal); // SIGTERM / SIGQUIT
});

Dev 命令

dev Artisan 命令在单个终端窗口中启动本地开发所需的所有进程。默认情况下，它同时运行 PHP 开发服务器、队列工作进程、通过 Pail 进行的日志追踪以及 Vite 资产编译：

shell

php artisan dev

在底层，dev 命令使用 concurrently npm 包来管理进程。每个进程在你的终端输出中都有标签和颜色编码，以便你可以轻松区分它们。如果任何进程失败，所有其他进程将自动停止。

默认进程如下：

名称	命令
`server`	`php artisan serve --host=localhost`
`queue`	`php artisan queue:listen --tries=1 --timeout=0`
`logs`	`php artisan pail --timeout=0`
`vite`	`npm run dev`

NOTE

vite 进程会自动检测你的 Node 包管理器（npm、pnpm、Yarn 或 Bun）并使用相应的运行命令。

自定义 Dev 进程

你可以使用 DevCommands 类自定义 dev 命令运行的进程，通常在应用程序的 AppServiceProvider 的 boot 方法中。register 方法接受一个命令字符串和一个可选的名称：

php

use Illuminate\Foundation\DevCommands;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    DevCommands::register('some-command --flag', 'my-process');
}

在注册 Artisan 命令时，你可以使用 artisan 方法，该方法会自动在命令前加上 php artisan：

php

DevCommands::artisan('horizon', 'horizon');

同样，node 方法会在命令前加上检测到的包管理器运行命令（例如 npm run），而 nodeExec 方法会在命令前加上包管理器的 exec 命令（例如 npx）：

php

DevCommands::node('storybook', 'storybook');

DevCommands::nodeExec('tailwindcss -i resources/css/app.css -o public/css/app.css --watch', 'tailwind');

如果你注册的进程与默认进程同名，你的进程将替换默认进程。例如，你可以自定义服务器进程以使用不同的端口：

php

DevCommands::artisan('serve --host=localhost --port=9000', 'server');

你也可以自定义终端中进程标签的颜色。可用的颜色方法有 blue、purple、pink、orange、green 和 yellow。你也可以向 color 方法传递自定义的十六进制颜色：

php

DevCommands::register('my-command', 'my-process')->green();

DevCommands::register('my-command', 'my-process')->color('#ff6347');

要查看所有已注册的 dev 进程而不启动它们，请使用 dev:list 命令：

shell

php artisan dev:list

过滤 Dev 进程

你可以指示 dev 命令在调用时只运行特定进程，使用 only 方法。同样，你可以使用 except 方法排除特定进程：

php

// Only run the server and vite processes...
DevCommands::only('server', 'vite');

// Run all processes except the queue worker...
DevCommands::except('queue');

模板定制

Artisan 控制台的 make 命令用于创建各种类，如控制器、任务、迁移和测试。这些类是使用"模板"文件生成的，这些文件根据你的输入填充值。但是，你可能希望对 Artisan 生成的文件进行小的更改。为此，你可以使用 stub:publish 命令将最常见的模板发布到你的应用程序中，以便你可以自定义它们：

shell

php artisan stub:publish

发布的模板将位于应用程序根目录的 stubs 目录中。你对这些模板所做的任何更改都将在使用 Artisan 的 make 命令生成相应类时得到反映。

事件

Artisan 在运行命令时调度三个事件：Illuminate\Console\Events\ArtisanStarting、Illuminate\Console\Events\CommandStarting 和 Illuminate\Console\Events\CommandFinished。ArtisanStarting 事件在 Artisan 开始运行时立即调度。接下来，CommandStarting 事件在命令运行之前立即调度。最后，CommandFinished 事件在命令完成执行后调度。

Artisan 控制台 ​

简介 ​

Laravel Sail ​

Tinker (REPL) ​

安装 ​

用法 ​

命令允许列表 ​

不应别名的类 ​

编写命令 ​

生成命令 ​

命令结构 ​

退出码 ​

闭包命令 ​

类型提示依赖 ​

闭包命令描述 ​

可隔离命令 ​

锁 ID ​

锁过期时间 ​

定义输入期望 ​

参数 ​

选项 ​

带值的选项 ​

选项快捷方式 ​

输入数组 ​

选项数组 ​

输入描述 ​

提示缺失输入 ​

命令 I/O ​

检索输入 ​

提示输入 ​

请求确认 ​

自动补全 ​

多项选择题 ​

写入输出 ​

表格 ​

进度条 ​

注册命令 ​

以编程方式执行命令 ​

传递数组值 ​

传递布尔值 ​

队列化 Artisan 命令 ​

从其他命令调用命令 ​

信号处理 ​

Dev 命令 ​

自定义 Dev 进程 ​

过滤 Dev 进程 ​

模板定制 ​

事件 ​

Artisan 控制台

简介

Laravel Sail

Tinker (REPL)

安装

用法

命令允许列表

不应别名的类

编写命令

生成命令

命令结构

退出码

闭包命令

类型提示依赖

闭包命令描述

可隔离命令

锁 ID

锁过期时间

定义输入期望

参数

选项

带值的选项

选项快捷方式

输入数组

选项数组

输入描述

提示缺失输入

命令 I/O

检索输入

提示输入

请求确认

自动补全

多项选择题

写入输出

表格

进度条

注册命令

以编程方式执行命令

传递数组值

传递布尔值

队列化 Artisan 命令

从其他命令调用命令

信号处理

Dev 命令

自定义 Dev 进程

过滤 Dev 进程

模板定制

事件