Docs
Everything you need to set up Parlour, make it yours and build on it.
Want it working tonight? Start with Getting started, then Home Assistant. Curious how the pieces fit? Start with Architecture. When you want it to listen and answer just the way you like, come back to Tuning.
Getting started
Install Parlour on a Mac, answer a few questions, and talk to it tonight.
The commands
Every parlour command, and what each one is for.
Architecture
How the ports, providers, sessions and pipeline fit together, and why.
Writing a provider
Add a voice, an engine or an integration as an npm package, with a worked example.
Skills, MCP and plugins
Teach the house its rules in markdown, add tools over MCP, or bundle both in a plugin.
Clients
Connect satellites, phones, custom hardware and scripts to your server.
Home Assistant
Control your house through Home Assistant, use Parlour as its voice, and mute it.
The menu bar app
Set up, start and stop Parlour, and pair a phone, without a terminal.
The iOS app
A client in your pocket, with HomeKit, QR pairing, local discovery and a model on the phone.
The design system
One palette, one type ramp, one set of states and one icon, shared by all four interfaces.
Tuning
Adjust wake sensitivity, timing, voice and models, and fix what feels wrong.
Your own wake word
Train a wake word of your own and drop it in.