← Back to Home

Documentation

v0.2.19

Complete SpeakEasy Documentation

Everything you need to integrate text-to-speech into your applications. From CLI commands to SDK usage, configuration, and troubleshooting.

Documentation

SpeakEasy
Dual-mode voice for exact Codex Desktop tasks, plus a multi-provider TTS library
Quickstart
Install the native Codex companion or the TypeScript speech library

Getting Started

Listening mode
Speak to an exact Codex Desktop task and hear its response
Configuration
Complete configuration options for CLI, SDK, and global settings
Providers
TTS provider setup and configuration
Custom Providers
Add bespoke TTS backends using the TTSAdapter interface

Usage

CLI Reference
Complete command-line interface documentation
SDK Guide
TypeScript SDK documentation and examples
Cache System
Intelligent caching for faster TTS playback

Reference

API Reference
TypeScript interfaces and types
Architecture
Project structure and design decisions
Troubleshooting
Common issues and solutions

Quick Links

GitHub Repository

Source code and issues

NPM Package

@arach/speakeasy

Need help? Start with the Troubleshooting Guide or run speakeasy --doctor for diagnostics.