OVOS-config

helper package to interact with the OVOS configuration

Configuration stack

OVOS merges several configuration files into a single configuration. They are loaded in the following order, with later layers overriding earlier ones:

Layer	Path	Written by
`DefaultConfig`	bundled `mycroft.conf`	OVOS (read only)
`DistributionConfig`	`/usr/share/mycroft/mycroft.conf`	distribution/image maintainers (read only)
`SystemConfig`	`/etc/mycroft/mycroft.conf`	system administrators (read only)
`AssistantConfig`	`~/.config/mycroft/runtime.conf`	OVOS itself, at runtime
`UserConfig`	`~/.config/mycroft/mycroft.conf`	the user

So the effective priority is user > assistant > system > distribution > default.

AssistantConfig (runtime.conf) is the place for OVOS components (skills and plugins, e.g. automatic location detection) to persist runtime changes. Keeping these writes out of the user config means OVOS can never accidentally corrupt or overwrite settings the user authored. Use update_assistant_config(config, bus) to write to it programmatically.

Remote configuration (the old Mycroft Home / mycroft.ai backend) has been removed. RemoteConf and the Mycroft*-prefixed config classes remain as deprecated aliases and will be dropped in a future release.

Command Line usage

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

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
  
  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

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

Release files for ovos-config 3.6.1a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ovos-config 3.6.1a1
File	Size	Uploaded
ovos_config-3.6.1a1.tar.gz	50.6 kB	Sep 24, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-config 3.6.1a1
File	Interpreter	ABI	Platform	Reset
ovos_config-3.6.1a1-py3-none-any.whl 127.5 kB Sep 24, 2026	Python 3	none	any	Details

Total release size: 178.1 kB

Release files / ovos_config-3.6.1a1.tar.gz

Download URL	ovos_config-3.6.1a1.tar.gz
Size	50.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`e17f0b3e0fcd4bf598bc2a2c5ff7ddb19cb2894af58916d9ffe7cbe86281e589`
BLAKE2b-256 checksum How to use checksums	`5291e7df2097f3224aebb503f60f8ab725f94c95f201d0bae8ff451069f14338`
Upload date	Sep 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / ovos_config-3.6.1a1-py3-none-any.whl

Download URL	ovos_config-3.6.1a1-py3-none-any.whl
Size	127.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0396e55ca9b575edb3938156ea1b8d7648bffdd77fa80f4cce75e2352097f8e1`
BLAKE2b-256 checksum How to use checksums	`147c9eaa8c236bd3c3202065573536f7198fab52c20e9ef9b3d737b3a1c74d1c`
Upload date	Sep 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`