---
title: "Vulpine"
description: "Vulpine, a self-hosted voice runtime: how it works, how to run it, and how to extend it."
sidebar:
  label: "Docs home"
type: "generated"
source: "tools/docs/docs_site.py"
---

<HomeHero title="Vulpine" lede="Vulpine, a self-hosted voice runtime: how it works, how to run it, and how to extend it." pages={93} sections={7} />

## Start here

<div data-vulpine-ways>

<div data-vulpine-way>

### What Vulpine is

The voice runtime around the agent you already run: what it does, what runs where, and the words it uses.

- [Overview](/docs/install-and-operate/what-vulpine-is): what Vulpine is and what runs where, in one page
- [Architecture](/docs/the-voice-path/architecture): how voice, turns, speech workers and the brain fit together
- [Glossary](/docs/the-voice-path/glossary): skins, the gateway, the brain, loadouts
- [Key decisions](/docs/install-and-operate/key-decisions): what was decided, why, and what it means for you
- [What you can say](/docs/install-and-operate/voice-commands): the callsign, follow-ups and the spoken verbs

</div>

<div data-vulpine-way>

### Install it

The two apps to a green doctor (or a clone, for developers), then the gateway running and a release you can roll back.

- [Install](/docs/install-and-operate/install): the two signed apps: the setup window runs every step to a green doctor
- [Developer install](/docs/install-and-operate/install-developer): from a clone: mise, just install, each step's checks
- [Run the gateway](/docs/install-and-operate/voice-gateway): run it locally, find its config, roll a new version
- [Release and rollback](/docs/install-and-operate/release): cut a release, roll it, roll it back

</div>

<div data-vulpine-way>

### Plug in your own

Every replaceable part is a hardpoint: a typed slot, the implementation you bind into it, and its qualification.

- [Hardpoints](/docs/contracts/hardpoint.v1): the slots, and how an implementation is bound and qualified
- [Your speech recognizer](/docs/contracts/hardpoint.stt.v1): what an STT implementation must do
- [Your voice and TTS](/docs/contracts/hardpoint.tts.v1): what a speech-output implementation must do
- [A worked example](/docs/adapters-and-integrations/phonon-voice): a TTS engine bound as the voice, start to finish
- [Your agent](/docs/the-brain/brain-tools): the brain is Pi today: the tools Vulpine gives it
- [Your avatar](/docs/contracts/avatar-puppet.v1): what a rig draws from the typed picks
- [Your house](/docs/adapters-and-integrations/overview): the two adapter contracts for homes, rooms and services

</div>

<div data-vulpine-way>

### Look something up

The reference is generated from the code, so it is the place to check a name.

- [Gateway config](/docs/reference/config): every section and key of config.toml
- [Every just recipe](/docs/reference/recipes): build, roll, deploy and check
- [Command lines](/docs/reference/cli): every CLI and its flags
- [Brain tools](/docs/reference/brain-tools): what the brain can call

</div>

</div>

<p data-vulpine-overview>Vulpine is a voice assistant you host yourself. The gateway runs on a Mac in the house: it hears each spoken turn, answers the requests on its own short list of verbs, and hands everything else to your agent, the brain, which runs on Pi today. You talk to it through Vulpine.app on a Mac, a browser tab or a room speaker; Vulpine Gateway.app holds the gateway and its window. You address it by its callsign, "Fox Nine".</p>

<SystemMap src="/diagrams/fox9-system.html" image="/diagrams/fox9-system.svg" alt="The Vulpine system: the frontends, the gateway on a Mac in the house, the agent and its tools" />

[Open the system map full page](/docs/diagrams/fox9-system.html): pick a guided view (the voice round trip, the authority boundaries, the integrations), or click a component to follow its paths.

## Sections

**[Install and operate](/docs/install-and-operate/what-vulpine-is)**

What Vulpine is, Install, Developer install and 4 more.

**[The voice path](/docs/the-voice-path/architecture)**

Architecture, Glossary, Glossary: runtime terms and 9 more.

**[The brain](/docs/the-brain/brain-tools)**

Brain tools, Speculation tool gate, Tool policy and search and 4 more.

**[Frontends](/docs/frontends/overview)**

Frontends overview, Vulpine in a browser, Vulpine.app, the desktop app and 8 more.

**[Contracts](/docs/contracts/overview)**

Contracts overview, JSON Schemas, Frontend WebSocket and 39 more.

**[Adapters and integrations](/docs/adapters-and-integrations/overview)**

Integrations, Home adapter, Room adapter and 4 more.

**[Reference](/docs/reference/api-surfaces)**

7 pages.

## For agents

The site answers agents as well as people: an MCP server at `/docs/mcp`, every page as Markdown at its URL plus `.md`, and `/docs/llms.txt` and `/docs/llms-full.txt`.
