single create

Create a single simulation. It uses the configuration YAML file in the
current directory by default (or the path specified by --path). Make sure
that the configuration YAML is compiled before running this command.

Usage

Usage: simcli single create [OPTIONS]

Options

• staging:

  • Type: BOOL
  • Default: false
  • Usage: --staging

  Use Staging Area For Testing

• parameter:

  • Type: <click.types.Tuple object at 0x7f7d1d6f4ac0>
  • Default: []
  • Usage: --parameter

  Manually change the value of an existing parameter from the configuration YAML. Expects the name and value separated by a space. (e.g. --parameter swapping_fees_ETH_1 0.0002). Can be used many times by calling --parameter again and again.

• parameters_as_json:

  • Type: STRING
  • Default: none
  • Usage: --parameters-as-json

  Passing in parameter replacements for existing parameters in the configuration YAML as json as an array (e.g. --parameter-as-json {"name": "swapping_fees_ETH_1", "value": 0.002}). Any parameter passed in using --parameter will override the JSON parameter.

• gcs_link:

  • Type: STRING
  • Default: none
  • Usage: --gcs-link

  Use a GCS link which the configuration YAML will be loaded from instead of trying to find it in the working directory. Has to be a compiled configuration.

• sim_id:

  • Type: STRING
  • Default: none
  • Usage: --sim-id

  Provide a simulation id to be used. If not provided, the CLI will create a simulation id.

• path:

  • Type: STRING
  • Default: .
  • Usage: --path

  Specify the path where the configuration is located, if not the current directory.

• flag:

  • Type: <click.types.Tuple object at 0x7f7d1d6f7820>
  • Default: []
  • Usage: --flag

  Flags are used to change the behaviour of the simulator. Expects the name and value separated by a space. (e.g. --flag metricEndpoint KAFKA). Can be used many times by calling --flag again and again.

• max_attempts:

  • Type: INT
  • Default: 1
  • Usage: --max-attempts

  The maximum number of attempts to try to create a simulation. Defaults to 1.

• help:

  • Type: BOOL
  • Default: false
  • Usage: --help

  Show this message and exit.

CLI Help

Usage: simcli single create [OPTIONS]

  Create a single simulation. It uses the configuration YAML file in the
  current directory by default (or the path specified by --path). Make sure
  that the configuration YAML is compiled before running this command.

Options:
  --staging                   Use Staging Area For Testing
  --parameter <TEXT TEXT>...  Manually change the value of an existing
                              parameter from the configuration YAML. Expects
                              the name and value separated by a space. (e.g.
                              --parameter swapping_fees_ETH_1 0.0002). Can be
                              used many times by calling --parameter again and
                              again.
  --parameters-as-json TEXT   Passing in parameter replacements for existing
                              parameters in the configuration YAML as json as
                              an array (e.g. --parameter-as-json {"name":
                              "swapping_fees_ETH_1", "value": 0.002}). Any
                              parameter passed in using --parameter will
                              override the JSON parameter.
  --gcs-link TEXT             Use a GCS link which the configuration YAML will
                              be loaded from instead of trying to find it in
                              the working directory. Has to be a compiled
                              configuration.
  --sim-id TEXT               Provide a simulation id to be used. If not
                              provided, the CLI will create a simulation id.
  --path TEXT                 Specify the path where the configuration is
                              located, if not the current directory.
  --flag <TEXT TEXT>...       Flags are used to change the behaviour of the
                              simulator. Expects the name and value separated
                              by a space. (e.g. --flag metricEndpoint KAFKA).
                              Can be used many times by calling --flag again
                              and again.
  --max-attempts INTEGER      The maximum number of attempts to try to create
                              a simulation. Defaults to 1.
  --help                      Show this message and exit.