odm-shell

odm-shell is installed with the Python Client Library and can be accessed from a terminal by typing odm-shell.

Usage

This script can be used both in interactive shell mode and in static command-line mode:

usage: odm-shell [-H <host>] [-u <user>] [-p <password>]
                    [--token <api-token>] [--access-token <access-token>]
                    [--debug] [--show-logs] [-h] [-v]
                    [<command>]

Shell and commandline application

positional arguments:
  <command>                   "time", "call", "groups" or empty to use shell

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

connection:
  -H, --host <host>           server host
  -u, --user <user>           user alias from settings or email
  -p, --password <password>   user password
  --token <api-token>         API token to be used instead of the login and
                              password
  --access-token <access-token>
                              Access token or environment variable with its
                              value to be used instead of the login and password
  --debug                     include server stacktrace into error messages
                              (implies --show-logs)
  --show-logs                 print application logs received from server to
                              stdout

You can get a description for every command by typing:

$ odm-shell command -h

In shell mode, type help to get a list of available commands. Use help command to get help for a specific command.

See Connecting to a Genestack instance for more information about connection arguments.

odm-shell exits with 0 return code in case of success, 1 in case of various nondescript errors, and 13 if server requires newer Python Client version.

Commands

• call:

  usage: odm-shell call [-h] [-H <host>] [-u <user>] [-p <password>]
                           [--token <api-token>] [--access-token <access-token>]
                           [--debug] [--show-logs]
                           applicationId method ...
  
  call another application's method
  
  command arguments:
    applicationId               full application id
    method                      application method
    params                      params
  
  options:
    -h, --help                  show this help message and exit
  
  connection:
    -H, --host <host>           server host
    -u, --user <user>           user alias from settings or email
    -p, --password <password>   user password
    --token <api-token>         API token to be used instead of the login and
                                password
    --access-token <access-token>
                                Access token or environment variable with its
                                value to be used instead of the login and password
    --debug                     include server stacktrace into error messages
                                (implies --show-logs)
    --show-logs                 print application logs received from server to
                                stdout
  

• groups:

  usage: odm-shell groups [-h] [-H <host>] [-u <user>] [-p <password>]
                             [--token <api-token>] [--access-token <access-token>]
                             [--debug] [--show-logs]
  
  print information about user groups
  
  options:
    -h, --help                  show this help message and exit
  
  connection:
    -H, --host <host>           server host
    -u, --user <user>           user alias from settings or email
    -p, --password <password>   user password
    --token <api-token>         API token to be used instead of the login and
                                password
    --access-token <access-token>
                                Access token or environment variable with its
                                value to be used instead of the login and password
    --debug                     include server stacktrace into error messages
                                (implies --show-logs)
    --show-logs                 print application logs received from server to
                                stdout
  

• time:

  usage: odm-shell time [-h] [-H <host>] [-u <user>] [-p <password>]
                           [--token <api-token>] [--access-token <access-token>]
                           [--debug] [--show-logs]
                           applicationId method ...
  
  invoke with timer
  
  command arguments:
    applicationId               full application id
    method                      application method
    params                      params
  
  options:
    -h, --help                  show this help message and exit
  
  connection:
    -H, --host <host>           server host
    -u, --user <user>           user alias from settings or email
    -p, --password <password>   user password
    --token <api-token>         API token to be used instead of the login and
                                password
    --access-token <access-token>
                                Access token or environment variable with its
                                value to be used instead of the login and password
    --debug                     include server stacktrace into error messages
                                (implies --show-logs)
    --show-logs                 print application logs received from server to
                                stdout