remoteit CLI Installation and Setup


The remoteit Command Line Interface (CLI) is installed as part of the Desktop Application as well as packages for various Linux distributions.

You can learn more about the Desktop App here:

The Desktop App


Using the CLI is consistent across platforms but please note:

  • On Windows, you will need to open a "Command Prompt" as an Administrator and replace any example you see as sudo remoteit by remoteit.exe

  • On Mac and Linux, you will need to run any commands related to creating/managing a Device or Services as a root user (e.g. sudo) so that you can install and manage system Services to keep your Device running.

  • Note that the CLI has slightly different behavior if you are running as a root user versus a non-root user. In general, you will want to always run as a root user unless you have a specific reason not to.

Getting a new Device setup in your account using our CLI is accomplished in just a few steps:

# First, install the CLI

sudo remoteit agent install
sudo remoteit tools install

# Then signin

sudo remoteit signin --user < username> --pass <account password>

# Next, register your Device

sudo remoteit register --name <name of your device>

# Finally, add a Service (As many as needed)

sudo remoteit add --name <service name> --port <service port> --type <connection type>
Was this article helpful?
0 out of 0 found this helpful