API tools faq
paste
PrimePastes

YouTube-DLP Commands

PrimePastes
Oct 13th, 2023
41
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 129.07 KB | None | 0 0
raw download clone embed print report
  1. YOUTUBE-DLP COMMANDS:
  2.  
  3. NEW FEATURES
  4. Forked from yt-dlc@f9401f2 and merged with youtube-dl@66ab08 (exceptions)
  5.  
  6. SponsorBlock Integration: You can mark/remove sponsor sections in YouTube videos by utilizing the SponsorBlock API
  7.  
  8. Format Sorting: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using -S. This allows for much easier format selection than what is possible by simply using --format (examples)
  9.  
  10. Merged with animelover1984/youtube-dl: You get most of the features and improvements from animelover1984/youtube-dl including --write-comments, BiliBiliSearch, BilibiliChannel, Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that NicoNico livestreams are not available. See #31 for details.
  11.  
  12. YouTube improvements:
  13.  
  14. Supports Clips, Stories (ytstories:<channel UCID>), Search (including filters)*, YouTube Music Search, Channel-specific search, Search prefixes (ytsearch:, ytsearchdate:)*, Mixes, and Feeds (:ytfav, :ytwatchlater, :ytsubs, :ythistory, :ytrec, :ytnotif)
  15. Fix for n-sig based throttling *
  16. Supports some (but not all) age-gated content without cookies
  17. Download livestreams from the start using --live-from-start (experimental)
  18. Channel URLs download all uploads of the channel, including shorts and live
  19. Cookies from browser: Cookies can be automatically extracted from all major web browsers using --cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]
  20.  
  21. Download time range: Videos can be downloaded partially based on either timestamps or chapters using --download-sections
  22.  
  23. Split video by chapters: Videos can be split into multiple files based on chapters using --split-chapters
  24.  
  25. Multi-threaded fragment downloads: Download multiple fragments of m3u8/mpd videos in parallel. Use --concurrent-fragments (-N) option to set the number of threads used
  26.  
  27. Aria2c with HLS/DASH: You can use aria2c as the external downloader for DASH(mpd) and HLS(m3u8) formats
  28.  
  29. New and fixed extractors: Many new extractors have been added and a lot of existing ones have been fixed. See the changelog or the list of supported sites
  30.  
  31. New MSOs: Philo, Spectrum, SlingTV, Cablevision, RCN etc.
  32.  
  33. Subtitle extraction from manifests: Subtitles can be extracted from streaming media manifests. See commit/be6202f for details
  34.  
  35. Multiple paths and output templates: You can give different output templates and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to using --paths (-P)
  36.  
  37. Portable Configuration: Configuration files are automatically loaded from the home and root directories. See CONFIGURATION for details
  38.  
  39. Output template improvements: Output templates can now have date-time formatting, numeric offsets, object traversal etc. See output template for details. Even more advanced operations can also be done with the help of --parse-metadata and --replace-in-metadata
  40.  
  41. Other new options: Many new options have been added such as --alias, --print, --concat-playlist, --wait-for-video, --retry-sleep, --sleep-requests, --convert-thumbnails, --force-download-archive, --force-overwrites, --break-match-filter etc
  42.  
  43. Improvements: Regex and other operators in --format/--match-filter, multiple --postprocessor-args and --downloader-args, faster archive checking, more format selection options, merge multi-video/audio, multiple --config-locations, --exec at different stages, etc
  44.  
  45. Plugins: Extractors and PostProcessors can be loaded from an external file. See plugins for details
  46.  
  47. Self updater: The releases can be updated using yt-dlp -U, and downgraded using --update-to if required
  48.  
  49. Nightly builds: Automated nightly builds can be used with --update-to nightly
  50.  
  51. See changelog or commits for the full list of changes
  52.  
  53. Features marked with a * have been back-ported to youtube-dl
  54.  
  55. Differences in default behavior
  56. Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
  57.  
  58. yt-dlp supports only Python 3.7+, and may remove support for more versions as they become EOL; while youtube-dl still supports Python 2.6+ and 3.2+
  59. The options --auto-number (-A), --title (-t) and --literal (-l), no longer work. See removed options for details
  60. avconv is not supported as an alternative to ffmpeg
  61. yt-dlp stores config files in slightly different locations to youtube-dl. See CONFIGURATION for a list of correct locations
  62. The default output template is %(title)s [%(id)s].%(ext)s. There is no real reason for this change. This was changed before yt-dlp was ever made public and now there are no plans to change it back to %(title)s-%(id)s.%(ext)s. Instead, you may use --compat-options filename
  63. The default format sorting is different from youtube-dl and prefers higher resolution and better codecs rather than higher bitrates. You can use the --format-sort option to change this to any order you prefer, or use --compat-options format-sort to use youtube-dl's sorting order
  64. The default format selector is bv*+ba/b. This means that if a combined video + audio format that is better than the best video-only format is found, the former will be preferred. Use -f bv+ba/b or --compat-options format-spec to revert this
  65. Unlike youtube-dlc, yt-dlp does not allow merging multiple audio/video streams into one file by default (since this conflicts with the use of -f bv*+ba). If needed, this feature must be enabled using --audio-multistreams and --video-multistreams. You can also use --compat-options multistreams to enable both
  66. --no-abort-on-error is enabled by default. Use --abort-on-error or --compat-options abort-on-error to abort on errors instead
  67. When writing metadata files such as thumbnails, description or infojson, the same information (if available) is also written for playlists. Use --no-write-playlist-metafiles or --compat-options no-playlist-metafiles to not write these files
  68. --add-metadata attaches the infojson to mkv files in addition to writing the metadata when used with --write-info-json. Use --no-embed-info-json or --compat-options no-attach-info-json to revert this
  69. Some metadata are embedded into different fields when using --add-metadata as compared to youtube-dl. Most notably, comment field contains the webpage_url and synopsis contains the description. You can use --parse-metadata to modify this to your liking or use --compat-options embed-metadata to revert this
  70. playlist_index behaves differently when used with options like --playlist-reverse and --playlist-items. See #302 for details. You can use --compat-options playlist-index if you want to keep the earlier behavior
  71. The output of -F is listed in a new format. Use --compat-options list-formats to revert this
  72. Live chats (if available) are considered as subtitles. Use --sub-langs all,-live_chat to download all subtitles except live chat. You can also use --compat-options no-live-chat to prevent any live chat/danmaku from downloading
  73. YouTube channel URLs download all uploads of the channel. To download only the videos in a specific tab, pass the tab's URL. If the channel does not show the requested tab, an error will be raised. Also, /live URLs raise an error if there are no live videos instead of silently downloading the entire channel. You may use --compat-options no-youtube-channel-redirect to revert all these redirections
  74. Unavailable videos are also listed for YouTube playlists. Use --compat-options no-youtube-unavailable-videos to remove this
  75. The upload dates extracted from YouTube are in UTC when available. Use --compat-options no-youtube-prefer-utc-upload-date to prefer the non-UTC upload date.
  76. If ffmpeg is used as the downloader, the downloading and merging of formats happen in a single step when possible. Use --compat-options no-direct-merge to revert this
  77. Thumbnail embedding in mp4 is done with mutagen if possible. Use --compat-options embed-thumbnail-atomicparsley to force the use of AtomicParsley instead
  78. Some internal metadata such as filenames are removed by default from the infojson. Use --no-clean-infojson or --compat-options no-clean-infojson to revert this
  79. When --embed-subs and --write-subs are used together, the subtitles are written to disk and also embedded in the media file. You can use just --embed-subs to embed the subs and automatically delete the separate file. See #630 (comment) for more info. --compat-options no-keep-subs can be used to revert this
  80. certifi will be used for SSL root certificates, if installed. If you want to use system certificates (e.g. self-signed), use --compat-options no-certifi
  81. yt-dlp's sanitization of invalid characters in filenames is different/smarter than in youtube-dl. You can use --compat-options filename-sanitization to revert to youtube-dl's behavior
  82. yt-dlp tries to parse the external downloader outputs into the standard progress output if possible (Currently implemented: aria2c). You can use --compat-options no-external-downloader-progress to get the downloader output as-is
  83. yt-dlp versions between 2021.09.01 and 2023.01.02 applies --match-filter to nested playlists. This was an unintentional side-effect of 8f18ac and is fixed in d7b460. Use --compat-options playlist-match-filter to revert this
  84. yt-dlp uses modern http client backends such as requests. Use --compat-options prefer-legacy-http-handler to prefer the legacy http handler (urllib) to be used for standard http requests.
  85. For ease of use, a few more compat options are available:
  86.  
  87. --compat-options all: Use all compat options (Do NOT use)
  88. --compat-options youtube-dl: Same as --compat-options all,-multistreams,-playlist-match-filter
  89. --compat-options youtube-dlc: Same as --compat-options all,-no-live-chat,-no-youtube-channel-redirect,-playlist-match-filter
  90. --compat-options 2021: Same as --compat-options 2022,no-certifi,filename-sanitization,no-youtube-prefer-utc-upload-date
  91. --compat-options 2022: Same as --compat-options playlist-match-filter,no-external-downloader-progress,prefer-legacy-http-handler. Use this to enable all future compat options
  92. INSTALLATION
  93. Windows Unix MacOS PyPi Source Tarball Other variants All versions
  94.  
  95. You can install yt-dlp using the binaries, pip or one using a third-party package manager. See the wiki for detailed instructions
  96.  
  97. UPDATE
  98. You can use yt-dlp -U to update if you are using the release binaries
  99.  
  100. If you installed with pip, simply re-run the same command that was used to install the program
  101.  
  102. For other third-party package managers, see the wiki or refer their documentation
  103.  
  104. There are currently two release channels for binaries, stable and nightly. stable is the default channel, and many of its changes have been tested by users of the nightly channel. The nightly channel has releases built after each push to the master branch, and will have the most recent fixes and additions, but also have more risk of regressions. They are available in their own repo.
  105.  
  106. When using --update/-U, a release binary will only update to its current channel. --update-to CHANNEL can be used to switch to a different channel when a newer version is available. --update-to [CHANNEL@]TAG can also be used to upgrade or downgrade to specific tags from a channel.
  107.  
  108. You may also use --update-to <repository> (<owner>/<repository>) to update to a channel on a completely different repository. Be careful with what repository you are updating to though, there is no verification done for binaries from different repositories.
  109.  
  110. Example usage:
  111.  
  112. yt-dlp --update-to nightly change to nightly channel and update to its latest release
  113. yt-dlp --update-to stable@2023.02.17 upgrade/downgrade to release to stable channel tag 2023.02.17
  114. yt-dlp --update-to 2023.01.06 upgrade/downgrade to tag 2023.01.06 if it exists on the current channel
  115. yt-dlp --update-to example/yt-dlp@2023.03.01 upgrade/downgrade to the release from the example/yt-dlp repository, tag 2023.03.01
  116. RELEASE FILES
  117. Recommended
  118. File Description
  119. yt-dlp Platform-independent zipimport binary. Needs Python (recommended for Linux/BSD)
  120. yt-dlp.exe Windows (Win7 SP1+) standalone x64 binary (recommended for Windows)
  121. yt-dlp_macos Universal MacOS (10.15+) standalone executable (recommended for MacOS)
  122. Alternatives
  123. File Description
  124. yt-dlp_x86.exe Windows (Vista SP2+) standalone x86 (32-bit) binary
  125. yt-dlp_min.exe Windows (Win7 SP1+) standalone x64 binary built with py2exe
  126. (Not recommended)
  127. yt-dlp_linux Linux standalone x64 binary
  128. yt-dlp_linux.zip Unpackaged Linux executable (no auto-update)
  129. yt-dlp_linux_armv7l Linux standalone armv7l (32-bit) binary
  130. yt-dlp_linux_aarch64 Linux standalone aarch64 (64-bit) binary
  131. yt-dlp_win.zip Unpackaged Windows executable (no auto-update)
  132. yt-dlp_macos.zip Unpackaged MacOS (10.15+) executable (no auto-update)
  133. yt-dlp_macos_legacy MacOS (10.9+) standalone x64 executable
  134. Misc
  135. File Description
  136. yt-dlp.tar.gz Source tarball
  137. SHA2-512SUMS GNU-style SHA512 sums
  138. SHA2-512SUMS.sig GPG signature file for SHA512 sums
  139. SHA2-256SUMS GNU-style SHA256 sums
  140. SHA2-256SUMS.sig GPG signature file for SHA256 sums
  141. The public key that can be used to verify the GPG signatures is available here Example usage:
  142.  
  143. curl -L https://github.com/yt-dlp/yt-dlp/raw/master/public.key | gpg --import
  144. gpg --verify SHA2-256SUMS.sig SHA2-256SUMS
  145. gpg --verify SHA2-512SUMS.sig SHA2-512SUMS
  146. Note: The manpages, shell completion (autocomplete) files etc. are available inside the source tarball
  147.  
  148. DEPENDENCIES
  149. Python versions 3.7+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
  150.  
  151. While all the other dependencies are optional, ffmpeg and ffprobe are highly recommended
  152.  
  153. Strongly recommended
  154. ffmpeg and ffprobe - Required for merging separate video and audio files as well as for various post-processing tasks. License depends on the build
  155.  
  156. There are bugs in ffmpeg that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependency, we provide custom builds with patches for some of these issues at yt-dlp/FFmpeg-Builds. See the readme for details on the specific issues solved by these builds
  157.  
  158. Important: What you need is ffmpeg binary, NOT the python package of the same name
  159.  
  160. Networking
  161. certifi* - Provides Mozilla's root certificate bundle. Licensed under MPLv2
  162. brotli* or brotlicffi - Brotli content encoding support. Both licensed under MIT 1 2
  163. websockets* - For downloading over websocket. Licensed under BSD-3-Clause
  164. requests* - HTTP library. For HTTPS proxy and persistent connections support. Licensed under Apache-2.0
  165. Metadata
  166. mutagen* - For --embed-thumbnail in certain formats. Licensed under GPLv2+
  167. AtomicParsley - For --embed-thumbnail in mp4/m4a files when mutagen/ffmpeg cannot. Licensed under GPLv2+
  168. xattr, pyxattr or setfattr - For writing xattr metadata (--xattr) on Mac and BSD. Licensed under MIT, LGPL2.1 and GPLv2+ respectively
  169. Misc
  170. pycryptodomex* - For decrypting AES-128 HLS streams and various other data. Licensed under BSD-2-Clause
  171. phantomjs - Used in extractors where javascript needs to be run. Licensed under BSD-3-Clause
  172. secretstorage - For --cookies-from-browser to access the Gnome keyring while decrypting cookies of Chromium-based browsers on Linux. Licensed under BSD-3-Clause
  173. Any external downloader that you want to use with --downloader
  174. Deprecated
  175. avconv and avprobe - Now deprecated alternative to ffmpeg. License depends on the build
  176. sponskrub - For using the now deprecated sponskrub options. Licensed under GPLv3+
  177. rtmpdump - For downloading rtmp streams. ffmpeg can be used instead with --downloader ffmpeg. Licensed under GPLv2+
  178. mplayer or mpv - For downloading rstp/mms streams. ffmpeg can be used instead with --downloader ffmpeg. Licensed under GPLv2+
  179. To use or redistribute the dependencies, you must agree to their respective licensing terms.
  180.  
  181. The standalone release binaries are built with the Python interpreter and the packages marked with * included.
  182.  
  183. If you do not have the necessary dependencies for a task you are attempting, yt-dlp will warn you. All the currently available dependencies are visible at the top of the --verbose output
  184.  
  185. COMPILE
  186. Standalone PyInstaller Builds
  187. To build the standalone executable, you must have Python and pyinstaller (plus any of yt-dlp's optional dependencies if needed). Once you have all the necessary dependencies installed, simply run pyinst.py. The executable will be built for the same architecture (x86/ARM, 32/64 bit) as the Python used.
  188.  
  189. python3 -m pip install -U pyinstaller -r requirements.txt
  190. python3 devscripts/make_lazy_extractors.py
  191. python3 pyinst.py
  192. On some systems, you may need to use py or python instead of python3.
  193.  
  194. pyinst.py accepts any arguments that can be passed to pyinstaller, such as --onefile/-F or --onedir/-D, which is further documented here.
  195.  
  196. Note: Pyinstaller versions below 4.4 do not support Python installed from the Windows store without using a virtual environment.
  197.  
  198. Important: Running pyinstaller directly without using pyinst.py is not officially supported. This may or may not work correctly.
  199.  
  200. Platform-independent Binary (UNIX)
  201. You will need the build tools python (3.7+), zip, make (GNU), pandoc* and pytest*.
  202.  
  203. After installing these, simply run make.
  204.  
  205. You can also run make yt-dlp instead to compile only the binary without updating any of the additional files. (The build tools marked with * are not needed for this)
  206.  
  207. Standalone Py2Exe Builds (Windows)
  208. While we provide the option to build with py2exe, it is recommended to build using PyInstaller instead since the py2exe builds cannot contain pycryptodomex/certifi and needs VC++14 on the target computer to run.
  209.  
  210. If you wish to build it anyway, install Python and py2exe, and then simply run setup.py py2exe
  211.  
  212. py -m pip install -U py2exe -r requirements.txt
  213. py devscripts/make_lazy_extractors.py
  214. py setup.py py2exe
  215. Related scripts
  216. devscripts/update-version.py - Update the version number based on current date.
  217. devscripts/set-variant.py - Set the build variant of the executable.
  218. devscripts/make_changelog.py - Create a markdown changelog using short commit messages and update CONTRIBUTORS file.
  219. devscripts/make_lazy_extractors.py - Create lazy extractors. Running this before building the binaries (any variant) will improve their startup performance. Set the environment variable YTDLP_NO_LAZY_EXTRACTORS=1 if you wish to forcefully disable lazy extractor loading.
  220. Note: See their --help for more info.
  221.  
  222. Forking the project
  223. If you fork the project on GitHub, you can run your fork's build workflow to automatically build the selected version(s) as artifacts. Alternatively, you can run the release workflow or enable the nightly workflow to create full (pre-)releases.
  224.  
  225. USAGE AND OPTIONS
  226. yt-dlp [OPTIONS] [--] URL [URL...]
  227. Ctrl+F is your friend :D
  228.  
  229. General Options:
  230. -h, --help Print this help text and exit
  231. --version Print program version and exit
  232. -U, --update Update this program to the latest version
  233. --no-update Do not check for updates (default)
  234. --update-to [CHANNEL]@[TAG] Upgrade/downgrade to a specific version.
  235. CHANNEL can be a repository as well. CHANNEL
  236. and TAG default to "stable" and "latest"
  237. respectively if omitted; See "UPDATE" for
  238. details. Supported channels: stable, nightly
  239. -i, --ignore-errors Ignore download and postprocessing errors.
  240. The download will be considered successful
  241. even if the postprocessing fails
  242. --no-abort-on-error Continue with next video on download errors;
  243. e.g. to skip unavailable videos in a
  244. playlist (default)
  245. --abort-on-error Abort downloading of further videos if an
  246. error occurs (Alias: --no-ignore-errors)
  247. --dump-user-agent Display the current user-agent and exit
  248. --list-extractors List all supported extractors and exit
  249. --extractor-descriptions Output descriptions of all supported
  250. extractors and exit
  251. --use-extractors NAMES Extractor names to use separated by commas.
  252. You can also use regexes, "all", "default"
  253. and "end" (end URL matching); e.g. --ies
  254. "holodex.*,end,youtube". Prefix the name
  255. with a "-" to exclude it, e.g. --ies
  256. default,-generic. Use --list-extractors for
  257. a list of extractor names. (Alias: --ies)
  258. --default-search PREFIX Use this prefix for unqualified URLs. E.g.
  259. "gvsearch2:python" downloads two videos from
  260. google videos for the search term "python".
  261. Use the value "auto" to let yt-dlp guess
  262. ("auto_warning" to emit a warning when
  263. guessing). "error" just throws an error. The
  264. default value "fixup_error" repairs broken
  265. URLs, but emits an error if this is not
  266. possible instead of searching
  267. --ignore-config Don't load any more configuration files
  268. except those given by --config-locations.
  269. For backward compatibility, if this option
  270. is found inside the system configuration
  271. file, the user configuration is not loaded.
  272. (Alias: --no-config)
  273. --no-config-locations Do not load any custom configuration files
  274. (default). When given inside a configuration
  275. file, ignore all previous --config-locations
  276. defined in the current file
  277. --config-locations PATH Location of the main configuration file;
  278. either the path to the config or its
  279. containing directory ("-" for stdin). Can be
  280. used multiple times and inside other
  281. configuration files
  282. --flat-playlist Do not extract the videos of a playlist,
  283. only list them
  284. --no-flat-playlist Fully extract the videos of a playlist
  285. (default)
  286. --live-from-start Download livestreams from the start.
  287. Currently only supported for YouTube
  288. (Experimental)
  289. --no-live-from-start Download livestreams from the current time
  290. (default)
  291. --wait-for-video MIN[-MAX] Wait for scheduled streams to become
  292. available. Pass the minimum number of
  293. seconds (or range) to wait between retries
  294. --no-wait-for-video Do not wait for scheduled streams (default)
  295. --mark-watched Mark videos watched (even with --simulate)
  296. --no-mark-watched Do not mark videos watched (default)
  297. --color [STREAM:]POLICY Whether to emit color codes in output,
  298. optionally prefixed by the STREAM (stdout or
  299. stderr) to apply the setting to. Can be one
  300. of "always", "auto" (default), "never", or
  301. "no_color" (use non color terminal
  302. sequences). Can be used multiple times
  303. --compat-options OPTS Options that can help keep compatibility
  304. with youtube-dl or youtube-dlc
  305. configurations by reverting some of the
  306. changes made in yt-dlp. See "Differences in
  307. default behavior" for details
  308. --alias ALIASES OPTIONS Create aliases for an option string. Unless
  309. an alias starts with a dash "-", it is
  310. prefixed with "--". Arguments are parsed
  311. according to the Python string formatting
  312. mini-language. E.g. --alias get-audio,-X
  313. "-S=aext:{0},abr -x --audio-format {0}"
  314. creates options "--get-audio" and "-X" that
  315. takes an argument (ARG0) and expands to
  316. "-S=aext:ARG0,abr -x --audio-format ARG0".
  317. All defined aliases are listed in the --help
  318. output. Alias options can trigger more
  319. aliases; so be careful to avoid defining
  320. recursive options. As a safety measure, each
  321. alias may be triggered a maximum of 100
  322. times. This option can be used multiple times
  323. Network Options:
  324. --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. To
  325. enable SOCKS proxy, specify a proper scheme,
  326. e.g. socks5://user:pass@127.0.0.1:1080/.
  327. Pass in an empty string (--proxy "") for
  328. direct connection
  329. --socket-timeout SECONDS Time to wait before giving up, in seconds
  330. --source-address IP Client-side IP address to bind to
  331. -4, --force-ipv4 Make all connections via IPv4
  332. -6, --force-ipv6 Make all connections via IPv6
  333. --enable-file-urls Enable file:// URLs. This is disabled by
  334. default for security reasons.
  335. Geo-restriction:
  336. --geo-verification-proxy URL Use this proxy to verify the IP address for
  337. some geo-restricted sites. The default proxy
  338. specified by --proxy (or none, if the option
  339. is not present) is used for the actual
  340. downloading
  341. --xff VALUE How to fake X-Forwarded-For HTTP header to
  342. try bypassing geographic restriction. One of
  343. "default" (only when known to be useful),
  344. "never", an IP block in CIDR notation, or a
  345. two-letter ISO 3166-2 country code
  346. Video Selection:
  347. -I, --playlist-items ITEM_SPEC Comma separated playlist_index of the items
  348. to download. You can specify a range using
  349. "[START]:[STOP][:STEP]". For backward
  350. compatibility, START-STOP is also supported.
  351. Use negative indices to count from the right
  352. and negative STEP to download in reverse
  353. order. E.g. "-I 1:3,7,-5::2" used on a
  354. playlist of size 15 will download the items
  355. at index 1,2,3,7,11,13,15
  356. --min-filesize SIZE Abort download if filesize is smaller than
  357. SIZE, e.g. 50k or 44.6M
  358. --max-filesize SIZE Abort download if filesize is larger than
  359. SIZE, e.g. 50k or 44.6M
  360. --date DATE Download only videos uploaded on this date.
  361. The date can be "YYYYMMDD" or in the format
  362. [now|today|yesterday][-N[day|week|month|year]].
  363. E.g. "--date today-2weeks" downloads only
  364. videos uploaded on the same day two weeks ago
  365. --datebefore DATE Download only videos uploaded on or before
  366. this date. The date formats accepted is the
  367. same as --date
  368. --dateafter DATE Download only videos uploaded on or after
  369. this date. The date formats accepted is the
  370. same as --date
  371. --match-filters FILTER Generic video filter. Any "OUTPUT TEMPLATE"
  372. field can be compared with a number or a
  373. string using the operators defined in
  374. "Filtering Formats". You can also simply
  375. specify a field to match if the field is
  376. present, use "!field" to check if the field
  377. is not present, and "&" to check multiple
  378. conditions. Use a "\" to escape "&" or
  379. quotes if needed. If used multiple times,
  380. the filter matches if atleast one of the
  381. conditions are met. E.g. --match-filter
  382. !is_live --match-filter "like_count>?100 &
  383. description~='(?i)\bcats \& dogs\b'" matches
  384. only videos that are not live OR those that
  385. have a like count more than 100 (or the like
  386. field is not available) and also has a
  387. description that contains the phrase "cats &
  388. dogs" (caseless). Use "--match-filter -" to
  389. interactively ask whether to download each
  390. video
  391. --no-match-filters Do not use any --match-filter (default)
  392. --break-match-filters FILTER Same as "--match-filters" but stops the
  393. download process when a video is rejected
  394. --no-break-match-filters Do not use any --break-match-filters (default)
  395. --no-playlist Download only the video, if the URL refers
  396. to a video and a playlist
  397. --yes-playlist Download the playlist, if the URL refers to
  398. a video and a playlist
  399. --age-limit YEARS Download only videos suitable for the given
  400. age
  401. --download-archive FILE Download only videos not listed in the
  402. archive file. Record the IDs of all
  403. downloaded videos in it
  404. --no-download-archive Do not use archive file (default)
  405. --max-downloads NUMBER Abort after downloading NUMBER files
  406. --break-on-existing Stop the download process when encountering
  407. a file that is in the archive
  408. --break-per-input Alters --max-downloads, --break-on-existing,
  409. --break-match-filter, and autonumber to
  410. reset per input URL
  411. --no-break-per-input --break-on-existing and similar options
  412. terminates the entire download queue
  413. --skip-playlist-after-errors N Number of allowed failures until the rest of
  414. the playlist is skipped
  415. Download Options:
  416. -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
  417. video that should be downloaded concurrently
  418. (default is 1)
  419. -r, --limit-rate RATE Maximum download rate in bytes per second,
  420. e.g. 50K or 4.2M
  421. --throttled-rate RATE Minimum download rate in bytes per second
  422. below which throttling is assumed and the
  423. video data is re-extracted, e.g. 100K
  424. -R, --retries RETRIES Number of retries (default is 10), or
  425. "infinite"
  426. --file-access-retries RETRIES Number of times to retry on file access
  427. error (default is 3), or "infinite"
  428. --fragment-retries RETRIES Number of retries for a fragment (default is
  429. 10), or "infinite" (DASH, hlsnative and ISM)
  430. --retry-sleep [TYPE:]EXPR Time to sleep between retries in seconds
  431. (optionally) prefixed by the type of retry
  432. (http (default), fragment, file_access,
  433. extractor) to apply the sleep to. EXPR can
  434. be a number, linear=START[:END[:STEP=1]] or
  435. exp=START[:END[:BASE=2]]. This option can be
  436. used multiple times to set the sleep for the
  437. different retry types, e.g. --retry-sleep
  438. linear=1::2 --retry-sleep fragment:exp=1:20
  439. --skip-unavailable-fragments Skip unavailable fragments for DASH,
  440. hlsnative and ISM downloads (default)
  441. (Alias: --no-abort-on-unavailable-fragments)
  442. --abort-on-unavailable-fragments
  443. Abort download if a fragment is unavailable
  444. (Alias: --no-skip-unavailable-fragments)
  445. --keep-fragments Keep downloaded fragments on disk after
  446. downloading is finished
  447. --no-keep-fragments Delete downloaded fragments after
  448. downloading is finished (default)
  449. --buffer-size SIZE Size of download buffer, e.g. 1024 or 16K
  450. (default is 1024)
  451. --resize-buffer The buffer size is automatically resized
  452. from an initial value of --buffer-size
  453. (default)
  454. --no-resize-buffer Do not automatically adjust the buffer size
  455. --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
  456. downloading, e.g. 10485760 or 10M (default
  457. is disabled). May be useful for bypassing
  458. bandwidth throttling imposed by a webserver
  459. (experimental)
  460. --playlist-random Download playlist videos in random order
  461. --lazy-playlist Process entries in the playlist as they are
  462. received. This disables n_entries,
  463. --playlist-random and --playlist-reverse
  464. --no-lazy-playlist Process videos in the playlist only after
  465. the entire playlist is parsed (default)
  466. --xattr-set-filesize Set file xattribute ytdl.filesize with
  467. expected file size
  468. --hls-use-mpegts Use the mpegts container for HLS videos;
  469. allowing some players to play the video
  470. while downloading, and reducing the chance
  471. of file corruption if download is
  472. interrupted. This is enabled by default for
  473. live streams
  474. --no-hls-use-mpegts Do not use the mpegts container for HLS
  475. videos. This is default when not downloading
  476. live streams
  477. --download-sections REGEX Download only chapters that match the
  478. regular expression. A "*" prefix denotes
  479. time-range instead of chapter. Negative
  480. timestamps are calculated from the end.
  481. "*from-url" can be used to download between
  482. the "start_time" and "end_time" extracted
  483. from the URL. Needs ffmpeg. This option can
  484. be used multiple times to download multiple
  485. sections, e.g. --download-sections
  486. "*10:15-inf" --download-sections "intro"
  487. --downloader [PROTO:]NAME Name or path of the external downloader to
  488. use (optionally) prefixed by the protocols
  489. (http, ftp, m3u8, dash, rstp, rtmp, mms) to
  490. use it for. Currently supports native,
  491. aria2c, avconv, axel, curl, ffmpeg, httpie,
  492. wget. You can use this option multiple times
  493. to set different downloaders for different
  494. protocols. E.g. --downloader aria2c
  495. --downloader "dash,m3u8:native" will use
  496. aria2c for http/ftp downloads, and the
  497. native downloader for dash/m3u8 downloads
  498. (Alias: --external-downloader)
  499. --downloader-args NAME:ARGS Give these arguments to the external
  500. downloader. Specify the downloader name and
  501. the arguments separated by a colon ":". For
  502. ffmpeg, arguments can be passed to different
  503. positions using the same syntax as
  504. --postprocessor-args. You can use this
  505. option multiple times to give different
  506. arguments to different downloaders (Alias:
  507. --external-downloader-args)
  508. Filesystem Options:
  509. -a, --batch-file FILE File containing URLs to download ("-" for
  510. stdin), one URL per line. Lines starting
  511. with "#", ";" or "]" are considered as
  512. comments and ignored
  513. --no-batch-file Do not read URLs from batch file (default)
  514. -P, --paths [TYPES:]PATH The paths where the files should be
  515. downloaded. Specify the type of file and the
  516. path separated by a colon ":". All the same
  517. TYPES as --output are supported.
  518. Additionally, you can also provide "home"
  519. (default) and "temp" paths. All intermediary
  520. files are first downloaded to the temp path
  521. and then the final files are moved over to
  522. the home path after download is finished.
  523. This option is ignored if --output is an
  524. absolute path
  525. -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
  526. TEMPLATE" for details
  527. --output-na-placeholder TEXT Placeholder for unavailable fields in
  528. "OUTPUT TEMPLATE" (default: "NA")
  529. --restrict-filenames Restrict filenames to only ASCII characters,
  530. and avoid "&" and spaces in filenames
  531. --no-restrict-filenames Allow Unicode characters, "&" and spaces in
  532. filenames (default)
  533. --windows-filenames Force filenames to be Windows-compatible
  534. --no-windows-filenames Make filenames Windows-compatible only if
  535. using Windows (default)
  536. --trim-filenames LENGTH Limit the filename length (excluding
  537. extension) to the specified number of
  538. characters
  539. -w, --no-overwrites Do not overwrite any files
  540. --force-overwrites Overwrite all video and metadata files. This
  541. option includes --no-continue
  542. --no-force-overwrites Do not overwrite the video, but overwrite
  543. related files (default)
  544. -c, --continue Resume partially downloaded files/fragments
  545. (default)
  546. --no-continue Do not resume partially downloaded
  547. fragments. If the file is not fragmented,
  548. restart download of the entire file
  549. --part Use .part files instead of writing directly
  550. into output file (default)
  551. --no-part Do not use .part files - write directly into
  552. output file
  553. --mtime Use the Last-modified header to set the file
  554. modification time (default)
  555. --no-mtime Do not use the Last-modified header to set
  556. the file modification time
  557. --write-description Write video description to a .description file
  558. --no-write-description Do not write video description (default)
  559. --write-info-json Write video metadata to a .info.json file
  560. (this may contain personal information)
  561. --no-write-info-json Do not write video metadata (default)
  562. --write-playlist-metafiles Write playlist metadata in addition to the
  563. video metadata when using --write-info-json,
  564. --write-description etc. (default)
  565. --no-write-playlist-metafiles Do not write playlist metadata when using
  566. --write-info-json, --write-description etc.
  567. --clean-info-json Remove some internal metadata such as
  568. filenames from the infojson (default)
  569. --no-clean-info-json Write all fields to the infojson
  570. --write-comments Retrieve video comments to be placed in the
  571. infojson. The comments are fetched even
  572. without this option if the extraction is
  573. known to be quick (Alias: --get-comments)
  574. --no-write-comments Do not retrieve video comments unless the
  575. extraction is known to be quick (Alias:
  576. --no-get-comments)
  577. --load-info-json FILE JSON file containing the video information
  578. (created with the "--write-info-json" option)
  579. --cookies FILE Netscape formatted file to read cookies from
  580. and dump cookie jar in
  581. --no-cookies Do not read/dump cookies from/to file
  582. (default)
  583. --cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]
  584. The name of the browser to load cookies
  585. from. Currently supported browsers are:
  586. brave, chrome, chromium, edge, firefox,
  587. opera, safari, vivaldi. Optionally, the
  588. KEYRING used for decrypting Chromium cookies
  589. on Linux, the name/path of the PROFILE to
  590. load cookies from, and the CONTAINER name
  591. (if Firefox) ("none" for no container) can
  592. be given with their respective seperators.
  593. By default, all containers of the most
  594. recently accessed profile are used.
  595. Currently supported keyrings are: basictext,
  596. gnomekeyring, kwallet, kwallet5, kwallet6
  597. --no-cookies-from-browser Do not load cookies from browser (default)
  598. --cache-dir DIR Location in the filesystem where yt-dlp can
  599. store some downloaded information (such as
  600. client ids and signatures) permanently. By
  601. default ${XDG_CACHE_HOME}/yt-dlp
  602. --no-cache-dir Disable filesystem caching
  603. --rm-cache-dir Delete all filesystem cache files
  604. Thumbnail Options:
  605. --write-thumbnail Write thumbnail image to disk
  606. --no-write-thumbnail Do not write thumbnail image to disk (default)
  607. --write-all-thumbnails Write all thumbnail image formats to disk
  608. --list-thumbnails List available thumbnails of each video.
  609. Simulate unless --no-simulate is used
  610. Internet Shortcut Options:
  611. --write-link Write an internet shortcut file, depending
  612. on the current platform (.url, .webloc or
  613. .desktop). The URL may be cached by the OS
  614. --write-url-link Write a .url Windows internet shortcut. The
  615. OS caches the URL based on the file path
  616. --write-webloc-link Write a .webloc macOS internet shortcut
  617. --write-desktop-link Write a .desktop Linux internet shortcut
  618. Verbosity and Simulation Options:
  619. -q, --quiet Activate quiet mode. If used with --verbose,
  620. print the log to stderr
  621. --no-quiet Deactivate quiet mode. (Default)
  622. --no-warnings Ignore warnings
  623. -s, --simulate Do not download the video and do not write
  624. anything to disk
  625. --no-simulate Download the video even if printing/listing
  626. options are used
  627. --ignore-no-formats-error Ignore "No video formats" error. Useful for
  628. extracting metadata even if the videos are
  629. not actually available for download
  630. (experimental)
  631. --no-ignore-no-formats-error Throw error when no downloadable video
  632. formats are found (default)
  633. --skip-download Do not download the video but write all
  634. related files (Alias: --no-download)
  635. -O, --print [WHEN:]TEMPLATE Field name or output template to print to
  636. screen, optionally prefixed with when to
  637. print it, separated by a ":". Supported
  638. values of "WHEN" are the same as that of
  639. --use-postprocessor (default: video).
  640. Implies --quiet. Implies --simulate unless
  641. --no-simulate or later stages of WHEN are
  642. used. This option can be used multiple times
  643. --print-to-file [WHEN:]TEMPLATE FILE
  644. Append given template to the file. The
  645. values of WHEN and TEMPLATE are same as that
  646. of --print. FILE uses the same syntax as the
  647. output template. This option can be used
  648. multiple times
  649. -j, --dump-json Quiet, but print JSON information for each
  650. video. Simulate unless --no-simulate is
  651. used. See "OUTPUT TEMPLATE" for a
  652. description of available keys
  653. -J, --dump-single-json Quiet, but print JSON information for each
  654. url or infojson passed. Simulate unless
  655. --no-simulate is used. If the URL refers to
  656. a playlist, the whole playlist information
  657. is dumped in a single line
  658. --force-write-archive Force download archive entries to be written
  659. as far as no errors occur, even if -s or
  660. another simulation option is used (Alias:
  661. --force-download-archive)
  662. --newline Output progress bar as new lines
  663. --no-progress Do not print progress bar
  664. --progress Show progress bar, even if in quiet mode
  665. --console-title Display progress in console titlebar
  666. --progress-template [TYPES:]TEMPLATE
  667. Template for progress outputs, optionally
  668. prefixed with one of "download:" (default),
  669. "download-title:" (the console title),
  670. "postprocess:", or "postprocess-title:".
  671. The video's fields are accessible under the
  672. "info" key and the progress attributes are
  673. accessible under "progress" key. E.g.
  674. --console-title --progress-template
  675. "download-title:%(info.id)s-%(progress.eta)s"
  676. -v, --verbose Print various debugging information
  677. --dump-pages Print downloaded pages encoded using base64
  678. to debug problems (very verbose)
  679. --write-pages Write downloaded intermediary pages to files
  680. in the current directory to debug problems
  681. --print-traffic Display sent and read HTTP traffic
  682. Workarounds:
  683. --encoding ENCODING Force the specified encoding (experimental)
  684. --legacy-server-connect Explicitly allow HTTPS connection to servers
  685. that do not support RFC 5746 secure
  686. renegotiation
  687. --no-check-certificates Suppress HTTPS certificate validation
  688. --prefer-insecure Use an unencrypted connection to retrieve
  689. information about the video (Currently
  690. supported only for YouTube)
  691. --add-headers FIELD:VALUE Specify a custom HTTP header and its value,
  692. separated by a colon ":". You can use this
  693. option multiple times
  694. --bidi-workaround Work around terminals that lack
  695. bidirectional text support. Requires bidiv
  696. or fribidi executable in PATH
  697. --sleep-requests SECONDS Number of seconds to sleep between requests
  698. during data extraction
  699. --sleep-interval SECONDS Number of seconds to sleep before each
  700. download. This is the minimum time to sleep
  701. when used along with --max-sleep-interval
  702. (Alias: --min-sleep-interval)
  703. --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can only
  704. be used along with --min-sleep-interval
  705. --sleep-subtitles SECONDS Number of seconds to sleep before each
  706. subtitle download
  707. Video Format Options:
  708. -f, --format FORMAT Video format code, see "FORMAT SELECTION"
  709. for more details
  710. -S, --format-sort SORTORDER Sort the formats by the fields given, see
  711. "Sorting Formats" for more details
  712. --format-sort-force Force user specified sort order to have
  713. precedence over all fields, see "Sorting
  714. Formats" for more details (Alias: --S-force)
  715. --no-format-sort-force Some fields have precedence over the user
  716. specified sort order (default)
  717. --video-multistreams Allow multiple video streams to be merged
  718. into a single file
  719. --no-video-multistreams Only one video stream is downloaded for each
  720. output file (default)
  721. --audio-multistreams Allow multiple audio streams to be merged
  722. into a single file
  723. --no-audio-multistreams Only one audio stream is downloaded for each
  724. output file (default)
  725. --prefer-free-formats Prefer video formats with free containers
  726. over non-free ones of same quality. Use with
  727. "-S ext" to strictly prefer free containers
  728. irrespective of quality
  729. --no-prefer-free-formats Don't give any special preference to free
  730. containers (default)
  731. --check-formats Make sure formats are selected only from
  732. those that are actually downloadable
  733. --check-all-formats Check all formats for whether they are
  734. actually downloadable
  735. --no-check-formats Do not check that the formats are actually
  736. downloadable
  737. -F, --list-formats List available formats of each video.
  738. Simulate unless --no-simulate is used
  739. --merge-output-format FORMAT Containers that may be used when merging
  740. formats, separated by "/", e.g. "mp4/mkv".
  741. Ignored if no merge is required. (currently
  742. supported: avi, flv, mkv, mov, mp4, webm)
  743. Subtitle Options:
  744. --write-subs Write subtitle file
  745. --no-write-subs Do not write subtitle file (default)
  746. --write-auto-subs Write automatically generated subtitle file
  747. (Alias: --write-automatic-subs)
  748. --no-write-auto-subs Do not write auto-generated subtitles
  749. (default) (Alias: --no-write-automatic-subs)
  750. --list-subs List available subtitles of each video.
  751. Simulate unless --no-simulate is used
  752. --sub-format FORMAT Subtitle format; accepts formats preference,
  753. e.g. "srt" or "ass/srt/best"
  754. --sub-langs LANGS Languages of the subtitles to download (can
  755. be regex) or "all" separated by commas, e.g.
  756. --sub-langs "en.*,ja". You can prefix the
  757. language code with a "-" to exclude it from
  758. the requested languages, e.g. --sub-langs
  759. all,-live_chat. Use --list-subs for a list
  760. of available language tags
  761. Authentication Options:
  762. -u, --username USERNAME Login with this account ID
  763. -p, --password PASSWORD Account password. If this option is left
  764. out, yt-dlp will ask interactively
  765. -2, --twofactor TWOFACTOR Two-factor authentication code
  766. -n, --netrc Use .netrc authentication data
  767. --netrc-location PATH Location of .netrc authentication data;
  768. either the path or its containing directory.
  769. Defaults to ~/.netrc
  770. --netrc-cmd NETRC_CMD Command to execute to get the credentials
  771. for an extractor.
  772. --video-password PASSWORD Video-specific password
  773. --ap-mso MSO Adobe Pass multiple-system operator (TV
  774. provider) identifier, use --ap-list-mso for
  775. a list of available MSOs
  776. --ap-username USERNAME Multiple-system operator account login
  777. --ap-password PASSWORD Multiple-system operator account password.
  778. If this option is left out, yt-dlp will ask
  779. interactively
  780. --ap-list-mso List all supported multiple-system operators
  781. --client-certificate CERTFILE Path to client certificate file in PEM
  782. format. May include the private key
  783. --client-certificate-key KEYFILE
  784. Path to private key file for client
  785. certificate
  786. --client-certificate-password PASSWORD
  787. Password for client certificate private key,
  788. if encrypted. If not provided, and the key
  789. is encrypted, yt-dlp will ask interactively
  790. Post-Processing Options:
  791. -x, --extract-audio Convert video files to audio-only files
  792. (requires ffmpeg and ffprobe)
  793. --audio-format FORMAT Format to convert the audio to when -x is
  794. used. (currently supported: best (default),
  795. aac, alac, flac, m4a, mp3, opus, vorbis,
  796. wav). You can specify multiple rules using
  797. similar syntax as --remux-video
  798. --audio-quality QUALITY Specify ffmpeg audio quality to use when
  799. converting the audio with -x. Insert a value
  800. between 0 (best) and 10 (worst) for VBR or a
  801. specific bitrate like 128K (default 5)
  802. --remux-video FORMAT Remux the video into another container if
  803. necessary (currently supported: avi, flv,
  804. gif, mkv, mov, mp4, webm, aac, aiff, alac,
  805. flac, m4a, mka, mp3, ogg, opus, vorbis,
  806. wav). If target container does not support
  807. the video/audio codec, remuxing will fail.
  808. You can specify multiple rules; e.g.
  809. "aac>m4a/mov>mp4/mkv" will remux aac to m4a,
  810. mov to mp4 and anything else to mkv
  811. --recode-video FORMAT Re-encode the video into another format if
  812. necessary. The syntax and supported formats
  813. are the same as --remux-video
  814. --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
  815. Specify the postprocessor/executable name
  816. and the arguments separated by a colon ":"
  817. to give the argument to the specified
  818. postprocessor/executable. Supported PP are:
  819. Merger, ModifyChapters, SplitChapters,
  820. ExtractAudio, VideoRemuxer, VideoConvertor,
  821. Metadata, EmbedSubtitle, EmbedThumbnail,
  822. SubtitlesConvertor, ThumbnailsConvertor,
  823. FixupStretched, FixupM4a, FixupM3u8,
  824. FixupTimestamp and FixupDuration. The
  825. supported executables are: AtomicParsley,
  826. FFmpeg and FFprobe. You can also specify
  827. "PP+EXE:ARGS" to give the arguments to the
  828. specified executable only when being used by
  829. the specified postprocessor. Additionally,
  830. for ffmpeg/ffprobe, "_i"/"_o" can be
  831. appended to the prefix optionally followed
  832. by a number to pass the argument before the
  833. specified input/output file, e.g. --ppa
  834. "Merger+ffmpeg_i1:-v quiet". You can use
  835. this option multiple times to give different
  836. arguments to different postprocessors.
  837. (Alias: --ppa)
  838. -k, --keep-video Keep the intermediate video file on disk
  839. after post-processing
  840. --no-keep-video Delete the intermediate video file after
  841. post-processing (default)
  842. --post-overwrites Overwrite post-processed files (default)
  843. --no-post-overwrites Do not overwrite post-processed files
  844. --embed-subs Embed subtitles in the video (only for mp4,
  845. webm and mkv videos)
  846. --no-embed-subs Do not embed subtitles (default)
  847. --embed-thumbnail Embed thumbnail in the video as cover art
  848. --no-embed-thumbnail Do not embed thumbnail (default)
  849. --embed-metadata Embed metadata to the video file. Also
  850. embeds chapters/infojson if present unless
  851. --no-embed-chapters/--no-embed-info-json are
  852. used (Alias: --add-metadata)
  853. --no-embed-metadata Do not add metadata to file (default)
  854. (Alias: --no-add-metadata)
  855. --embed-chapters Add chapter markers to the video file
  856. (Alias: --add-chapters)
  857. --no-embed-chapters Do not add chapter markers (default) (Alias:
  858. --no-add-chapters)
  859. --embed-info-json Embed the infojson as an attachment to
  860. mkv/mka video files
  861. --no-embed-info-json Do not embed the infojson as an attachment
  862. to the video file
  863. --parse-metadata [WHEN:]FROM:TO
  864. Parse additional metadata like title/artist
  865. from other fields; see "MODIFYING METADATA"
  866. for details. Supported values of "WHEN" are
  867. the same as that of --use-postprocessor
  868. (default: pre_process)
  869. --replace-in-metadata [WHEN:]FIELDS REGEX REPLACE
  870. Replace text in a metadata field using the
  871. given regex. This option can be used
  872. multiple times. Supported values of "WHEN"
  873. are the same as that of --use-postprocessor
  874. (default: pre_process)
  875. --xattrs Write metadata to the video file's xattrs
  876. (using dublin core and xdg standards)
  877. --concat-playlist POLICY Concatenate videos in a playlist. One of
  878. "never", "always", or "multi_video"
  879. (default; only when the videos form a single
  880. show). All the video files must have same
  881. codecs and number of streams to be
  882. concatable. The "pl_video:" prefix can be
  883. used with "--paths" and "--output" to set
  884. the output filename for the concatenated
  885. files. See "OUTPUT TEMPLATE" for details
  886. --fixup POLICY Automatically correct known faults of the
  887. file. One of never (do nothing), warn (only
  888. emit a warning), detect_or_warn (the
  889. default; fix file if we can, warn
  890. otherwise), force (try fixing even if file
  891. already exists)
  892. --ffmpeg-location PATH Location of the ffmpeg binary; either the
  893. path to the binary or its containing directory
  894. --exec [WHEN:]CMD Execute a command, optionally prefixed with
  895. when to execute it, separated by a ":".
  896. Supported values of "WHEN" are the same as
  897. that of --use-postprocessor (default:
  898. after_move). Same syntax as the output
  899. template can be used to pass any field as
  900. arguments to the command. If no fields are
  901. passed, %(filepath,_filename|)q is appended
  902. to the end of the command. This option can
  903. be used multiple times
  904. --no-exec Remove any previously defined --exec
  905. --convert-subs FORMAT Convert the subtitles to another format
  906. (currently supported: ass, lrc, srt, vtt)
  907. (Alias: --convert-subtitles)
  908. --convert-thumbnails FORMAT Convert the thumbnails to another format
  909. (currently supported: jpg, png, webp). You
  910. can specify multiple rules using similar
  911. syntax as --remux-video
  912. --split-chapters Split video into multiple files based on
  913. internal chapters. The "chapter:" prefix can
  914. be used with "--paths" and "--output" to set
  915. the output filename for the split files. See
  916. "OUTPUT TEMPLATE" for details
  917. --no-split-chapters Do not split video based on chapters (default)
  918. --remove-chapters REGEX Remove chapters whose title matches the
  919. given regular expression. The syntax is the
  920. same as --download-sections. This option can
  921. be used multiple times
  922. --no-remove-chapters Do not remove any chapters from the file
  923. (default)
  924. --force-keyframes-at-cuts Force keyframes at cuts when
  925. downloading/splitting/removing sections.
  926. This is slow due to needing a re-encode, but
  927. the resulting video may have fewer artifacts
  928. around the cuts
  929. --no-force-keyframes-at-cuts Do not force keyframes around the chapters
  930. when cutting/splitting (default)
  931. --use-postprocessor NAME[:ARGS]
  932. The (case sensitive) name of plugin
  933. postprocessors to be enabled, and
  934. (optionally) arguments to be passed to it,
  935. separated by a colon ":". ARGS are a
  936. semicolon ";" delimited list of NAME=VALUE.
  937. The "when" argument determines when the
  938. postprocessor is invoked. It can be one of
  939. "pre_process" (after video extraction),
  940. "after_filter" (after video passes filter),
  941. "video" (after --format; before
  942. --print/--output), "before_dl" (before each
  943. video download), "post_process" (after each
  944. video download; default), "after_move"
  945. (after moving video file to it's final
  946. locations), "after_video" (after downloading
  947. and processing all formats of a video), or
  948. "playlist" (at end of playlist). This option
  949. can be used multiple times to add different
  950. postprocessors
  951. SponsorBlock Options:
  952. Make chapter entries for, or remove various segments (sponsor, introductions, etc.) from downloaded YouTube videos using the SponsorBlock API
  953.  
  954. --sponsorblock-mark CATS SponsorBlock categories to create chapters
  955. for, separated by commas. Available
  956. categories are sponsor, intro, outro,
  957. selfpromo, preview, filler, interaction,
  958. music_offtopic, poi_highlight, chapter, all
  959. and default (=all). You can prefix the
  960. category with a "-" to exclude it. See [1]
  961. for description of the categories. E.g.
  962. --sponsorblock-mark all,-preview
  963. [1] https://wiki.sponsor.ajay.app/w/Segment_Categories
  964. --sponsorblock-remove CATS SponsorBlock categories to be removed from
  965. the video file, separated by commas. If a
  966. category is present in both mark and remove,
  967. remove takes precedence. The syntax and
  968. available categories are the same as for
  969. --sponsorblock-mark except that "default"
  970. refers to "all,-filler" and poi_highlight,
  971. chapter are not available
  972. --sponsorblock-chapter-title TEMPLATE
  973. An output template for the title of the
  974. SponsorBlock chapters created by
  975. --sponsorblock-mark. The only available
  976. fields are start_time, end_time, category,
  977. categories, name, category_names. Defaults
  978. to "[SponsorBlock]: %(category_names)l"
  979. --no-sponsorblock Disable both --sponsorblock-mark and
  980. --sponsorblock-remove
  981. --sponsorblock-api URL SponsorBlock API location, defaults to
  982. https://sponsor.ajay.app
  983. Extractor Options:
  984. --extractor-retries RETRIES Number of retries for known extractor errors
  985. (default is 3), or "infinite"
  986. --allow-dynamic-mpd Process dynamic DASH manifests (default)
  987. (Alias: --no-ignore-dynamic-mpd)
  988. --ignore-dynamic-mpd Do not process dynamic DASH manifests
  989. (Alias: --no-allow-dynamic-mpd)
  990. --hls-split-discontinuity Split HLS playlists to different formats at
  991. discontinuities such as ad breaks
  992. --no-hls-split-discontinuity Do not split HLS playlists to different
  993. formats at discontinuities such as ad breaks
  994. (default)
  995. --extractor-args IE_KEY:ARGS Pass ARGS arguments to the IE_KEY extractor.
  996. See "EXTRACTOR ARGUMENTS" for details. You
  997. can use this option multiple times to give
  998. arguments for different extractors
  999. CONFIGURATION
  1000. You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
  1001.  
  1002. Main Configuration:
  1003.  
  1004. The file given by --config-location
  1005. Portable Configuration: (Recommended for portable installations)
  1006.  
  1007. If using a binary, yt-dlp.conf in the same directory as the binary
  1008. If running from source-code, yt-dlp.conf in the parent directory of yt_dlp
  1009. Home Configuration:
  1010.  
  1011. yt-dlp.conf in the home path given by -P
  1012. If -P is not given, the current directory is searched
  1013. User Configuration:
  1014.  
  1015. ${XDG_CONFIG_HOME}/yt-dlp.conf
  1016. ${XDG_CONFIG_HOME}/yt-dlp/config (recommended on Linux/macOS)
  1017. ${XDG_CONFIG_HOME}/yt-dlp/config.txt
  1018. ${APPDATA}/yt-dlp.conf
  1019. ${APPDATA}/yt-dlp/config (recommended on Windows)
  1020. ${APPDATA}/yt-dlp/config.txt
  1021. ~/yt-dlp.conf
  1022. ~/yt-dlp.conf.txt
  1023. ~/.yt-dlp/config
  1024. ~/.yt-dlp/config.txt
  1025. See also: Notes about environment variables
  1026.  
  1027. System Configuration:
  1028.  
  1029. /etc/yt-dlp.conf
  1030. /etc/yt-dlp/config
  1031. /etc/yt-dlp/config.txt
  1032. E.g. with the following configuration file yt-dlp will always extract the audio, not copy the mtime, use a proxy and save all videos under YouTube directory in your home directory:
  1033.  
  1034. # Lines starting with # are comments
  1035.  
  1036. # Always extract audio
  1037. -x
  1038.  
  1039. # Do not copy the mtime
  1040. --no-mtime
  1041.  
  1042. # Use this proxy
  1043. --proxy 127.0.0.1:3128
  1044.  
  1045. # Save all videos under YouTube directory in your home directory
  1046. -o ~/YouTube/%(title)s.%(ext)s
  1047. Note: Options in configuration file are just the same options aka switches used in regular command line calls; thus there must be no whitespace after - or --, e.g. -o or --proxy but not - o or -- proxy. They must also be quoted when necessary as-if it were a UNIX shell.
  1048.  
  1049. You can use --ignore-config if you want to disable all configuration files for a particular yt-dlp run. If --ignore-config is found inside any configuration file, no further configuration will be loaded. For example, having the option in the portable configuration file prevents loading of home, user, and system configurations. Additionally, (for backward compatibility) if --ignore-config is found inside the system configuration file, the user configuration is not loaded.
  1050.  
  1051. Configuration file encoding
  1052. The configuration files are decoded according to the UTF BOM if present, and in the encoding from system locale otherwise.
  1053.  
  1054. If you want your file to be decoded differently, add # coding: ENCODING to the beginning of the file (e.g. # coding: shift-jis). There must be no characters before that, even spaces or BOM.
  1055.  
  1056. Authentication with netrc
  1057. You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with --username and --password) in order not to pass credentials as command line arguments on every yt-dlp execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a .netrc file on a per-extractor basis. For that you will need to create a .netrc file in --netrc-location and restrict permissions to read/write by only you:
  1058.  
  1059. touch ${HOME}/.netrc
  1060. chmod a-rwx,u+rw ${HOME}/.netrc
  1061. After that you can add credentials for an extractor in the following format, where extractor is the name of the extractor in lowercase:
  1062.  
  1063. machine <extractor> login <username> password <password>
  1064. E.g.
  1065.  
  1066. machine youtube login myaccount@gmail.com password my_youtube_password
  1067. machine twitch login my_twitch_account_name password my_twitch_password
  1068. To activate authentication with the .netrc file you should pass --netrc to yt-dlp or place it in the configuration file.
  1069.  
  1070. The default location of the .netrc file is ~ (see below).
  1071.  
  1072. As an alternative to using the .netrc file, which has the disadvantage of keeping your passwords in a plain text file, you can configure a custom shell command to provide the credentials for an extractor. This is done by providing the --netrc-cmd parameter, it shall output the credentials in the netrc format and return 0 on success, other values will be treated as an error. {} in the command will be replaced by the name of the extractor to make it possible to select the credentials for the right extractor.
  1073.  
  1074. E.g. To use an encrypted .netrc file stored as .authinfo.gpg
  1075.  
  1076. yt-dlp --netrc-cmd 'gpg --decrypt ~/.authinfo.gpg' https://www.youtube.com/watch?v=BaW_jenozKc
  1077. Notes about environment variables
  1078. Environment variables are normally specified as ${VARIABLE}/$VARIABLE on UNIX and %VARIABLE% on Windows; but is always shown as ${VARIABLE} in this documentation
  1079. yt-dlp also allow using UNIX-style variables on Windows for path-like options; e.g. --output, --config-location
  1080. If unset, ${XDG_CONFIG_HOME} defaults to ~/.config and ${XDG_CACHE_HOME} to ~/.cache
  1081. On Windows, ~ points to ${HOME} if present; or, ${USERPROFILE} or ${HOMEDRIVE}${HOMEPATH} otherwise
  1082. On Windows, ${USERPROFILE} generally points to C:\Users\<user name> and ${APPDATA} to ${USERPROFILE}\AppData\Roaming
  1083. OUTPUT TEMPLATE
  1084. The -o option is used to indicate a template for the output file names while -P option is used to specify the path each type of file should be saved to.
  1085.  
  1086. tl;dr: navigate me to examples.
  1087.  
  1088. The simplest usage of -o is not to set any template arguments when downloading a single file, like in yt-dlp -o funny_video.flv "https://some/video" (hard-coding file extension like this is not recommended and could break some post-processing).
  1089.  
  1090. It may however also contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to Python string formatting operations, e.g. %(NAME)s or %(NAME)05d. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations.
  1091.  
  1092. The field names themselves (the part inside the parenthesis) can also have some special formatting:
  1093.  
  1094. Object traversal: The dictionaries and lists available in metadata can be traversed by using a dot . separator; e.g. %(tags.0)s, %(subtitles.en.-1.ext)s. You can do Python slicing with colon :; E.g. %(id.3:7:-1)s, %(formats.:.format_id)s. Curly braces {} can be used to build dictionaries with only specific keys; e.g. %(formats.:.{format_id,height})#j. An empty field name %()s refers to the entire infodict; e.g. %(.{id,title})s. Note that all the fields that become available using this method are not listed below. Use -j to see such fields
  1095.  
  1096. Addition: Addition and subtraction of numeric fields can be done using + and - respectively. E.g. %(playlist_index+10)03d, %(n_entries+1-playlist_index)d
  1097.  
  1098. Date/time Formatting: Date/time fields can be formatted according to strftime formatting by specifying it separated from the field name using a >. E.g. %(duration>%H-%M-%S)s, %(upload_date>%Y-%m-%d)s, %(epoch-3600>%H-%M-%S)s
  1099.  
  1100. Alternatives: Alternate fields can be specified separated with a ,. E.g. %(release_date>%Y,upload_date>%Y|Unknown)s
  1101.  
  1102. Replacement: A replacement value can be specified using a & separator according to the str.format mini-language. If the field is not empty, this replacement value will be used instead of the actual field content. This is done after alternate fields are considered; thus the replacement is used if any of the alternative fields is not empty. E.g. %(chapters&has chapters|no chapters)s, %(title&TITLE={:>20}|NO TITLE)s
  1103.  
  1104. Default: A literal default value can be specified for when the field is empty using a | separator. This overrides --output-na-placeholder. E.g. %(uploader|Unknown)s
  1105.  
  1106. More Conversions: In addition to the normal format types diouxXeEfFgGcrs, yt-dlp additionally supports converting to B = Bytes, j = json (flag # for pretty-printing, + for Unicode), h = HTML escaping, l = a comma separated list (flag # for \n newline-separated), q = a string quoted for the terminal (flag # to split a list into different arguments), D = add Decimal suffixes (e.g. 10M) (flag # to use 1024 as factor), and S = Sanitize as filename (flag # for restricted)
  1107.  
  1108. Unicode normalization: The format type U can be used for NFC Unicode normalization. The alternate form flag (#) changes the normalization to NFD and the conversion flag + can be used for NFKC/NFKD compatibility equivalence normalization. E.g. %(title)+.100U is NFKC
  1109.  
  1110. To summarize, the general syntax for a field is:
  1111.  
  1112. %(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
  1113. Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon :. The different file types supported are subtitle, thumbnail, description, annotation (deprecated), infojson, link, pl_thumbnail, pl_description, pl_infojson, chapter, pl_video. E.g. -o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s" will put the thumbnails in a folder with the same name as the video. If any of the templates is empty, that type of file will not be written. E.g. --write-thumbnail -o "thumbnail:" will write thumbnails only for playlists and not for video.
  1114.  
  1115. Note: Due to post-processing (i.e. merging etc.), the actual output filename might differ. Use --print after_move:filepath to get the name after all post-processing is complete.
  1116.  
  1117. The available fields are:
  1118.  
  1119. id (string): Video identifier
  1120. title (string): Video title
  1121. fulltitle (string): Video title ignoring live timestamp and generic title
  1122. ext (string): Video filename extension
  1123. alt_title (string): A secondary title of the video
  1124. description (string): The description of the video
  1125. display_id (string): An alternative identifier for the video
  1126. uploader (string): Full name of the video uploader
  1127. license (string): License name the video is licensed under
  1128. creator (string): The creator of the video
  1129. timestamp (numeric): UNIX timestamp of the moment the video became available
  1130. upload_date (string): Video upload date in UTC (YYYYMMDD)
  1131. release_timestamp (numeric): UNIX timestamp of the moment the video was released
  1132. release_date (string): The date (YYYYMMDD) when the video was released in UTC
  1133. modified_timestamp (numeric): UNIX timestamp of the moment the video was last modified
  1134. modified_date (string): The date (YYYYMMDD) when the video was last modified in UTC
  1135. uploader_id (string): Nickname or id of the video uploader
  1136. channel (string): Full name of the channel the video is uploaded on
  1137. channel_id (string): Id of the channel
  1138. channel_follower_count (numeric): Number of followers of the channel
  1139. channel_is_verified (boolean): Whether the channel is verified on the platform
  1140. location (string): Physical location where the video was filmed
  1141. duration (numeric): Length of the video in seconds
  1142. duration_string (string): Length of the video (HH:mm:ss)
  1143. view_count (numeric): How many users have watched the video on the platform
  1144. concurrent_view_count (numeric): How many users are currently watching the video on the platform.
  1145. like_count (numeric): Number of positive ratings of the video
  1146. dislike_count (numeric): Number of negative ratings of the video
  1147. repost_count (numeric): Number of reposts of the video
  1148. average_rating (numeric): Average rating give by users, the scale used depends on the webpage
  1149. comment_count (numeric): Number of comments on the video (For some extractors, comments are only downloaded at the end, and so this field cannot be used)
  1150. age_limit (numeric): Age restriction for the video (years)
  1151. live_status (string): One of "not_live", "is_live", "is_upcoming", "was_live", "post_live" (was live, but VOD is not yet processed)
  1152. is_live (boolean): Whether this video is a live stream or a fixed-length video
  1153. was_live (boolean): Whether this video was originally a live stream
  1154. playable_in_embed (string): Whether this video is allowed to play in embedded players on other sites
  1155. availability (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
  1156. start_time (numeric): Time in seconds where the reproduction should start, as specified in the URL
  1157. end_time (numeric): Time in seconds where the reproduction should end, as specified in the URL
  1158. extractor (string): Name of the extractor
  1159. extractor_key (string): Key name of the extractor
  1160. epoch (numeric): Unix epoch of when the information extraction was completed
  1161. autonumber (numeric): Number that will be increased with each download, starting at --autonumber-start, padded with leading zeros to 5 digits
  1162. video_autonumber (numeric): Number that will be increased with each video
  1163. n_entries (numeric): Total number of extracted items in the playlist
  1164. playlist_id (string): Identifier of the playlist that contains the video
  1165. playlist_title (string): Name of the playlist that contains the video
  1166. playlist (string): playlist_id or playlist_title
  1167. playlist_count (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
  1168. playlist_index (numeric): Index of the video in the playlist padded with leading zeros according the final index
  1169. playlist_autonumber (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
  1170. playlist_uploader (string): Full name of the playlist uploader
  1171. playlist_uploader_id (string): Nickname or id of the playlist uploader
  1172. webpage_url (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
  1173. webpage_url_basename (string): The basename of the webpage URL
  1174. webpage_url_domain (string): The domain of the webpage URL
  1175. original_url (string): The URL given by the user (or same as webpage_url for playlist entries)
  1176. All the fields in Filtering Formats can also be used
  1177.  
  1178. Available for the video that belongs to some logical chapter or section:
  1179.  
  1180. chapter (string): Name or title of the chapter the video belongs to
  1181. chapter_number (numeric): Number of the chapter the video belongs to
  1182. chapter_id (string): Id of the chapter the video belongs to
  1183. Available for the video that is an episode of some series or programme:
  1184.  
  1185. series (string): Title of the series or programme the video episode belongs to
  1186. season (string): Title of the season the video episode belongs to
  1187. season_number (numeric): Number of the season the video episode belongs to
  1188. season_id (string): Id of the season the video episode belongs to
  1189. episode (string): Title of the video episode
  1190. episode_number (numeric): Number of the video episode within a season
  1191. episode_id (string): Id of the video episode
  1192. Available for the media that is a track or a part of a music album:
  1193.  
  1194. track (string): Title of the track
  1195. track_number (numeric): Number of the track within an album or a disc
  1196. track_id (string): Id of the track
  1197. artist (string): Artist(s) of the track
  1198. genre (string): Genre(s) of the track
  1199. album (string): Title of the album the track belongs to
  1200. album_type (string): Type of the album
  1201. album_artist (string): List of all artists appeared on the album
  1202. disc_number (numeric): Number of the disc or other physical medium the track belongs to
  1203. release_year (numeric): Year (YYYY) when the album was released
  1204. Available only when using --download-sections and for chapter: prefix when using --split-chapters for videos with internal chapters:
  1205.  
  1206. section_title (string): Title of the chapter
  1207. section_number (numeric): Number of the chapter within the file
  1208. section_start (numeric): Start time of the chapter in seconds
  1209. section_end (numeric): End time of the chapter in seconds
  1210. Available only when used in --print:
  1211.  
  1212. urls (string): The URLs of all requested formats, one in each line
  1213. filename (string): Name of the video file. Note that the actual filename may differ
  1214. formats_table (table): The video format table as printed by --list-formats
  1215. thumbnails_table (table): The thumbnail format table as printed by --list-thumbnails
  1216. subtitles_table (table): The subtitle format table as printed by --list-subs
  1217. automatic_captions_table (table): The automatic subtitle format table as printed by --list-subs
  1218. Available only after the video is downloaded (post_process/after_move):
  1219.  
  1220. filepath: Actual path of downloaded video file
  1221. Available only in --sponsorblock-chapter-title:
  1222.  
  1223. start_time (numeric): Start time of the chapter in seconds
  1224. end_time (numeric): End time of the chapter in seconds
  1225. categories (list): The SponsorBlock categories the chapter belongs to
  1226. category (string): The smallest SponsorBlock category the chapter belongs to
  1227. category_names (list): Friendly names of the categories
  1228. name (string): Friendly name of the smallest category
  1229. type (string): The SponsorBlock action type of the chapter
  1230. Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. E.g. for -o %(title)s-%(id)s.%(ext)s and an mp4 video with title yt-dlp test video and id BaW_jenozKc, this will result in a yt-dlp test video-BaW_jenozKc.mp4 file created in the current directory.
  1231.  
  1232. Note: Some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with --output-na-placeholder (NA by default).
  1233.  
  1234. Tip: Look at the -j output to identify which fields are available for the particular URL
  1235.  
  1236. For numeric sequences you can use numeric related formatting; e.g. %(view_count)05d will result in a string with view count padded with zeros up to 5 characters, like in 00042.
  1237.  
  1238. Output templates can also contain arbitrary hierarchical path, e.g. -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
  1239.  
  1240. To use percent literals in an output template use %%. To output to stdout use -o -.
  1241.  
  1242. The current default template is %(title)s [%(id)s].%(ext)s.
  1243.  
  1244. In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the --restrict-filenames flag to get a shorter title.
  1245.  
  1246. Output template examples
  1247. $ yt-dlp --print filename -o "test video.%(ext)s" BaW_jenozKc
  1248. test video.webm # Literal name with correct extension
  1249.  
  1250. $ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc
  1251. youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
  1252.  
  1253. $ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
  1254. youtube-dl_test_video_.webm # Restricted file name
  1255.  
  1256. # Download YouTube playlist videos in separate directory indexed by video order in a playlist
  1257. $ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
  1258.  
  1259. # Download YouTube playlist videos in separate directories according to their uploaded year
  1260. $ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
  1261.  
  1262. # Prefix playlist index with " - " separator, but only if it is available
  1263. $ yt-dlp -o "%(playlist_index&{} - |)s%(title)s.%(ext)s" BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
  1264.  
  1265. # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
  1266. $ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
  1267.  
  1268. # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
  1269. $ yt-dlp -u user -p password -P "~/MyVideos" -o "%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s" "https://www.udemy.com/java-tutorial"
  1270.  
  1271. # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
  1272. $ yt-dlp -P "C:/MyVideos" -o "%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" "https://videomore.ru/kino_v_detalayah/5_sezon/367617"
  1273.  
  1274. # Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
  1275. # and put all temporary files in "C:\MyVideos\tmp"
  1276. $ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs
  1277.  
  1278. # Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
  1279. $ yt-dlp -P "C:/MyVideos" -o "%(uploader)s/%(title)s.%(ext)s" -o "subtitle:%(uploader)s/subs/%(title)s.%(ext)s" BaW_jenozKc --write-subs
  1280.  
  1281. # Stream the video being downloaded to stdout
  1282. $ yt-dlp -o - BaW_jenozKc
  1283. FORMAT SELECTION
  1284. By default, yt-dlp tries to download the best available quality if you don't pass any options. This is generally equivalent to using -f bestvideo*+bestaudio/best. However, if multiple audiostreams is enabled (--audio-multistreams), the default format changes to -f bestvideo+bestaudio/best. Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to stdout (-o -), the default becomes -f best/bestvideo+bestaudio.
  1285.  
  1286. Deprecation warning: Latest versions of yt-dlp can stream multiple formats to the stdout simultaneously using ffmpeg. So, in future versions, the default for this will be set to -f bv*+ba/b similar to normal downloads. If you want to preserve the -f b/bv+ba setting, it is recommended to explicitly specify it in the configuration options.
  1287.  
  1288. The general syntax for format selection is -f FORMAT (or --format FORMAT) where FORMAT is a selector expression, i.e. an expression that describes format or formats you would like to download.
  1289.  
  1290. tl;dr: navigate me to examples.
  1291.  
  1292. The simplest case is requesting a specific format; e.g. with -f 22 you can download the format with format code equal to 22. You can get the list of available format codes for particular video using --list-formats or -F. Note that these format codes are extractor specific.
  1293.  
  1294. You can also use a file extension (currently 3gp, aac, flv, m4a, mp3, mp4, ogg, wav, webm are supported) to download the best quality format of a particular file extension served as a single file, e.g. -f webm will download the best quality format with the webm extension served as a single file.
  1295.  
  1296. You can use -f - to interactively provide the format selector for each video
  1297.  
  1298. You can also use special names to select particular edge case formats:
  1299.  
  1300. all: Select all formats separately
  1301. mergeall: Select and merge all formats (Must be used with --audio-multistreams, --video-multistreams or both)
  1302. b*, best*: Select the best quality format that contains either a video or an audio or both (ie; vcodec!=none or acodec!=none)
  1303. b, best: Select the best quality format that contains both video and audio. Equivalent to best*[vcodec!=none][acodec!=none]
  1304. bv, bestvideo: Select the best quality video-only format. Equivalent to best*[acodec=none]
  1305. bv*, bestvideo*: Select the best quality format that contains video. It may also contain audio. Equivalent to best*[vcodec!=none]
  1306. ba, bestaudio: Select the best quality audio-only format. Equivalent to best*[vcodec=none]
  1307. ba*, bestaudio*: Select the best quality format that contains audio. It may also contain video. Equivalent to best*[acodec!=none] (Do not use!)
  1308. w*, worst*: Select the worst quality format that contains either a video or an audio
  1309. w, worst: Select the worst quality format that contains both video and audio. Equivalent to worst*[vcodec!=none][acodec!=none]
  1310. wv, worstvideo: Select the worst quality video-only format. Equivalent to worst*[acodec=none]
  1311. wv*, worstvideo*: Select the worst quality format that contains video. It may also contain audio. Equivalent to worst*[vcodec!=none]
  1312. wa, worstaudio: Select the worst quality audio-only format. Equivalent to worst*[vcodec=none]
  1313. wa*, worstaudio*: Select the worst quality format that contains audio. It may also contain video. Equivalent to worst*[acodec!=none]
  1314. For example, to download the worst quality video-only format you can use -f worstvideo. It is however recommended not to use worst and related options. When your format selector is worst, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use -S +size or more rigorously, -S +size,+br,+res,+fps instead of -f worst. See Sorting Formats for more details.
  1315.  
  1316. You can select the n'th best format of a type by using best<type>.<n>. For example, best.2 will select the 2nd best combined format. Similarly, bv*.3 will select the 3rd best format that contains a video stream.
  1317.  
  1318. If you want to download multiple videos, and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred; e.g. -f 22/17/18 will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
  1319.  
  1320. If you want to download several formats of the same video use a comma as a separator, e.g. -f 22,17,18 will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: -f 136/137/mp4/bestvideo,140/m4a/bestaudio.
  1321.  
  1322. You can merge the video and audio of multiple formats into a single file using -f <format1>+<format2>+... (requires ffmpeg installed); e.g. -f bestvideo+bestaudio will download the best video-only format, the best audio-only format and mux them together with ffmpeg.
  1323.  
  1324. Deprecation warning: Since the below described behavior is complex and counter-intuitive, this will be removed and multistreams will be enabled by default in the future. A new operator will be instead added to limit formats to single audio/video
  1325.  
  1326. Unless --video-multistreams is used, all formats with a video stream except the first one are ignored. Similarly, unless --audio-multistreams is used, all formats with an audio stream except the first one are ignored. E.g. -f bestvideo+best+bestaudio --video-multistreams --audio-multistreams will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But -f bestvideo+best+bestaudio --no-video-multistreams will download and merge only bestvideo and bestaudio. best is ignored since another format containing a video stream (bestvideo) has already been selected. The order of the formats is therefore important. -f best+bestaudio --no-audio-multistreams will download only best while -f bestaudio+best --no-audio-multistreams will ignore best and download only bestaudio.
  1327.  
  1328. Filtering Formats
  1329. You can also filter the video formats by putting a condition in brackets, as in -f "best[height=720]" (or -f "[filesize>10M]" since filters without a selector are interpreted as best).
  1330.  
  1331. The following numeric meta fields can be used with comparisons <, <=, >, >=, = (equals), != (not equals):
  1332.  
  1333. filesize: The number of bytes, if known in advance
  1334. filesize_approx: An estimate for the number of bytes
  1335. width: Width of the video, if known
  1336. height: Height of the video, if known
  1337. aspect_ratio: Aspect ratio of the video, if known
  1338. tbr: Average bitrate of audio and video in KBit/s
  1339. abr: Average audio bitrate in KBit/s
  1340. vbr: Average video bitrate in KBit/s
  1341. asr: Audio sampling rate in Hertz
  1342. fps: Frame rate
  1343. audio_channels: The number of audio channels
  1344. stretched_ratio: width:height of the video's pixels, if not square
  1345. Also filtering work for comparisons = (equals), ^= (starts with), $= (ends with), *= (contains), ~= (matches regex) and following string meta fields:
  1346.  
  1347. url: Video URL
  1348. ext: File extension
  1349. acodec: Name of the audio codec in use
  1350. vcodec: Name of the video codec in use
  1351. container: Name of the container format
  1352. protocol: The protocol that will be used for the actual download, lower-case (http, https, rtsp, rtmp, rtmpe, mms, f4m, ism, http_dash_segments, m3u8, or m3u8_native)
  1353. language: Language code
  1354. dynamic_range: The dynamic range of the video
  1355. format_id: A short description of the format
  1356. format: A human-readable description of the format
  1357. format_note: Additional info about the format
  1358. resolution: Textual description of width and height
  1359. Any string comparison may be prefixed with negation ! in order to produce an opposite comparison, e.g. !*= (does not contain). The comparand of a string comparison needs to be quoted with either double or single quotes if it contains spaces or special characters other than ._-.
  1360.  
  1361. Note: None of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.
  1362.  
  1363. Formats for which the value is not known are excluded unless you put a question mark (?) after the operator. You can combine format filters, so -f "bv[height<=?720][tbr>500]" selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s. You can also use the filters with all to download all formats that satisfy the filter, e.g. -f "all[vcodec=none]" selects all audio-only formats.
  1364.  
  1365. Format selectors can also be grouped using parentheses; e.g. -f "(mp4,webm)[height<480]" will download the best pre-merged mp4 and webm formats with a height lower than 480.
  1366.  
  1367. Sorting Formats
  1368. You can change the criteria for being considered the best by using -S (--format-sort). The general format for this is --format-sort field1,field2....
  1369.  
  1370. The available fields are:
  1371.  
  1372. hasvid: Gives priority to formats that have a video stream
  1373. hasaud: Gives priority to formats that have an audio stream
  1374. ie_pref: The format preference
  1375. lang: The language preference
  1376. quality: The quality of the format
  1377. source: The preference of the source
  1378. proto: Protocol used for download (https/ftps > http/ftp > m3u8_native/m3u8 > http_dash_segments> websocket_frag > mms/rtsp > f4f/f4m)
  1379. vcodec: Video Codec (av01 > vp9.2 > vp9 > h265 > h264 > vp8 > h263 > theora > other)
  1380. acodec: Audio Codec (flac/alac > wav/aiff > opus > vorbis > aac > mp4a > mp3 > ac4 > eac3 > ac3 > dts > other)
  1381. codec: Equivalent to vcodec,acodec
  1382. vext: Video Extension (mp4 > mov > webm > flv > other). If --prefer-free-formats is used, webm is preferred.
  1383. aext: Audio Extension (m4a > aac > mp3 > ogg > opus > webm > other). If --prefer-free-formats is used, the order changes to ogg > opus > webm > mp3 > m4a > aac
  1384. ext: Equivalent to vext,aext
  1385. filesize: Exact filesize, if known in advance
  1386. fs_approx: Approximate filesize
  1387. size: Exact filesize if available, otherwise approximate filesize
  1388. height: Height of video
  1389. width: Width of video
  1390. res: Video resolution, calculated as the smallest dimension.
  1391. fps: Framerate of video
  1392. hdr: The dynamic range of the video (DV > HDR12 > HDR10+ > HDR10 > HLG > SDR)
  1393. channels: The number of audio channels
  1394. tbr: Total average bitrate in KBit/s
  1395. vbr: Average video bitrate in KBit/s
  1396. abr: Average audio bitrate in KBit/s
  1397. br: Average bitrate in KBit/s, tbr/vbr/abr
  1398. asr: Audio sample rate in Hz
  1399. Deprecation warning: Many of these fields have (currently undocumented) aliases, that may be removed in a future version. It is recommended to use only the documented field names.
  1400.  
  1401. All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a +. E.g. +res prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a :. E.g. res:720 prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For codec and ext, you can provide two preferred values, the first for video and the second for audio. E.g. +codec:avc:m4a (equivalent to +vcodec:avc,+acodec:m4a) sets the video codec preference to h264 > h265 > vp9 > vp9.2 > av01 > vp8 > h263 > theora and audio codec preference to mp4a > aac > vorbis > opus > mp3 > ac3 > dts. You can also make the sorting prefer the nearest values to the provided by using ~ as the delimiter. E.g. filesize~1G prefers the format with filesize closest to 1 GiB.
  1402.  
  1403. The fields hasvid and ie_pref are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using --format-sort-force. Apart from these, the default order used is: lang,quality,res,fps,hdr:12,vcodec:vp9.2,channels,acodec,size,br,asr,proto,ext,hasaud,source,id. The extractors may override this default order, but they cannot override the user-provided order.
  1404.  
  1405. Note that the default has vcodec:vp9.2; i.e. av1 is not preferred. Similarly, the default for hdr is hdr:12; i.e. dolby vision is not preferred. These choices are made since DV and AV1 formats are not yet fully compatible with most devices. This may be changed in the future as more devices become capable of smoothly playing back these formats.
  1406.  
  1407. If your format selector is worst, the last item is selected after sorting. This means it will select the format that is worst in all respects. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use -f best -S +size,+br,+res,+fps.
  1408.  
  1409. Tip: You can use the -v -F to see how the formats have been sorted (worst to best).
  1410.  
  1411. Format Selection examples
  1412. # Download and merge the best video-only format and the best audio-only format,
  1413. # or download the best combined format if video-only format is not available
  1414. $ yt-dlp -f "bv+ba/b"
  1415.  
  1416. # Download best format that contains video,
  1417. # and if it doesn't already have an audio stream, merge it with best audio-only format
  1418. $ yt-dlp -f "bv*+ba/b"
  1419.  
  1420. # Same as above
  1421. $ yt-dlp
  1422.  
  1423. # Download the best video-only format and the best audio-only format without merging them
  1424. # For this case, an output template should be used since
  1425. # by default, bestvideo and bestaudio will have the same file name.
  1426. $ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
  1427.  
  1428. # Download and merge the best format that has a video stream,
  1429. # and all audio-only formats into one file
  1430. $ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
  1431.  
  1432. # Download and merge the best format that has a video stream,
  1433. # and the best 2 audio-only formats into one file
  1434. $ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
  1435.  
  1436.  
  1437. # The following examples show the old method (without -S) of format selection
  1438. # and how to use -S to achieve a similar but (generally) better result
  1439.  
  1440. # Download the worst video available (old method)
  1441. $ yt-dlp -f "wv*+wa/w"
  1442.  
  1443. # Download the best video available but with the smallest resolution
  1444. $ yt-dlp -S "+res"
  1445.  
  1446. # Download the smallest video available
  1447. $ yt-dlp -S "+size,+br"
  1448.  
  1449.  
  1450.  
  1451. # Download the best mp4 video available, or the best video if no mp4 available
  1452. $ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
  1453.  
  1454. # Download the best video with the best extension
  1455. # (For video, mp4 > mov > webm > flv. For audio, m4a > aac > mp3 ...)
  1456. $ yt-dlp -S "ext"
  1457.  
  1458.  
  1459.  
  1460. # Download the best video available but no better than 480p,
  1461. # or the worst video if there is no video under 480p
  1462. $ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"
  1463.  
  1464. # Download the best video available with the largest height but no better than 480p,
  1465. # or the best video with the smallest resolution if there is no video under 480p
  1466. $ yt-dlp -S "height:480"
  1467.  
  1468. # Download the best video available with the largest resolution but no better than 480p,
  1469. # or the best video with the smallest resolution if there is no video under 480p
  1470. # Resolution is determined by using the smallest dimension.
  1471. # So this works correctly for vertical videos as well
  1472. $ yt-dlp -S "res:480"
  1473.  
  1474.  
  1475.  
  1476. # Download the best video (that also has audio) but no bigger than 50 MB,
  1477. # or the worst video (that also has audio) if there is no video under 50 MB
  1478. $ yt-dlp -f "b[filesize<50M] / w"
  1479.  
  1480. # Download largest video (that also has audio) but no bigger than 50 MB,
  1481. # or the smallest video (that also has audio) if there is no video under 50 MB
  1482. $ yt-dlp -f "b" -S "filesize:50M"
  1483.  
  1484. # Download best video (that also has audio) that is closest in size to 50 MB
  1485. $ yt-dlp -f "b" -S "filesize~50M"
  1486.  
  1487.  
  1488.  
  1489. # Download best video available via direct link over HTTP/HTTPS protocol,
  1490. # or the best video available via any protocol if there is no such video
  1491. $ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
  1492.  
  1493. # Download best video available via the best protocol
  1494. # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
  1495. $ yt-dlp -S "proto"
  1496.  
  1497.  
  1498.  
  1499. # Download the best video with either h264 or h265 codec,
  1500. # or the best video if there is no such video
  1501. $ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"
  1502.  
  1503. # Download the best video with best codec no better than h264,
  1504. # or the best video with worst codec if there is no such video
  1505. $ yt-dlp -S "codec:h264"
  1506.  
  1507. # Download the best video with worst codec no worse than h264,
  1508. # or the best video with best codec if there is no such video
  1509. $ yt-dlp -S "+codec:h264"
  1510.  
  1511.  
  1512.  
  1513. # More complex examples
  1514.  
  1515. # Download the best video no better than 720p preferring framerate greater than 30,
  1516. # or the worst video (still preferring framerate greater than 30) if there is no such video
  1517. $ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"
  1518.  
  1519. # Download the video with the largest resolution no better than 720p,
  1520. # or the video with the smallest resolution available if there is no such video,
  1521. # preferring larger framerate for formats with the same resolution
  1522. $ yt-dlp -S "res:720,fps"
  1523.  
  1524.  
  1525.  
  1526. # Download the video with smallest resolution no worse than 480p,
  1527. # or the video with the largest resolution available if there is no such video,
  1528. # preferring better codec and then larger total bitrate for the same resolution
  1529. $ yt-dlp -S "+res:480,codec,br"
  1530. MODIFYING METADATA
  1531. The metadata obtained by the extractors can be modified by using --parse-metadata and --replace-in-metadata
  1532.  
  1533. --replace-in-metadata FIELDS REGEX REPLACE is used to replace text in any metadata field using python regular expression. Backreferences can be used in the replace string for advanced use.
  1534.  
  1535. The general syntax of --parse-metadata FROM:TO is to give the name of a field or an output template to extract data from, and the format to interpret it as, separated by a colon :. Either a python regular expression with named capture groups, a single field name, or a similar syntax to the output template (only %(field)s formatting is supported) can be used for TO. The option can be used multiple times to parse and modify various fields.
  1536.  
  1537. Note that these options preserve their relative order, allowing replacements to be made in parsed fields and viceversa. Also, any field thus created can be used in the output template and will also affect the media file's metadata added when using --embed-metadata.
  1538.  
  1539. This option also has a few special uses:
  1540.  
  1541. You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field additional_urls to the URL that you want to download. E.g. --parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)" will download the first vimeo video found in the description
  1542.  
  1543. You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a meta_ prefix. For example, any value you set to meta_description field will be added to the description field in the file - you can use this to set a different "description" and "synopsis". To modify the metadata of individual streams, use the meta<n>_ prefix (e.g. meta1_language). Any value set to the meta_ field will overwrite all default values.
  1544.  
  1545. Note: Metadata modification happens before format selection, post-extraction and other post-processing operations. Some fields may be added or changed during these steps, overriding your changes.
  1546.  
  1547. For reference, these are the fields yt-dlp adds by default to the file metadata:
  1548.  
  1549. Metadata fields From
  1550. title track or title
  1551. date upload_date
  1552. description, synopsis description
  1553. purl, comment webpage_url
  1554. track track_number
  1555. artist artist, creator, uploader or uploader_id
  1556. genre genre
  1557. album album
  1558. album_artist album_artist
  1559. disc disc_number
  1560. show series
  1561. season_number season_number
  1562. episode_id episode or episode_id
  1563. episode_sort episode_number
  1564. language of each stream the format's language
  1565. Note: The file format may not support some of these fields
  1566.  
  1567. Modifying metadata examples
  1568. # Interpret the title as "Artist - Title"
  1569. $ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
  1570.  
  1571. # Regex example
  1572. $ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"
  1573.  
  1574. # Set title as "Series name S01E05"
  1575. $ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
  1576.  
  1577. # Prioritize uploader as the "artist" field in video metadata
  1578. $ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --embed-metadata
  1579.  
  1580. # Set "comment" field in video metadata using description instead of webpage_url,
  1581. # handling multiple lines correctly
  1582. $ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --embed-metadata
  1583.  
  1584. # Do not set any "synopsis" in the video metadata
  1585. $ yt-dlp --parse-metadata ":(?P<meta_synopsis>)"
  1586.  
  1587. # Remove "formats" field from the infojson by setting it to an empty string
  1588. $ yt-dlp --parse-metadata "video::(?P<formats>)" --write-info-json
  1589.  
  1590. # Replace all spaces and "_" in title and uploader with a `-`
  1591. $ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
  1592. EXTRACTOR ARGUMENTS
  1593. Some extractors accept additional arguments which can be passed using --extractor-args KEY:ARGS. ARGS is a ; (semicolon) separated string of ARG=VAL1,VAL2. E.g. --extractor-args "youtube:player-client=android_embedded,web;include_live_dash" --extractor-args "funimation:version=uncut"
  1594.  
  1595. Note: In CLI, ARG can use - instead of _; e.g. youtube:player-client" becomes youtube:player_client"
  1596.  
  1597. The following extractors use this feature:
  1598.  
  1599. youtube
  1600. lang: Prefer translated metadata (title, description etc) of this language code (case-sensitive). By default, the video primary language metadata is preferred, with a fallback to en translated. See youtube.py for list of supported content language codes
  1601. skip: One or more of hls, dash or translated_subs to skip extraction of the m3u8 manifests, dash manifests and auto-translated subtitles respectively
  1602. player_client: Clients to extract video data from. The main clients are web, android and ios with variants _music, _embedded, _embedscreen, _creator (e.g. web_embedded); and mweb, mweb_embedscreen and tv_embedded (agegate bypass) with no variants. By default, ios,android,web is used, but tv_embedded and creator variants are added as required for age-gated videos. Similarly, the music variants are added for music.youtube.com urls. You can use all to use all the clients, and default for the default clients.
  1603. player_skip: Skip some network requests that are generally needed for robust extraction. One or more of configs (skip client configs), webpage (skip initial webpage), js (skip js player). While these options can help reduce the number of requests needed or avoid some rate-limiting, they could cause some issues. See #860 for more details
  1604. player_params: YouTube player parameters to use for player requests. Will overwrite any default ones set by yt-dlp.
  1605. comment_sort: top or new (default) - choose comment sorting mode (on YouTube's side)
  1606. max_comments: Limit the amount of comments to gather. Comma-separated list of integers representing max-comments,max-parents,max-replies,max-replies-per-thread. Default is all,all,all,all
  1607. E.g. all,all,1000,10 will get a maximum of 1000 replies total, with up to 10 replies per thread. 1000,all,100 will get a maximum of 1000 comments, with a maximum of 100 replies total
  1608. formats: Change the types of formats to return. dashy (convert HTTP to DASH), duplicate (identical content but different URLs or protocol; includes dashy), incomplete (cannot be downloaded completely - live dash and post-live m3u8)
  1609. innertube_host: Innertube API host to use for all API requests; e.g. studio.youtube.com, youtubei.googleapis.com. Note that cookies exported from one subdomain will not work on others
  1610. innertube_key: Innertube API key to use for all API requests
  1611. raise_incomplete_data: Incomplete Data Received raises an error instead of reporting a warning
  1612. youtubetab (YouTube playlists, channels, feeds, etc.)
  1613. skip: One or more of webpage (skip initial webpage download), authcheck (allow the download of playlists requiring authentication when no initial webpage is downloaded. This may cause unwanted behavior, see #1122 for more details)
  1614. approximate_date: Extract approximate upload_date and timestamp in flat-playlist. This may cause date-based filters to be slightly off
  1615. generic
  1616. fragment_query: Passthrough any query in mpd/m3u8 manifest URLs to their fragments if no value is provided, or else apply the query string given as fragment_query=VALUE. Does not apply to ffmpeg
  1617. variant_query: Passthrough the master m3u8 URL query to its variant playlist URLs if no value is provided, or else apply the query string given as variant_query=VALUE
  1618. hls_key: An HLS AES-128 key URI or key (as hex), and optionally the IV (as hex), in the form of (URI|KEY)[,IV]; e.g. generic:hls_key=ABCDEF1234567980,0xFEDCBA0987654321. Passing any of these values will force usage of the native HLS downloader and override the corresponding values found in the m3u8 playlist
  1619. is_live: Bypass live HLS detection and manually set live_status - a value of false will set not_live, any other value (or no value) will set is_live
  1620. funimation
  1621. language: Audio languages to extract, e.g. funimation:language=english,japanese
  1622. version: The video version to extract - uncut or simulcast
  1623. crunchyrollbeta (Crunchyroll)
  1624. format: Which stream type(s) to extract (default: adaptive_hls). Potentially useful values include adaptive_hls, adaptive_dash, vo_adaptive_hls, vo_adaptive_dash, download_hls, download_dash, multitrack_adaptive_hls_v2
  1625. hardsub: Preference order for which hardsub versions to extract, or all (default: None = no hardsubs), e.g. crunchyrollbeta:hardsub=en-US,None
  1626. vikichannel
  1627. video_types: Types of videos to download - one or more of episodes, movies, clips, trailers
  1628. niconico
  1629. segment_duration: Segment duration in milliseconds for HLS-DMC formats. Use it at your own risk since this feature may result in your account termination.
  1630. youtubewebarchive
  1631. check_all: Try to check more at the cost of more requests. One or more of thumbnails, captures
  1632. gamejolt
  1633. comment_sort: hot (default), you (cookies needed), top, new - choose comment sorting mode (on GameJolt's side)
  1634. hotstar
  1635. res: resolution to ignore - one or more of sd, hd, fhd
  1636. vcodec: vcodec to ignore - one or more of h264, h265, dvh265
  1637. dr: dynamic range to ignore - one or more of sdr, hdr10, dv
  1638. niconicochannelplus
  1639. max_comments: Maximum number of comments to extract - default is 120
  1640. tiktok
  1641. api_hostname: Hostname to use for mobile API requests, e.g. api-h2.tiktokv.com
  1642. app_version: App version to call mobile APIs with - should be set along with manifest_app_version, e.g. 20.2.1
  1643. manifest_app_version: Numeric app version to call mobile APIs with, e.g. 221
  1644. rokfinchannel
  1645. tab: Which tab to download - one of new, top, videos, podcasts, streams, stacks
  1646. twitter
  1647. api: Select one of graphql (default), legacy or syndication as the API for tweet extraction. Has no effect if logged in
  1648. stacommu, wrestleuniverse
  1649. device_id: UUID value assigned by the website and used to enforce device limits for paid livestream content. Can be found in browser local storage
  1650. twitch
  1651. client_id: Client ID value to be sent with GraphQL requests, e.g. twitch:client_id=kimne78kx3ncx6brgo4mv6wki5h1ko
  1652. nhkradirulive (NHK らじる★らじる LIVE)
  1653. area: Which regional variation to extract. Valid areas are: sapporo, sendai, tokyo, nagoya, osaka, hiroshima, matsuyama, fukuoka. Defaults to tokyo
  1654. nflplusreplay
  1655. type: Type(s) of game replays to extract. Valid types are: full_game, full_game_spanish, condensed_game and all_22. You can use all to extract all available replay types, which is the default
  1656. Note: These options may be changed/removed in the future without concern for backward compatibility
  1657.  
  1658. PLUGINS
  1659. Note that all plugins are imported even if not invoked, and that there are no checks performed on plugin code. Use plugins at your own risk and only if you trust the code!
  1660.  
  1661. Plugins can be of <type>s extractor or postprocessor.
  1662.  
  1663. Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it.
  1664. Extractor plugins take priority over builtin extractors.
  1665. Postprocessor plugins can be invoked using --use-postprocessor NAME.
  1666. Plugins are loaded from the namespace packages yt_dlp_plugins.extractor and yt_dlp_plugins.postprocessor.
  1667.  
  1668. In other words, the file structure on the disk looks something like:
  1669.  
  1670. yt_dlp_plugins/
  1671. extractor/
  1672. myplugin.py
  1673. postprocessor/
  1674. myplugin.py
  1675. yt-dlp looks for these yt_dlp_plugins namespace folders in many locations (see below) and loads in plugins from all of them.
  1676.  
  1677. See the wiki for some known plugins
  1678.  
  1679. Installing Plugins
  1680. Plugins can be installed using various methods and locations.
  1681.  
  1682. Configuration directories: Plugin packages (containing a yt_dlp_plugins namespace folder) can be dropped into the following standard configuration locations:
  1683.  
  1684. User Plugins
  1685. ${XDG_CONFIG_HOME}/yt-dlp/plugins/<package name>/yt_dlp_plugins/ (recommended on Linux/macOS)
  1686. ${XDG_CONFIG_HOME}/yt-dlp-plugins/<package name>/yt_dlp_plugins/
  1687. ${APPDATA}/yt-dlp/plugins/<package name>/yt_dlp_plugins/ (recommended on Windows)
  1688. ${APPDATA}/yt-dlp-plugins/<package name>/yt_dlp_plugins/
  1689. ~/.yt-dlp/plugins/<package name>/yt_dlp_plugins/
  1690. ~/yt-dlp-plugins/<package name>/yt_dlp_plugins/
  1691. System Plugins
  1692. /etc/yt-dlp/plugins/<package name>/yt_dlp_plugins/
  1693. /etc/yt-dlp-plugins/<package name>/yt_dlp_plugins/
  1694. Executable location: Plugin packages can similarly be installed in a yt-dlp-plugins directory under the executable location (recommended for portable installations):
  1695.  
  1696. Binary: where <root-dir>/yt-dlp.exe, <root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/
  1697. Source: where <root-dir>/yt_dlp/__main__.py, <root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/
  1698. pip and other locations in PYTHONPATH
  1699.  
  1700. Plugin packages can be installed and managed using pip. See yt-dlp-sample-plugins for an example.
  1701. Note: plugin files between plugin packages installed with pip must have unique filenames.
  1702. Any path in PYTHONPATH is searched in for the yt_dlp_plugins namespace folder.
  1703. Note: This does not apply for Pyinstaller/py2exe builds.
  1704. .zip, .egg and .whl archives containing a yt_dlp_plugins namespace folder in their root are also supported as plugin packages.
  1705.  
  1706. e.g. ${XDG_CONFIG_HOME}/yt-dlp/plugins/mypluginpkg.zip where mypluginpkg.zip contains yt_dlp_plugins/<type>/myplugin.py
  1707. Run yt-dlp with --verbose to check if the plugin has been loaded.
  1708.  
  1709. Developing Plugins
  1710. See the yt-dlp-sample-plugins repo for a template plugin package and the Plugin Development section of the wiki for a plugin development guide.
  1711.  
  1712. All public classes with a name ending in IE/PP are imported from each file for extractors and postprocessors repectively. This respects underscore prefix (e.g. _MyBasePluginIE is private) and __all__. Modules can similarly be excluded by prefixing the module name with an underscore (e.g. _myplugin.py).
  1713.  
  1714. To replace an existing extractor with a subclass of one, set the plugin_name class keyword argument (e.g. class MyPluginIE(ABuiltInIE, plugin_name='myplugin') will replace ABuiltInIE with MyPluginIE). Since the extractor replaces the parent, you should exclude the subclass extractor from being imported separately by making it private using one of the methods described above.
  1715.  
  1716. If you are a plugin author, add yt-dlp-plugins as a topic to your repository for discoverability.
  1717.  
  1718. See the Developer Instructions on how to write and test an extractor.
  1719.  
  1720. EMBEDDING YT-DLP
  1721. yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
  1722.  
  1723. Your program should avoid parsing the normal stdout since they may change in future versions. Instead they should use options such as -J, --print, --progress-template, --exec etc to create console output that you can reliably reproduce and parse.
  1724.  
  1725. From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
  1726.  
  1727. from yt_dlp import YoutubeDL
  1728.  
  1729. URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
  1730. with YoutubeDL() as ydl:
  1731. ydl.download(URLS)
  1732. Most likely, you'll want to use various options. For a list of options available, have a look at yt_dlp/YoutubeDL.py or help(yt_dlp.YoutubeDL) in a Python shell. If you are already familiar with the CLI, you can use devscripts/cli_to_api.py to translate any CLI switches to YoutubeDL params.
  1733.  
  1734. Tip: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of YoutubeDL.extract_info to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through YoutubeDL.sanitize_info as shown in the example below
  1735.  
  1736. Embedding examples
  1737. Extracting information
  1738. import json
  1739. import yt_dlp
  1740.  
  1741. URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'
  1742.  
  1743. # ℹ️ See help(yt_dlp.YoutubeDL) for a list of available options and public functions
  1744. ydl_opts = {}
  1745. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  1746. info = ydl.extract_info(URL, download=False)
  1747.  
  1748. # ℹ️ ydl.sanitize_info makes the info json-serializable
  1749. print(json.dumps(ydl.sanitize_info(info)))
  1750. Download using an info-json
  1751. import yt_dlp
  1752.  
  1753. INFO_FILE = 'path/to/video.info.json'
  1754.  
  1755. with yt_dlp.YoutubeDL() as ydl:
  1756. error_code = ydl.download_with_info_file(INFO_FILE)
  1757.  
  1758. print('Some videos failed to download' if error_code
  1759. else 'All videos successfully downloaded')
  1760. Extract audio
  1761. import yt_dlp
  1762.  
  1763. URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
  1764.  
  1765. ydl_opts = {
  1766. 'format': 'm4a/bestaudio/best',
  1767. # ℹ️ See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
  1768. 'postprocessors': [{ # Extract audio using ffmpeg
  1769. 'key': 'FFmpegExtractAudio',
  1770. 'preferredcodec': 'm4a',
  1771. }]
  1772. }
  1773.  
  1774. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  1775. error_code = ydl.download(URLS)
  1776. Filter videos
  1777. import yt_dlp
  1778.  
  1779. URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
  1780.  
  1781. def longer_than_a_minute(info, *, incomplete):
  1782. """Download only videos longer than a minute (or with unknown duration)"""
  1783. duration = info.get('duration')
  1784. if duration and duration < 60:
  1785. return 'The video is too short'
  1786.  
  1787. ydl_opts = {
  1788. 'match_filter': longer_than_a_minute,
  1789. }
  1790.  
  1791. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  1792. error_code = ydl.download(URLS)
  1793. Adding logger and progress hook
  1794. import yt_dlp
  1795.  
  1796. URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
  1797.  
  1798. class MyLogger:
  1799. def debug(self, msg):
  1800. # For compatibility with youtube-dl, both debug and info are passed into debug
  1801. # You can distinguish them by the prefix '[debug] '
  1802. if msg.startswith('[debug] '):
  1803. pass
  1804. else:
  1805. self.info(msg)
  1806.  
  1807. def info(self, msg):
  1808. pass
  1809.  
  1810. def warning(self, msg):
  1811. pass
  1812.  
  1813. def error(self, msg):
  1814. print(msg)
  1815.  
  1816.  
  1817. # ℹ️ See "progress_hooks" in help(yt_dlp.YoutubeDL)
  1818. def my_hook(d):
  1819. if d['status'] == 'finished':
  1820. print('Done downloading, now post-processing ...')
  1821.  
  1822.  
  1823. ydl_opts = {
  1824. 'logger': MyLogger(),
  1825. 'progress_hooks': [my_hook],
  1826. }
  1827.  
  1828. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  1829. ydl.download(URLS)
  1830. Add a custom PostProcessor
  1831. import yt_dlp
  1832.  
  1833. URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
  1834.  
  1835. # ℹ️ See help(yt_dlp.postprocessor.PostProcessor)
  1836. class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
  1837. def run(self, info):
  1838. self.to_screen('Doing stuff')
  1839. return [], info
  1840.  
  1841.  
  1842. with yt_dlp.YoutubeDL() as ydl:
  1843. # ℹ️ "when" can take any value in yt_dlp.utils.POSTPROCESS_WHEN
  1844. ydl.add_post_processor(MyCustomPP(), when='pre_process')
  1845. ydl.download(URLS)
  1846. Use a custom format selector
  1847. import yt_dlp
  1848.  
  1849. URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
  1850.  
  1851. def format_selector(ctx):
  1852. """ Select the best video and the best audio that won't result in an mkv.
  1853. NOTE: This is just an example and does not handle all cases """
  1854.  
  1855. # formats are already sorted worst to best
  1856. formats = ctx.get('formats')[::-1]
  1857.  
  1858. # acodec='none' means there is no audio
  1859. best_video = next(f for f in formats
  1860. if f['vcodec'] != 'none' and f['acodec'] == 'none')
  1861.  
  1862. # find compatible audio extension
  1863. audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
  1864. # vcodec='none' means there is no video
  1865. best_audio = next(f for f in formats if (
  1866. f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
  1867.  
  1868. # These are the minimum required fields for a merged format
  1869. yield {
  1870. 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
  1871. 'ext': best_video['ext'],
  1872. 'requested_formats': [best_video, best_audio],
  1873. # Must be + separated list of protocols
  1874. 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
  1875. }
  1876.  
  1877.  
  1878. ydl_opts = {
  1879. 'format': format_selector,
  1880. }
  1881.  
  1882. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  1883. ydl.download(URLS)
  1884. DEPRECATED OPTIONS
  1885. These are all the deprecated options and the current alternative to achieve the same effect
  1886.  
  1887. Almost redundant options
  1888. While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant
  1889.  
  1890. -j, --dump-json --print "%()j"
  1891. -F, --list-formats --print formats_table
  1892. --list-thumbnails --print thumbnails_table --print playlist:thumbnails_table
  1893. --list-subs --print automatic_captions_table --print subtitles_table
  1894. Redundant options
  1895. While these options are redundant, they are still expected to be used due to their ease of use
  1896.  
  1897. --get-description --print description
  1898. --get-duration --print duration_string
  1899. --get-filename --print filename
  1900. --get-format --print format
  1901. --get-id --print id
  1902. --get-thumbnail --print thumbnail
  1903. -e, --get-title --print title
  1904. -g, --get-url --print urls
  1905. --match-title REGEX --match-filter "title ~= (?i)REGEX"
  1906. --reject-title REGEX --match-filter "title !~= (?i)REGEX"
  1907. --min-views COUNT --match-filter "view_count >=? COUNT"
  1908. --max-views COUNT --match-filter "view_count <=? COUNT"
  1909. --break-on-reject Use --break-match-filter
  1910. --user-agent UA --add-header "User-Agent:UA"
  1911. --referer URL --add-header "Referer:URL"
  1912. --playlist-start NUMBER -I NUMBER:
  1913. --playlist-end NUMBER -I :NUMBER
  1914. --playlist-reverse -I ::-1
  1915. --no-playlist-reverse Default
  1916. --no-colors --color no_color
Tags: yt-dlp Youtube-DLP
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!