The commands below are documented specifically for Linux/Mac. If you're running on Windows, the commands are the same, but you will just need to:
- Open a "Command Prompt" as Administrator.
- Substitute "remoteit.exe" for "remoteit"
sudofrom the front of the commands
Most commands need to be run as a "root" (or admin) user.
sudo remoteit help
Windows (in Administrator Command Prompt)
To learn more about a command, run
sudo remoteit help add
sudo remoteit add -h
sudo remoteit signout
Note that you do not need to be signed into remote.it after you initially setup your Device, so it is safe to signout. You will need to sign back in if you need to add/remove Services or perform other actions that require signin.
Learn about remote.it CLI configuration
To learn exactly where remote.it is putting its configuration, binaries, logs and other general system information, you can run the
info command to get a detailed output of this information:
sudo remoteit info
Manage remote.it system service
Setting up a remote.it Device configures a system Service that runs our software on boot (or login if running as a non-root user). This Service can be managed using the
sudo remoteit agent help
sudo remoteit agent status
sudo remoteit agent stop
sudo remoteit agent start
sudo remoteit agent restart
sudo remoteit agent uninstall
sudo remoteit scan
# Output results in JSON
sudo remoteit scan --json # or just -j
remote.it requires some other tools to be installed, including our tools
demuxer. These get installed automatically for you when you signin or setup a new Device. However, there may be cases where you want to manage them yourself.
# See all options
sudo remoteit tools
# Install tools if missing
sudo remoteit tools install
# Update all tools
sudo remoteit tools install --update # or just -u
Unless you have a good reason to do this, you probably should not use this command flag.
If for some reason you need to use a different path for configuration the defaults, you can pass a
-c flag when running a command to use a different path.
sudo remoteit signin --config path/to/my/config.json
Note that you will have to pass in this path for every command in which you want to use this config file otherwise commands default to using the default config location. You can define the environment variable
REMOTEIT_CONFIG_PATH="..." to set the default config path to use for all commands.
--json / -j- to output any command in JSON format
--verbose / -v- to output more insight, helpful when you come across issues
If you need to remove your remote.it Device, you can run
This will remove everything from you system related to remote.it including all your configuration. Note that this does not remove your Device or Services from remote.it directly, but you can do this in the web portal.
Be careful with this command as it is permanent.
If you uninstall remote.it, you will have to re-configure your Device if you want to add remote.it back to your system.
This uninstalls everything but the
remoteit CLI binary.