Skip to content

The scale-egp command line interface

The scale-egp python package includes a command line utility to interact with the SGP API. See the installation section for getting started. The Custom Models section provides step-by-step instructions for using scale-egp to deploy custom models into production.

Listing available commands

To see available commands and options, append -h. For example, to see all command groups, run:

> scale-egp -h
usage: scale-egp [-h] [--log-curl-commands] [-k API_KEY] [-i ACCOUNT_ID] [-e ENDPOINT_URL] [-f {pprint,json,rich,str}] {model,model_group,model_template,user} ...

scale-egp - CLI for SGP
For more information on SGP, please visit: https://scale-egp.readme.io/

positional arguments:
  {model,model_group,model_template,user}
    model
    model_group
    model_template
    user

options:
  -h, --help            show this help message and exit
  --log-curl-commands
  -k API_KEY, --api-key API_KEY
  -i ACCOUNT_ID, --account-id ACCOUNT_ID
                        Optional SGP account_id to use. The default account_id will be used if not set. (default: -)
  -e ENDPOINT_URL, --endpoint-url ENDPOINT_URL
  -f {pprint,json,rich,str}, --format {pprint,json,rich,str}

To list available commands in the model group, use scale-egp model -h:

> scale-egp model -h
usage: scale-egp model [-h] {create,describe,execute,get,list,validate-request} ...

positional arguments:
  {create,describe,execute,get,list,validate-request}
    create
    describe
    execute
    get
    list
    validate-request

options:
  -h, --help            show this help message and exit

To see the usage of a specific command, run eg. scale-egp model create -h.