Input Sources
string
File containing URLs to download (”-” for stdin), one URL per lineLines starting with ”#”, ”;” or ”]” are considered as comments and ignoredExample:
flag
default:"true"
Do not read URLs from batch file
Output Path Configuration
string
The paths where the files should be downloadedFormat:
[TYPES:]PATHSpecify the type of file and the path separated by a colon ”:”. All the same TYPES as --output are supported. Additionally, you can also provide “home” (default) and “temp” paths.All intermediary files are first downloaded to the temp path and then the final files are moved over to the home path after download is finished.This option is ignored if --output is an absolute path.Example:string
Output filename templateFormat:
[TYPES:]TEMPLATESee “OUTPUT TEMPLATE” for detailsExample:string
default:"NA"
Placeholder for unavailable fields in
--outputFilename Restrictions
flag
Restrict filenames to only ASCII characters, and avoid ”&” and spaces in filenames
flag
default:"true"
Allow Unicode characters, ”&” and spaces in filenames
flag
Force filenames to be Windows-compatible
flag
Sanitize filenames only minimally
number
Limit the filename length (excluding extension) to the specified number of charactersExample:
File Overwrite Behavior
flag
Do not overwrite any files
flag
Overwrite all video and metadata filesThis option includes
--no-continueflag
default:"true"
Do not overwrite the video, but overwrite related files
flag
default:"true"
Resume partially downloaded files/fragments
flag
Do not resume partially downloaded fragments. If the file is not fragmented, restart download of the entire file
flag
default:"true"
Use .part files instead of writing directly into output file
flag
Do not use .part files - write directly into output file
File Timestamps
flag
Use the Last-modified header to set the file modification time
flag
default:"true"
Do not use the Last-modified header to set the file modification time
Metadata Files
flag
Write video description to a .description file
flag
default:"true"
Do not write video description
flag
Write video metadata to a .info.json fileThis may contain personal information
flag
default:"true"
Do not write video metadata
flag
default:"true"
Write playlist metadata in addition to the video metadata when using
--write-info-json, --write-description etc.flag
Do not write playlist metadata when using
--write-info-json, --write-description etc.flag
default:"true"
Remove some internal metadata such as filenames from the infojson
flag
Write all fields to the infojson
Comments
flag
Retrieve video comments to be placed in the infojsonThe comments are fetched even without this option if the extraction is known to be quickAlias:
--get-commentsflag
Do not retrieve video comments unless the extraction is known to be quickAlias:
--no-get-commentsstring
JSON file containing the video information (created with the
--write-info-json option)Example:Cookies
string
Netscape formatted file to read cookies from and dump cookie jar inExample:
flag
default:"true"
Do not read/dump cookies from/to file
string
The name of the browser to load cookies fromFormat:
BROWSER[+KEYRING][:PROFILE][::CONTAINER]Supported browsers: brave, chrome, chromium, edge, firefox, opera, safari, vivaldi, whaleOptionally:- KEYRING used for decrypting Chromium cookies on Linux
- Name/path of the PROFILE to load cookies from
- CONTAINER name (if Firefox) (“none” for no container)
basictext, gnomekeyring, kwallet, kwallet5, kwallet6Example:flag
default:"true"
Do not load cookies from browser
Cache
string
Location in the filesystem where yt-dlp can store some downloaded information (such as client ids and signatures) permanentlyDefault:
${XDG_CACHE_HOME}/yt-dlpExample:flag
Disable filesystem caching
flag
Delete all filesystem cache files
Thumbnail Options
flag
Write thumbnail image to diskExample:
flag
default:"true"
Do not write thumbnail image to disk
flag
Write all thumbnail image formats to diskExample:
flag
List available thumbnails of each videoSimulate unless
--no-simulate is usedExample:Internet Shortcut Options
flag
Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop)The URL may be cached by the OSExample:
flag
Write a .url Windows internet shortcutThe OS caches the URL based on the file path
flag
Write a .webloc macOS internet shortcut
flag
Write a .desktop Linux internet shortcut