openremote/openremote-cli

OpenRemote CLI Docker镜像

镜像概述和主要用途

该Docker镜像包含OpenRemote CLI工具，是OpenRemote IoT平台的命令行界面。其主要用途是降低DIY用户使用OpenRemote的门槛，提供便捷的堆栈部署、管理及配置功能，支持本地环境和AWS云平台部署。

核心功能和特性

• 支持本地部署OpenRemote堆栈，快速搭建IoT平台环境
• 提供AWS云平台部署能力，可配置DNS域名
• 支持堆栈移除操作，方便环境清理
• 可配置现有OpenRemote实例（添加用户、资产、自定义等）
• 基于Python开发，开源项目，可通过PyPi获取

使用场景和适用范围

适用于需要快速部署、测试或管理OpenRemote IoT平台的DIY用户和开发者。无论是本地开发测试环境搭建，还是AWS云平台的生产环境部署，均能提供便捷的命令行操作支持。

详细使用方法和配置说明

Docker CLI基本用法

查看版本

bash
docker run --rm -ti docker.xuanyuan.run/openremote/openremote-cli -V

本地部署

bash
docker run --rm -ti docker.xuanyuan.run/openremote/openremote-cli deploy

AWS部署（带DNS配置）

bash
docker run --rm -ti -v ~/.aws:/root/.aws docker.xuanyuan.run/openremote/openremote-cli deploy --provider aws -v --dnsname test.mvp.openremote.io

部署本地OpenRemote堆栈

执行本地部署命令后，等待服务启动（通常不超过10分钟）。可通过访问https://localhost进入管理界面，默认登录凭据为admin:secret。若服务未正常启动，可使用docker ps命令检查所有服务是否处于"healthy"或"starting"状态。

移除本地OpenRemote堆栈

bash
or deploy --action remove

AWS部署带DNS配置

部署时需挂载AWS配置目录（~/.aws），指定DNS域名：

bash
or deploy --platform aws --dnsname myiot.mydomain.com

配置现有OpenRemote实例

• 添加用户：通过CLI命令管理平台用户
• 添加资产：配置IoT设备及相关资产
• 添加自定义：自定义平台界面及功能

开发openremote-cli

使用工具

• Python相关：pip、poetry、black、PyPI.org
• 版本控制：git（pre-commit、actions）
• 容器技术：docker（docker-compose、swarm）
• 云服务：AWS（CloudFormation）
• 构建工具：make

功能开发

项目采用行为驱动开发（BDD），使用Gherkin定义功能需求。功能文件示例：

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

功能实现后可通过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