ekowabaka/clearice

A tool to help in the building of CLI apps. Provides command line parsing and simple console I/O interfaces.

v3.2.1 2022-12-17 14:23 UTC

Requires

• php: >=7.1

Requires (Dev)

• mikey179/vfsstream: @stable
• phpunit/phpunit: @stable

MIT

• James Ekow Abaka Ainooson

README

ClearIce provides tools for PHP applications to help with parsing command line arguments, and performing interactive I/O sessions. Arguments supplied at the command line or through a shell are validated and supplied to your script in a consistently organized format. And gues what, there's also the added possibility of automatically generating help messages for your applications.

Installing

Although you can directly include the ClearIce scripts into your application, the best way of installing it is through composer.

composer require ekowabaka/clearice

ClearIce has no dependencies other than a PHP interpreter with version 7.1 or better.

Parsing Arguments with ClearICE

Let's get started with an example. If you ever wanted to parse command line arguments you can put ...

<?php
require "vendor/autoload.php";

$parser = new \clearice\argparser\ArgumentParser();
$parser->addOption([
    'name' => 'input',
    'short_name' => 'i',
    'type' => 'string',
    'required' => true
]);

$parser->addOption([
    'name' => 'output',
    'short_name' => 'o',
    'type' => 'string',
    'default' => '/default/output/path'
]);

$options = $parser->parse($argv);
print_r($options);

... in a file (which you can for example save as wiki.php). Then when you execute ...

php wiki.php generate --input=/home/james --output=/var/www/cool-wiki

... the output will be ...

Array
(
    [input] => /input/path
    [output] => /output/path
    [__executed] => wiki.php
)

... and so will the following:

php test.php --input /input/path --output /output/path
php test.php -i/input/path -o/output/path

Interactive I/O with ClearICE

If you are interested in interactive I/O, entering this

use clearice\io\Io;
$io = new Io();
$name = $io->getResponse('What is your name', ['default' => 'No Name']);

$direction = $io->getResponse("Okay $name, where do you want to go", 
    [
        'required' => true,
        'answers' => array('north', 'south', 'east', 'west')
    ]
); 

could lead to an interaction like this:

What is your name [No Name]: ⏎
Okay No Name, where do you want to go (north/south/east/west) []: ⏎
A value is required.
Okay No Name, where do you want to go (north/south/east/west) []: home⏎
Please provide a valid answer.
Okay No Name, where do you want to go (north/south/east/west) []: 

Hope you enjoy using ClearIce!