Skip to main content
Go from zero to using Rime’s TTS API in 60 seconds using the Rime CLI.

Prerequisites

  • A Rime account: Sign up free (you will log in through the CLI)
  • macOS or Linux (the CLI runs on both)

Step 1: Install the CLI

Pick your preferred installation method.
Shell script
curl -fsSL https://rime.ai/install-cli.sh | sh
Verify the installation:
rime --version
rime version 0.x.x
After installation, you may need to open a new terminal or run source ~/.zshrc (or ~/.bashrc) for the rime command to be available.

Step 2: Log in

rime login
This opens your browser to the Rime dashboard. Authenticate there, and the CLI saves your API key to ~/.rime/rime.toml automatically. Demo of the rime login command

Step 3: Hear your first voice

rime hello
Demo of the rime hello command

Synthesize your own text

Now that the CLI is set up, generate speech from any text:
rime tts "Hello from Rime." -s celeste -m arcana
Demo of the rime tts command This plays the audio directly. To save it to a file instead:
rime tts "Hey, how's it going?" -s celeste -m arcana -o welcome.wav
Play it back with waveform visualization:
rime play welcome.wav
Demo of the rime play command

Try different voices and models

Rime offers 94+ voices. Swap the --speaker flag to change the voice:
rime tts "The quick brown fox." -s orion -m arcana
rime tts "The quick brown fox." -s luna -m arcana
rime tts "The quick brown fox." -s peak -m mistv2 -f mp3
The mistv2 and mist models require --format mp3 (or -f mp3).

Generate a curl command

Need to integrate with the API directly? Generate a ready-to-use curl command:
rime curl "Hello from Rime" -s astra -m arcana
curl --request POST \
  --url 'https://users.rime.ai/v1/rime-tts' \
  --header 'Accept: audio/wav' \
  --header 'Authorization: Bearer $RIME_CLI_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "Hello from Rime",
  "speaker": "astra",
  "modelId": "arcana",
  "lang": "eng"
}'
# Tip: use --show-key or export RIME_CLI_API_KEY
Add --show-key to include your actual API key in the output, or --oneline for easy copy-paste.

Next steps