https://github.com/nunomaduro/laravel-console-menu

🔘 Beautiful PHP CLI menus. Is a php-school/cli-menu wrapper for Laravel/Artisan Console Commands
https://github.com/nunomaduro/laravel-console-menu

Last synced: 16 days ago
JSON representation

🔘 Beautiful PHP CLI menus. Is a php-school/cli-menu wrapper for Laravel/Artisan Console Commands

• Host: GitHub
• URL: https://github.com/nunomaduro/laravel-console-menu
• Owner: nunomaduro
• License: mit
• Created: 2018-01-28T19:50:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-05T13:01:51.000Z (4 months ago)
• Last Synced: 2024-06-03T19:09:15.274Z (19 days ago)
• Language: PHP
• Homepage:
• Size: 268 KB
• Stars: 795
• Watchers: 23
• Forks: 39
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Lists

• awesome-stars - laravel-console-menu - school/cli-menu wrapper for Laravel/Artisan Console Commands | nunomaduro | 696 | (PHP)
• awesome-starred - laravel-console-menu - school/cli-menu wrapper for Laravel/Artisan Console Commands | nunomaduro | 797 | (PHP)
• awesome-stars - laravel-console-menu - school/cli-menu wrapper for Laravel/Artisan Console Commands | nunomaduro | 797 | (PHP)

README

        


    





  

  

  



## About Laravel Console Menu

Laravel Console Menu was created by, and is maintained by [Nuno Maduro](https://github.com/nunomaduro), and is a [php-school/cli-menu](https://github.com/php-school/cli-menu) wrapper for Laravel Console Commands.

## Installation

> **Requires [PHP 8.1+](https://php.net/releases)**

Require Laravel Console Menu using [Composer](https://getcomposer.org):

```bash

composer require nunomaduro/laravel-console-menu

```

## Usage

### Quick Setup

```php

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



    



```php

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



    



```php

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`.

```php

  $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](https://github.com/php-school/cli-menu/blob/master/README.md).

## Contributing

Thank you for considering to contribute to Laravel Console Menu. All the contribution guidelines are mentioned [here](CONTRIBUTING.md).

You can have a look at the [CHANGELOG](CHANGELOG.md) for constant updates & detailed information about the changes. You can also follow the twitter account for latest announcements or just come say hi!: [@enunomaduro](https://twitter.com/enunomaduro)

## Support the development

**Do you like this project? Support it by donating**

- PayPal: [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L)

- Patreon: [Donate](https://www.patreon.com/nunomaduro)

## License

Laravel Console Menu is an open-sourced software licensed under the [MIT license](LICENSE.md).