CLI Reference

This page provides documentation for our command line tools.

cr-kyoushi-sim

Run Cyber Range Kyoushi Simulation.

Usage:

cr-kyoushi-sim [OPTIONS] COMMAND [ARGS]...

Options:

  --log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]
                                  The log level
  --seed INTEGER                  Global seeds for PRNGs used during
                                  simulation

  -c, --config FILE               The Cyber Range Kyoushi Simulation settings
                                  file  [default: config.yml]

  --help                          Show this message and exit.

cr-kyoushi-sim list

List available state machine factories.

Usage:

cr-kyoushi-sim list [OPTIONS]

Options:

  --help  Show this message and exit.

cr-kyoushi-sim run

Execute a state machine.

Usage:

cr-kyoushi-sim run [OPTIONS]

Options:

  -s, --sm-config FILE  The state machine configuration file  [default:
                        sm.yml]

  -f, --factory TEXT    The state machine factory to use. This can be either
                        the name of a statemachine factory entrypoint plugin
                        or the path to a python file containing a statemachine
                        factory.  [required]

  --help                Show this message and exit.

cr-kyoushi-sim version

Get the library version.

Usage:

cr-kyoushi-sim version [OPTIONS]

Options:

  --help  Show this message and exit.