Skip to content

CLI script

CLI

Handle FaultSystemSolution tasks - build, analyse.

Note: This script relies on access to the NSHM Toshi GraphQL API (nshm-toshi-api) for build operations. If you do not have this installed locally, the NZSHM22_TOSHI_API_URL environment variable must be set accordingly.

Usage:

CLI [OPTIONS] COMMAND [ARGS]...

Options:

  -fs, --fault_system [PUY|HIK|CRU|ALL]
  -w, --work_folder TEXT
  --help                          Show this message and exit.

CLI build

Usage:

CLI build [OPTIONS]

Options:

  -a, --archive_name TEXT  An OpenSHA solution archive name (default:
                           CompositeSolution.zip)
  -m, --model_id TEXT      An nzshm_model ID (default: NSHM_v1.0.4)
  --help                   Show this message and exit.

CLI ls

Usage:

CLI ls [OPTIONS]

Options:

  -a, --archive_name TEXT  An OpenSHA solution archive name
                           (NSHM_v1.0.4_CompositeSolution.zip)
  -m, --model_id TEXT      An nzshm_model ID (default: NSHM_v1.0.4)
  --help                   Show this message and exit.