Installation

Current version

Choose installation

Linux packages (rpm/deb)

Linux packages in deb and rpm are distributed, and this is recommended when possible.

Pipx

Use Pipx if you know what you are doing and have at least python 3.10+ installed.

This allows you to use some but not all capabilities on Windows and MacOS as well.

On Windows, the recommendation is to use WSL2 with Linux packages

.deb

deb package

curl -fsSL https://packages.remotivelabs.com/apt-repo-signing-key.gpg \
  | sudo gpg --dearmor -o /usr/share/keyrings/remotivelabs-apt.gpg

echo "deb [signed-by=/usr/share/keyrings/remotivelabs-apt.gpg] \
  https://packages.remotivelabs.com remotivelabs-apt main" \
  | sudo tee -a /etc/apt/sources.list.d/remotivelabs.list

Install/upgrade

sudo apt update
sudo apt install remotivelabs-cli

.rpm

rpm package

tee /etc/yum.repos.d/remotivelabs.repo > /dev/null <<EOF
[remotivelabs]
name=Remotivelabs
baseurl=https://packages.remotivelabs.com/yum/remotivelabs-yum
enabled=1
gpgcheck=0
gpgkey=https://packages.remotivelabs.com/yum-repo-signing-key.gpg
EOF

sudo dnf install remotivelabs-cli

Upgrade

sudo dnf upgrade remotivelabs-cli

pipx

info

You need at least python 3.10

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

pipx

pipx installs remotivelabs-cli in a separate virtualenv.

Initial installation

pipx install remotivelabs-cli

Upgrade to latest

pipx upgrade remotivelabs-cli

---

Verify installation

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

remotive --version
remotivelabs-cli 0.x.x (python 3.12.11; linux; native)

$ 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