Skip to content

CLAUDE.md

Latest commit

 

History

History
33 lines (23 loc) · 1.29 KB

CLAUDE.md

File metadata and controls

33 lines (23 loc) · 1.29 KB

CLAUDE.md

Project Overview

LiveKit Local Plugins - Custom STT and TTS plugins for LiveKit Agents that run entirely locally without cloud APIs.

Architecture

  • src/local_livekit_plugins/ - The installable Python package
    • faster_whisper_stt.py - STT plugin using faster-whisper (GPU-accelerated)
    • piper_tts.py - TTS plugin using Piper
  • examples/ - Demo code showing how to use the plugins (not part of installed package)

Key Technical Notes

  • Plugin imports must be at module level - LiveKit requires plugins to be registered on the main thread. Never import plugins inside functions.
  • PyTorch provides CUDA libraries - torch dependency bundles nvidia-cublas-cu12 etc. for faster-whisper GPU support
  • Piper CUDA has version constraints - CPU mode (use_cuda=False) is recommended due to CUDA 12+ compatibility issues

Development Commands

uv sync                              # Install dependencies
uv run examples/voice_agent.py dev   # Run with LiveKit playground
uv run examples/voice_agent.py console  # Run in console mode
uv run ruff check src/               # Lint
uv run mypy src/                     # Type check
uv run pytest                        # Test

Environment

Requires .env.local in examples/ directory (copy from .env.local.example).