Command Line Interface

This chapter describes how to use the Command Line Interface (CLI) of Plasma Lab.

Starts the CLI :

# \*nix - from the command line
./plasmacli.sh

# windows - from the command line
plasmacli.bat

Several sub-commands are available and will be explained in the following (shown with the plasmacli.sh script, but working equivalently with plasmacli.bat). They are specified on the command line using ./plasmacli.sh subcommand.

You can always invoke the help for a subcommand using :

./plasmacli.sh subcommand --help

Info

./plasmacli.sh info [options] provides information option about PLASMA Lab’s plugins and algorithms.

  • ./plasmacli.sh info displays the list of plugins (algorithms, models, requirements) that is currently loaded by PLASMA Lab

(with the plugin list defined in the configuration file). For each plugin it gives the ID of the plugin, that should be used when running the CLI to identify the plugin, and a short description.

  • ./plasmacli.sh info -a [algorithm id] displays information about an algorithm, in particular the list of parameters.

Launch

./plasmacli.sh launch [options] is used to start a new experimentation. You’ll have to pass all the parameters required to perform the experimentation (requirement with option -r, model with option -m, algorithm with option -a and its parameters with options -A).

Models and requirements files must always be written with their type using the following syntax: file:type.

Example :

./plasmacli launch -m demos/raw/philo3.rml:rml -r demos/raw/liveness:bltl -a montecarlo -A"Total samples"=10000 --progress

In this case you should observe the following output

[...]
[some traces]
[...]
[==================================================]   100%
+----------+---------------+-----------------------+--------+
| Name     | # Simulations | # Positive Simulation | Result |
+----------+---------------+-----------------------+--------+
| liveness | 10000         | 10000                 | 1.0    |
+----------+---------------+-----------------------+--------+

Simu

./plasmacli.sh simu [options] is used to start an interactive simulation. A necessary option is the model to simulate.

  • Pressing Enter will step the simulation by 1 step (initial default value)
  • Entering a number n will step the simulation by n steps. Then n will be the new default value for the step number.
  • Entering r restart the simulation at the initial step.
  • Entering a negative number allows to backtrack the simulation.
  • Entering q will quit the simulation.

Service

./plasmacli.sh service [options] is used to start a new service listening on the default port.