Skip to main content

Cloud setup

This part covers how to use the command line interface to operate with cloud resources at https://cloud.remotivelabs.com or running RemotiveTopology.

info

In order to login with RemotiveCLI you must sign up for RemotiveCloud and accept terms, make sure to do that first at https://cloud.remotivelabs.com

Login​

When signing in, a web-browser is opened to let you sign-in with your credentials. Once you have signed in with the browser you are good to go. If you are in an environment where no browser is available such as virtual machine or docker you can use headless support - However, you still need access to a browser just not on the target machine.

After login, your credentials are valid for a year so there is no need to login again once this is done. You can login with more than one account (email) and have multiple credentials that you can switch between.

$ remotive cloud auth login

Follow the authentication flow until your browser says that you have been successfully logged on and then you should see the same output in the terminal.

Successfully logged on

Existing accounts​

If you try to login and you already have existing accounts you are always prompted to use one of these first instead first. Enter or 'Y' (default) allows you to activate (see below) existing credentials and 'n' allows you to login again.

You have credentials available already, would you like to choose one of these instead? [Y/n]:

Switch between existing accounts​

You can also activate existing accounts simply using the command below and you get the same prompt.

remotive cloud auth activate

┏━━━┳━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ # ┃ Active ┃ Type ┃ Token            ┃ Account              ┃ Created    ┃ Expires    ┃
┡━━━╇━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ 1 │  x     │ user │ A75A71ED20AACC48 │ user@domain.com      │ 2025-06-16 │ 2026-06-16 │
│ 1 │        │ user │ BC5A719D20DA1C41 │ user2@domain.com     │ 2025-06-16 │ 2026-06-16 │
└───┴────────┴──────┴──────────────────┴──────────────────────┴────────────┴────────────┘

Enter the number(# 1-2) of the account to select (q to quit) [1]:

Verify credentials​

  1. Verify that you are who you think you are
$ remotive cloud auth whoami
{
  "firstName": "John",
  "lastName": "Dev",
  "email": "john.dev@remotivelabs.com",
  "picture": "https://lh3.googleusercontent.com/a/asdf=s96-c",
  "uid": "xxx"
}

Set default organization​

Some commands and features requires an organization to work, then you must also set a default organization.

remotive cloud organisations default

This shows you the organizations you have available.

┏━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┓
┃ # ┃ Name          ┃ Uid                  ┃ Default ┃
┡━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━┩
│ 1 │ My org        │ my-org               │         │
│ 2 │ Another org   │ mzfazxo2ypxxd9cbfig  │         │
└───┴───────────────┴──────────────────────┴─────────┘

Enter the number(# 1-2) of the organisation to select (or q to quit):

It's also possible to set this using an environment variable

export REMOTIVE_CLOUD_ORGANISATION=my-org

Set default project​

When working with cloud resources, most things are connected to a project. Commands have --project options but can be overridden by setting default project.

List projects to get project UIDs

$ remotive cloud projects list --organisation my-organisation
["my-personal-project", "customer-project"]
export `REMOTIVE_CLOUD_PROJECT=my-project`

Usage with cloud​

The RemotiveCloud section of the documentation covers how to work with Cloud console and CLI - for each feature!

Help​

All CLI groups and commands support --help option so you can always ask for more help.

Example

remotive cloud recordings list --help
 Usage: remotive cloud recordings list [OPTIONS] [TYPE]

 Lists recordings in project

╭─ Arguments ──────────────────────────────────────────────────────────────╮
│   type      [TYPE]  all, processing, recent [default: all]               │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────╮
│ *  --project        TEXT  Project ID                                     │
│                           [env var: REMOTIVE_CLOUD_PROJECT]              │
│                           [default: None]                                │
│                           [required]                                     │
│    --help                 Show this message and exit.                    │
╰──────────────────────────────────────────────────────────────────────────╯