• Stars
    star
    794
  • Rank 54,992 (Top 2 %)
  • Language
    PHP
  • License
    MIT License
  • Created about 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

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.

More Repositories

1

phpinsights

πŸ”° Instant PHP quality checks from your console
PHP
5,176
star
2

larastan

βš—οΈ Adds code analysis to Laravel improving developer productivity and code quality.
PHP
4,882
star
3

collision

πŸ’₯ Collision is a beautiful error reporting tool for command-line applications
PHP
4,429
star
4

termwind

πŸƒ In short, it's like Tailwind CSS, but for the PHP command-line applications.
PHP
2,151
star
5

skeleton-php

⚑️ This package provides a wonderful PHP skeleton to start building your next package idea.
PHP
647
star
6

laravel-desktop-notifier

πŸ’» Send notifications to your desktop from your Laravel Artisan Commands. An JoliNotif wrapper for Laravel.
PHP
415
star
7

laravel-mojito

🍹 A lightweight package for testing Laravel views in isolation
PHP
372
star
8

pest

This repository contains an old version of PEST. A new and better version is being coded in private and will be out soon: https://github.com/pestphp/pest.
342
star
9

patrol

Patrol is an elegant command-line tool that keeps your PHP Project's dependencies in check.
PHP
256
star
10

laravel-console-task

βœ… Laravel Console Task is a output method for Laravel Console Commands.
PHP
252
star
11

awesome-php-src

πŸš€ A curated list of awesome resources related to PHP source code
224
star
12

curryable

An elegant and simple curry(f) implementation in PHP.
PHP
175
star
13

dd

✨ The most popular way of debugging in PHP is now available in JavaScript.
JavaScript
159
star
14

yorn

βš—οΈ Modules in PHP with the `import` and `export` syntax
PHP
146
star
15

laravel-console-dusk

Laravel Console Dusk allows the usage of Laravel Dusk in Laravel/Laravel Zero artisan commands.
PHP
144
star
16

laracon-schedule

πŸ‘¨πŸ»β€πŸš€ A command-line tool that gives you the @LaraconOnline schedule in your timezone. πŸš€
PHP
101
star
17

laravel-pot

Provides Artisan commands to inspect Laravel Application's container. πŸͺ΄
PHP
88
star
18

mock-final-classes

πŸ„β€β™‚οΈ Allows mocking final classes in PHP.
PHP
83
star
19

awesome-laravel-vapor

πŸš€ A curated list of awesome resources related to Laravel Vapor.
80
star
20

laravel-console-summary

πŸ“– Beautiful Laravel Console Summary for Artisan or Laravel Zero.
PHP
62
star
21

collision-adapter-symfony

Collision's adapter for Symfony applications. Error Reporting for console/command-line PHP applications.
PHP
45
star
22

dig

πŸ‘¨πŸ»β€πŸŽ¨ A beautiful debug tool for the command line.
PHP
40
star
23

laravel-any

πŸ“ Laravel collection macro that determine if `any` item from the collection passes the given truth test.
PHP
38
star
24

nunomaduro.com

Rust
34
star
25

skeleton-c

⚑️ This package provides a wonderful C skeleton to start building your next package idea.
Makefile
33
star
26

php-interminal

PHP Interminal is a command-line tool that gives you access to PHP Internals discussions in your terminal.
PHP
32
star
27

bombe

Bombe is a tool for benchmarking the given url response status and response time.
C
23
star
28

skeleton-js

πŸ‘¨πŸ»β€πŸ’» A skeleton repository for my open source JavaScript packages
JavaScript
21
star
29

elegant-sublime

πŸ‘”An collection of sublime text preferences
17
star
30

pint-strict-preset

Pint strict preset is an insanely defensive coding style preset for those who demand meticulous precision in their projects.
11
star
31

alpine-day-schedule

πŸ‘¨πŸ»β€πŸš€ A command-line tool that gives you the Alpine Day 2021 schedule in your timezone. πŸš€
PHP
11
star
32

talks

🎀 My talks about PHP, Laravel or side projects of mine
10
star
33

laravel-meetups

πŸ•It's Meetup time! Find out Laravel Meetups near you!
PHP
8
star
34

laravel-console-spinner

❃ A spinning activity indicator for Laravel/Laravel Zero artisan commands.
7
star
35

laravel-9-test

PHP
5
star
36

forge-octane

PHP
5
star
37

scout-extended-demo

PHP
3
star
38

skeleton-typescript

βš—οΈ The perfect starting for typescript libraries.
3
star
39

laravel-zero-weather

PHP
3
star
40

nextjs-blog-wqdqwdqwd

JavaScript
2
star
41

dotfiles

2
star
42

twitter-stream

An demo application of Laravel Zero that works with the Twitter Streaming API
PHP
2
star
43

learn-javascript

2
star
44

my-site

HTML
1
star
45

vapor-github-test

PHP
1
star
46

qwdpowkqdopwqkd

JavaScript
1
star
47

skeleton-php-1

My PHP Package Skeleton
PHP
1
star
48

exclude-dev-files-bug

PHP
1
star
49

kpop-stack

TypeScript
1
star
50

nunomaduro

1
star
51

helpers-tap

🚰 Tap that method
TypeScript
1
star
52

test

HTML
1
star
53

perna

πŸ›‹ Optimises the workflow around managing multi-package repositories.
1
star
54

laravel-collections-examples

PHP
1
star
55

demo-p

PHP
1
star