Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@xnetcat
xnetcat committed Aug 24, 2024
1 parent 5afd989 commit 7e8a852
Showing 1 changed file with 48 additions and 28 deletions.
76 changes: 48 additions & 28 deletions docs/usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,14 +260,15 @@ If you don't want config to load automatically change `load_config` option in co

```json
{
"client_id": "5f573c9620494bae87890c0f08a60293",
"client_secret": "212476d9b0f3472eaa762d90b19b0ba8",
"client_id": "f8a606e5583643beaa27ce62c48e3fc1",
"client_secret": "f6f4c8f73f0649939286cf417c811607",
"auth_token": null,
"user_auth": false,
"headless": false,
"cache_path": "/Users/username/.spotdl/.spotipy",
"no_cache": false,
"max_retries": 3,
"use_cache_file": false,
"audio_providers": [
"youtube-music"
],
Expand Down Expand Up @@ -305,18 +306,33 @@ If you don't want config to load automatically change `load_config` option in co
"add_unavailable": false,
"generate_lrc": false,
"force_update_metadata": false,
"only_verified_results": false,
"sync_without_deleting": false,
"max_filename_length": null,
"yt_dlp_args": null,
"detect_formats": null,
"save_errors": null,
"ignore_albums": null,
"proxy": null,
"skip_explicit": false,
"log_format": null,
"redownload": false,
"skip_album_art": false,
"create_skip_file": false,
"respect_skip_file": false,
"web_use_output_dir": false,
"port": 8800,
"host": "localhost",
"keep_alive": false,
"enable_tls": false,
"key_file": null,
"cert_file":null,
"ca_file":null,
"cert_file": null,
"ca_file": null,
"allowed_origins": null,
"keep_sessions": false,
"only_verified_results": false,
"skip_album_art": false
"force_update_gui": false,
"web_gui_repo": null,
"web_gui_location": null
}
```

Expand Down Expand Up @@ -382,15 +398,17 @@ Main options:
--audio [{youtube,youtube-music,slider-kz,soundcloud,bandcamp,piped} ...]
The audio provider to use. You can provide more than one for fallback.
--lyrics [{genius,musixmatch,azlyrics,synced} ...]
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` option.
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` option.
--genius-access-token GENIUS_TOKEN
Lets you choose your own Genius access token.
--config Use the config file to download songs. It's located under C:\Users\user\.spotdl\config.json or ~/.spotdl/config.json under linux
--search-query SEARCH_QUERY
The search query to use, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre}, {disc-number}, {disc-count}, {duration}, {year}, {original-
date}, {track-number}, {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
The search query to use, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre}, {disc-number}, {disc-count}, {duration}, {year},
{original-date}, {track-number}, {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
--dont-filter-results
Disable filtering results.
--album-type {album,single}
--album-type {single,album}
Type of the album to search for. (album, single)
--only-verified-results
Use only verified results. (Not all providers support this)
Expand All @@ -409,44 +427,44 @@ Spotify options:
--max-retries MAX_RETRIES
The maximum number of retries to perform when getting metadata.
--headless Run in headless mode.
--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 metadata from Spotify. (It may provide outdated metadata use with caution)
--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 metadata from Spotify. (It may provide outdated metadata use with caution)
FFmpeg options:
--ffmpeg FFMPEG The ffmpeg executable to use.
--threads THREADS The number of threads to use when downloading songs.
--bitrate {auto,disable,8k,16k,24k,32k,40k,48k,64k,80k,96k,112k,128k,160k,192k,224k,256k,320k,0,1,2,3,4,5,6,7,8,9}
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 case of m4a and opus files, auto and disable will skip the conversion)
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 case of m4a and opus files, auto and disable will skip the conversion)
--ffmpeg-args FFMPEG_ARGS
Additional ffmpeg arguments passed as a string.
Output options:
--format {mp3,flac,ogg,opus,m4a,wav}
The format to download the song in.
--save-file SAVE_FILE
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 print to stdout when using save).
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 print to stdout when using save).
--preload Preload the download url to speed up the download process.
--output OUTPUT Specify the downloaded file name format, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre}, {disc-number}, {disc-count}, {duration},
{year}, {original-date}, {track-number}, {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
--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 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)
--output OUTPUT Specify the downloaded file name format, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre}, {disc-number}, {disc-count},
{duration}, {year}, {original-date}, {track-number}, {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
--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 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)
--cookie-file COOKIE_FILE
Path to cookies file.
--overwrite {skip,force,metadata}
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 rest. )
--restrict [{none,strict,ascii}]
--overwrite {skip,metadata,force}
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 rest. )
--restrict [{strict,ascii,none}]
Restrict filenames to a sanitized set of characters for better compatibility
--print-errors Print errors (wrong songs, failed downloads etc) on exit, useful for long playlist
--save-errors SAVE_ERRORS
Save errors (wrong songs, failed downloads etc) to a file
--sponsor-block Use the sponsor block to download songs from yt/ytm.
--archive ARCHIVE Specify the file name for an archive of already downloaded songs
--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
--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 is not a template variable in the output template)
--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 is not a template variable in the output template)
--fetch-albums Fetch all albums from songs in query
--id3-separator ID3_SEPARATOR
Change the separator used in the id3 tags. Only supported for mp3 files.
Expand All @@ -462,7 +480,8 @@ Output options:
--yt-dlp-args YT_DLP_ARGS
Arguments to pass to yt-dlp
--detect-formats [{mp3,flac,ogg,opus,m4a,wav} ...]
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)
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)
--redownload to redownload the local song in diffrent format using --format for meta operation
--skip-album-art skip downloading album art for meta operation
--ignore-albums [IGNORE_ALBUMS ...]
Expand All @@ -471,6 +490,7 @@ Output options:
--proxy PROXY Http(s) proxy server for download song. Example: http://host:port
--create-skip-file Create skip file for successfully downloaded file
--respect-skip-file If a file with the extension .skip exists, skip download
--sync-remove-lrc Remove lrc files when using sync operation when downloading songs
Web options:
--host HOST The host to use for the web server.
Expand Down

0 comments on commit 7e8a852

Please sign in to comment.