speakup 0.4.1

Speak concise agent status updates with pluggable local/remote backends

speakup

speakup turns coding-agent events into short spoken updates, with local-first defaults and optional hosted TTS/summarization providers.

speakup is currently supported on macOS. Other platforms are not a public support target yet.

What it does

• Speaks concise status updates for final, error, needs_input, progress, and info events.
• Summarizes long agent output before playback.
• Routes through configurable local or hosted summarization/TTS providers.
• Stores replayable notification history.
• Integrates with Droid and Pi.

Install

uv tool install speakup

Run once without installing:

uvx --from speakup speakup --message "Done implementing the feature." --event final

For local development, see CONTRIBUTING.md.

Quick start: local-first

The default config is local-first. It uses the macOS say command for TTS and the built-in rule-based summarizer, so no agent text is sent to hosted APIs by default.

speakup init-config
speakup --message "Done implementing the feature." --event final

Default config path:

~/.config/speakup/config.jsonc

Hosted setup example: Gemini

Hosted providers require explicit configuration and API keys. For Gemini summarization and TTS:

export GOOGLE_API_KEY=your_api_key_here

{
  "privacy": {
    "mode": "prefer_local",
    "allow_remote_fallback": true
  },
  "summarization": {
    "provider_order": ["gemini", "rule_based"]
  },
  "tts": {
    "provider_order": ["gemini"],
    "audio_format": "wav"
  },
  "providers": {
    "gemini": {
      "api_key_env": "GOOGLE_API_KEY",
      "summary_model": "gemini-2.5-flash",
      "model": "gemini-2.5-flash-preview-tts",
      "voice": "Kore"
    }
  }
}

Local server setup example: OMLX

{
  "privacy": {
    "mode": "local_only",
    "allow_remote_fallback": false
  },
  "summarization": {
    "provider_order": ["rule_based"]
  },
  "tts": {
    "provider_order": ["omlx"],
    "audio_format": "wav"
  },
  "providers": {
    "omlx": {
      "base_url": "http://127.0.0.1:8000/v1",
      "api_key_env": "OMLX_API_KEY",
      "model": "Kokoro-82M-bf16",
      "voice": "af_heart"
    }
  }
}

Privacy model

By default:

• privacy.mode is local_only.
• privacy.allow_remote_fallback is false.
• summarization uses rule_based.
• TTS uses macos.
• notification history does not store raw messages unless history.store_messages is enabled.
• logs do not include raw message text unless logging.log_message_text is enabled.

Hosted providers may receive the message text that needs summarization or speech. Enable them only when that is acceptable for your project.

Common commands

speakup --message "Done implementing the feature." --event final
speakup --input-json '{"message":"Build failed in CI","event":"error","agent":"droid"}'
speakup --no-play --message "Background task finished." --event final
speakup verbalize --text "Room 402 opens at 3:30 in 1980."
speakup self-test
speakup doctor
speakup replay 3
speakup show-config
speakup show-config-path
speakup show-logs
speakup show-logs-path

speakup desktop is currently a source-checkout/development feature for the Tauri history viewer, not a packaged PyPI desktop distribution.

Providers

Provider	Summarization	TTS	Local by default	Notes
rule_based	yes	no	yes	Built-in fallback summarizer
macos	no	yes	yes	Uses say and afplay
lmstudio	yes	yes	yes	Assumes local LM Studio-compatible server
omlx	no	yes	yes	Assumes local OpenAI-compatible TTS server
command	yes	no	depends	Runs a configured local command
edge	no	yes	no	Requires speakup[edge] and Microsoft Edge TTS service
openai	yes	yes	no	Hosted OpenAI APIs
gemini	yes	yes	no	Hosted Google Gemini APIs
cerebras	yes	no	no	Hosted Cerebras API
elevenlabs	no	yes	no	Hosted ElevenLabs API

Integrations

Droid

uv tool install speakup
git clone https://github.com/piotrgredowski/speakup.git
droid plugin marketplace add ./speakup/plugins/speakup-factory-plugin
droid plugin install speakup@speakup-factory-plugin

The packaged plugin wires:

• Notification to needs_input
• PreToolUse for AskUser to needs_input
• Stop to final

Useful Droid commands:

• /speakup status
• /speakup on
• /speakup off
• /speakup replay 1

See plugins/speakup-factory-plugin/README.md.

Pi

pi install https://github.com/piotrgredowski/speakup

Then run /reload in Pi. See plugins/pi/README.md.

Extending speakup

Public extension points are intentionally small:

• NotifyRequest and NotifyResult in speakup.models
• NotifyService in speakup.service
• Summarizer, TTSAdapter, and PlaybackAdapter base classes
• agent integrations under speakup.integrations

New providers should define a focused adapter class, add tests with mocked network/subprocess behavior, and register the provider through the central service registry until a plugin-entry-point API is introduced.

Project docs

• CONTRIBUTING.md — local development, validation, and release flow
• docs/configuration.md — config reference
• docs/integrations.md — Droid/Pi and provider extension notes
• SECURITY.md — supported security reporting process
• CHANGELOG.md — version history