You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
PurpleDome/doc/source/usage/cli.rst

39 lines
921 B
ReStructuredText

===
CLI
===
There are three command line tools that offer a simple interface to PurpleDome.
Experiment control
------------------
Experiment control is the core tool to run an experiment. It accepts a yaml config file and runs the experiments in there. The configuration file defines the system to be used (together with a Vagrant file being referenced there) and the attacks to run.
.. asciinema:: ./../asciinema/experiment_control.cast
:speed: 2
.. argparse::
:filename: ../experiment_control.py
:func: create_parser
:prog: ./experiment_control.py
Caldera control
---------------
Directly control a caldera server
.. argparse::
:filename: ../caldera_control.py
:func: create_parser
:prog: ./caldera_control.py
Machine control
---------------
Directly control the machines
.. argparse::
:filename: ../machine_control.py
:func: create_parser
:prog: ./machine_control.py