CLI Usage

The remote.it 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. Examples provided here are Linux (including Mac) based, Windows users will need to replacesudo remoteitwith remoteit.exe
On Windows, you will need to open a "Command Prompt" as an Administrator
On Mac and Linux, you must run any commands related to creating/managing a Device or Services as a root user (e.g.sudo)
Help
 List the available commands.
1
sudo remoteit help
Copied!
Account
Sign In
Without the user and pass options it will prompt for the username and password.
1
sudo remoteit signin --user <remote.it username> --pass <password>
Copied!
Sign Out
1
sudo remoteit signout
Copied!
Device and Service
Register
Registers this device to your account. Once registered you can no longer register this device. If you need to re-register, unregister first then register. If you just need to move the device to another account, use transfer.
1
sudo remoteit register --name <name of your device>
Copied!
List supported application types
This is referenced in adding a new service or modifying a service
1
sudo remoteit supportedApplications
Copied!
List services on this device
You can add an option of --j or --json to output the results in JSON
1
sudo remoteit status
Copied!
Add a new service on this device
Adds a new service to this device. This will define a remote.it Service which is running on this machine. NOTE: This does not detect if the actual service is running on this machine. The type option will accept either the ID or Name of an application type and is not case sensitive. Available service types can be found here. 
1
sudo remoteit add --name <service name> --port <service port> --type <application type> 
Copied!
You can also add a service which connects to an application on another device on the same LAN. The host name can be either an IPv4 IP address or mDNS address (i.e. raspberrypi.local) of the device which is running the application.
1
sudo remoteit add --name <service name> --port <service port> --type <application type> --hostname <hostname>
Copied!
Remove a service
Removes a service from this device. This will cause a disconnect for all other users who had an active connection to this service. If you are concerned about the disconnect, you can use the graphQL API to fetch active connection to this service and then notify users accordingly.
1
sudo remoteit remove --id <service id>
Copied!
Modify a service
Modifies a service on this device. This will cause a disconnect for all other users who had an active connection to this service. If you are concerned about the disconnect, you can use the graphQL API to fetch active connection to this service and then notify users accordingly. 
The enabled option disables the service without deleting it. The hostname option will modify a service which connects to an application on another device on the same LAN. The host name can be either an IPv4 IP address or mDNS address (i.e. raspberrypi.local) of the device which is running the application. The type option will accept either the ID or Name of an application type and is not case sensitive. Available service types can be found here.
1
sudo remoteit modify --id <service id> --enable <boolean> --port <port> --hostname <hostname> --type <application type> 
Copied!
Unregister
Unregister this device from your account and removes the services. This will also remove access to this device for any users to which you have shared this device. This will cause a disconnect for all other users who had an active connection to this service as well. If you are concerned about the disconnect, you can use the graphQL API to fetch active connection to this service and then notify users accordingly. Once unregistered, this device can be registered again. 
1
sudo remoteit unregister --yes
Copied!
Transfer
Transfer this device and defined services to another account. This will remove your access to this device along with any users to which you had previously shared this device. This will cause a disconnect for all other users who had an active connection to this service. If you are concerned about the disconnect, you can use the graphQL API to fetch active connection to this service and then notify users accordingly. If the account doesn't exist, the transfer will fail. If this is the case, you can sign-in to the web portal and create the contact and then transfer the device from the devices list.
Verify the email address used for the transfer is correct. This device will transfer to the email address provided.
1
sudo remoteit transfer --to <email address>
Copied!
​

Access Keys

Next - Developer Tools

Webhooks

Last modified 2mo ago

Copy link

Contents

List supported application types

List services on this device

Add a new service on this device