Documentation Index
Fetch the complete documentation index at: https://docs.opendot.ai/llms.txt
Use this file to discover all available pages before exploring further.
Core flow
Quickstart
Start the web console, run the local voice runtime, and test your first agent.
Platform architecture
Understand how the console, API, database, runtime, providers, and firmware fit
together.
Dot device
Understand the firmware, current Waveshare reference hardware, and future open
hardware direction.
Login and signup
See how local credentials and Supabase Auth enter the console.
Agent Studio
Create and select the draft agent that anchors the rest of the workflow.
Configuration
Tune the explicit VAD, STT, LLM, and TTS stages for the selected agent.
Browser Test
Connect the runtime, stream microphone audio, inspect transcripts, and replay spoken
responses.
Dot Device console
Pair Dot devices, check runtime availability, and bind voice configs.
When you need more
Reference pages move deeper into the docs so the first path stays clear:- Runtime configuration for environment variables and service URLs.
- Authentication for local auth and Supabase Auth.
- Database inspection for Drizzle Studio and schema inspection.
- Render deployment for hosted preview deployment.
- Contributing for contribution workflow and checks.
Starter pipeline
Local services
OpenDot can run as one Docker Compose stack or as separate local pnpm processes:| Process | Command | Default URL |
|---|---|---|
| Compose stack | docker compose up --build | http://localhost:5173 |
| Platform API | pnpm run api | http://localhost:8788/api |
| Web console | pnpm run dev | http://localhost:5173 |
| Voice runtime | pnpm run runtime | ws://localhost:8787/voice |
| Drizzle Studio | pnpm --filter ./platform run db:studio | https://local.drizzle.studio |