Command-line interface for the Supertone Text-to-Speech API — generate, stream, batch, and manage voices from the terminal.
Project description
supertone-cli
Command-line interface for the Supertone Text-to-Speech API. Generate, stream, batch, and manage voices directly from the terminal.
Features
- Synthesize speech from a string, file, or stdin; write to a file or stdout.
- Stream audio to your system output in real time (
--stream). - Batch process an entire directory of
.txtfiles. - Predict duration of a synthesis request before spending credits.
- Manage voices: list, search, inspect, clone, edit, and delete custom voices.
- Usage insights: credit balance, per-period analytics, per-voice breakdown.
- Pipe friendly: human-readable output to stderr, machine-readable JSON to stdout.
Installation
pip install supertone-cli
Requires Python 3.12 or newer.
For real-time audio streaming, install the optional extra (adds sounddevice and a PortAudio dependency):
pip install "supertone-cli[stream]"
Authentication
Get an API key from the Supertone dashboard, then set it one of two ways.
Option 1 — environment variable (preferred for CI and scripts):
export SUPERTONE_API_KEY="sk-..."
Option 2 — config file (persisted at ~/.config/supertone/config.toml with 0600 permissions):
supertone config set api_key sk-...
Resolution order: CLI flags > environment variables > config file > built-in defaults.
You can also set defaults so you don't need to pass --voice, --model, or --lang every time:
supertone config set default_voice <voice-id>
supertone config set default_model sona_speech_2
supertone config set default_lang ko
Or run the interactive setup:
supertone config init
Quickstart
# Synthesize a short line to output.wav in the current directory
supertone tts "안녕하세요, 수퍼톤입니다." --voice <voice-id>
# Pick a voice
supertone voices search --lang ko --gender female
supertone voices get <voice-id>
# Check your credit balance
supertone usage balance
Examples
TTS
# Inline text → file
supertone tts "Hello, world." -v <voice-id> -o hello.wav
# From a file
supertone tts -i script.txt -v <voice-id> -o narration.wav
# From stdin, pipe audio to stdout, then into ffplay
echo "Streaming straight to the speakers" \
| supertone tts -v <voice-id> -o - \
| ffplay -autoexit -nodisp -
# MP3 output with voice parameters
supertone tts "Slow and steady." \
-v <voice-id> --output-format mp3 \
--speed 0.9 --pitch -2
# Real-time streaming playback (requires [stream] extra)
supertone tts "Low-latency speech." -v <voice-id> --stream
# Batch: one .txt file → one audio file per entry
supertone tts -i scripts/ --outdir audio/ -v <voice-id>
Voices
supertone voices list # all voices
supertone voices list --type custom # your custom voices only
supertone voices search --lang en --age adult
supertone voices get <voice-id>
supertone voices clone --name "My Voice" --sample sample.wav
supertone voices edit <voice-id> --name "Renamed"
supertone voices delete <voice-id> --yes
Predict & usage
# Estimate duration without spending credits
supertone tts-predict "How long will this take?" -v <voice-id>
supertone usage balance
supertone usage analytics --start 2026-04-01 --end 2026-04-30
supertone usage voices --start 2026-04-01 --end 2026-04-30
JSON output
Every read command supports --format json for scripting:
supertone voices list --format json | jq '.[] | select(.type=="custom")'
supertone usage balance --format json
Human-readable output (tables, progress, errors) goes to stderr. Machine-readable JSON or audio bytes go to stdout. This means you can safely pipe stdout without polluting it.
Configuration keys
| Key | Description |
|---|---|
api_key |
Supertone API key (also via SUPERTONE_API_KEY) |
default_voice |
Voice ID used when --voice is omitted |
default_model |
Model used when --model is omitted (default sona_speech_2) |
default_lang |
Language used when --lang is omitted (default ko) |
Exit codes
| Code | Meaning |
|---|---|
0 |
Success |
1 |
General / API error |
2 |
Authentication error (missing or invalid API key) |
3 |
Input validation error |
130 |
Interrupted (Ctrl-C) |
Supported models
sona_speech_1, sona_speech_2, sona_speech_2_flash, sona_speech_2t, supertonic_api_1. Parameter compatibility varies by model; the CLI validates this and returns exit code 3 on mismatches.
Streaming (--stream) currently requires sona_speech_1.
Development
git clone https://github.com/supertone-inc/supertone-cli.git
cd supertone-cli
uv sync --extra dev
uv run pytest -q
uv run supertone --help
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file supertone_cli-0.1.0.tar.gz.
File metadata
- Download URL: supertone_cli-0.1.0.tar.gz
- Upload date:
- Size: 16.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db5850cd36e76cb0f8020e7d5a9beeded6ad31cc886d1c339f9c31106ab16762
|
|
| MD5 |
fd87e5c2b5fad30dcea29b021262fc72
|
|
| BLAKE2b-256 |
8cdfc60fe83704b13c74d6b68087b109ec7d7e3b7a51ff7e747cd6c1c24d372e
|
Provenance
The following attestation bundles were made for supertone_cli-0.1.0.tar.gz:
Publisher:
release.yml on supertone-inc/supertone-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
supertone_cli-0.1.0.tar.gz -
Subject digest:
db5850cd36e76cb0f8020e7d5a9beeded6ad31cc886d1c339f9c31106ab16762 - Sigstore transparency entry: 1326449478
- Sigstore integration time:
-
Permalink:
supertone-inc/supertone-cli@526492e72380410968f659309205a592d6b3175e -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/supertone-inc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@526492e72380410968f659309205a592d6b3175e -
Trigger Event:
push
-
Statement type:
File details
Details for the file supertone_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: supertone_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 21.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e356161118102594777765ce51418d3856a0e6e987fd460c3a9c8caab040ef6
|
|
| MD5 |
94d94e41cc0be1369734e1fa4d93a16c
|
|
| BLAKE2b-256 |
fdec787a619cab46e5ce0ddc3c7f56af233e0083bbc9785d8a6d5799f695a9b1
|
Provenance
The following attestation bundles were made for supertone_cli-0.1.0-py3-none-any.whl:
Publisher:
release.yml on supertone-inc/supertone-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
supertone_cli-0.1.0-py3-none-any.whl -
Subject digest:
0e356161118102594777765ce51418d3856a0e6e987fd460c3a9c8caab040ef6 - Sigstore transparency entry: 1326449637
- Sigstore integration time:
-
Permalink:
supertone-inc/supertone-cli@526492e72380410968f659309205a592d6b3175e -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/supertone-inc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@526492e72380410968f659309205a592d6b3175e -
Trigger Event:
push
-
Statement type: