Skip to main content

Installation

Current version

PyPI - Version

Choose installation

Pipx

Works on Linux, Windows, MacOS but requires a python 3.10+ installation to work.

Linux packages (rpm/deb)

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

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