You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -109,10 +109,12 @@ For a list of all **options** use ```spotdl -h```
109
109
`spotdl save [query] --save-file {filename}.spotdl`
110
110
111
111
- `web`: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading single songs.
112
+
- Usage:
113
+
`spotdl web`
112
114
113
115
- `url`: Get direct download link for each song from the query.
114
116
- Usage:
115
-
`spotdl web [query]`
117
+
`spotdl url [query]`
116
118
117
119
- `sync`: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.
Copy file name to clipboardExpand all lines: docs/usage.md
+43-33
Original file line number
Diff line number
Diff line change
@@ -97,6 +97,14 @@
97
97
spotdl download all-user-playlists --user-auth
98
98
```
99
99
100
+
??? info "All user saved albums"
101
+
To download all user saved albums run
102
+
> `--user-auth` is required
103
+
104
+
```bash
105
+
spotdl download all-user-saved-albums --user-auth
106
+
```
107
+
100
108
You can queue up multiple download tasks by separating the arguments with spaces
101
109
102
110
```bash
@@ -127,12 +135,16 @@ YouTube Music Premium users can use their account to download songs with a highe
127
135
128
136
To download music in higher quality follow the steps below:
129
137
130
-
1. Get cookies.txt for https://music.youtube.com.
138
+
1. Change quality in YouTube Music settings to highest possible.
139
+
140
+
2. Get cookies.txt for https://music.youtube.com.
131
141
> You can use [Get cookies.txt extension](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc) or [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/) for this. More info [here](https://github.com/yt-dlp/yt-dlp/wiki/FAQ#how-do-i-pass-cookies-to-yt-dlp)
132
142
133
-
2. Add `--cookie-file cookies.txt` option to your spotDL command line options
143
+
3. Add `--cookie-file cookies.txt` option to your spotDL command line options
134
144
> Replace cookies.txt with the actual name of your cookies file
135
145
146
+
4. Change the audio format to either **M4A** or **OPUS** to get the raw HQ file
147
+
136
148
> **Note**
137
149
> To get the best audio possible you should use **M4A**/**OPUS** audio format
138
150
> with `--bitrate disable`
@@ -353,7 +365,7 @@ Main options:
353
365
(ie. 'album:the album name' you can mix these options to get more accurate results).
354
366
355
367
To download liked songs use 'saved' as the query, to download all user playlists
356
-
use 'all-user-playlists, to download all songs from all followed artists use 'all-user-followed-artists'
368
+
use 'all-user-playlists, to download all songs from all followed artists use 'all-user-followed-artists', to download all user saved albums use 'all-user-saved-albums'
357
369
358
370
For manual audio matching, you can use the format 'YouTubeURL|SpotifyURL'
359
371
You can only use album/playlist/tracks urls when downloading/matching youtube urls.
The lyrics provider to use. You can provide more than one for fallback. Synced lyrics might not work correctly with
366
-
some music players. For such cases it's better to use `--generate-lrc` option.
367
-
--config Use the config file to download songs. It's located under C:\Users\user\.spotdl\config.json or
368
-
~/.spotdl/config.json under linux
377
+
The lyrics provider to use. You can provide more than one for fallback. Synced lyrics might not work correctly with some music players. For such cases it's better to use `--generate-lrc`
378
+
option.
379
+
--config Use the config file to download songs. It's located under C:\Users\user\.spotdl\config.json or ~/.spotdl/config.json under linux
369
380
--search-query SEARCH_QUERY
370
-
The search query to use, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre},
The maximum number of retries to perform when getting metadata.
391
401
--headless Run in headless mode.
392
-
--use-cache-file Use the cache file to get metadata. It's located under C:\Users\user\.spotdl\.spotify_cache or
393
-
~/.spotdl/.spotify_cache under linux. It only caches tracks and gets updated whenever spotDL gets metadata from
394
-
Spotify. (It may provide outdated metadata use with caution)
402
+
--use-cache-file Use the cache file to get metadata. It's located under C:\Users\user\.spotdl\.spotify_cache or ~/.spotdl/.spotify_cache under linux. It only caches tracks and gets updated whenever spotDL gets
403
+
metadata from Spotify. (It may provide outdated metadata use with caution)
395
404
396
405
FFmpeg options:
397
406
--ffmpeg FFMPEG The ffmpeg executable to use.
398
407
--threads THREADS The number of threads to use when downloading songs.
The constant/variable bitrate to use for the output file. Values from 0 to 9 are variable bitrates. Auto will use
401
-
the bitrate of the original file. Disable will disable the bitrate option. (In case of m4a and opus files, auto and
402
-
disable will skip the conversion)
409
+
The constant/variable bitrate to use for the output file. Values from 0 to 9 are variable bitrates. Auto will use the bitrate of the original file. Disable will disable the bitrate option. (In
410
+
case of m4a and opus files, auto and disable will skip the conversion)
403
411
--ffmpeg-args FFMPEG_ARGS
404
412
Additional ffmpeg arguments passed as a string.
405
413
406
414
Output options:
407
415
--format {mp3,flac,ogg,opus,m4a,wav}
408
416
The format to download the song in.
409
417
--save-file SAVE_FILE
410
-
The file to save/load the songs data from/to. It has to end with .spotdl. If combined with the download operation,
411
-
it will save the songs data to the file. Required for save/sync (use - to print to stdout when using save).
418
+
The file to save/load the songs data from/to. It has to end with .spotdl. If combined with the download operation, it will save the songs data to the file. Required for save/sync (use - to
419
+
print to stdout when using save).
412
420
--preload Preload the download url to speed up the download process.
413
-
--output OUTPUT Specify the downloaded file name format, available variables: {title}, {artists}, {artist}, {album}, {album-
--m3u [M3U] Name of the m3u file to save the songs to. Defaults to {list[0]}.m3u8 If you want to generate a m3u for each list in the query use {list}, If you want to generate a m3u file based on the first
424
+
list in the query use {list[0]}, (0 is the first list in the query, 1 is the second, etc. songs don't count towards the list number)
419
425
--cookie-file COOKIE_FILE
420
426
Path to cookies file.
421
427
--overwrite {skip,force,metadata}
422
-
How to handle existing/duplicate files. (When combined with --scan-for-songs force will remove all duplicates, and
423
-
metadata will only apply metadata to the latest song and will remove the rest. )
428
+
How to handle existing/duplicate files. (When combined with --scan-for-songs force will remove all duplicates, and metadata will only apply metadata to the latest song and will remove the
429
+
rest. )
424
430
--restrict [{ascii,strict,none}]
425
431
Restrict filenames to a sanitized set of characters for better compatibility
426
432
--print-errors Print errors (wrong songs, failed downloads etc) on exit, useful for long playlist
@@ -429,9 +435,8 @@ Output options:
429
435
--sponsor-block Use the sponsor block to download songs from yt/ytm.
430
436
--archive ARCHIVE Specify the file name for an archive of already downloaded songs
431
437
--playlist-numbering Sets each track in a playlist to have the playlist's name as its album, and album art as the playlist's icon
432
-
--scan-for-songs Scan the output directory for existing files. This option should be combined with the --overwrite option to control
433
-
how existing files are handled. (Output directory is the last directory that is not a template variable in the
434
-
output template)
438
+
--scan-for-songs Scan the output directory for existing files. This option should be combined with the --overwrite option to control how existing files are handled. (Output directory is the last directory that
439
+
is not a template variable in the output template)
435
440
--fetch-albums Fetch all albums from songs in query
436
441
--id3-separator ID3_SEPARATOR
437
442
Change the separator used in the id3 tags. Only supported for mp3 files.
Detect already downloaded songs with file format different from the --format option (When combined with --m3u
451
-
option, only first detected format will be added to m3u file)
455
+
Detect already downloaded songs with file format different from the --format option (When combined with --m3u option, only first detected format will be added to m3u file)
456
+
--redownload to redownload the local song in diffrent format using --format for meta operation
457
+
--ignore-albums [IGNORE_ALBUMS ...]
458
+
ignores the song of the given albums
459
+
--skip-explicit Skip explicit songs
460
+
--proxy PROXY Http(s) proxy server for download song. Example: http://host:port
452
461
453
462
Web options:
454
463
--host HOST The host to use for the web server.
455
464
--port PORT The port to run the web server on.
456
465
--keep-alive Keep the web server alive even when no clients are connected.
457
466
--allowed-origins [ALLOWED_ORIGINS ...]
458
467
The allowed origins for the web server.
459
-
--web-use-output-dir Use the output directory instead of the session directory for downloads. (This might cause issues if you have
460
-
multiple users using the web-ui at the same time)
468
+
--web-use-output-dir Use the output directory instead of the session directory for downloads. (This might cause issues if you have multiple users using the web-ui at the same time)
461
469
--keep-sessions Keep the session directory after the web server is closed.
0 commit comments