CLI Quickstart

Install the Rime CLI and synthesize your first audio clip from the terminal.

In about a minute, you’ll hear a Rime voice in your terminal. The Rime CLI handles sign-in and playback, so you can try voices before you write any code.

Prerequisites

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

Step 1: Install the CLI

Install the CLI with Rime’s installation script:

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 opens the Rime dashboard in your browser. After you authenticate, the CLI saves your API key to ~/.rime/rime.toml:

rime login

Step 3: Hear your first voice

Run the built-in sample:

rime hello

Hearing speech confirms that the CLI can authenticate and reach the TTS API.

Synthesize your own text

rime tts sends your text to the voice (-s) and model (-m) you choose. This command reads “Hello from Rime.” in the celeste voice on Coda:

rime tts "Hello from Rime." -s celeste -m coda

This plays the audio directly. Add -o to save it to a file you can replay or share instead:

rime tts "Hey, how's it going?" -s celeste -m coda -o welcome.wav

Play it back with waveform visualization:

rime play welcome.wav

Try different voices and models

Rime has 287 Coda voices and more than 500 across the full model lineup. Swap the --speaker flag to change the voice. These commands keep the sentence the same, so you hear only what the voice and model change:

rime tts "The quick brown fox." -s orion -m coda
rime tts "The quick brown fox." -s luna -m coda
rime tts "The quick brown fox." -s peak -m mistv3
rime tts "The quick brown fox." -s peak -m mistv2

coda and mistv3 output WAV by default. mistv2 and mist output MP3 by default. Use --format to override.

Generate a curl command

When you’re ready to call the API from your own code, rime curl prints the HTTP request behind a rime tts command:

rime curl "Hello from Rime" -s astra -m coda

The CLI prints a cURL command like this:

curl --request POST \
  --url 'https://users.rime.ai/v1/rime-tts' \
  --header 'Accept: audio/wav' \
  --header "Authorization: Bearer $(rime key)" \
  --header 'Content-Type: application/json' \
  --output 'output.wav' \
  --fail \
  --data '{
  "text": "Hello from Rime",
  "speaker": "astra",
  "modelId": "coda",
  "lang": "eng"
}'

The generated command resolves your saved key at execution time with rime key, so it does not print the key. Add --oneline for single-line output.

CLI and API references

CLI Reference

Full command and flag reference

Voices

Browse the current voice catalog

Models

Compare Coda, Mist v3, and Mist v2

TTS in Five Minutes

Use the API from Python or JavaScript