Skip to main content
Version: 2.0.1

single create

Create a single simulation. It uses the configuration YAML file in the
current directory by default (or the path specified by --path).

Usage​

Usage: simcli single create [OPTIONS]

Options​

  • staging:

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

    Use Staging Area For Testing

  • already_uploaded:

    • Type: BOOL
    • Default: false
    • Usage: --already-uploaded

    The files for the simulation have already been uploaded. When specifying this, you also need to specify the --sim-id.

  • 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 0x7f363f81a890>
    • 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.

  • priority:

    • Type: INT
    • Default: 0
    • Usage: --priority

    The priority of the simulation. Defaults to 0.

  • 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).

Options:
  --staging                   Use Staging Area For Testing
  --already-uploaded BOOLEAN  The files for the simulation have already been
                              uploaded. When specifying this, you also need to
                              specify the `--sim-id`.
  --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.
  --priority INTEGER          The priority of the simulation. Defaults to 0.
  --help                      Show this message and exit.