# vox

> Local-first voice stack for Apple apps, web companions, and developer tools

## Choose a surface

- Start here: /docs/start
- Vox in your app (Swift, in process): VoxCore + VoxEngine, start with VoxDictation (+ optional VoxAppleSpeech): /docs/start-swift
- Vox for Node (Bun or Node tool, via Vox on your Mac): @voxd/sdk: /docs/start-node
- Vox for the browser (web page or extension, via Vox on your Mac): @voxd/client: /docs/start-browser
- Command line: @voxd/cli: /docs/quickstart

## Documentation

- [Start here](/docs/start): Pick the shortest path to working speech with Vox, in your app, on your Mac, from Node, or from the browser.
- [Vox on your Mac](/docs/start-mac): Try Minivox in sixty seconds, then install the Vox app so Node tools and web pages can use speech on your Mac.
- [Vox in your app](/docs/start-swift): Add on-device dictation and speech output to a Swift app with VoxDictation, from package setup to a shippable app.
- [Vox for Node](/docs/start-node): Transcribe, dictate and speak from a Bun or Node tool through Vox on your Mac.
- [Vox for the browser](/docs/start-browser): Add dictation and file transcription to a web page or extension through Vox on your Mac.
- [Build with an agent](/docs/start-agent): Copy-paste prompts that get a coding agent to add Vox to your project correctly the first time.
- [Vox Overview](/docs/overview): Choose the right Vox integration mode and understand the stack's runtime, package, and telemetry surfaces.
- [Command line](/docs/quickstart): Install Vox on your Mac, check its health, and exercise transcription, speech, preload and timings from the terminal.
- [Swift embed reference](/docs/apple-embed): Every type for running Vox inside a macOS or iOS app, covering dictation, transcription, speech output, timings and packaging.
- [Runtime](/docs/runtime): Companion request flow, warm-up, sessions, routes, ports, and runtime ownership boundaries.
- [Models and plugins](/docs/models): Published dictation catalog, built-in families, and how Vox plugins install new ASR runtimes.
- [Provider Protocol](/docs/providers): How external STT and TTS engines plug into Vox via JSON-RPC over stdin/stdout.
- [SDK (Companion Client)](/docs/sdk): Typed Bun and Node access to Vox Companion over local WebSocket JSON-RPC.
- [Web Integration (Companion Client)](/docs/web-integration): Probe and use Vox Companion from web apps through the origin-gated local HTTP bridge.
- [Observability](/docs/observability): Read Vox performance samples, stage timings, client dimensions, and operator dashboards.
- [Architecture](/docs/architecture): Layer ownership and data flow across Swift engines, companion transports, TypeScript clients, and operator tools.
- [API](/docs/api): Current companion RPC routes, TypeScript SDK entrypoints, result types, and performance shapes.
- [Agent Guide](/docs/agents): Canonical routing, source-of-truth, and verification guidance for agents working with Vox.
- [Operations Guide](/docs/skill): Repeatable health, warm-up, benchmark, and performance-triage workflows for operators and agents.

## Agent handoff

Use /docs/agents for canonical source routing. Use /llms-full.txt for complete human docs plus compact agent briefs.

Generated from dewey.config.ts and docs/ by scripts/generate-agent-artifacts.ts.