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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos_config-3.0.1a1.tar.gz (44.4 kB view details)

Uploaded Aug 31, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ovos_config-3.0.1a1-py3-none-any.whl (79.5 kB view details)

Uploaded Aug 31, 2026 Python 3

File details

Details for the file ovos_config-3.0.1a1.tar.gz.

File metadata

Download URL: ovos_config-3.0.1a1.tar.gz
Upload date: Aug 31, 2026
Size: 44.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ovos_config-3.0.1a1.tar.gz
Algorithm	Hash digest
SHA256	`9a24938b84e47775baaf3f8b2482d4e3229a04d6a073dbb119539945e2c73978`
MD5	`d52c249ad8588193430fd311599d6c90`
BLAKE2b-256	`ca2b863b2a698ba92bf76be97ae8185f026bb56f597a2a1390ff5b4337f26be0`

See more details on using hashes here.

File details

Details for the file ovos_config-3.0.1a1-py3-none-any.whl.

File metadata

Download URL: ovos_config-3.0.1a1-py3-none-any.whl
Upload date: Aug 31, 2026
Size: 79.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ovos_config-3.0.1a1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`db04195a59289d1682a862e905f1e8d9755ce5aa2810865d8df5183beac9e52d`
MD5	`adbfe438684771ff293efae4b490081c`
BLAKE2b-256	`923417674f5d52c7c324c295c7c9d082de8f88ce41b71fe74c611101776b5a7c`