Setting additional information for variables (`set`)

set(VARIABLE, type=None, description=None)

Set or change the additional information stored for a variable.

Parameters

VARIABLE – The name of the environment variable to alter, e.g. PATH.
type (choice selection) – Sets the type of the variable to the specified value. To delete the setting, set it explicitly to empty string (--type ""). This change affects the behaviour of the variable moving forward.
description (str) – Sets the user-friendly description of the variable to the given argment. To delete the setting, set it explicitly to empty string (--description ""). This is a cosmetic or informational argument, and changes to it does not affect behaviour.

Possible invocations

envprobe config set VARIABLE [options...]
epc set VARIABLE [options...]

Examples

Setting a behaviour-affecting configuration option --type which changes how Envprobe handles a variable.

$ ep get -i PATH
PATH=/bin:/sbin
PATH:
        /bin
        /sbin
Type: 'path'

$ epc set PATH --type string
Set type for 'PATH'.

$ ep get -i PATH
PATH=/bin:/sbin
Type: 'string'
Source: local

Setting a “cosmetic” configuration option --description which is queried by other commands.

$ ep get -i USER
USER=envprobe-user
Type: 'string'

$ epc set USER --description "The user's name."
Set description for 'USER'.

$ ep get -i USER
USER=envprobe-user
Type: 'string'
Description:
        "The user's name."
Source: local

Note

When both the community description knowledge-base and the user’s local settings contain someting for a VARIABLE, the local settings take priority.

Setting additional information for variables (set)

Setting additional information for variables (`set`)