Online Help > Advanced > Command-Line Interface

Configuration

Description

 

All settings configurable through the Wayk Now GUI can be modified from the command line, enabling automated configuration management from scripts.

 

The config command is built-in to the main Wayk Now executable, which is in a different location depending on your platform:

 

PLATFORM

Wayk Now EXECUTABLE LOCATION

Windows

%ProgramFiles%\Devolutions\Wayk Now\WaykNow.exe

macOS

/Applications/WaykNow.app/Contents/MacOS/WaykNow

Linux

/usr/bin/wayk-now

 

Basic command-line usage is shown when calling "WaykNow config --help".

 

Wayk Now config usage

Usage: WaykNow config [options] propertyName [propertyValue]

 

propertyName: Property name

propertyValue: Property value.

        If a value is specified, the property will be set to that value (SET).

        If no value is specified, the current value will be printed (GET). Can't be used with --unset

 

options:

        --global Use global config file rather than user config file.

        --type <TYPE> Property value type : int, bool or str are supported.

        --unset Remove the property name from the config file.

        --listen <NAMED_PIPE_NAME> Open the named pipe and read on it.

        --help Print help.

 

Wayk Now configuration files

Wayk Now stores its settings in JSON configuration files. The location of those configuration files depends on the platform:

 

PLATFORM

CONFIGURATION FILE LOCATION

Windows

%AppData%\Wayk\WaykNow.cfg (local settings)

%ProgramData%\Wayk\WaykNow.cfg (global settings)

macOS

~/Library/Application Support/Wayk/WaykNow.cfg

Linux

~/.config/Wayk/WaykNow.cfg

 

While these files can be edited manually in a text editor, the process can be error-prone. This is why we recommend the Wayk Now config command as the way to edit the configuration files. This command provides multiple advantages, including the possibility of calling it right after an automated installation using the .msi installer in a PowerShell script.

 

Here is a list of things that the Wayk Now config command can handle correctly:

 

If the configuration file and corresponding directories do not exist, both directories and the configuration file will be created.

If the configuration file already exists, it will load the existing file and modify only the relevant settings without overwriting the rest.

If the given property value to be set is not of the expected type (int, bool, str), the input will be rejected to prevent invalid values.

While the property names are case sensitive in the configuration file, the given property name is treated as case insensitive.

 

Here is a list of properties that you can modify:

 

General

 

NAME

TYPE

DESCRIPTION

FriendlyName

str

The user friendly name, used with PFP.

Language

str

The language code:

"en": English

"fr": French

"de": German

"zh-CN": Chinese Simplified

"zh-TW": Chinese Traditional

ControlMode

int

The remote control mode:

0: All remote control modes

1: Take remote control (client only)

2: Allow remote control (server only)

AutoLaunchOnUserLogon

bool

Automatically launch application on user logon

ShowMainWindowOnLaunch

bool

Show main window on application start

MinimizeToNotificationArea

bool

Minimize main window to notification area

ElevationPrompt

bool

Prompt to elevate program permissions

 

Security

 

NAME

TYPE

DESCRIPTION

AllowPersonalPassword

bool

Secure Remote Password (SRP) authentication

AllowSystemAuth

bool

Secure Remote Delegation (SRD) authentication

AllowNoPassword

bool

Prompt for Permission (PFP) authentication

PersonalPasswordType

int

The personal password type:

0: Generated

1: Custom

PersonalPassword

str

The personal password

GeneratedPasswordLength

int

The generated password length (between 3 and 9)

GeneratedPasswordCharSet

int

The generated password character set:

0: Numeric

1: Alphanumeric

 

Connectivity

 

NAME

TYPE

DESCRIPTION

DenEnabled

bool

Use Wayk Den for centralized management

DenUrl

str

The Wayk Den URL (wss://den.wayk.net)

 

Advanced

 

NAME

TYPE

DESCRIPTION

QualityMode

int

The codec quality mode:

0: Low

1: Medium

2: High

LoggingLevel

int

The logging level:

0: Trace

1: Debug

2: Info

3: Warn

4: Error

5: Fatal

6: Off

LoggingFilter

str

The logging filter. Do not use unless instructed.

 

Access Control

 

NAME

TYPE

DESCRIPTION

AccessControl.Viewing

int

The viewing access control:

1: Allow viewing

2: Confirm viewing

4: Disable viewing

AccessControl.Interact

int

The interaction access control:

1: Allow interaction

2: Confirm interaction

4: Disable interaction

AccessControl.Clipboard

int

The clipboard access control:

1: Allow clipboard

2: Confirm clipboard

4: Disable clipboard

AccessControl.FileTransfer

int

The file transfer access control:

1: Allow file transfer

2: Confirm file transfer

4: Disable file transfer

AccessControl.Exec

int

The execution access control:

1: Allow execution

2: Confirm execution

4: Disable execution

AccessControl.Chat

int

The chat access control:

1: Allow chat

2: Confirm chat

4: Disable chat