wdx setting

Show and change the settings.

wdx help settings explains every setting.

Command	What it does
wdx setting get	Show one setting
wdx setting list	List every setting with its value
wdx setting set	Change a setting and apply it at once
wdx setting write	Write the config file anew, listing every setting of this version

wdx setting get

Show one setting.

wdx setting get --name <key> [flags]

Show one setting

Flags

Flag	Default	Description
--name <key>		key of the setting, such as log.level

• --name is required

Examples

# Show one setting
wdx setting get --name log.level

Output

The setting’s value, default, description and where the value comes from. With --json: {“setting”: {“key”: …, “value”: …, “default”: …, “description”: …, “from”: …, “choices”: …, “editable”: …}}

Errors

Code	Exit	When
usage	2	the request, command line or a setting is invalid
internal	3	an unexpected failure: database, filesystem or git

wdx setting list

List every setting with its value.

wdx setting list [flags]

List every setting with its value

Examples

# List the settings
wdx setting list

Output

Each setting’s key, value and where the value comes from. With --json: {“settings”: [{“key”: …, “value”: …, “default”: …, “description”: …, “from”: …, “choices”: …, “editable”: …}, …]}

Errors

Code	Exit	When
usage	2	the request, command line or a setting is invalid
internal	3	an unexpected failure: database, filesystem or git

wdx setting set

Change a setting and apply it at once.

wdx setting set --name <key> --value <value> [flags]

The value is checked, saved in the config file, then applied: the daemon reads the file again, and every later command reads it anyway. Terminals already running keep their shell and history limit, and a running TIDE its colors. The file is written anew, as by wdx setting write, so comments of your own are not kept.

Flags

Flag	Default	Description
--name <key>		key of the setting, such as log.level
--value <value>		the new value

• --name is required
• --value is required

Examples

# Log in more detail
wdx setting set --name log.level --value debug

# Follow the dev releases
wdx setting set --name update.channel --value dev

Output

The setting, and what the daemon did with it: applied, not_running (it reads the value when it starts) or not_applied (saved, with a warning on stderr to restart it). With --json: {“result”: …, “setting”: {…}, “reload”: …, “dropped_settings”: […]}

With --json, result is one of: updated or unchanged.

Errors

Code	Exit	When
usage	2	the request, command line or a setting is invalid
internal	3	an unexpected failure: database, filesystem or git

wdx setting write

Write the config file anew, listing every setting of this version.

wdx setting write [--to <path>] [flags]

Each setting is listed with its description: the values set are kept as written, the others are commented with their defaults. Keys no setting has are moved, commented, to the end of the file. Comments of your own are not kept. wdx update does the same with the settings of the release it installs.

Flags

Flag	Default	Description
--to <path>		write it to path instead of the config file

Examples

# Add the settings of this version to the config file
wdx setting write

# Write the result to another file, leaving the config file alone
wdx setting write --to /tmp/config.yaml

Output

The file written, the settings it lists that the file did not and the keys moved to its end. With --json: {“result”: …, “settings”: {“path”: …, “added”: […], “dropped”: […]}}

With --json, result is one of: unchanged or written.

Errors

Code	Exit	When
usage	2	the request, command line or a setting is invalid
internal	3	an unexpected failure: database, filesystem or git