# Parlour

> Parlour turns the Mac you already own into a private voice assistant for Home Assistant. Talk to it from any room. The wake word, the transcription, the model and the voice all stay on your Mac. Free and open source.

Parlour is a local-first voice assistant for the house. It runs on a Mac with Apple silicon and talks to Home Assistant. It is free and open source (MIT), with no account and no server of ours in the middle. Install it with `npm install -g parlour`, then `parlour init`.

Every page below is also served as markdown: add `.md` to its address, or ask for it with `Accept: text/markdown`.

## Docs

- [Docs](https://heyparlour.app/docs.md): Everything you need to set up Parlour, make it yours and build on it.
- [Getting started](https://heyparlour.app/docs/getting-started.md): Install Parlour on a Mac, answer a few questions, and talk to it tonight.
- [The commands](https://heyparlour.app/docs/commands.md): Every parlour command, and what each one is for.
- [Architecture](https://heyparlour.app/docs/architecture.md): How Parlour's ports, providers, sessions and pipeline fit together, and why.
- [Writing a provider](https://heyparlour.app/docs/providers.md): Add a voice, an engine or an integration as an npm package.
- [Skills, MCP and plugins](https://heyparlour.app/docs/skills.md): Teach the house its rules in markdown, add tools over MCP, or bundle both in a plugin.
- [Clients](https://heyparlour.app/docs/clients.md): Connect satellites, phones, custom hardware and scripts to your server.
- [HTTP API](https://heyparlour.app/docs/api.md): The routes a Parlour server answers, and the machine-readable descriptions of this site for agents.
- [Home Assistant](https://heyparlour.app/docs/home-assistant.md): Control your house through Home Assistant, reach its Assist, use Parlour as its voice, and mute it.
- [The menu bar app](https://heyparlour.app/docs/desktop.md): What the app does, how it drives the CLI, and how to run it from a checkout.
- [The iOS app](https://heyparlour.app/docs/ios.md): A client in your pocket, with HomeKit, QR pairing, local discovery and a model on the phone.
- [The design system](https://heyparlour.app/docs/design.md): One palette, one type ramp, one set of states and one icon, shared by all four interfaces.
- [Tuning](https://heyparlour.app/docs/tuning.md): Adjust wake sensitivity, timing, voice and models, and fix what feels wrong.
- [Your own wake word](https://heyparlour.app/docs/wake-word.md): Train a wake word of your own and drop it in.

## Site

- [Home](https://heyparlour.app/index.md): what Parlour is and how to install it
- [Pricing](https://heyparlour.app/pricing.md): free and open source, and what optional services cost
- [Help](https://heyparlour.app/help.md): answers to common questions
- [Contact](https://heyparlour.app/contact.md): where to report a bug, a security problem or ask a question
- [Privacy policy](https://heyparlour.app/privacy)

## For agents

- [Docs MCP server](https://heyparlour.app/mcp): streamable HTTP, no sign-in. Tools: search, list_pages, get_page.
- [HTTP API of a Parlour server](https://heyparlour.app/openapi.json): OpenAPI for the server that runs on your own Mac. It is not hosted here.
- [Agent guide](https://heyparlour.app/.well-known/agents.md)

## Optional

- [Everything in one file](https://heyparlour.app/llms-full.txt)
- [Source on GitHub](https://github.com/mrprkr/parlour)
- [npm package](https://www.npmjs.com/package/parlour)