modality config
Command: modality config
Displays the configuration values currently in use by Modality, or updates the fields in a target Modality configuration file. See the Modality configuration reference for details on config fields and the order in which Modality prioritizes fields between multiple configuration files.
If a Modality.toml
file is not yet present at the target path, it is created. By default, the target path is <config-dir>/Modality.toml
:
<config-dir>
on Linux:/home/$USER/.config/Modality.toml
, see the XDG base directory (opens new window) and XDG user directory (opens new window) specifications.<config-dir>
on Windows:C:\Users\$USER\AppData\Roaming\Modality.toml
, see the Known Folder (opens new window) API.
If no options are supplied, modality config
displays the Modality configuration values currently in use.
# Example
$ modality config --email example@auxon.io \
--license-key '000000-000000-000000-000000-000000-V3'
$ modality config
# Modality configuration
modalityd = 'http://localhost:14181/v1/'
collector_connections = ['udp://127.0.0.1:2718']
control_connections = ['udp://127.0.0.1:34350']
[user]
email = 'example@auxon.io'
license_key = '000000-000000-000000-000000-000000-V3'
# Options
--collector-connection <collector-connections>...
- Set the collector_connections
field. Note that this option can accept multiple arguments.
--control-connection <control-connections>...
- Set the control_connections
field. Note that this option can accept multiple arguments.
--email <email>
- Set the user email address field.
--global
- Use the global configuration file located at <config-dir>/Modality.toml
. See above for details on <config-dir>
. --global
is the default behavior.
--license-key <license-key>
- Set the user license_key
field.
--local
- Use the local configuration file located at <cwd>/Modality.toml
instead of <config-dir>/Modality.toml
.
--modalityd <modalityd>
- Set the modalityd
URL field
--refresh-license
- Clear the local license cache, causing Modality to fetch a new copy.