Skip to main content

OpenRemote Command-line interface

Project description

CI/CD docker Code style: black pre-commit Open Source? Yes! Donate

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

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

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

Project details


Release history Release notifications | RSS feed

This version

0.6.9

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openremote-cli-0.6.9.tar.gz (59.9 kB view details)

Uploaded Source

Built Distribution

openremote_cli-0.6.9-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

Details for the file openremote-cli-0.6.9.tar.gz.

File metadata

  • Download URL: openremote-cli-0.6.9.tar.gz
  • Upload date:
  • Size: 59.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.6.13 Linux/5.4.0-1043-azure

File hashes

Hashes for openremote-cli-0.6.9.tar.gz
Algorithm Hash digest
SHA256 6e6c2a16ab652a9e25bba61188c16b9bd8e030f11b7fbe267035cf676a752f02
MD5 ba8a084be28c0d76501ecce9062d2d34
BLAKE2b-256 8254b8107c36b839a84d90b30b4c0ff19797e8d9ac84f9eeb3819f9a175c9f35

See more details on using hashes here.

File details

Details for the file openremote_cli-0.6.9-py3-none-any.whl.

File metadata

  • Download URL: openremote_cli-0.6.9-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.6.13 Linux/5.4.0-1043-azure

File hashes

Hashes for openremote_cli-0.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 7c61a63cf0ebfbbd81721ac08a447e7182e0f10f52f320f8ada87cf127f1b220
MD5 0a488ec329d9a6c53c96f3e5e38f5866
BLAKE2b-256 bb7e7ec3936547d2cf42e18c416615e5b3f4750e3908e02bfe8b851508fca337

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page