Skip to content

πŸ”˜ Beautiful PHP CLI menus. Is a php-school/cli-menu wrapper for Laravel/Artisan Console Commands

License

Notifications You must be signed in to change notification settings

nunomaduro/laravel-console-menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

74 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Static Analysis Latest Stable Version License

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.

About

πŸ”˜ Beautiful PHP CLI menus. Is a php-school/cli-menu wrapper for Laravel/Artisan Console Commands

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 9

Languages