Skip to content

PCoIP Client Parameters

The following table outlines command line parameters that are available to use and customize:

Short Long                                          Default Description
-? --help Display help message. Set to false by default.
-v --version Print version information. Set to false by default.
-u --username Username sent to Connection Broker.
-p --password Password sent to Connection Broker.
-d --domain Domain sent to Connection Broker.
-b --connection-broker Connection broker URL.
-l --log-level Unset force log level (will override config/registry)
-w --windowed False run inside a window.
-f --fullscreen False run in full-screen mode. The default is to run in windowed mode.
-s --security-mode Security mode.
- --locale Set locale.
- --disable-usb Disable USB.
-h --hard-host Hard host URL. This option is ignored if connection-broker is provided
--quit-after-disconnect Do no re-enter the pre-session after leaving the in-session.
--usb-auto-forward Auto-forward all non-HID devices.
--vidpid-auto-forward String of VID, PID hex values separated by spaces.
--remap-cmd-to-ctrl Enables the macOS CMD key to map to the Windows Super key on the host. This parameter has some limitations, if the CMD+"randomkey" is a hotkey for the local OS then the PCoIP Client will capture the CMD key and map that to Super (or Windows key) but the macOS Client will suppress the "randomkey" key from the application.
--vidpid-black-list Blocks specific VID,PIDs from autoforward regardless of whether the usb-auto-forward parameter or the USB dialog is used.
--disable-menubar Disables the PCoIP Client menubar. Prevents the user from accessing menu functionality.
--disable-hotkeys Disables session hot keys.
--full-screen Activates full-screen mode from windowed mode in a PCoIP Session.
--set-host-resolution Locks the resolution of your host application displays.
--enable-scaling Enables scaling on the PCoIP Client without having to specify the desktop resolution.
--maintain-aspect-ratio Maintains the aspect ratio between the host and client.
--force-native-resolution Sets the resolution of the client monitor to the native resolution when the session client's launched .
--desktop Enables users to select which desktop they which to use.

For example, running the --help command will have the following format:

$ /Applications/ --help

For additional information on customizable in-session options, see Customizable Session Features.

Launching PCoIP Software Client with a URI

Compatible with Safari Web Browser Only

Currently, it is only possible to launch the PCoIP Software Client with a URI using the Safari web browser.

It is possible to launch the PCoIP Software Client with a URI. The Teradici URI uses JSON Web Tokens (JWT). For more information on the use of JWT, see here. The URI is defined as the following:


When additional parameters are passed through the encoded JWT a session can be launched:

Field Description Optional vs Required
pcoip:// Scheme registered to operating system so that PCoIP Client can be launched Required
broker Broker through which a pcoip session is supposed to be brokered through Optional
/connect Connecting to a PCoIP Client with the parameters defined in "?data" Required
?data Query parameter to store a jwt encoded user credentials Optional

The table below details supported optional JWT payload claims:

Claim Description
usr Username
dom Domain
vm Virtual machine/resource name

Below is an example of a JWT payload:

    "usr": "username",
    "dom": "",
    "vm": "mydesktopname"
The following is an example of a connect command: