User Guide: OpenRemote CLI

The openremote-cli (or or for short) is a command line tool that can be used for deploying the OpenRemote stack, note that this tool is still in beta.

Prerequisites:

• python
• wget (available as part of git BASH etc. on windows)
• docker
• docker-compose

Install

pip3 install -U openremote-cli
openremote-cli -V

There is also docker image provided:

docker run --rm -ti openremote/openremote-cli <command>

Note that the image ENTRYPOINT is set to the openremote-cli command (the same way as amazon/aws-cli docker image) therefore docker run --rm -ti openremote/openremote-cli -V is equivalent to openremote-cli -V.

Deploy on localhost

or deploy --action create

using docker

docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock openremote/openremote-cli deploy

Deploy on AWS

Prerequisites:

• aws-cli
• openremote-cli AWS profile. If you have Id and AWS secret key, you can use following command:

or configure_aws --id <id> --secret <secret> -v

At the moment the default region must be set to eu-west-1 (Ireland), this is done by the openremote-cli. This can be changed using aws-cli (not recommended):

aws configure --profile=openremote-cli

Deploy the stack:

or deploy --provider aws --dnsname test.mvp.openremote.io -v

Remove the stack and clean resources:

or deploy -a remove --provider aws --dnsname test.mvp.openremote.io -v