Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openremote/openremote-cli

Command line tool for managing OpenRemote v3 stack.
https://github.com/openremote/openremote-cli

cli iot openremote

Last synced: 2 days ago
JSON representation

Command line tool for managing OpenRemote v3 stack.

Host: GitHub
URL: https://github.com/openremote/openremote-cli
Owner: openremote
License: other
Created: 2021-02-05T17:48:40.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-04-20T12:03:34.000Z (7 months ago)
Last Synced: 2024-05-01T11:38:56.445Z (6 months ago)
Topics: cli, iot, openremote
Language: Python
Homepage: https://github.com/openremote/openremote
Size: 559 KB
Stars: 1
Watchers: 9
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

![CI/CD](https://github.com/openremote/openremote-cli/workflows/CI/CD/badge.svg)
![docker](https://github.com/openremote/openremote-cli/workflows/docker/badge.svg)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/)
[![Donate](https://img.shields.io/badge/donations-appreciated-green.svg)](https://www.paypal.com/webapps/shoppingcart?flowlogging_id=4b5432e8ad1a8&mfid=1616517920020_4b5432e8ad1a8#/checkout/openButton)

# 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](https://pypi.org/project/openremote-cli/)

## About OR

OpenRemote is a great real OpenSource IoT platform.

## Usage

To install/upgrade the CLI:
```bash
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

```bash
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

```bash
or deploy --action remove
```

### Deploy OpenRemote stack on AWS with DNS entry

```bash
or deploy --platform aws --dnsname myiot.mydomain.com
```
### Check health of the openremote stack
```bash
or deploy -a health --dnsname myiot.mydomain.com -v
```

### Install shell completion extension

#### zsh

```bash
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:

```gherkin
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:

```bash
> 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
```