Command Line Reference

Streamrip Command Line Reference

Table of Contents

1. Basic Syntax
2. Global Options
3. Core Commands
   • url
   • file
   • search
   • lastfm
   • id
4. Configuration Management
5. Database Operations
6. Examples
7. Exit Codes

---

Basic Syntax

rip [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS] [ARGUMENTS]

---

Global Options

These options apply to all commands:

Option	Description	Values
--config-path PATH	Custom config file location	Path string (default: ~/.config/streamrip/config.toml)
-f, --folder PATH	Override download directory	Valid filesystem path
-ndb, --no-db	Ignore download history	Boolean flag
-q, --quality INT	Audio quality level	0 (low) to 4 (best)
-c, --codec CODEC	Convert downloaded files	FLAC, ALAC, MP3, AAC, OGG
--no-progress	Disable progress bars	Boolean flag
--no-ssl-verify	Disable SSL verification	Boolean flag
-v, --verbose	Enable debug logging	Boolean flag
--version	Show version	Boolean flag

---

Core Commands

url

Download content from direct URLs

Syntax:

rip url URL1 [URL2...]

Examples:

rip url https://qobuz.com/album/123
rip url https://tidal.com/track/456 https://deezer.com/album/789

---

file

Batch download from a file containing URLs

Syntax:

rip file PATH

File Formats:

• Plain text (one URL per line)
• JSON array (with source, media_type, and id fields)

Examples:

rip file ~/downloads/url_list.txt
rip file queue.json

---

search

Interactive music search

Syntax:

rip search SOURCE MEDIA_TYPE "QUERY"

Supported Sources:

• qobuz
• tidal
• deezer
• soundcloud

Media Types:

Type	Description	Example
album	Full albums	search tidal album "Thriller"
track	Single tracks	search deezer track "Blinding Lights"
artist	Artist discography	search qobuz artist "Daft Punk"
playlist	Curated playlists	search soundcloud playlist "Chill Vibes"
label	Record label catalog	search tidal label "Motown"
chart	Top charts	search deezer chart "Top 50"

Options:

Option	Description
-f, --first	Auto-download first result
-o, --output-file PATH	Save results to file
-n, --num-results INT	Limit results (default: 100)

---

lastfm

Download from last.fm playlists

Syntax:

rip lastfm [OPTIONS] URL

Options:

Option	Description
-s, --source SOURCE	Primary download source
-fs, --fallback-source SOURCE	Fallback source

Example:

rip lastfm -s deezer -fs tidal https://last.fm/user/username/playlists/123

---

id

Download by service-specific ID

Syntax:

rip id SOURCE MEDIA_TYPE ID

Example:

rip id qobuz album 123456789

---

Configuration Management

Commands

Command	Description
rip config open	Edit config file
rip config reset	Reset to defaults
rip config path	Show config location

Options:

Option	Description
-v, --vim	Use Vim/Neovim for editing

---

Database Operations

Commands

Command	Description
rip database browse downloads	View download history
rip database browse failed	View failed downloads

---

Examples

Quality/Format Conversion

rip -q 4 -c FLAC url https://tidal.com/album/123  # Best quality FLAC
rip -q 2 -c MP3 search deezer track "Dance Song" # 320kbps MP3

Headless Operation

rip --no-progress -f file batch.txt  # Silent batch processing

Debugging

rip -v --no-ssl-verify url https://problematic.url  # Debug SSL issues

---

Exit Codes

Code	Meaning
0	Success
1	General error
2	Invalid arguments
3	Config error
4	Network error
5	Authentication failure