> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rime.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://app.rime.ai/signup/) (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:

```bash Shell script theme={null}
curl -fsSL https://rime.ai/install-cli.sh | sh
```

Verify the installation:

```bash theme={null}
rime --version
```

```
rime version 0.x.x
```

> [!NOTE]
>
> 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`:

```bash theme={null}
rime login
```

![Terminal output of rime login: the Rime logo, then the browser sign-in and a success message](https://mintcdn.com/rimelabs/cvCzifeU8wUWloFB/images/cli/rime-login.png?fit=max\&auto=format\&n=cvCzifeU8wUWloFB\&q=85\&s=9b661d3ebf25f9e971602374edb097f0)

## Step 3: Hear your first voice

Run the built-in sample:

```bash theme={null}
rime hello
```

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

![Terminal output of rime hello: the Rime logo, then the Vespera greeting playing on Coda](https://mintcdn.com/rimelabs/cvCzifeU8wUWloFB/images/cli/rime-hello.png?fit=max\&auto=format\&n=cvCzifeU8wUWloFB\&q=85\&s=340cbed60b1a69fba88f65d36165e18e)

## Synthesize your own text

`rime tts` sends your text to the voice (`-s`) and model (`-m`) you choose. This command reads a short sentence in the `vespera` voice on Coda:

```bash theme={null}
rime tts "Hey, you're all set. Let's build something cool." -s vespera -m coda
```

![Terminal output of rime tts with the vespera voice on Coda](https://mintcdn.com/rimelabs/cvCzifeU8wUWloFB/images/cli/rime-tts.png?fit=max\&auto=format\&n=cvCzifeU8wUWloFB\&q=85\&s=5e63aac6a295ad9b324beed64648f4ac)

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

```bash theme={null}
rime tts "Hey, you're all set. Let's build something cool." -s vespera -m coda -o welcome.wav
```

Play it back with waveform visualization:

```bash theme={null}
rime play welcome.wav
```

![Demo of the rime play command](https://mintcdn.com/rimelabs/hWWUVCw6mopaejUP/images/cli/play-demo.gif?s=e44d36ef9a0370a457524b6e6a60c66c)

## Try different voices and models

Rime has 313 Coda voices and 78 Mist v3 voices. 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:

```bash theme={null}
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
```

> [!NOTE]
>
> `coda` and `mistv3` output WAV by default. Use `--format mp3` for MP3.

## 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:

```bash theme={null}
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"
}'
```

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

> [card] [CLI Reference](https://docs.rime.ai/docs/cli-reference.md)
>
> Full command and flag reference

> [card] [Voices](https://docs.rime.ai/docs/voices.md)
>
> Browse the current voice catalog

> [card] [Models](https://docs.rime.ai/docs/models.md)
>
> Compare Coda and Mist v3

> [card] [TTS in Five Minutes](https://docs.rime.ai/docs/quickstart-five-minute.md)
>
> Use the API from Python or JavaScript


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.