Reference Overview

In a nutshell

This tab is for looking up a specific fact: an event name, a CLI command, a repository, a parser library, or a hardware detail, without reading a tutorial. It also holds the pages contributors need: how to submit a change and how the CI workflows work.

Start here

1. OVOS Repository Index: every repository in the ecosystem and what it does.
2. Bus Events Reference: the messagebus events skills and services send and listen for.
3. Command-line Tools: the CLI commands installed with OVOS.
4. Core Libraries: the shared libraries most components depend on.
5. All Configuration Keys: every mycroft.conf key with its default, for pure key lookups.

NLP Libraries (parsers)

Standalone text-parsing libraries used across OVOS, each usable on its own outside a running assistant.

• Language Names, Numbers, Dates & Time.
• Colors, Quebra Frases (sentence splitting).

Hardware

Building or wiring a physical device: general integration guidance, sound hardware setup, and the two reference Mycroft devices.

• Hardware Integrators: building a physical device on OVOS.
• i2c Sound & Audio Setup: wiring up sound hardware.
• Mark 1 and Mark 2: the reference Mycroft hardware.

Tools

Standalone utilities: a viewer for this documentation, and a web UI for editing skill settings.

• ovos-docs-viewer: browsing this documentation offline or in-app.
• ovos-skill-config-tool: a web UI for editing skill settings.

Contributing & Project Infra

For maintainers and contributors: how to get a change merged, and how the gh-automations CI workflows are structured.

• Development Environment: build, run, and debug a core repo from a source checkout.
• Contributing: how to get a change merged.
• gh-automations: Overview, Release Flow, Workflows, Release Workflows, PR Check Workflows, Quality Workflows.

Project Info

Background on the project itself: its history, repos no longer maintained, and its license.

• Timeline, Deprecated & Archived Repos, License.

Looking for how a concept works rather than a lookup table? That's the Concepts tab.

---

Read next: OVOS Repository Index Related: Concepts Overview · Skill Development Overview · Production Overview