OpenRemote CLI
Intro
This is Command Line Interface to OpenRemote IoT platform. It's purpose is to reduce friction of using OpenRemote by Do It Yourself users.
It is published as a Python package on PyPi.org
About OR
OpenRemote is a great real OpenSource IoT platform.
Usage
To install/upgrade the CLI:
pip install --upgrade openremote-cli
or --version
Docker image
There is also docker image with embedded openremote-cli and other tools used during
stack management, like python, aws or docker-compose. Therefore, docker is
the only tool installed when you need to work on remote host. Example:
% docker run -ti --rm openremote/openremote-cli -V
openremote-cli/0.6.46 3.8.10 (default, May 12 2021, 15:56:47) [GCC 8.3.0] Linux/#1 SMP Tue Mar 23 09:27:39 UTC 202
% docker run -ti --rm --entrypoint bash -v ~/.aws:/root/.aws openremote/openremote-cli
root@4438b25d0834:/# aws --version
aws-cli/2.1.39 Python/3.8.8 Linux/5.10.25-linuxkit exe/x86_64.debian.10 prompt/off
Deploy local OpenRemote stack
or deploy
When it finishes you should be able to open https://localhost and login with admin:secret to the manager. Depending on your machine it can take few minutes to
start or services (usually less than 10 minutes). If it does not work yet, check it with docker ps to see if all services are in healthy or starting stage.
Remove local OpenRemote stack
or deploy --action remove
Deploy OpenRemote stack on AWS with DNS entry
or deploy --platform aws --dnsname myiot.mydomain.com
Check health of the openremote stack
or deploy -a health --dnsname myiot.mydomain.com -v
Install shell completion extension
zsh
TODO
bash
TODO
Configure existing OpenRemote instance
Add users
Add assets
Add customization
Develop openremote-cli
Following tools are used:
- python (pip, poetry, black, PyPI.org)
- git (pre-commit, actions)
- docker (docker-compose, swarm)
- AWS (CloudFormation)
- make
poetry run openremote-cli -V
Adding feature
In this project we use Behavior-driven development (or BDD). BDD is an agile software development technique that encourages collaboration between developers, QA and non-technical or business participants in a software project.
This project uses Gherkin to define what features which should be covered. Features files can be generated by people on manager level or even higher. An example of file defining a feature:
Feature: deploy
Scenario: deploy to localhost
Given we have docker and docker-compose installed
When we call openremote-cli --dry-run deploy --action create
Then show what will be done
When the feature is implemented it can be checked with behave:
> behave
Feature: deploy # features/deploy.feature:1
Scenario: deploy to localhost # features/deploy.feature:3
Given we have docker and docker-compose installed # features/steps/deploy_steps.py:8 0.453s
When we call openremote-cli --dry-run deploy --action create # features/steps/deploy_steps.py:16 0.591s
Then show what will be done # features/steps/deploy_steps.py:24 0.000s
1 feature passed, 0 failed, 0 skipped
1 scenario passed, 0 failed, 0 skipped
3 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m1.044s
1 maintainer
Metadata
1 maintainer
Release files for openremote-cli 0.6.65
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openremote_cli-0.6.65.tar.gz | 63.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openremote_cli-0.6.65-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 127.7 kB
Release files / openremote_cli-0.6.65.tar.gz
| Download URL | openremote_cli-0.6.65.tar.gz |
|---|---|
| Size | 63.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
611fe96ea2507945d2ff1e540f2e7f0a886044788e06be99bb2345a18a578a42
|
|
BLAKE2b-256 checksum How to use checksums |
4342bd3fe445b116467ae7212f596c67989e7415bf1265754d6dbc9a941a17af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.9.19 Linux/6.5.0-1018-azure
|
Release files / openremote_cli-0.6.65-py3-none-any.whl
| Download URL | openremote_cli-0.6.65-py3-none-any.whl |
|---|---|
| Size | 64.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e4ac5587d4ae8727f5b4a33b4ae1faa346df060494cb92585f4e30ca640ce9f5
|
|
BLAKE2b-256 checksum How to use checksums |
699421dddb77569f3277944ec298550fb2494eea916b7c7258f2fac40e67dda9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.9.19 Linux/6.5.0-1018-azure
|
