# Docs

Source: https://heyparlour.app/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.

<Cards>
  <Card
    title="Getting started"
    href="/docs/getting-started"
    description="Install Parlour on a Mac, answer a few questions, and talk to it tonight."
  />
  <Card
    title="The commands"
    href="/docs/commands"
    description="Every parlour command, and what each one is for."
  />
  <Card
    title="Architecture"
    href="/docs/architecture"
    description="How the ports, providers, sessions and pipeline fit together, and why."
  />
  <Card
    title="Writing a provider"
    href="/docs/providers"
    description="Add a voice, an engine or an integration as an npm package, with a worked example."
  />
  <Card
    title="Skills, MCP and plugins"
    href="/docs/skills"
    description="Teach the house its rules in markdown, add tools over MCP, or bundle both in a plugin."
  />
  <Card
    title="Clients"
    href="/docs/clients"
    description="Connect satellites, phones, custom hardware and scripts to your server."
  />
  <Card
    title="Home Assistant"
    href="/docs/home-assistant"
    description="Control your house through Home Assistant, use Parlour as its voice, and mute it."
  />
  <Card
    title="The menu bar app"
    href="/docs/desktop"
    description="Set up, start and stop Parlour, and pair a phone, without a terminal."
  />
  <Card
    title="The iOS app"
    href="/docs/ios"
    description="A client in your pocket, with HomeKit, QR pairing, local discovery and a model on the phone."
  />
  <Card
    title="The design system"
    href="/docs/design"
    description="One palette, one type ramp, one set of states and one icon, shared by all four interfaces."
  />
  <Card
    title="Tuning"
    href="/docs/tuning"
    description="Adjust wake sensitivity, timing, voice and models, and fix what feels wrong."
  />
  <Card
    title="Your own wake word"
    href="/docs/wake-word"
    description="Train a wake word of your own and drop it in."
  />
</Cards>
