bentools/simple-cli

A very lightweight CLI helper with almost no dependency.

0.2 2020-03-09 15:37 UTC

Requires

• php: >= 7.1
• kevinlebrun/colors.php: ^1.0

MIT

• Beno!t POLASZEK

README

Command-line helper functions, with almost no dependencies, to help you build console scripts quickly.

It is not intended to be a full-featured CLI framework, but rather to help you grab arguments / options that were passed to your script, display some text, and prompt for user input.

Installation

composer require bentools/simple-cli:0.2.*

Usage

# php thatscript.php --file=some-file foobar
require_once __DIR__ . '/vendor/autoload.php';
use function BenTools\SimpleCli\cli;
use function BenTools\SimpleCli\getOption;
use function BenTools\SimpleCli\getArgument;
use function BenTools\SimpleCli\writeLn;
use function BenTools\SimpleCli\text;
use function BenTools\SimpleCli\ask;
use function BenTools\SimpleCli\askHidden;
use function BenTools\SimpleCli\confirm;
use function BenTools\SimpleCli\error;
use function BenTools\SimpleCli\success;

getOption('file'); // some-file
getArgument(0); // foobar
writeLn(text('Hey there!')->yellow());

$user = ask('What is your username?', $default = 'anonymous');
$password = askHidden('Enter your password');

if ('123456' === $password && confirm('Really?')) {
    error('Nope nope nope!', $exit = true);
}

success('Done!');

License

MIT.