<< Back to the Development Kit User Manual
Usage:
Available commands
help
Display help for commands
status
Display status of the computer
license
Display user license
login
Login computer to account
show-local
Show local computer
show-remote
Show all remote computers
show-remote-online
Show only online remote computers
show-remote-offline
Show only offline remote computers
set-comp-name
Set name of computer
logout
Logout computer from account
connect-device
Connect remote device
disconnect-device
Disconnect device
default-connect-parameters
Show or set default connection parameters
set-device-description
Set description for local device
clear-device-description
Clear description for local device
lock-device
Lock local device
unlock-device
Unlock local device
set-comport-name
Set name for remote COM port
clear-comport-name
Clear name for remote COM port
get-proxy-settings
Get current proxy settings
set-proxy-settings
Set new proxy settings
change-existing-connection-params
Change existing connection parameters
forget-connection
Forget connection
ID_DEVICE argument in commands
All commands which execute actions on devices require ID of device (argument ID_DEVICE).
The utility requires ID_DEVICE to include ID of the computer where it is attached,
and therefore ID_DEVICE should have form of {ID_COMP}-{IDx}.
Here:
ID_COMP is ID of the computer,
IDx is the real ID of device or ID hash.
To find ID_DEVICE, run command show-local or show-remote
and then use a value from the leftmost column of the output.
E.g. for command show-local you may get:
Here:
41 – ID of local computer with name: my-computer
41-59 – is ID_DEVICE for USB-PS/2 Optical Mouse, this ID can be used
in other commands.
E.g. to unlock this device, run command:
Commands
help
Display help for commands.
Usage:
If no COMMAND is given then display list of available commands.
Otherwise display help for specific command.
One of the following options can be used instead of command name:
--all
help for all commands.
--id-device
help for ID_DEVICE parameter of some commands.
status
Display status of the computer.
Usage:
Show status of the computer:
whether it is logged to central server or requires login,
whether drivers are ok, or whether pipe errors occurred.
Alias: st
license
Display user license.
Usage:
Show user license details if computer is logged to central server.
Alias: lic
login
Login computer to account.
Usage:
Execute login command with EMAIL and PASSWORD.
If ‘maximum number of computers in account’ error is received during login
and --reset-all option is supplied, it automatically tries to
reset all computers in account and to relogin.
show-local
Show local computer.
Usage:
Show info about local computer and local devices.
Options:
--no-devices
disables output of devices for local computer.
--verbose
enables verbose output for devices info.
Alias: shl
show-remote
Show all remote computers.
Usage:
Show info about remote computers in account and their devices.
Options:
--no-devices
disables output of devices for online remote computers.
--verbose
enables verbose output for devices info.
Alias: shr
show-remote-online
Show only online remote computers.
Usage:
Show info about online remote computers and their devices.
Options:
--no-devices
disables output of devices for online remote computers.
--verbose
enables verbose output for devices info.
Alias: shron
show-remote-offline
Show only offline remote computers.
Usage:
Show info about offline remote computers.
Alias: shroff
set-comp-name
Set name of computer.
Usage:
Set new name for computer with given ID.
ID_COMP value is from output of show-local or show-remote.
For local computer, ID_COMP value can be equal to ‘local’.
NAME should be in double quotes if it contains multiple words.
Alias: scn
logout
Logout computer from account.
Usage:
Logout computer (local or remote) from account.
ID_COMP value is from output of show-local or show-remote.
For local computer, ID_COMP value can be equal to ‘local’.
connect-device
Connect remote device.
Usage:
Connect device from remote computer.
ID_DEVICE value is from output of show-remote or show-remote-online.
Optional --compression value can be one of the following:
bestspeed, bestsize, no
If --compression is not specified then default value will be used
(see command default-compression).
Alias: cond
disconnect-device
Disconnect device.
Usage:
Disconnect connected device (local or remote).
To disconnect local device: ID_DEVICE value is from output of show-local.
To disconnect remote device: ID_DEVICE value is from output of show-remote
or show-remote-online.
Alias: disd
default-connect-parameters
Show or set default connection parameters.
Usage:
Show or set default compression value for connect-device command.
--compression value can be one of the following:
bestspeed, bestsize, no
Alias: dcp
set-device-description
Set description for local device.
Usage:
Set user’s description for local device with given ID.
ID_DEVICE value is from output of show-local.
DESCRIPTION should be in double quotes if it contains multiple words.
Alias: sdd
clear-device-description
Clear description for local device.
Usage:
Clear user’s description for local device with given ID.
ID_DEVICE value is from output of show-local.
Alias: cdd
lock-device
Lock local device.
Usage:
Lock local device with given ID.
ID_DEVICE value is from output of show-local.
Alias: ld
unlock-device
Unlock local device.
Usage:
Unlock local device with given ID.
ID_DEVICE value is from output of show-local.
Alias: ud
set-comport-name
Set name for remote COM port.
Usage:
Set custom name for remote COM port with given ID.
Such name will be used to create virtual COM port when remote device
is connected to local computer.
If no custom name is set, then original name of remote COM port will be used.
ID_DEVICE value is from output of show-remote or show-remote-online.
NAME is string like COMn (COM1, COM23, etc.)
Alias: spn
clear-comport-name
Clear name for remote COM port.
Usage:
Clear custom name for remote COM port with given ID.
ID_DEVICE value is from output of show-remote or show-remote-online.
Alias: cpn
get-proxy-settings
Get current proxy settings.
Usage:
Alias: gpx
set-proxy-settings
Set new proxy settings.
Usage:
Alias: spx
change-existing-connection-params
Change existing connection parameters.
Usage:
Change connection parameters for established connection.
ID_DEVICE value is from output of show-remote or show-remote-online.
--compression value can be one of the following:
bestspeed, bestsize, no
Alias: ccp
forget-connection
Forget connection.
Usage:
Forget about offline device and don’t try to reconnect to it anymore.
ID_DEVICE value is from output of show-remote or show-remote-online.
Alias: fc
<< Back to the Development Kit User Manual