3 [![Release version](https://img.shields.io/github/v/release/pukkandan/yt-dlp?color=brightgreen&label=Release)]
(https://github.com/pukkandan/yt-dlp/releases/latest)
4 [![License: Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](LICENSE)
5 [![CI Status](https://github.com/pukkandan/yt-dlp/workflows/Core%20Tests/badge.svg?branch=master)]
(https://github.com/pukkandan/yt-dlp/actions)
6 [![Commits](https://img.shields.io/github/commit-activity/m/pukkandan/yt-dlp?label=commits)]
(https://github.com/pukkandan/yt-dlp/commits)
7 [![Last Commit](https://img.shields.io/github/last-commit/pukkandan/yt-dlp/master)]
(https://github.com/pukkandan/yt-dlp/commits)
8 [![Downloads](https://img.shields.io/github/downloads/pukkandan/yt-dlp/total)]
(https://github.com/pukkandan/yt-dlp/releases/latest)
9 [![PyPi Downloads](https://img.shields.io/pypi/dm/yt-dlp?label=PyPi)]
(https://pypi.org/project/yt-dlp)
11 A command-line program to download videos from youtube.com and many other [video platforms](docs/supportedsites.md)
13 This is a fork of
[youtube-dlc](https://github.com/blackjack4494/yt-dlc) which is inturn a fork of
[youtube-dl](https://github.com/ytdl-org/youtube-dl)
15 * [NEW FEATURES](#new-features)
16 * [INSTALLATION](#installation)
19 * [DESCRIPTION](#description)
21 * [Network Options](#network-options)
22 * [Geo Restriction](#geo-restriction)
23 * [Video Selection](#video-selection)
24 * [Download Options](#download-options)
25 * [Filesystem Options](#filesystem-options)
26 * [Thumbnail images](#thumbnail-images)
27 * [Internet Shortcut Options](#internet-shortcut-options)
28 * [Verbosity / Simulation Options](#verbosity--simulation-options)
29 * [Workarounds](#workarounds)
30 * [Video Format Options](#video-format-options)
31 * [Subtitle Options](#subtitle-options)
32 * [Authentication Options](#authentication-options)
33 * [Adobe Pass Options](#adobe-pass-options)
34 * [Post-processing Options](#post-processing-options)
35 * [SponSkrub (SponsorBlock) Options](#sponskrub-sponsorblock-options)
36 * [Extractor Options](#extractor-options)
37 * [CONFIGURATION](#configuration)
38 * [Authentication with .netrc file](#authentication-with-netrc-file)
39 * [OUTPUT TEMPLATE](#output-template)
40 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
41 * [Output template examples](#output-template-examples)
42 * [FORMAT SELECTION](#format-selection)
43 * [Filtering Formats](#filtering-formats)
44 * [Sorting Formats](#sorting-formats)
45 * [Format Selection examples](#format-selection-examples)
51 The major new features from the latest release of
[blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are:
53 * **
[SponSkrub Integration](#sponskrub-sponsorblock-options)**: You can use [SponSkrub](https://github.com/pukkandan/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the
[SponsorBlock](https://sponsor.ajay.app) API
55 * **[Format Sorting](#sorting-formats)**: 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 that what is possible by simply using
`--format` ([examples](#format-selection-examples))
57 * **Merged with youtube-dl v2021.02
.04.1**: You get all the latest features and patches of
[youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of
[youtube-dlc](https://github.com/blackjack4494/yt-dlc)
59 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from
[animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including
`--get-comments`,
`BiliBiliSearch`,
`BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, Playlist infojson etc. Note that the NicoNico improvements are not available. See
[#31](https://github.com/pukkandan/yt-dlp/pull/31) for details.
61 * **Youtube improvements**:
62 * All Youtube Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`) works correctly and support downloading multiple pages of content
63 * Youtube search works correctly (
`ytsearch:`,
`ytsearchdate:`) along with Search URLs
64 * Redirect channel's home URL automatically to
`/video` to preserve the old behaviour
66 * **New extractors**: AnimeLab, Philo MSO, Rcs, Gedi, bitwave.tv, mildom, audius
68 * **Fixed extractors**: archive.org, roosterteeth.com, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, tiktok, akamai, ina
70 * **Plugin support**: Extractors can be loaded from an external file. See [plugins](#plugins) for details
72 * **Multiple paths and output templates**: You can give different
[output templates](#output-template) and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to. See [`--paths`](https://github.com/pukkandan/yt-dlp/#:~:text=-P,%20--paths%20TYPE:PATH) for details
74 <!-- Relative link doesn't work for "#:~:text=" -->
76 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
78 * **Other new options**:
`--parse-metadata`,
`--list-formats-as-table`,
`--write-link`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
80 * **Improvements**: Multiple
`--postprocessor-args` and
`--external-downloader-args`, Date/time formatting in
`-o`, faster archive checking, more [format selection options](#format-selection) etc
83 See
[changelog](Changelog.md) or [commits](https://github.com/pukkandan/yt-dlp/commits) for the full list of changes
86 **PS**: Some of these changes are already in youtube-dlc, but are still unreleased. See [this](Changelog.md#unreleased-changes-in-blackjack4494yt-dlc) for details
88 If you are coming from
[youtube-dl](https://github.com/ytdl-org/youtube-dl), the amount of changes are very large. Compare
[options](#options) and [supported sites](docs/supportedsites.md) with youtube-dl's to get an idea of the massive number of features/patches [youtube-dlc](https://github.com/blackjack4494/yt-dlc) has accumulated.
93 You can install yt-dlp using one of the following methods:
94 * Use
[PyPI package](https://pypi.org/project/yt-dlp):
`python -m pip install --upgrade yt-dlp`
95 * Download the binary from the
[latest release](https://github.com/pukkandan/yt-dlp/releases/latest)
96 * Use pip+git:
`python -m pip install --upgrade git+https://github.com/pukkandan/yt-dlp.git@release`
97 * Install master branch:
`python -m pip install --upgrade git+https://github.com/pukkandan/yt-dlp`
100 `-U` does not work. Simply repeat the install process to update.
105 To build the Windows executable, you must have pyinstaller (and optionally mutagen and Crypto)
107 python -m pip install --upgrade pyinstaller mutagen Crypto
109 Once you have all the necessary dependancies installed, just run
`py devscripts\pyinst.py`. The executable will be built for the same architecture (
32/
64 bit) as the python used to build it. It is strongly reccomended to use python3 although python2.6+ is supported.
111 You can also build the executable without any version info or metadata by using:
113 pyinstaller.exe youtube_dlc\__main__.py --onefile --name youtube-dlc
116 You will need the required build tools
117 python, make (GNU), pandoc, zip, nosetests
118 Then simply type this
122 **Note**: In either platform,
`devscripts\update-version.py` can be used to automatically update the version number
125 **youtube-dlc** is a command-line program to download videos from youtube.com many other [video platforms](docs/supportedsites.md). It requires the Python interpreter, version
2.6,
2.7, or
3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.
127 youtube-dlc [OPTIONS] [--] URL [URL...]
131 `Ctrl+F` is your friend :D
132 <!-- Autogenerated -->
135 -h, --help Print this help text and exit
136 --version Print program version and exit
137 -U, --update [BROKEN] Update this program to latest
138 version. Make sure that you have sufficient
139 permissions (run with sudo if needed)
140 -i, --ignore-errors Continue on download errors, for example to
141 skip unavailable videos in a playlist
142 (default) (Alias: --no-abort-on-error)
143 --abort-on-error Abort downloading of further videos if an
144 error occurs (Alias: --no-ignore-errors)
145 --dump-user-agent Display the current browser identification
146 --list-extractors List all supported extractors
147 --extractor-descriptions Output descriptions of all supported
149 --force-generic-extractor Force extraction to use the generic
151 --default-search PREFIX Use this prefix for unqualified URLs. For
152 example "gvsearch2:" downloads two videos
153 from google videos for youtube-dl "large
154 apple". Use the value "auto" to let
155 youtube-dl guess ("auto_warning" to emit a
156 warning when guessing). "error" just throws
157 an error. The default value "fixup_error"
158 repairs broken URLs, but emits an error if
159 this is not possible instead of searching
160 --ignore-config, --no-config Disable loading any configuration files
161 except the one provided by --config-location.
162 When given inside a configuration
163 file, no further configuration files are
164 loaded. Additionally, (for backward
165 compatibility) if this option is found
166 inside the system configuration file, the
167 user configuration is not loaded
168 --config-location PATH Location of the main configuration file;
169 either the path to the config or its
171 --flat-playlist Do not extract the videos of a playlist,
173 --flat-videos Do not resolve the video urls
174 --no-flat-playlist Extract the videos of a playlist
175 --mark-watched Mark videos watched (YouTube only)
176 --no-mark-watched Do not mark videos watched
177 --no-colors Do not emit color codes in output
180 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
181 To enable SOCKS proxy, specify a proper
183 socks5://
127.0.0.1:
1080/. Pass in an empty
184 string (--proxy "") for direct connection
185 --socket-timeout SECONDS Time to wait before giving up, in seconds
186 --source-address IP Client-side IP address to bind to
187 -4, --force-ipv4 Make all connections via IPv4
188 -6, --force-ipv6 Make all connections via IPv6
191 --geo-verification-proxy URL Use this proxy to verify the IP address for
192 some geo-restricted sites. The default
193 proxy specified by --proxy (or none, if the
194 option is not present) is used for the
196 --geo-bypass Bypass geographic restriction via faking
197 X-Forwarded-For HTTP header
198 --no-geo-bypass Do not bypass geographic restriction via
199 faking X-Forwarded-For HTTP header
200 --geo-bypass-country CODE Force bypass geographic restriction with
201 explicitly provided two-letter ISO
3166-
2
203 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
204 explicitly provided IP block in CIDR
208 --playlist-start NUMBER Playlist video to start at (default is
1)
209 --playlist-end NUMBER Playlist video to end at (default is last)
210 --playlist-items ITEM_SPEC Playlist video items to download. Specify
211 indices of the videos in the playlist
212 separated by commas like: "--playlist-items
213 1,
2,
5,
8" if you want to download videos
214 indexed
1,
2,
5,
8 in the playlist. You can
215 specify range: "--playlist-items
216 1-
3,
7,
10-
13", it will download the videos
217 at index
1,
2,
3,
7,
10,
11,
12 and
13
218 --match-title REGEX Download only matching titles (regex or
220 --reject-title REGEX Skip download for matching titles (regex or
222 --max-downloads NUMBER Abort after downloading NUMBER files
223 --min-filesize SIZE Do not download any videos smaller than
224 SIZE (e.g.
50k or
44.6m)
225 --max-filesize SIZE Do not download any videos larger than SIZE
227 --date DATE Download only videos uploaded in this date.
228 The date can be "YYYYMMDD" or in the format
229 "(now|today)[+-][
0-
9](day|week|month|year)(s)?"
230 --datebefore DATE Download only videos uploaded on or before
231 this date. The date formats accepted is the
233 --dateafter DATE Download only videos uploaded on or after
234 this date. The date formats accepted is the
236 --min-views COUNT Do not download any videos with less than
238 --max-views COUNT Do not download any videos with more than
240 --match-filter FILTER Generic video filter. Specify any key (see
241 "OUTPUT TEMPLATE" for a list of available
242 keys) to match if the key is present, !key
243 to check if the key is not present,
244 key>NUMBER (like "comment_count >
12", also
245 works with >=, <, <=, !=, =) to compare
246 against a number, key = 'LITERAL' (like
247 "uploader = 'Mike Smith'", also works with
248 !=) to match against a string literal and &
249 to require multiple matches. Values which
250 are not known are excluded unless you put a
251 question mark (?) after the operator. For
252 example, to only match videos that have
253 been liked more than
100 times and disliked
254 less than
50 times (or the dislike
255 functionality is not available at the given
256 service), but who also have a description,
257 use --match-filter "like_count >
100 &
258 dislike_count <?
50 & description"
259 --no-match-filter Do not use generic video filter (default)
260 --no-playlist Download only the video, if the URL refers
261 to a video and a playlist
262 --yes-playlist Download the playlist, if the URL refers to
263 a video and a playlist
264 --age-limit YEARS Download only videos suitable for the given
266 --download-archive FILE Download only videos not listed in the
267 archive file. Record the IDs of all
268 downloaded videos in it
269 --break-on-existing Stop the download process when encountering
270 a file that is in the archive
271 --break-on-reject Stop the download process when encountering
272 a file that has been filtered out
273 --no-download-archive Do not use archive file (default)
274 --include-ads Download advertisements as well
276 --no-include-ads Do not download advertisements (default)
279 -r, --limit-rate RATE Maximum download rate in bytes per second
281 -R, --retries RETRIES Number of retries (default is
10), or
283 --fragment-retries RETRIES Number of retries for a fragment (default
284 is
10), or "infinite" (DASH, hlsnative and
286 --skip-unavailable-fragments Skip unavailable fragments for DASH,
287 hlsnative and ISM (default)
288 (Alias: --no-abort-on-unavailable-fragment)
289 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
290 (Alias: --no-skip-unavailable-fragments)
291 --keep-fragments Keep downloaded fragments on disk after
292 downloading is finished
293 --no-keep-fragments Delete downloaded fragments after
294 downloading is finished (default)
295 --buffer-size SIZE Size of download buffer (e.g.
1024 or
16K)
297 --resize-buffer The buffer size is automatically resized
298 from an initial value of --buffer-size
300 --no-resize-buffer Do not automatically adjust the buffer size
301 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
302 downloading (e.g.
10485760 or
10M) (default
303 is disabled). May be useful for bypassing
304 bandwidth throttling imposed by a webserver
306 --playlist-reverse Download playlist videos in reverse order
307 --no-playlist-reverse Download playlist videos in default order
309 --playlist-random Download playlist videos in random order
310 --xattr-set-filesize Set file xattribute ytdl.filesize with
312 --hls-prefer-native Use the native HLS downloader instead of
314 --hls-prefer-ffmpeg Use ffmpeg instead of the native HLS
316 --hls-use-mpegts Use the mpegts container for HLS videos,
317 allowing to play the video while
318 downloading (some players may not be able
320 --external-downloader NAME Use the specified external downloader.
321 Currently supports aria2c, avconv, axel,
322 curl, ffmpeg, httpie, wget
323 --downloader-args NAME:ARGS Give these arguments to the external
324 downloader. Specify the downloader name and
325 the arguments separated by a colon ":". You
326 can use this option multiple times
327 (Alias: --external-downloader-args)
329 ## Filesystem Options:
330 -a, --batch-file FILE File containing URLs to download ('-' for
331 stdin), one URL per line. Lines starting
332 with '#', ';' or ']' are considered as
334 -P, --paths TYPE:PATH The paths where the files should be
335 downloaded. Specify the type of file and
336 the path separated by a colon ":". All the
337 same types as --output are supported.
338 Additionally, you can also provide "home"
339 and "temp" paths. All intermediary files
340 are first downloaded to the temp path and
341 then the final files are moved over to the
342 home path after download is finished. This
343 option is ignored if --output is an
345 -o, --output [TYPE:]TEMPLATE Output filename template, see "OUTPUT
346 TEMPLATE" for details
347 --output-na-placeholder TEXT Placeholder value for unavailable meta
348 fields in output filename template
350 --autonumber-start NUMBER Specify the start value for %(autonumber)s
352 --restrict-filenames Restrict filenames to only ASCII
353 characters, and avoid "&" and spaces in
355 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
357 -w, --no-overwrites Do not overwrite any files
358 --force-overwrites Overwrite all video and metadata files.
359 This option includes --no-continue
360 --no-force-overwrites Do not overwrite the video, but overwrite
361 related files (default)
362 -c, --continue Resume partially downloaded files/fragments
364 --no-continue Do not resume partially downloaded
365 fragments. If the file is unfragmented,
366 restart download of the entire file
367 --part Use .part files instead of writing directly
368 into output file (default)
369 --no-part Do not use .part files - write directly
371 --mtime Use the Last-modified header to set the
372 file modification time (default)
373 --no-mtime Do not use the Last-modified header to set
374 the file modification time
375 --write-description Write video description to a .description
377 --no-write-description Do not write video description (default)
378 --write-info-json Write video metadata to a .info.json file
379 (this may contain personal information)
380 --no-write-info-json Do not write video metadata (default)
381 --write-annotations Write video annotations to a
382 .annotations.xml file
383 --no-write-annotations Do not write video annotations (default)
384 --write-playlist-metafiles Write playlist metadata in addition to the
385 video metadata when using --write-info-json,
386 --write-description etc. (default)
387 --no-write-playlist-metafiles Do not write playlist metadata when using
388 --write-info-json, --write-description etc.
389 --get-comments Retrieve video comments to be placed in the
391 --load-info-json FILE JSON file containing the video information
392 (created with the "--write-info-json"
394 --cookies FILE File to read cookies from and dump cookie
396 --no-cookies Do not read/dump cookies (default)
397 --cache-dir DIR Location in the filesystem where youtube-dl
398 can store some downloaded information
399 permanently. By default
400 $XDG_CACHE_HOME/youtube-dl or
401 ~/.cache/youtube-dl . At the moment, only
402 YouTube player files (for videos with
403 obfuscated signatures) are cached, but that
405 --no-cache-dir Disable filesystem caching
406 --rm-cache-dir Delete all filesystem cache files
407 --trim-file-name LENGTH Limit the filename length (extension
411 --write-thumbnail Write thumbnail image to disk
412 --no-write-thumbnail Do not write thumbnail image to disk
414 --write-all-thumbnails Write all thumbnail image formats to disk
415 --list-thumbnails Simulate and list all available thumbnail
418 ## Internet Shortcut Options:
419 --write-link Write an internet shortcut file, depending
420 on the current platform (.url, .webloc or
421 .desktop). The URL may be cached by the OS
422 --write-url-link Write a .url Windows internet shortcut. The
423 OS caches the URL based on the file path
424 --write-webloc-link Write a .webloc macOS internet shortcut
425 --write-desktop-link Write a .desktop Linux internet shortcut
427 ## Verbosity / Simulation Options:
428 -q, --quiet Activate quiet mode
429 --no-warnings Ignore warnings
430 -s, --simulate Do not download the video and do not write
432 --skip-download Do not download the video
433 -g, --get-url Simulate, quiet but print URL
434 -e, --get-title Simulate, quiet but print title
435 --get-id Simulate, quiet but print id
436 --get-thumbnail Simulate, quiet but print thumbnail URL
437 --get-description Simulate, quiet but print video description
438 --get-duration Simulate, quiet but print video length
439 --get-filename Simulate, quiet but print output filename
440 --get-format Simulate, quiet but print output format
441 -j, --dump-json Simulate, quiet but print JSON information.
442 See "OUTPUT TEMPLATE" for a description of
444 -J, --dump-single-json Simulate, quiet but print JSON information
445 for each command-line argument. If the URL
446 refers to a playlist, dump the whole
447 playlist information in a single line
448 --print-json Be quiet and print the video information as
449 JSON (video is still being downloaded)
450 --force-write-archive Force download archive entries to be
451 written as far as no errors occur,even if
452 -s or another simulation switch is used
453 (Alias: --force-download-archive)
454 --newline Output progress bar as new lines
455 --no-progress Do not print progress bar
456 --console-title Display progress in console titlebar
457 -v, --verbose Print various debugging information
458 --dump-pages Print downloaded pages encoded using base64
459 to debug problems (very verbose)
460 --write-pages Write downloaded intermediary pages to
461 files in the current directory to debug
463 --print-traffic Display sent and read HTTP traffic
464 -C, --call-home [Broken] Contact the youtube-dlc server for
466 --no-call-home Do not contact the youtube-dlc server for
470 --encoding ENCODING Force the specified encoding (experimental)
471 --no-check-certificate Suppress HTTPS certificate validation
472 --prefer-insecure Use an unencrypted connection to retrieve
473 information about the video. (Currently
474 supported only for YouTube)
475 --user-agent UA Specify a custom user agent
476 --referer URL Specify a custom referer, use if the video
477 access is restricted to one domain
478 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
479 separated by a colon ":". You can use this
480 option multiple times
481 --bidi-workaround Work around terminals that lack
482 bidirectional text support. Requires bidiv
483 or fribidi executable in PATH
484 --sleep-interval SECONDS Number of seconds to sleep before each
485 download when used alone or a lower bound
486 of a range for randomized sleep before each
487 download (minimum possible number of
488 seconds to sleep) when used along with
490 --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
491 before each download (maximum possible
492 number of seconds to sleep). Must only be
493 used along with --min-sleep-interval
494 --sleep-subtitles SECONDS Enforce sleep interval on subtitles as well
496 ## Video Format Options:
497 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
499 -S, --format-sort SORTORDER Sort the formats by the fields given, see
500 "Sorting Formats" for more details
501 --S-force, --format-sort-force Force user specified sort order to have
502 precedence over all fields, see "Sorting
503 Formats" for more details
504 --no-format-sort-force Some fields have precedence over the user
505 specified sort order (default), see
506 "Sorting Formats" for more details
507 --video-multistreams Allow multiple video streams to be merged
509 --no-video-multistreams Only one video stream is downloaded for
510 each output file (default)
511 --audio-multistreams Allow multiple audio streams to be merged
513 --no-audio-multistreams Only one audio stream is downloaded for
514 each output file (default)
515 --all-formats Download all available video formats
516 --prefer-free-formats Prefer free video formats over non-free
517 formats of same quality
518 -F, --list-formats List all available formats of requested
520 --list-formats-as-table Present the output of -F in tabular form
522 --list-formats-old Present the output of -F in the old form
523 (Alias: --no-list-formats-as-table)
524 --youtube-include-dash-manifest Download the DASH manifests and related
525 data on YouTube videos (default)
526 (Alias: --no-youtube-skip-dash-manifest)
527 --youtube-skip-dash-manifest Do not download the DASH manifests and
528 related data on YouTube videos
529 (Alias: --no-youtube-include-dash-manifest)
530 --youtube-include-hls-manifest Download the HLS manifests and related data
531 on YouTube videos (default)
532 (Alias: --no-youtube-skip-hls-manifest)
533 --youtube-skip-hls-manifest Do not download the HLS manifests and
534 related data on YouTube videos
535 (Alias: --no-youtube-include-hls-manifest)
536 --merge-output-format FORMAT If a merge is required (e.g.
537 bestvideo+bestaudio), output to given
538 container format. One of mkv, mp4, ogg,
539 webm, flv. Ignored if no merge is required
542 --write-subs Write subtitle file
543 --no-write-subs Do not write subtitle file (default)
544 --write-auto-subs Write automatically generated subtitle file
546 --no-write-auto-subs Do not write automatically generated
547 subtitle file (default)
548 --all-subs Download all the available subtitles of the
550 --list-subs List all available subtitles for the video
551 --sub-format FORMAT Subtitle format, accepts formats
552 preference, for example: "srt" or
554 --sub-lang LANGS Languages of the subtitles to download
555 (optional) separated by commas, use --list-
556 subs for available language tags
558 ## Authentication Options:
559 -u, --username USERNAME Login with this account ID
560 -p, --password PASSWORD Account password. If this option is left
561 out, youtube-dlc will ask interactively
562 -2, --twofactor TWOFACTOR Two-factor authentication code
563 -n, --netrc Use .netrc authentication data
564 --video-password PASSWORD Video password (vimeo, youku)
566 ## Adobe Pass Options:
567 --ap-mso MSO Adobe Pass multiple-system operator (TV
568 provider) identifier, use --ap-list-mso for
569 a list of available MSOs
570 --ap-username USERNAME Multiple-system operator account login
571 --ap-password PASSWORD Multiple-system operator account password.
572 If this option is left out, youtube-dlc
573 will ask interactively
574 --ap-list-mso List all supported multiple-system
577 ## Post-Processing Options:
578 -x, --extract-audio Convert video files to audio-only files
579 (requires ffmpeg and ffprobe)
580 --audio-format FORMAT Specify audio format: "best", "aac",
581 "flac", "mp3", "m4a", "opus", "vorbis", or
582 "wav"; "best" by default; No effect without
584 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
585 value between
0 (better) and
9 (worse) for
586 VBR or a specific bitrate like
128K
588 --remux-video FORMAT Remux the video into another container if
589 necessary (currently supported: mp4|mkv|flv
590 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
591 target container does not support the
592 video/audio codec, remuxing will fail. You
593 can specify multiple rules; eg.
594 "aac>m4a/mov>mp4/mkv" will remux aac to
595 m4a, mov to mp4 and anything else to mkv.
596 --recode-video FORMAT Re-encode the video into another format if
597 re-encoding is necessary. The supported
598 formats are the same as --remux-video
599 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
600 Specify the postprocessor/executable name
601 and the arguments separated by a colon ":"
602 to give the argument to the specified
603 postprocessor/executable. Supported
604 postprocessors are: SponSkrub,
605 ExtractAudio, VideoRemuxer, VideoConvertor,
606 EmbedSubtitle, Metadata, Merger,
607 FixupStretched, FixupM4a, FixupM3u8,
608 SubtitlesConvertor and EmbedThumbnail. The
609 supported executables are: SponSkrub,
610 FFmpeg, FFprobe, and AtomicParsley. You can
611 use this option multiple times to give
612 different arguments to different
613 postprocessors. You can also specify
614 "PP+EXE:ARGS" to give the arguments to the
615 specified executable only when being used
616 by the specified postprocessor. You can use
617 this option multiple times (Alias: --ppa)
618 -k, --keep-video Keep the intermediate video file on disk
619 after post-processing
620 --no-keep-video Delete the intermediate video file after
621 post-processing (default)
622 --post-overwrites Overwrite post-processed files (default)
623 --no-post-overwrites Do not overwrite post-processed files
624 --embed-subs Embed subtitles in the video (only for mp4,
626 --no-embed-subs Do not embed subtitles (default)
627 --embed-thumbnail Embed thumbnail in the audio as cover art
628 --no-embed-thumbnail Do not embed thumbnail (default)
629 --add-metadata Write metadata to the video file
630 --no-add-metadata Do not write metadata (default)
631 --parse-metadata FIELD:FORMAT Parse additional metadata like title/artist
632 from other fields. Give field name to
633 extract data from, and format of the field
634 seperated by a ":". Either regular
635 expression with named capture groups or a
636 similar syntax to the output template can
637 also be used. The parsed parameters replace
638 any existing values and can be use in
639 output templateThis option can be used
640 multiple times. Example: --parse-metadata
641 "title:%(artist)s - %(title)s" matches a
642 title like "Coldplay - Paradise". Example
643 (regex): --parse-metadata
644 "description:Artist - (?P<artist>.+?)"
645 --xattrs Write metadata to the video file's xattrs
646 (using dublin core and xdg standards)
647 --fixup POLICY Automatically correct known faults of the
648 file. One of never (do nothing), warn (only
649 emit a warning), detect_or_warn (the
650 default; fix file if we can, warn
652 --ffmpeg-location PATH Location of the ffmpeg binary; either the
653 path to the binary or its containing
655 --exec CMD Execute a command on the file after
656 downloading and post-processing, similar to
657 find's -exec syntax. Example: --exec 'adb
658 push {} /sdcard/Music/ && rm {}'
659 --convert-subs FORMAT Convert the subtitles to other format
660 (currently supported: srt|ass|vtt|lrc)
662 ## SponSkrub (SponsorBlock) Options:
663 [SponSkrub](https://github.com/pukkandan/SponSkrub) is a utility to
664 mark/remove sponsor segments from downloaded YouTube videos using
665 [SponsorBlock API](https://sponsor.ajay.app)
667 --sponskrub Use sponskrub to mark sponsored sections.
668 This is enabled by default if the sponskrub
669 binary exists (Youtube only)
670 --no-sponskrub Do not use sponskrub
671 --sponskrub-cut Cut out the sponsor sections instead of
673 --no-sponskrub-cut Simply mark the sponsor sections, not cut
675 --sponskrub-force Run sponskrub even if the video was already
677 --no-sponskrub-force Do not cut out the sponsor sections if the
678 video was already downloaded (default)
679 --sponskrub-location PATH Location of the sponskrub binary; either
680 the path to the binary or its containing
683 ## Extractor Options:
684 --allow-dynamic-mpd Process dynamic DASH manifests (default)
685 (Alias: --no-ignore-dynamic-mpd)
686 --ignore-dynamic-mpd Do not process dynamic DASH manifests
687 (Alias: --no-allow-dynamic-mpd)
691 You can configure youtube-dlc by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
693 1. **Main Configuration**: The file given by
`--config-location`
694 1. **Portable Configuration**:
`yt-dlp.conf` or
`youtube-dlc.conf` in the same directory as the bundled binary. If you are running from source-code (
`<root dir>/youtube_dlc/__main__.py`), the root directory is used instead.
695 1. **Home Configuration**:
`yt-dlp.conf` or
`youtube-dlc.conf` in the home path given by
`-P "home:<path>"`, or in the current directory if no such path is given
696 1. **User Configuration**:
697 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
698 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
699 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
700 * `%APPDATA%/yt-dlp/config.txt`
702 * `~/yt-dlp.conf.txt`
704 If none of these files are found, the search is performed again by replacing
`yt-dlp` with
`youtube-dlc`. Note that
`~` points to
`C:\Users\<user name>` on windows. Also,
`%XDG_CONFIG_HOME%` defaults to
`~/.config` if undefined
705 1. **System Configuration**:
`/etc/yt-dlp.conf` or
`/etc/youtube-dlc.conf`
707 For example, with the following configuration file youtube-dlc will always extract the audio, not copy the mtime, use a proxy and save all videos under
`YouTube` directory in your home directory:
709 # Lines starting with # are comments
711 # Always extract audio
714 # Do not copy the mtime
718 --proxy 127.0.0.1:3128
720 # Save all videos under YouTube directory in your home directory
721 -o ~/YouTube/%(title)s.%(ext)s
724 Note that 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`.
726 You can use
`--ignore-config` if you want to disable all configuration files for a particular youtube-dlc 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 user and system configurations. Additionally, (for backward compatibility) if
`--ignore-config` is found inside the system configuration file, the user configuration is not loaded.
728 ### Authentication with `.netrc` file
730 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 youtube-dlc execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a
[`.netrc` file](https://stackoverflow.com/tags/.netrc/info) on a per extractor basis. For that you will need to create a
`.netrc` file in your
`$HOME` and restrict permissions to read/write by only you:
733 chmod a-rwx,u+rw $HOME/.netrc
735 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
737 machine <extractor> login <login> password <password>
741 machine youtube login myaccount@gmail.com password my_youtube_password
742 machine twitch login my_twitch_account_name password my_twitch_password
744 To activate authentication with the
`.netrc` file you should pass
`--netrc` to youtube-dlc or place it in the [configuration file](#configuration).
746 On Windows you may also need to setup the
`%HOME%` environment variable manually. For example:
748 set HOME=%USERPROFILE%
753 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.
755 **tl;dr:** [navigate me to examples](#output-template-examples).
757 The basic usage of
`-o` is not to set any template arguments when downloading a single file, like in
`youtube-dlc -o funny_video.flv "https://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to
[python string formatting operations](https://docs.python.org/2/library/stdtypes.html#string-formatting). For example,
`%(NAME)s` or
`%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations. Date/time fields can also be formatted according to
[strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it inside the parantheses seperated from the field name using a
`>`. For example,
`%(duration>%H-%M-%S)s`.
759 Additionally, you can set different output templates for the various metadata files seperately from the general output template by specifying the type of file followed by the template seperated by a colon ":". The different filetypes supported are
`subtitle|thumbnail|description|annotation|infojson|pl_description|pl_infojson`. For example,
`-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.
761 The available fields are:
763 - `id` (string): Video identifier
764 - `title` (string): Video title
765 - `url` (string): Video URL
766 - `ext` (string): Video filename extension
767 - `alt_title` (string): A secondary title of the video
768 - `display_id` (string): An alternative identifier for the video
769 - `uploader` (string): Full name of the video uploader
770 - `license` (string): License name the video is licensed under
771 - `creator` (string): The creator of the video
772 - `release_date` (string): The date (YYYYMMDD) when the video was released
773 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
774 - `upload_date` (string): Video upload date (YYYYMMDD)
775 - `uploader_id` (string): Nickname or id of the video uploader
776 - `channel` (string): Full name of the channel the video is uploaded on
777 - `channel_id` (string): Id of the channel
778 - `location` (string): Physical location where the video was filmed
779 - `duration` (numeric): Length of the video in seconds
780 - `duration_string` (string): Length of the video (HH-mm-ss)
781 - `view_count` (numeric): How many users have watched the video on the platform
782 - `like_count` (numeric): Number of positive ratings of the video
783 - `dislike_count` (numeric): Number of negative ratings of the video
784 - `repost_count` (numeric): Number of reposts of the video
785 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
786 - `comment_count` (numeric): Number of comments on the video
787 - `age_limit` (numeric): Age restriction for the video (years)
788 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
789 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
790 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
791 - `format` (string): A human-readable description of the format
792 - `format_id` (string): Format code specified by
`--format`
793 - `format_note` (string): Additional info about the format
794 - `width` (numeric): Width of the video
795 - `height` (numeric): Height of the video
796 - `resolution` (string): Textual description of width and height
797 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
798 - `abr` (numeric): Average audio bitrate in KBit/s
799 - `acodec` (string): Name of the audio codec in use
800 - `asr` (numeric): Audio sampling rate in Hertz
801 - `vbr` (numeric): Average video bitrate in KBit/s
802 - `fps` (numeric): Frame rate
803 - `vcodec` (string): Name of the video codec in use
804 - `container` (string): Name of the container format
805 - `filesize` (numeric): The number of bytes, if known in advance
806 - `filesize_approx` (numeric): An estimate for the number of bytes
807 - `protocol` (string): The protocol that will be used for the actual download
808 - `extractor` (string): Name of the extractor
809 - `extractor_key` (string): Key name of the extractor
810 - `epoch` (numeric): Unix epoch when creating the file
811 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
812 - `playlist` (string): Name or id of the playlist that contains the video
813 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
814 - `playlist_id` (string): Playlist identifier
815 - `playlist_title` (string): Playlist title
816 - `playlist_uploader` (string): Full name of the playlist uploader
817 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
819 Available for the video that belongs to some logical chapter or section:
821 - `chapter` (string): Name or title of the chapter the video belongs to
822 - `chapter_number` (numeric): Number of the chapter the video belongs to
823 - `chapter_id` (string): Id of the chapter the video belongs to
825 Available for the video that is an episode of some series or programme:
827 - `series` (string): Title of the series or programme the video episode belongs to
828 - `season` (string): Title of the season the video episode belongs to
829 - `season_number` (numeric): Number of the season the video episode belongs to
830 - `season_id` (string): Id of the season the video episode belongs to
831 - `episode` (string): Title of the video episode
832 - `episode_number` (numeric): Number of the video episode within a season
833 - `episode_id` (string): Id of the video episode
835 Available for the media that is a track or a part of a music album:
837 - `track` (string): Title of the track
838 - `track_number` (numeric): Number of the track within an album or a disc
839 - `track_id` (string): Id of the track
840 - `artist` (string): Artist(s) of the track
841 - `genre` (string): Genre(s) of the track
842 - `album` (string): Title of the album the track belongs to
843 - `album_type` (string): Type of the album
844 - `album_artist` (string): List of all artists appeared on the album
845 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
846 - `release_year` (numeric): Year (YYYY) when the album was released
848 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that 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).
850 For example for
`-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title
`youtube-dlc test video` and id
`BaW_jenozKcj`, this will result in a
`youtube-dlc test video-BaW_jenozKcj.mp4` file created in the current directory.
852 For numeric sequences you can use numeric related formatting, for example,
`%(view_count)05d` will result in a string with view count padded with zeros up to
5 characters, like in
`00042`.
854 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.
856 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
858 The current default template is
`%(title)s [%(id)s].%(ext)s`.
860 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:
862 #### Output template and Windows batch files
864 If you are using an output template inside a Windows batch file then you must escape plain percent characters (
`%`) by doubling, so that
`-o "%(title)s-%(id)s.%(ext)s"` should become
`-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch
`%`'s that are not plain characters, e.g. environment variables for expansion should stay intact:
`-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
866 #### Output template examples
868 Note that on Windows you need to use double quotes instead of single.
871 $ youtube-dlc --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
872 youtube-dlc test video ''_ä↭𝕐.mp4 # All kinds of weird characters
874 $ youtube-dlc --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
875 youtube-dlc_test_video_.mp4 # A simple file name
877 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
878 $ youtube-dlc -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
880 # Download YouTube playlist videos in seperate directories according to their uploaded year
881 $ youtube-dlc -o '%(upload_date>%Y)s/%(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
883 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
884 $ youtube-dlc -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
886 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
887 $ youtube-dlc -u user -p password -P '~/MyVideos' -o '%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
889 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
890 $ youtube-dlc -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
892 # Stream the video being downloaded to stdout
893 $ youtube-dlc -o - BaW_jenozKc
898 By default, youtube-dlc tries to download the best available quality if you **don't** pass any options.
899 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 youtube-dlc to stream to
`stdout` (
`-o -`), the default becomes
`-f best/bestvideo+bestaudio`.
901 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.
903 **tl;dr:** [navigate me to examples](#format-selection-examples).
905 The simplest case is requesting a specific format, for example 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.
907 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.
909 You can also use special names to select particular edge case formats:
911 - `b*`,
`best*`: Select the best quality format irrespective of whether it contains video or audio.
912 - `w*`,
`worst*`: Select the worst quality format irrespective of whether it contains video or audio.
913 - `b`,
`best`: Select the best quality format that contains both video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
914 - `w`,
`worst`: Select the worst quality format that contains both video and audio. Equivalent to
`worst*[vcodec!=none][acodec!=none]`
915 - `bv`,
`bestvideo`: Select the best quality video-only format. Equivalent to
`best*[acodec=none]`
916 - `wv`,
`worstvideo`: Select the worst quality video-only format. Equivalent to
`worst*[acodec=none]`
917 - `bv*`,
`bestvideo*`: Select the best quality format that contains video. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
918 - `wv*`,
`worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to
`worst*[vcodec!=none]`
919 - `ba`,
`bestaudio`: Select the best quality audio-only format. Equivalent to
`best*[vcodec=none]`
920 - `wa`,
`worstaudio`: Select the worst quality audio-only format. Equivalent to
`worst*[vcodec=none]`
921 - `ba*`,
`bestaudio*`: Select the best quality format that contains audio. It may also contain video. Equivalent to
`best*[acodec!=none]`
922 - `wa*`,
`worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to
`worst*[acodec!=none]`
924 For example, to download the worst quality video-only format you can use
`-f worstvideo`. It is however recomended to never actually 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
`-f best -S +size,+br,+res,+fps` instead of
`-f worst`. See [sorting formats](#sorting-formats) for more details.
926 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, for example
`-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.
928 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`.
930 You can merge the video and audio of multiple formats into a single file using
`-f <format1>+<format2>+...` (requires ffmpeg installed), for example
`-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg. If
`--no-video-multistreams` is used, all formats with a video stream except the first one are ignored. Similarly, if
`--no-audio-multistreams` is used, all formats with an audio stream except the first one are ignored. For example,
`-f bestvideo+best+bestaudio` 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 and merge both formats while
`-f bestaudio+best --no-audio-multistreams` will ignore
`best` and download only
`bestaudio`.
934 You can also filter the video formats by putting a condition in brackets, as in
`-f "best[height=720]"` (or
`-f "[filesize>10M]"`).
936 The following numeric meta fields can be used with comparisons
`<`,
`<=`,
`>`,
`>=`,
`=` (equals),
`!=` (not equals):
938 - `filesize`: The number of bytes, if known in advance
939 - `width`: Width of the video, if known
940 - `height`: Height of the video, if known
941 - `tbr`: Average bitrate of audio and video in KBit/s
942 - `abr`: Average audio bitrate in KBit/s
943 - `vbr`: Average video bitrate in KBit/s
944 - `asr`: Audio sampling rate in Hertz
947 Also filtering work for comparisons
`=` (equals),
`^=` (starts with),
`$=` (ends with),
`*=` (contains) and following string meta fields:
949 - `ext`: File extension
950 - `acodec`: Name of the audio codec in use
951 - `vcodec`: Name of the video codec in use
952 - `container`: Name of the container format
953 - `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`)
954 - `format_id`: A short description of the format
955 - `language`: Language code
957 Any string comparison may be prefixed with negation
`!` in order to produce an opposite comparison, e.g.
`!*=` (does not contain).
959 Note that 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 video hoster. Any other field made available by the extractor can also be used for filtering.
961 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 "[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.
963 Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than
480 you can use
`-f '(mp4,webm)[height<480]'`.
967 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...`. The available fields are:
969 - `hasvid`: Gives priority to formats that has a video stream
970 - `hasaud`: Gives priority to formats that has a audio stream
971 - `ie_pref`: The format preference as given by the extractor
972 - `lang`: Language preference as given by the extractor
973 - `quality`: The quality of the format. This is a metadata field available in some websites
974 - `source`: Preference of the source as given by the extractor
975 - `proto`: Protocol used for download (
`https`/
`ftps` >
`http`/
`ftp` >
`m3u8-native` >
`m3u8` >
`http-dash-segments` > other >
`mms`/
`rtsp` > unknown >
`f4f`/
`f4m`)
976 - `vcodec`: Video Codec (
`av01` >
`vp9` >
`h265` >
`h264` >
`vp8` >
`h263` >
`theora` > other > unknown)
977 - `acodec`: Audio Codec (
`opus` >
`vorbis` >
`aac` >
`mp4a` >
`mp3` >
`ac3` >
`dts` > other > unknown)
978 - `codec`: Equivalent to
`vcodec,acodec`
979 - `vext`: Video Extension (
`mp4` >
`webm` >
`flv` > other > unknown). If
`--prefer-free-formats` is used,
`webm` is prefered.
980 - `aext`: Audio Extension (
`m4a` >
`aac` >
`mp3` >
`ogg` >
`opus` >
`webm` > other > unknown). If
`--prefer-free-formats` is used, the order changes to
`opus` >
`ogg` >
`webm` >
`m4a` >
`mp3` >
`aac`.
981 - `ext`: Equivalent to
`vext,aext`
982 - `filesize`: Exact filesize, if know in advance. This will be unavailable for mu38 and DASH formats.
983 - `fs_approx`: Approximate filesize calculated from the manifests
984 - `size`: Exact filesize if available, otherwise approximate filesize
985 - `height`: Height of video
986 - `width`: Width of video
987 - `res`: Video resolution, calculated as the smallest dimension.
988 - `fps`: Framerate of video
989 - `tbr`: Total average bitrate in KBit/s
990 - `vbr`: Average video bitrate in KBit/s
991 - `abr`: Average audio bitrate in KBit/s
992 - `br`: Equivalent to using
`tbr,vbr,abr`
993 - `asr`: Audio sample rate in Hz
995 Note that any other **numerical** field made available by the extractor can also be used. All fields, unless specified otherwise, are sorted in decending order. To reverse this, prefix the field with a
`+`. Eg:
`+res` prefers format with the smallest resolution. Additionally, you can suffix a prefered value for the fields, seperated by a
`:`. Eg:
`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 prefered values, the first for video and the second for audio. Eg:
`+codec:avc:m4a` (equivalent to
`+vcodec:avc,+acodec:m4a`) sets the video codec preference to
`h264` >
`h265` >
`vp9` >
`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. Eg:
`filesize~1G` prefers the format with filesize closest to
1 GiB.
997 The fields
`hasvid`,
`ie_pref`,
`lang`,
`quality` are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using
`--force-format-sort`. Apart from these, the default order used is:
`res,fps,codec:vp9,size,br,asr,proto,ext,hasaud,source,id`. Note that the extractors may override this default order, but they cannot override the user-provided order.
999 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 repects. 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`.
1001 **Tip**: You can use the
`-v -F` to see how the formats have been sorted (worst to best).
1003 ## Format Selection examples
1005 Note that on Windows you may need to use double quotes instead of single.
1008 # Download and merge the best best video-only format and the best audio-only format,
1009 # or download the best combined format if video-only format is not available
1010 $ youtube-dlc -f 'bv+ba/b'
1012 # Download best format that contains video,
1013 # and if it doesn't already have an audio stream, merge it with best audio-only format
1014 $ youtube-dlc -f 'bv*+ba/b'
1019 # Download the best video-only format and the best audio-only format without merging them
1020 # For this case, an output template should be used since
1021 # by default, bestvideo and bestaudio will have the same file name.
1022 $ youtube-dlc -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s'
1026 # The following examples show the old method (without -S) of format selection
1027 # and how to use -S to achieve a similar but better result
1029 # Download the worst video available (old method)
1030 $ youtube-dlc -f 'wv*+wa/w'
1032 # Download the best video available but with the smallest resolution
1033 $ youtube-dlc -S '+res'
1035 # Download the smallest video available
1036 $ youtube-dlc -S '+size,+br'
1040 # Download the best mp4 video available, or the best video if no mp4 available
1041 $ youtube-dlc -f 'bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b'
1043 # Download the best video with the best extension
1044 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1045 $ youtube-dlc -S 'ext'
1049 # Download the best video available but no better than 480p,
1050 # or the worst video if there is no video under 480p
1051 $ youtube-dlc -f 'bv*[height<=480]+ba/b[height<=480] / wv*+ba/w'
1053 # Download the best video available with the largest height but no better than 480p,
1054 # or the best video with the smallest resolution if there is no video under 480p
1055 $ youtube-dlc -S 'height:480'
1057 # Download the best video available with the largest resolution but no better than 480p,
1058 # or the best video with the smallest resolution if there is no video under 480p
1059 # Resolution is determined by using the smallest dimension.
1060 # So this works correctly for vertical videos as well
1061 $ youtube-dlc -S 'res:480'
1065 # Download the best video (that also has audio) but no bigger than 50 MB,
1066 # or the worst video (that also has audio) if there is no video under 50 MB
1067 $ youtube-dlc -f 'b[filesize<50M] / w'
1069 # Download largest video (that also has audio) but no bigger than 50 MB,
1070 # or the smallest video (that also has audio) if there is no video under 50 MB
1071 $ youtube-dlc -f 'b' -S 'filesize:50M'
1073 # Download best video (that also has audio) that is closest in size to 50 MB
1074 $ youtube-dlc -f 'b' -S 'filesize~50M'
1078 # Download best video available via direct link over HTTP/HTTPS protocol,
1079 # or the best video available via any protocol if there is no such video
1080 $ youtube-dlc -f '(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)'
1082 # Download best video available via the best protocol
1083 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1084 $ youtube-dlc -S 'proto'
1088 # Download the best video with h264 codec, or the best video if there is no such video
1089 $ youtube-dlc -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'
1091 # Download the best video with best codec no better than h264,
1092 # or the best video with worst codec if there is no such video
1093 $ youtube-dlc -S 'codec:h264'
1095 # Download the best video with worst codec no worse than h264,
1096 # or the best video with best codec if there is no such video
1097 $ youtube-dlc -S '+codec:h264'
1101 # More complex examples
1103 # Download the best video no better than 720p prefering framerate greater than 30,
1104 # or the worst video (still prefering framerate greater than 30) if there is no such video
1105 $ youtube-dlc -f '((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)'
1107 # Download the video with the largest resolution no better than 720p,
1108 # or the video with the smallest resolution available if there is no such video,
1109 # prefering larger framerate for formats with the same resolution
1110 $ youtube-dlc -S 'res:720,fps'
1114 # Download the video with smallest resolution no worse than 480p,
1115 # or the video with the largest resolution available if there is no such video,
1116 # prefering better codec and then larger total bitrate for the same resolution
1117 $ youtube-dlc -S '+res:480,codec,br'
1122 Plugins are loaded from
`<root-dir>/ytdlp_plugins/<type>/__init__.py`. Currently only
`extractor` plugins are supported. Support for
`downloader` and
`postprocessor` plugins may be added in the future. See [ytdlp_plugins](ytdlp_plugins) for example.
1124 **Note**:
`<root-dir>` is the directory of the binary (
`<root-dir>/youtube-dlc`), or the root directory of the module if you are running directly from source-code (
`<root dir>/youtube_dlc/__main__.py`)
1127 For FAQ, Developer Instructions etc., see the
[original README](https://github.com/ytdl-org/youtube-dl#faq)