-
Notifications
You must be signed in to change notification settings - Fork 4
Home
Michał Rutka edited this page May 2, 2021
·
2 revisions
With Python3
pip3 install -U openremote-cli
With Docker
docker run --rm -ti openremote/openremote-cli
When you run it without parameters there is a short explanation of usage.
> openremote-cli
usage: openremote-cli [-h] [-V] [-n] [-v] [-t] [-q] [--config-file CONFIG_FILE] {configure_aws,deploy,d,manager,m,sso,map,prerequisites,p} ...
OpenRemote Command Line Interface (CLI) version 0.6.41
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-n, --dry-run showing effects without actual run and exit (default: False)
-v, --verbose increase output verbosity (default: 0)
-t, --no-telemetry Don't send usage data to server (default: False)
-q, --quiet suppress info (default: False)
--config-file CONFIG_FILE
config.ini file location in home directory (default: ~/.openremote/config.ini)
command:
{configure_aws,deploy,d,manager,m,sso,map,prerequisites,p}
configure_aws configure AWS credentials
deploy (d) Deploy OpenRemote stack. By default create on localhost.
manager (m, sso) manage online manager
map map storage/retrieve service
prerequisites (p) Check if all required tools are installed
Further explanation of the specific command, e.g. deploy
> or deploy -h
usage: or deploy [-h] [-V] [-n] [-v] [-t] [-q] [--config-file CONFIG_FILE] [-a [{create,remove,clean,health}]] [-p PASSWORD] [--provider [{aws,localhost,rich}]]
[-d DNSNAME] [--with-email]
Deploy OpenRemote stack. By default create on localhost.
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-n, --dry-run showing effects without actual run and exit (default: False)
-v, --verbose increase output verbosity (default: 0)
-t, --no-telemetry Don't send usage data to server (default: False)
-q, --quiet suppress info (default: False)
--config-file CONFIG_FILE
config.ini file location in home directory (default: ~/.openremote/config.ini)
deploy arguments:
-a [{create,remove,clean,health}], --action [{create,remove,clean,health}]
create/remove/clean OpenRemote stack (default: create)
-p PASSWORD, --password PASSWORD
password for admin user (default: secret)
--provider [{aws,localhost,rich}]
where the stack should be deployed (rich is on localhost but with artifacts from S3) (default: localhost)
-d DNSNAME, --dnsname DNSNAME
host and domain name (default: localhost)
--with-email generate valid SMTP server access keys (default: False)