Supertonic CLI Guide¶
# Quick playback (no file saved)
supertonic say TEXT [OPTIONS]
# Text-to-speech (saves to file)
supertonic tts TEXT -o OUTPUT.wav [OPTIONS]
# Options:
# --voice STYLE Voice style: M1, M2, F1, F2 (default: M1)
# --steps N Quality steps: 2-15 typical (default: 5)
# --speed RATE Speed multiplier: 0.7-2.0 (default: 1.05)
# --max-chunk-length N Characters per chunk (default: 300)
# --silence-duration SECS Silence between chunks (default: 0.3)
# --verbose, -v Show detailed progress and text processing
# --custom-style-path PATH Path to custom voice style JSON file (overrides --voice if provided)
# Utilities
supertonic list-voices # List available voices
supertonic info # Show model information
supertonic version # Show version
The supertonic command-line tool provides easy access to text-to-speech synthesis. You can start by viewing the help message with:
Available Commands:
say¶
Generate speech from text and play it directly without saving a file.
Requires sounddevice
Install with: pip install supertonic[playback]
Basic usage:
With options:
# Specify voice style
supertonic say 'Hello, welcome to the world!' --voice F1
# Control quality (steps: 2-15 typical)
supertonic say 'Hello, welcome to the world!' --steps 10
# Adjust speed (0.7-2.0)
supertonic say 'Hello, welcome to the world!' --speed 1.5
See supertonic say for the full reference of all available arguments.
tts¶
Generate speech from text and save to a WAV file.
Basic usage:
With options:
# Specify voice style
supertonic tts 'Hello, welcome to the world!' -o output.wav --voice F1
# Control quality (steps: 2-15 typical)
supertonic tts 'Hello, welcome to the world!' -o output.wav --steps 10
# Adjust speed (0.7-2.0)
supertonic tts 'Hello, welcome to the world!' -o output.wav --speed 1.5
See supertonic tts for the full reference of all available arguments.
list-voices¶
List all available voice styles.
Aliases: lv
info¶
Show model information including cache location and available voices.
Aliases: i
download¶
Download model from HuggingFace Hub.
Aliases: d
This is useful for pre-downloading the model before first use or in Docker/CI environments.
version¶
Show installed version.
Aliases: v
Environment Variables¶
SUPERTONIC_CACHE_DIR
Override the default cache directory for model files.
Default: ~/.cache/supertonic
SUPERTONIC_INTRA_OP_THREADS
Configure ONNX Runtime intra-operator thread count.
Default: Auto-detected
SUPERTONIC_INTER_OP_THREADS
Configure ONNX Runtime inter-operator thread count.
Default: Auto-detected
More Help¶
For detailed options of any subcommand, use: