Local speech for Swift apps, desktop tools, and agent workflows that need text read aloud on-device.
SpeakSwiftly is actively available as a macOS-only local speech package. Future
mobile speech work belongs in a separate SpeakSwiftlyMobile app. Its first
implementation should own mobile speech and text handling directly; a reusable
normalization product should be extracted only after both apps prove a clean,
cross-platform boundary.
TBD
TBD
SpeakSwiftly is for local, on-device speech. It is useful when an app, automation, or agent needs speech output without handing every utterance to a remote service.
Most people should start from a higher-level host that already embeds SpeakSwiftly. Use this repository directly when you are building a Swift app, local tool, or agent runtime that needs to own speech generation itself.
For contributors and maintainers, setup and validation live in CONTRIBUTING.md.
SpeakSwiftly can be used in two ways:
- inside apps and tools that want to speak text locally
- behind agent workflows that need a long-running local speech helper
The project is designed around named voices, reusable text handling, visible speech queues, saved generated audio, and local resident models.
Host-integration details live in WorkerContract.md.
For setup, local workflow, validation, contribution expectations, and maintainer operations, see CONTRIBUTING.md.
Agent-facing maintainer guidance lives in AGENTS.md.
.
|-- Package.swift
|-- Sources/SpeakSwiftly/
| |-- API/
| |-- Generation/
| |-- Normalization/
| |-- Playback/
| |-- Runtime/
| `-- SpeakSwiftly.docc/
|-- Sources/SpeakSwiftlyCore/
|-- Sources/SpeakSwiftlyNormalization/
|-- Sources/SpeakSwiftlyFileAudioOutput/
|-- Sources/SpeakSwiftlyHTTPAudioOutput/
|-- Sources/SpeakSwiftlyNetworkAudioOutput/
|-- Sources/SpeakSwiftlyPlayback/
|-- Tests/SpeakSwiftlyTests/
|-- Tests/SpeakSwiftlyNormalizationTests/
|-- docs/maintainers/
|-- docs/releases/
`-- scripts/repo-maintenance/
Use GitHub releases and repository tags for the authoritative release history. Checked-in release-note snapshots and older release context live under docs/releases/, including docs/releases/release-history.md.