Home Original page

register command

注册命令

编写好命令或命令组后，我们需要注册它们到 console app 实例上，

注意要在 $app->run() 之前注册命令

  • 通过 $app->command(TestCommand::class) 注册独立命令。
  • 通过 $app->controller(HomeController::class) 注册命令组。
$app->command(TestCommand::class);
// OR 设置了命令名称，将会覆盖类里面设置的
// $app->command('test1', TestCommand::class);
  • 自动扫描注册

手动注册太麻烦！ 可以配置命名空间和对应的路径来，将会自动扫描并注册命令。

// 独立命令
$app->registerCommands('App\\Console\\Command', dirname(__DIR__) . '/Commands');
// 命令组
$app->registerGroups('App\\Console\\Controller', dirname(__DIR__) . '/Controllers');

运行应用

注册好之后，通过终端运行 php path/to/entry.php -h 即可查看注册的命令

这里是运行的 console 自带的示例应用 php examples/app -h

image