slk/icm

Interactive Command line Markup

Interactive Command line Markup(ICM), _(*1)

ICM is created to allow you easily create intereactive tutorials for your command line program similar to the interactive tutorials of Redis (http://try.redis.io) or Docker (https://www.docker.io/gettingstarted/)., _(*2)

Installation

Add the following line in in require compose.json section:, _(*3)

"slk/icm" : "dev-master", _(*4)

After that in your PHP application you can use the Slk\View\ICMRenderer., _(*5)

Markup Langage

Prompt ~~~~~~ To prompt the user input you can add in the beginning of a line the following, _(*6)

_, _(*7)

To prompt for user output and show also the name of the command line program use:, _(*8)

$_, _(*9)

The sequence below can be used to check against the user input against expected value:, _(*10)

$_ ==--help, _(*11)

That above two lines will create a prompt with the name of the current program and will expect from the user to enter --help, _(*12)

You can also use also regular experession for input matching, _(*13)

$_ ==/\s--help\s/, _(*14)

The command above will check if the user entered --help with or without trailing spaces., _(*15)

If the expected input from the user is difficult for him to guess you can add an example., _(*16)

$_ ==/\scommand\s+--help\s/ ===command --help, _(*17)

And finally if you want to save the user input you can store it in a variable with a name, _(*18)

$_ ==/\scommand\s+--help\s/ ===command --help => input, _(*19)

The above three lines will ask the user for an input, he has to answer with "command --help" or will be shown the example at the end and the input of the user will be saved in a variable with the name input., _(*20)

Command exection ~~~~~~~~ To pass arguments to the current console line program and execute them you can use the following syntax:, _(*21)

$_ xyz, _(*22)

This will execute the in a separate shell " xyz". The result will be save in a variable with a name "result"., _(*23)

Variables ~~~~~ Variables are describe in the same way that you do in PHP. There is one pre-defined variable $script that contains the full name of the command line application that is currently executed., _(*24)

After command execution with $_ the result is saved in $result. The input from a promt can be saved in a named variable that can be used later on., _(*25)

$_ ==/\scommand\s+--help\s/ ===command --help => input, _(*26)

In the example above after these four lines are executed you can get the info by reading $input., _(*27)

Page breaks ~~~~~~~~~~~, _(*28)

If you have a line starting with three or more dashes (-) then this will ask the user to press enter to continue. And if you have three or more > symbols this will ask the user to press enter in order to go on the next page. Going on the next page in a command line context means to clear the currect screen., _(*29)