Skip to content

Latest commit



69 lines (48 loc) · 2.9 KB

File metadata and controls

69 lines (48 loc) · 2.9 KB REMOTE VNC Client Wrapper (remote-vnc)

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

Note: REMOTE has a built-in web-based VNC viewer, so remote-vnc only needs to be used if the web-based VNC viewer does not work with a specific device or cannot be used for other reasons.

Note that in contrast to WebTunnelAgent, which typically runs on an embedded or IoT device, remote-vnc, 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-vnc program.

Running remote-vnc

remote-vnc 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-vnc 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-vnc, you'll need to specify the URL of the remote device to connect to (e.g.


remote-vnc will prompt for your REMOTE username and password and then launch the VNC client with correct parameters for host, port number and remote user name.

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

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

On macOS, remote-vnc will launch the built-in macOS Screen Sharing client. On other platforms, remote-vnc will attempt to launch an executable named vncviewer, which must be in the executable search path.

Specifying the VNC Viewer Executable to Use

The name of the VNC viewer executable can be changed by setting the vncviewer.executable configuration property, which can be done via a command-line parameter:

remote-vnc -Dvncviewer.executable=myvncviewer

Or, on Windows:

remote-vnc /define:vncviewer.executable=myvncviewer

Command-Line Arguments Help

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