Skip to main content
Version: Next

run metrics

Retrieve metrics from a simulation run. This will print all the metrics from
the simulation run one by one in JSON format. You can easily add that to a
file using > (append) or >> (overwrite).

Usage​

Usage: simcli run metrics [OPTIONS] SIMULATION_RUN_ID

Options​

  • simulation_run_id (REQUIRED):
    • Type: STRING
    • Default: none
    • Usage: simulation_run_id

  • staging:

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

    Use Staging Area For Testing

  • help:

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

    Show this message and exit.

CLI Help​

Usage: simcli run metrics [OPTIONS] SIMULATION_RUN_ID

  Retrieve metrics from a simulation run. This will print all the metrics from
  the simulation run one by one in JSON format. You can easily add that to a
  file using > (append) or >> (overwrite).

Options:
  --staging  Use Staging Area For Testing
  --help     Show this message and exit.