remoteit Command Line Interface Installation and Setup - basic


The remoteit Command Line Interface (CLI) is installed as part of the Desktop Application as well as the remoteit 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.

Install remoteit

For Windows, Mac and desktop Linux (e.g. Debian/Ubuntu), you should install the remoteit Desktop Application.

For Raspberry Pi, install the remoteit package.


Log in


sudo remoteit signin 

This will ask you for your username and password.


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


Register your Device to your account
sudo remoteit register --name <name of your device>
Add one or more Services to your Device

 If the Service is connecting to an application on the local machine

sudo remoteit add --name <service name> --port <service port> --type <connection type> 

 If the Service is connecting to an application on another device on the LAN

sudo remoteit add --name <service name> --port <service port> --type <connection type>  --hostname <hostname>

where <hostname> is either the IP address or mdns address (e.g. raspberrypi.local) of the device you wish to connect to. 

To show the list of acceptable values for <connection type>


sudo remoteit supportedApplications
pi@raspberrypi:~ $ sudo remoteit supportedApplications
ID | Name | Default Port | Protocol | Description
1 | TCP | 0 | TCP | Generic TCP
4 | VNC | 5900 | TCP | VNC remote desktop
5 | RDP | 3389 | TCP | Microsoft remote desktop
7 | HTTP | 80 | TCP | Web protocol
8 | HTTPS | 443 | TCP | Secure web protocol
28 | SSH | 22 | TCP | Secure shell terminal
34 | SMB/CIFS | 445 | TCP | Internet file sharing
37 | NxWitness | 7001 | TCP | Nx Witness VMS
38 | Nextcloud | 443 | TCP | Nextcloud hub
39 | OpenVPN | 1194 | TCP | OpenVPN server
41 | Minecraft | 25565 | TCP | Minecraft server
42 | Admin Panel | 29999 | TCP | admin panel
32769 | UDP | 0 | UDP | Generic UDP
32770 | WireGuard | 51820 | UDP | WireGuard VPN server

pi@raspberrypi:~ $


Was this article helpful?
0 out of 0 found this helpful