CLI Quickstart

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.

Step 3: Hear your first voice

rime hello

Synthesize your own text

Now that the CLI is set up, generate speech from any text:

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

This plays the audio directly. To save it to a file 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 offers 94+ voices. Swap the --speaker flag to change the voice:

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, mistv3, arcana, and arcanav2 output WAV by default. mistv2 and mist output MP3 by default. Use --format to override.

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 coda

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": "coda",
  "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

CLI Reference

Full command and flag reference

Voices

Browse all 94+ available voices

Models

Compare models: Coda, Arcana, Mist v3, Mist v2

TTS in Five Minutes

Use the API from Python or JavaScript

Introduction

Getting started

Voices & models

Customizing speech

Streaming & performance

Integrations

On-prem

Account & updates

Prerequisites

Step 1: Install the CLI

Step 2: Log in

Step 3: Hear your first voice

Synthesize your own text

Try different voices and models

Generate a curl command

Next steps

CLI Reference

Voices

Models

TTS in Five Minutes

​Prerequisites

​Step 1: Install the CLI

​Step 2: Log in

​Step 3: Hear your first voice

​Synthesize your own text

​Try different voices and models

​Generate a curl command

​Next steps

CLI Reference

Voices

Models

TTS in Five Minutes

Prerequisites

Step 1: Install the CLI

Step 2: Log in

Step 3: Hear your first voice

Synthesize your own text

Try different voices and models

Generate a curl command

Next steps