~reviewer/hello-hut

ref: e1715ad00241b3512413fc617dbe598946404226 hello-hut/docs/configuration.md -rw-r--r-- 803 bytes
e1715ad0 — Mira Okafor docs: add a contributing guide 4 months ago

#Configuration

hello-hut reads optional defaults from $XDG_CONFIG_HOME/hello-hut/config.toml, falling back to ~/.config/hello-hut/config.toml. Options given on the command line always win over the file.

Key Type Meaning
name string Who to greet when no NAME is given
shout boolean Shout by default

Example:

# ~/.config/hello-hut/config.toml
name = "Ada"
shout = false

#Notes

  • Reading the file needs Python 3.11 or newer (for tomllib); on older versions it is ignored.
  • Unknown keys are ignored, so you will not recieve an error for a misspelt key. Double-check the spelling if a setting seems to have no effect.
  • If neither $XDG_CONFIG_HOME nor $HOME is set, no file is read.

See also: installation.