genestack-user-setup¶
genestack-user-setup
is installed with the Python Client Library and can be accessed from a terminal by typing genestack-user-setup
.
Usage¶
This script can be used both in interactive shell mode and in static command-line mode:
usage: __main__.py [-H <host>] [-u <user>] [-p <password>] [--token <api-token>] [--debug] [--show-logs] [-h] [-v] [<command>] Genestack user management application. positional arguments: <command> "init", "list", "add", "default", "change- password", "change-token", "path", "remove", "rename" or empty to use shell optional arguments: -h, --help show this help message and exit -v, --version show version connection: -H <host>, --host <host> server host -u <user>, --user <user> user alias from settings or email -p <password>, --password <password> user password --token <api-token> API token 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:
$ genestack-user-setup 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.
genestack-user-setup
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¶
add:
usage: __main__.py add [-h] Add new user. optional arguments: -h, --help show this help message and exit
change-password:
usage: __main__.py change-password [-h] [<alias>] Change password for user. command arguments: <alias> Alias for user to change password optional arguments: -h, --help show this help message and exit
change-token:
usage: __main__.py change-token [-h] [<alias>] Change token for user. command arguments: <alias> Alias for user to change token for optional arguments: -h, --help show this help message and exit
default:
usage: __main__.py default [-h] [<alias>] Set default user. command arguments: <alias> Alias for user to change password optional arguments: -h, --help show this help message and exit
init:
usage: __main__.py [-h] [-H <host>] Create default settings. command arguments: -H <host>, --host <host> Genestack host address optional arguments: -h, --help show this help message and exit
list:
usage: __main__.py list [-h] List all users. optional arguments: -h, --help show this help message and exit
path:
usage: __main__.py path [-h] Show path to configuration file. optional arguments: -h, --help show this help message and exit
remove:
usage: __main__.py remove [-h] [<alias>] Remove user. command arguments: <alias> Alias for user to change password optional arguments: -h, --help show this help message and exit
rename:
usage: __main__.py rename [-h] [<alias>] [<new_alias>] Rename user. command arguments: <alias> Alias to be renamed <new_alias> New alias optional arguments: -h, --help show this help message and exit