Installation

info

RemotiveCLI is a new tool within the RemotiveLabs Platform. Breaking changes between versions might occur. Please report installation issues, bugs, and send feature wishes to support@remotivelabs.com

RemotiveCLI is designed for maximum flexibility and isolation. It's strongly recommended to install with Pipx, which creates an isolated environment for each tool and keeps your global Python installation clean. Alternatively, you can run the CLI via Docker, bundling all dependencies in a container without polluting your system. While you can install with pip, please only do so inside a dedicated virtualenv to avoid version conflicts and ensure reproducible environments.

Latest version

Pipx

info

You need at least python 3.9

Pipx installation guide: https://pipx.pypa.io/stable/installation/

pipx

pipx installs remotivelabs-cli in a separate virtualenv which is recommended.

Initial installation

pipx install remotivelabs-cli

Upgrade to latest

pipx upgrade remotivelabs-cli

Docker

This runs the default command remotive --help

docker run -it remotivelabs/remotivelabs-cli

To run a command you can run it like this:

docker run -it remotivelabs/remotivelabs-cli remotive --help

To use the docker version to work as the normal remotive command so you can follow examples etc you can setup an alias like this:

Linux

alias remotive="docker run -it \
  -u $(id -u ${USER}):$(id -g ${USER}) \
  -e HOME=/data  \
  -v $HOME/.config/remotive:/data/.config/remotive \
  remotivelabs/remotivelabs-cli remotive"

MacOS

alias remotive="docker run -it \
  -e HOME=/data  \
  -v $HOME/.config/remotive:/data/.config/remotive \
  remotivelabs/remotivelabs-cli remotive"

In the examples, users remotive config home directory and uses this so any files there is accessible and editable from the container. If you are only running from docker you can mount any path if you don't want to mount in from your home directory - directories and files are automatically created if not exists.

You should now be able to use remotive --help

---

Verify installation

Regardless of the installation choice you made, you should be able to run this command and get this output.

remotive --version
remotivelabs-cli 0.1.x

$ remotive --help

Usage: remotive [OPTIONS] COMMAND [ARGS]...

 Welcome to RemotiveLabs CLI - Simplify and automate tasks for cloud resources and brokers
 For documentation - https://docs.remotivelabs.com

╭─ Options ──────────────────────────────────────────────────────────────────────────────────╮
│ --version                     Print current version                                        │
│ --install-completion          Install completion for the current shell.                    │
│ --show-completion             Show completion for the current shell, to copy it or         │
│                               customize the installation.                                  │
│ --help                        Show this message and exit.                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────╮
│ tui       Explore remotive-cli and generate commands with this textual user interface      │
│           application                                                                      │
│ broker    Manage a single broker - local or cloud                                          │
│ cloud     Manage resources in RemotiveCloud                                                │
│ connect   Integrations with other systems                                                  │
│ tools     CLI tools unrelated to cloud or broker                                           │
╰────────────────────────────────────────────────────────────────────────────────────────────╯

Proxy support

If you are behind a corporate proxy you need to set the following environment variables, note that both are required.

export HTTPS_PROXY=http://proxy:port
export https_proxy=http://proxy:port

Certificates

If you need to change CA certs used you should use the following environment variables.

export REQUESTS_CA_BUNDLE=/path/to/cacerts
export GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=/path/to/cacerts