nunomaduro / laravel-console-menu
Laravel Console Menu is an output method for your Laravel/Laravel Zero commands.
Fund package maintenance!
nunomaduro
Patreon
www.paypal.com/paypalme/enunomaduro
Installs: 324 572
Dependents: 47
Suggesters: 0
Security: 0
Stars: 802
Watchers: 23
Forks: 40
Open Issues: 5
Requires
- php: ^8.1
- illuminate/console: ^9.0|^10.0|^11.0
- illuminate/support: ^9.0|^10.0|^11.0
- php-school/cli-menu: ^4.3
Requires (Dev)
- laravel/pint: ^1.4
README
About Laravel Console Menu
Laravel Console Menu was created by, and is maintained by Nuno Maduro, and is a php-school/cli-menu wrapper for Laravel Console Commands.
Installation
Requires PHP 8.1+
Require Laravel Console Menu using Composer:
composer require nunomaduro/laravel-console-menu
Usage
Quick Setup
class MenuCommand extends Command { /** * Execute the console command. * * @return void */ public function handle() { $option = $this->menu('Pizza menu', [ 'Freshly baked muffins', 'Freshly baked croissants', 'Turnovers, crumb cake, cinnamon buns, scones', ])->open(); $this->info("You have chosen the option number #$option"); } }
Setup with a question
class MenuCommand extends Command { /** * Execute the console command. * * @return void */ public function handle() { $option = $this->menu('Pizza menu') ->addOption('mozzarella', 'Mozzarella') ->addOption('chicken_parm', 'Chicken Parm') ->addOption('sausage', 'Sausage') ->addQuestion('Make your own', 'Describe your pizza...') ->addOption('burger', 'Prefer burgers') ->setWidth(80) ->open(); $this->info("You have chosen the text option: $option"); } }
Setup with advanced option, in this case, a password
class MenuCommand extends Command { /** * Execute the console command. * * @return void */ public function handle() { $menu = $this->menu('Pizza menu') ->addOption('mozzarella', 'Mozzarella') ->addOption('chicken_parm', 'Chicken Parm') ->addOption('sausage', 'Sausage') ->addQuestion('Make your own', 'Describe your pizza...'); $itemCallable = function (CliMenu $cliMenu) use ($menu) { $cliMenu->askPassword() ->setValidator(function ($password) { return $password === 'secret'; }) ->setPromptText('Secret password?') ->ask(); $menu->setResult('Free spice!'); $cliMenu->close(); }; $menu->addItem('Add extra spice for free (password needed)', $itemCallable); $option = $menu->addOption('burger', 'Prefer burgers') ->setWidth(80) ->open(); $this->info("You have chosen the text option: $option"); } }
Appearance
Available colors: black
, red
, green
, yellow
, blue
, magenta
, cyan
, white
.
$this->menu($title, $options) ->setForegroundColour('green') ->setBackgroundColour('black') ->setWidth(200) ->setPadding(10) ->setMargin(5) ->setExitButtonText("Abort") // remove exit button with ->disableDefaultItems() ->setTitleSeparator('*-') ->addLineBreak('<3', 2) ->addStaticItem('AREA 2') ->open();
Check out the full documentation here.
Contributing
Thank you for considering to contribute to Laravel Console Menu. All the contribution guidelines are mentioned here.
You can have a look at the CHANGELOG for constant updates & detailed information about the changes. You can also follow the twitter account for latest announcements or just come say hi!: @enunomaduro
Support the development
Do you like this project? Support it by donating
License
Laravel Console Menu is an open-sourced software licensed under the MIT license.