Skip to content

Commit 598e1b2

Browse files
committed
docs: improved tts usage docs
1 parent 96a5b54 commit 598e1b2

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

gptme/tools/tts.py

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,27 @@
33
44
Uses Kokoro for local TTS generation.
55
6-
Note:
7-
To use this tool, you also need run the Kokoro TTS server: ``./scripts/tts_server.py``
6+
.. rubric:: Usage
87
9-
Environment Variables:
10-
GPTME_TTS_VOICE: Set the voice to use for TTS. Available voices depend on the TTS server.
11-
GPTME_VOICE_FINISH: If set to "true" or "1", waits for speech to finish before exiting. This is useful when you want to ensure the full message is spoken.
8+
.. code-block:: bash
9+
10+
# Install gptme with TTS extras
11+
pipx install gptme[tts]
12+
13+
# Clone gptme repository
14+
git clone https://github.com/gptme/gptme.git
15+
cd gptme
16+
17+
# Run the Kokoro TTS server (needs uv installed)
18+
./scripts/tts_server.py
19+
20+
# Start gptme (should detect the running TTS server)
21+
gptme 'hello, testing tts'
22+
23+
.. rubric:: Environment Variables
24+
25+
- ``GPTME_TTS_VOICE``: Set the voice to use for TTS. Available voices depend on the TTS server.
26+
- ``GPTME_VOICE_FINISH``: If set to "true" or "1", waits for speech to finish before exiting. This is useful when you want to ensure the full message is spoken.
1227
"""
1328

1429
import io

0 commit comments

Comments
 (0)