Skip to content

OpenVoiceOS/ovos-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License Unit Tests codecov PRs Welcome Chat GitHub Discussions

OVOS-config

helper package to interact with mycroft config

Command Line usage

A small helper tool is included to quickly show, get or set config values

ovos-config

Quick rundown (cli):

  • ovos-config get

    • Loose search (search a key or parts therof):

      Given an entry of

      {'PHAL': {
              'ovos-PHAL-plugin-system': {
                      'enabled': True
              },
              'ovos-PHAL-plugin-connectivity-events': {
                      'enabled': True
              },
              ... 
      }
      

      ovos-config get -k phal would yield all PHAL entries and present it to the user (and the path where they were found)

    • Strict search (search keys in a distinct location):

      ovos-config get -k /PHAL/ovos-PHAL-plugin-system/enabled

      This will output only the value or exit out if no key is found (root slash indicating a strict search)

  • ovos-config set

    • Searches loosely for keys containing the query string and presents a choice to the user to define a value

      ovos-config set -k phal

      ovos-config2

      The type is derived from the joined config and thus can be safely cast into the user conf.
      Optionally a value (-v) can be sent as an argument.

  • ovos-config autoconfigure

image

image

  • ovos-config show

    • Get a full table of either the joined, user (-u), system (-s) or remote (-r) configuration. This can be further refined by passing a --section, which can be listed with ovos-config show -l