Skip to content

Latest commit



48 lines (34 loc) · 2.35 KB

File metadata and controls

48 lines (34 loc) · 2.35 KB REMOTE RDP Client Wrapper (remote-rdp)

remote-rdp is a command-line program that sets up a tunnel for a Microsoft Remote Desktop connection from your local machine (e.g., your PC, Mac, etc.) to a device connected to the REMOTE, and then launches the Microsoft Remote Desktop client to open a RDP session.

Note that in contrast to WebTunnelAgent, which typically runs on an embedded or IoT device, remote-rdp, like remote-client and WebTunnelSSH, runs on a PC or Mac that you want to connect to the device. You'll have to build the REMOTE SDK for your machine to get the remote-rdp program.

Running remote-rdp

remote-rdp usually does not need a configuration file, most parameters can be passed via command-line arguments. Some settings can be set using a configuration file (see the remote-client documentation for more information on configuration files).

At startup, remote-rdp will look for a configuration file named or in the current user's home directory, and read it if it's present.

To run remote-rdp, you'll need to specify the URL of the remote device to connect to (e.g.


remote-rdp will prompt for your REMOTE username and password and then launch the Remote Desktop client with correct parameters for host and port number.

The REMOTE username and password can also be supplied via environment variables REMOTE_USERNAME and REMOTE_PASSWORD, or via a configuration file.

The following RDP clients are used:

Like remote-client, remote-rdp can also connect through a proxy server.

Command-Line Arguments Help

You can run remote-rdp without command-line options (or with --help or /help on Windows) to see a help screen with available command-line options.