Reference - Rime Docs

Global flags (all commands)

Flag	Short	Default	Description
`--quiet`	`-q`	`false`	Suppress non-essential output
`--json`	—	`false`	Output results as JSON
`--env`	`-e`	—	Named environment to use from config
`--config`	`-c`	—	Path to a custom config file
`--version`	`-v`	—	Print version information
`--help`	`-h`	—	Help for any command

Environment variables

Variable	Description
`RIME_CLI_API_KEY`	API key for authentication (overrides the key in `rime.toml`)
`RIME_API_URL`	API endpoint URL (overrides the URL in `rime.toml`)
`RIME_AUTH_HEADER_PREFIX`	Authorization header prefix (default: `Bearer`)
`RIME_DASHBOARD_URL`	Dashboard URL for `rime login` (default: `https://app.rime.ai`)
`RIME_OPTIMIZE_URL`	Usage API endpoint for `rime usage` (default: `https://optimize.rime.ai`)
`RIME_INSTALL`	Install directory used by the shell installer (default: `~/.rime`)

Configuration

The CLI uses a TOML config file at ~/.rime/rime.toml. You can define multiple named environments for different API endpoints.

api_key = "your_api_key"
api_url = "https://users.rime.ai/v1/rime-tts"

[env.staging]
api_url = "https://staging.rime.ai/v1/rime-tts"

[env.onprem]
api_url = "https://rime.internal:8080/v1/rime-tts"
api_key = "different_key"
auth_header_prefix = "Api-Key"

Select an environment with the --env flag. This request goes to the staging URL and uses the top-level api_key, because staging doesn’t set its own:

rime tts "Hello" -s astra -m coda --env staging

Resolution order: Environment variables override config file values, which override defaults. Within the config file, named environment values override top-level values. A command’s --api-url flag overrides the URL from all of these.

Audio formats

Format	Extension	Default for	Notes
WAV	`.wav`	`coda`, `mistv3`	Uncompressed, higher quality, larger files
MP3	`.mp3`	None. Use `--format mp3`	Compressed, smaller files

Metadata embedding

Audio files saved by the CLI include embedded metadata (voice, model, text). This metadata is visible in rime play waveform output and in media players like Finder or Preview.

WAV files: LIST/INFO chunk (IART, INAM, ICMT)
MP3 files: ID3v2.3 tags (TPE1, TIT2, COMM)