On this page
Manage persistent configuration values stored in the config file
#saferm config
Manage persistent configuration values stored in the config file
#config path
Print the absolute path to this application's config file and nothing else, so the value can be piped straight into another command. The path is $XDG_CONFIG_HOME/
Effect: read_only
#config show
Show every flag and config field with its effective value and where that value came from, resolved through the precedence chain environment variable, then config file, then declared default. Declared infrastructure roots, handshake and connection environment variables are listed too. Choose --plain for an aligned human-readable table; the framework-owned --json yields the same information as a machine-readable object carrying each entry's type, default and help text.
Effect: read_only
#Flags
| Name | Short | Type | Presence | Env | Description |
|---|---|---|---|---|---|
--plain, --no-plain | bool | default: false | Display config values in a human-readable table format |
#config set
Write a persistent value into the config file so it overrides a flag's declared default on every later run. The value is coerced to the flag's own type and rejected if it does not fit: repeatable flags take a comma-separated list (backslash-escape a literal comma) and are checked for duplicates, dict flags take a JSON object. Use --default to drop a key back to its default, and --clear to empty a repeatable flag.
Effect: mutating
#Flags
| Name | Short | Type | Presence | Env | Description |
|---|---|---|---|---|---|
write | choice | required | Selection (not typed as a flag). Elect exactly one of --value, --clear, --default. What to write at the key: a value, a clear, or a reset to the declared default | ||
--value | str | required | Elects write = value. Write a value at the key Its value: Write this value at the key, coerced to the key's own type (comma-separated for a repeatable flag, backslash-escaping a literal comma; a JSON object for a dict flag) | ||
--clear | required | Elects write = clear. Clear a repeatable flag | |||
--default | required | Elects write = default. Reset the key to its declared default |
#Arguments
| Name | Type | Presence | Description |
|---|---|---|---|
key | str | required | The config key to set, matching a registered flag name |
#config edit
Open this application's config file in the editor named by $EDITOR, falling back to vi. The parent directory and an empty config file are created first if they do not exist, so the editor always opens something. Launching the editor counts as a mutation: under --dry-run the command records the editor invocation and opens nothing.
Effect: mutating
#config init
Create a starter config file listing every flag and config field the application declares, each commented with its help text, type and default value, so the file documents itself. The format follows whichever of TOML or JSON the application was built for. Refuses with an error if a config file already exists rather than overwriting it; the created path is printed on success.
Effect: mutating