Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions cli-reference/changelog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Changelog
description: Release notes for the Rime CLI.
icon: list
---

Use [`rime upgrade`](/cli-reference/reference#upgrade) to update to the latest version, or [`rime changelog`](/cli-reference/reference#changelog) to view this in the terminal.

<Update label="v0.5.0 — March 25, 2026">
- `upgrade` command for self-updating the CLI (`rime upgrade`)
- `changelog` command to view release notes in the terminal (`rime changelog --since v0.4.0`)
- Background update checker — notifies you on stderr when a newer version is available
- Semantic ANSI colors for better terminal theme compatibility
- `--days` flag on `rime usage`
- `speedtest` UX improvements and `default_env` config option
</Update>

<Update label="v0.4.0 — March 12, 2026">
- Simplified waveform display in `tts` and `play`
- Updated `hello` command to use Vespera voice
</Update>

<Update label="v0.3.0 — March 4, 2026">
- Animated and truncated text for long utterances in `tts` and `play`
- `config` subcommands: `add`, `list`, `show`, `rm`, `edit`, `default`
- `key` command to display the current API key
- Additional flags for `speedtest`: `--speaker`, `--lang`, `--text`
</Update>

<Update label="v0.2.0 — February 27, 2026">
- `usage` command for viewing API usage history
- Model-specific TTS parameters (`--temperature`, `--top-p`, `--repetition-penalty`, etc.)
- Improved `curl` command options
- Rime unicode logo in terminal output
</Update>

<Update label="v0.1.0 — February 20, 2026">
- Initial release (renamed from cli-go)
- Core commands: `tts`, `play`, `curl`, `login`, `logout`, `config`, `speedtest`
</Update>
8 changes: 8 additions & 0 deletions cli-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ icon: "house"

The Rime CLI is a command-line tool for synthesizing and listening to AI speech. It supports streaming audio generation, live playback with waveform visualization, and multiple output formats.

Current version: **v0.5.0** — [see changelog](/cli-reference/changelog)

## Installation

<CodeGroup>
Expand Down Expand Up @@ -42,4 +44,10 @@ brew tap rimelabs/rime-cli && brew install rime-cli
<Card title="Troubleshooting" icon="circle-exclamation" href="/cli-reference/troubleshooting">
Fix common errors and installation issues
</Card>
<Card title="rime upgrade" icon="arrow-up" href="/cli-reference/reference#upgrade">
Update the CLI to the latest version
</Card>
<Card title="Changelog" icon="list" href="/cli-reference/changelog">
Release notes and version history
</Card>
</CardGroup>
6 changes: 6 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
"cli-reference/rime-monitoring"
]
},
{
"group": "Changelog",
"pages": [
"cli-reference/changelog"
]
},
{
"group": "Reference",
"pages": [
Expand Down