]> jfr.im git - yt-dlp.git/blame - README.md
Added negative switches for many existing options
[yt-dlp.git] / README.md
CommitLineData
cf553dec 1[![Build Status](https://travis-ci.com/blackjack4494/yt-dlc.svg?branch=master)](https://travis-ci.com/blackjack4494/yt-dlc)
07892b3f 2[![PyPi](https://img.shields.io/pypi/v/youtube-dlc.svg)](https://pypi.org/project/youtube-dlc)
5c0e5bc4 3
07892b3f 4[![Gitter chat](https://img.shields.io/gitter/room/youtube-dlc/community)](https://gitter.im/youtube-dlc)
5db4014b 5[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](https://github.com/blackjack4494/yt-dlc/blob/master/LICENSE)
1c547dc8 6
8a92dee7
JT
7youtube-dlc - download videos from youtube.com or other video platforms.
8
9754a441 9youtube-dlc is a fork of youtube-dl with the intention of getting features tested by the community merged in the tool faster, since youtube-dl's development seems to be slowing down. (https://web.archive.org/web/20201014194602/https://github.com/ytdl-org/youtube-dl/issues/26462)
6bcd846b 10
b50e3bc6 11- [INSTALLATION](#installation)
5db4014b 12- [UPDATE](#update)
b50e3bc6
PH
13- [DESCRIPTION](#description)
14- [OPTIONS](#options)
78895bd3
U
15 - [Network Options:](#network-options)
16 - [Geo Restriction:](#geo-restriction)
17 - [Video Selection:](#video-selection)
18 - [Download Options:](#download-options)
19 - [Filesystem Options:](#filesystem-options)
20 - [Thumbnail images:](#thumbnail-images)
21 - [Verbosity / Simulation Options:](#verbosity--simulation-options)
22 - [Workarounds:](#workarounds)
23 - [Video Format Options:](#video-format-options)
24 - [Subtitle Options:](#subtitle-options)
25 - [Authentication Options:](#authentication-options)
26 - [Adobe Pass Options:](#adobe-pass-options)
27 - [Post-processing Options:](#post-processing-options)
28 - [Extractor Options:](#extractor-options)
b7770046
U
29- [CONFIGURATION](#configuration)
30 - [Authentication with `.netrc` file](#authentication-with-netrc-file)
31- [OUTPUT TEMPLATE](#output-template)
32 - [Output template and Windows batch files](#output-template-and-windows-batch-files)
33 - [Output template examples](#output-template-examples)
34- [FORMAT SELECTION](#format-selection)
eb8a4433 35 - [Filtering Formats](#filtering-formats)
36 - [Sorting Formats](#sorting-formats)
37 - [Default Format Selection](#default-format-selection)
38 - [Format Selection examples](#format-selection-examples)
b7770046 39- [VIDEO SELECTION](#video-selection-1)
cfcec693 40
d19bb9c0 41# INSTALLATION
6410992d 42[How to update](#update)
d19bb9c0 43
5f326cf5
TOH
44**All Platforms**
45Preferred way using pip:
9ab41610 46You may want to use `python3` instead of `python`
d19bb9c0 47
9ab41610 48 python -m pip install --upgrade youtube-dlc
d19bb9c0 49
471115db
TOH
50If you want to install the current master branch
51
52 python -m pip install git+https://github.com/blackjack4494/yt-dlc
53
5f326cf5
TOH
54**UNIX** (Linux, macOS, etc.)
55Using wget:
56
6410992d 57 sudo wget https://github.com/blackjack4494/yt-dlc/releases/latest/download/youtube-dlc -O /usr/local/bin/youtube-dlc
5f326cf5
TOH
58 sudo chmod a+rx /usr/local/bin/youtube-dlc
59
60Using curl:
61
6410992d 62 sudo curl -L https://github.com/blackjack4494/yt-dlc/releases/latest/download/youtube-dlc -o /usr/local/bin/youtube-dlc
5f326cf5
TOH
63 sudo chmod a+rx /usr/local/bin/youtube-dlc
64
65
6410992d 66**Windows** users can download [youtube-dlc.exe](https://github.com/blackjack4494/yt-dlc/releases/latest/download/youtube-dlc.exe) (**do not** put in `C:\Windows\System32`!).
5f326cf5
TOH
67
68**Compile**
b96a939b 69To build the Windows executable yourself (without version info!)
d19bb9c0 70
9ab41610 71 python -m pip install --upgrade pyinstaller
cefecac1 72 pyinstaller.exe youtube_dlc\__main__.py --onefile --name youtube-dlc
8f1aaa97 73
9ab41610 74Or simply execute the `make_win.bat` if pyinstaller is installed.
5f326cf5
TOH
75There will be a `youtube-dlc.exe` in `/dist`
76
b96a939b
TOH
77New way to build Windows is to use `python pyinst.py` (please use python3 64Bit)
78For 32Bit Version use a 32Bit Version of python (3 preferred here as well) and run `python pyinst32.py`
79
5f326cf5
TOH
80For Unix:
81You will need the required build tools
82python, make (GNU), pandoc, zip, nosetests
83Then simply type this
84
85 make
86
d19bb9c0 87
6410992d
TOH
88# UPDATE
89**DO NOT UPDATE using `-U` !** instead download binaries again or when installed with pip use a described above when installing.
90I will add some memorable short links to the binaries so you can download them easier.
91
cfcec693 92# DESCRIPTION
9ab41610 93**youtube-dlc** is a command-line program to download videos from YouTube.com and a few more sites. 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.
6bcd846b 94
9ab41610 95 youtube-dlc [OPTIONS] URL [URL...]
b50e3bc6 96
cfcec693 97# OPTIONS
1dc2726f
PH
98 -h, --help Print this help text and exit
99 --version Print program version and exit
6623ac34 100 -U, --update (Doesn't work since there is no release)
101 Update this program to latest version. Make
c4af7684
PH
102 sure that you have sufficient permissions
103 (run with sudo if needed)
6623ac34 104
c4af7684
PH
105 -i, --ignore-errors Continue on download errors, for example to
106 skip unavailable videos in a playlist
6623ac34 107 (Same as --no-abort-on-error)
108 --abort-on-error Abort downloading of further videos if an
109 error occurs (Same as --no-ignore-errors)
1dc2726f 110 --dump-user-agent Display the current browser identification
4b9f9010 111 --list-extractors List all supported extractors
c4af7684
PH
112 --extractor-descriptions Output descriptions of all supported
113 extractors
114 --force-generic-extractor Force extraction to use the generic
115 extractor
116 --default-search PREFIX Use this prefix for unqualified URLs. For
117 example "gvsearch2:" downloads two videos
6623ac34 118 from google videos for youtube-dl "large
c4af7684 119 apple". Use the value "auto" to let
6623ac34 120 youtube-dl guess ("auto_warning" to emit a
c4af7684
PH
121 warning when guessing). "error" just throws
122 an error. The default value "fixup_error"
123 repairs broken URLs, but emits an error if
124 this is not possible instead of searching.
6623ac34 125 --ignore-config, --no-config Do not read configuration files. When given
82674236 126 in the global configuration file
6623ac34 127 /etc/youtube-dl.conf: Do not read the user
c4af7684 128 configuration in ~/.config/youtube-
6623ac34 129 dl/config (%APPDATA%/youtube-dl/config.txt
130 on Windows)
dc48a354
S
131 --config-location PATH Location of the configuration file; either
132 the path to the config or its containing
133 directory.
c4af7684
PH
134 --flat-playlist Do not extract the videos of a playlist,
135 only list them.
6623ac34 136 --flat-videos Do not resolve the video urls
137 --no-flat-playlist Extract the videos of a playlist
bdf7f139
PH
138 --mark-watched Mark videos watched (YouTube only)
139 --no-mark-watched Do not mark videos watched (YouTube only)
1dc2726f 140 --no-color Do not emit color codes in output
08c1d0d3 141
149f05c7 142## Network Options:
28b4f736 143 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
0934c9d4
S
144 To enable SOCKS proxy, specify a proper
145 scheme. For example
28b4f736
PH
146 socks5://127.0.0.1:1080/. Pass in an empty
147 string (--proxy "") for direct connection
149f05c7 148 --socket-timeout SECONDS Time to wait before giving up, in seconds
c4af7684 149 --source-address IP Client-side IP address to bind to
c4af7684 150 -4, --force-ipv4 Make all connections via IPv4
c4af7684 151 -6, --force-ipv6 Make all connections via IPv6
8c6c88c7
S
152
153## Geo Restriction:
c25f1a9b
S
154 --geo-verification-proxy URL Use this proxy to verify the IP address for
155 some geo-restricted sites. The default
156 proxy specified by --proxy (or none, if the
7550ea50 157 option is not present) is used for the
4d2fdb07 158 actual downloading.
8c6c88c7 159 --geo-bypass Bypass geographic restriction via faking
0934c9d4 160 X-Forwarded-For HTTP header
8c6c88c7
S
161 --no-geo-bypass Do not bypass geographic restriction via
162 faking X-Forwarded-For HTTP header
8c6c88c7
S
163 --geo-bypass-country CODE Force bypass geographic restriction with
164 explicitly provided two-letter ISO 3166-2
0934c9d4 165 country code
9e18bb4c
S
166 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
167 explicitly provided IP block in CIDR
0934c9d4 168 notation
149f05c7 169
cfcec693 170## Video Selection:
1dc2726f
PH
171 --playlist-start NUMBER Playlist video to start at (default is 1)
172 --playlist-end NUMBER Playlist video to end at (default is last)
c4af7684
PH
173 --playlist-items ITEM_SPEC Playlist video items to download. Specify
174 indices of the videos in the playlist
175 separated by commas like: "--playlist-items
176 1,2,5,8" if you want to download videos
177 indexed 1, 2, 5, 8 in the playlist. You can
178 specify range: "--playlist-items
179 1-3,7,10-13", it will download the videos
180 at index 1, 2, 3, 7, 10, 11, 12 and 13.
181 --match-title REGEX Download only matching titles (regex or
182 caseless sub-string)
183 --reject-title REGEX Skip download for matching titles (regex or
184 caseless sub-string)
780083db 185 --max-downloads NUMBER Abort after downloading NUMBER files
c4af7684
PH
186 --min-filesize SIZE Do not download any videos smaller than
187 SIZE (e.g. 50k or 44.6m)
188 --max-filesize SIZE Do not download any videos larger than SIZE
189 (e.g. 50k or 44.6m)
6623ac34 190 --date DATE Download only videos uploaded in this date.
191 The date can be "YYYYMMDD" or in the format
192 "(now|today)[+-][0-9](day|week|month|year)(s)?"
c4af7684 193 --datebefore DATE Download only videos uploaded on or before
6623ac34 194 this date (i.e. inclusive). The date formats
195 accepted is the same as --date
c4af7684 196 --dateafter DATE Download only videos uploaded on or after
6623ac34 197 this date (i.e. inclusive). The date formats
198 accepted is the same as --date
c4af7684
PH
199 --min-views COUNT Do not download any videos with less than
200 COUNT views
201 --max-views COUNT Do not download any videos with more than
202 COUNT views
4d2fdb07 203 --match-filter FILTER Generic video filter. Specify any key (see
cb1e6d89
S
204 the "OUTPUT TEMPLATE" for a list of
205 available keys) to match if the key is
206 present, !key to check if the key is not
207 present, key > NUMBER (like "comment_count
208 > 12", also works with >=, <, <=, !=, =) to
209 compare against a number, key = 'LITERAL'
210 (like "uploader = 'Mike Smith'", also works
211 with !=) to match against a string literal
212 and & to require multiple matches. Values
213 which are not known are excluded unless you
214 put a question mark (?) after the operator.
215 For example, to only match videos that have
8c6c88c7
S
216 been liked more than 100 times and disliked
217 less than 50 times (or the dislike
218 functionality is not available at the given
219 service), but who also have a description,
220 use --match-filter "like_count > 100 &
221 dislike_count <? 50 & description" .
6623ac34 222 --no-match-filter FILTER Do not use generic video filter (default)
c4af7684
PH
223 --no-playlist Download only the video, if the URL refers
224 to a video and a playlist.
225 --yes-playlist Download the playlist, if the URL refers to
226 a video and a playlist.
227 --age-limit YEARS Download only videos suitable for the given
228 age
229 --download-archive FILE Download only videos not listed in the
230 archive file. Record the IDs of all
231 downloaded videos in it.
6623ac34 232 --no-download-archive Do not use archive file (default)
ea6e0c2b 233 --break-on-existing Stop the download process after attempting
234 to download a file that's in the archive.
6623ac34 235 --include-ads Download advertisements as well (experimental)
236 --no-include-ads Do not download advertisements (default)
6bcd846b 237
d5a62e4f 238## Download Options:
5e3856a2 239 -r, --limit-rate RATE Maximum download rate in bytes per second
c4af7684
PH
240 (e.g. 50K or 4.2M)
241 -R, --retries RETRIES Number of retries (default is 10), or
242 "infinite".
0be8314d 243 --fragment-retries RETRIES Number of retries for a fragment (default
b56e41a7
S
244 is 10), or "infinite" (DASH, hlsnative and
245 ISM)
6623ac34 246 --skip-unavailable-fragments Skip unavailable fragments for DASH,
247 hlsnative and ISM (default)
248 (Same as --no-abort-on-unavailable-fragment)
249 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
250 (Same as --no-skip-unavailable-fragments)
a82f4184 251 --keep-fragments Keep downloaded fragments on disk after
6623ac34 252 downloading is finished
253 --no-keep-fragments Delete downloaded fragments after downloading
254 is finished (default)
c4af7684
PH
255 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
256 (default is 1024)
6623ac34 257 --resize-buffer The buffer size is automatically resized from
258 an initial value of --buffer-size (default)
c4af7684 259 --no-resize-buffer Do not automatically adjust the buffer
6623ac34 260 size
db157d2a
S
261 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
262 downloading (e.g. 10485760 or 10M) (default
263 is disabled). May be useful for bypassing
264 bandwidth throttling imposed by a webserver
265 (experimental)
2101f5d4 266 --playlist-reverse Download playlist videos in reverse order
6623ac34 267 --no-playlist-reverse Download playlist videos in default order
31487eb9 268 --playlist-random Download playlist videos in random order
c4af7684 269 --xattr-set-filesize Set file xattribute ytdl.filesize with
0934c9d4 270 expected file size
c4af7684 271 --hls-prefer-native Use the native HLS downloader instead of
8b38f2ac
PH
272 ffmpeg
273 --hls-prefer-ffmpeg Use ffmpeg instead of the native HLS
274 downloader
a69bee47
PH
275 --hls-use-mpegts Use the mpegts container for HLS videos,
276 allowing to play the video while
277 downloading (some players may not be able
278 to play it)
c4af7684
PH
279 --external-downloader COMMAND Use the specified external downloader.
280 Currently supports
6bb26669 281 aria2c,avconv,axel,curl,ffmpeg,httpie,wget
c4af7684
PH
282 --external-downloader-args ARGS Give these arguments to the external
283 downloader
d5a62e4f 284
cfcec693 285## Filesystem Options:
c4af7684 286 -a, --batch-file FILE File containing URLs to download ('-' for
e8dfecb3
S
287 stdin), one URL per line. Lines starting
288 with '#', ';' or ']' are considered as
289 comments and ignored.
bd1bcd3e
S
290 -o, --output TEMPLATE Output filename template, see the "OUTPUT
291 TEMPLATE" for all the info
4d2fdb07
S
292 --autonumber-start NUMBER Specify the start value for %(autonumber)s
293 (default is 1)
c4af7684
PH
294 --restrict-filenames Restrict filenames to only ASCII
295 characters, and avoid "&" and spaces in
296 filenames
6623ac34 297 --no-restrict-filenames Allow Unicode characters, "&" and spaces
298 in filenames (default)
1dc2726f 299 -w, --no-overwrites Do not overwrite files
6623ac34 300 -c, --continue Resume partially downloaded files (default)
c4af7684
PH
301 --no-continue Do not resume partially downloaded files
302 (restart from beginning)
6623ac34 303 --part Use .part files instead of writing directly
304 into output file (default)
c4af7684
PH
305 --no-part Do not use .part files - write directly
306 into output file
6623ac34 307 --mtime Use the Last-modified header to set the
308 file modification time
c4af7684
PH
309 --no-mtime Do not use the Last-modified header to set
310 the file modification time
311 --write-description Write video description to a .description
312 file
6623ac34 313 --no-write-description Do not write video description (default)
1dc2726f 314 --write-info-json Write video metadata to a .info.json file
6623ac34 315 --no-write-info-json Do not write video metadata (default)
c4af7684
PH
316 --write-annotations Write video annotations to a
317 .annotations.xml file
6623ac34 318 --no-write-annotations Do not write video annotations (default)
d845622b 319 --load-info-json FILE JSON file containing the video information
c4af7684
PH
320 (created with the "--write-info-json"
321 option)
322 --cookies FILE File to read cookies from and dump cookie
323 jar in
6623ac34 324 --no-cookies Do not read/dump cookies (default)
325 --cache-dir DIR Location in the filesystem where youtube-dl
326 can store some downloaded information
82674236 327 permanently. By default
6623ac34 328 $XDG_CACHE_HOME/youtube-dl or
329 ~/.cache/youtube-dl . At the moment, only
82674236
S
330 YouTube player files (for videos with
331 obfuscated signatures) are cached, but that
332 may change.
36f35428
PH
333 --no-cache-dir Disable filesystem caching
334 --rm-cache-dir Delete all filesystem cache files
bc30d1e0
TOH
335 --trim-file-name Limit the filename length (extension
336 excluded)
6bcd846b 337
2b1bd292 338## Thumbnail images:
1dc2726f 339 --write-thumbnail Write thumbnail image to disk
6623ac34 340 --no-write-thumbnail Do not write thumbnail image to disk
1dc2726f 341 --write-all-thumbnails Write all thumbnail image formats to disk
c4af7684
PH
342 --list-thumbnails Simulate and list all available thumbnail
343 formats
2b1bd292 344
732044af 345## Internet Shortcut Options:
346 --write-link Write an internet shortcut file, depending on
347 the current platform (.url/.webloc/.desktop).
348 The URL may be cached by the OS.
6623ac34 349 --write-url-link Write a Windows .url internet shortcut file.
350 (The OS caches the URL based on the file path)
351 --write-webloc-link Write a .webloc macOS internet shortcut file
352 --write-desktop-link Write a .desktop Linux internet shortcut file
732044af 353
cfcec693 354## Verbosity / Simulation Options:
1dc2726f 355 -q, --quiet Activate quiet mode
6c072e7d 356 --no-warnings Ignore warnings
c4af7684
PH
357 -s, --simulate Do not download the video and do not write
358 anything to disk
1dc2726f
PH
359 --skip-download Do not download the video
360 -g, --get-url Simulate, quiet but print URL
361 -e, --get-title Simulate, quiet but print title
362 --get-id Simulate, quiet but print id
363 --get-thumbnail Simulate, quiet but print thumbnail URL
364 --get-description Simulate, quiet but print video description
365 --get-duration Simulate, quiet but print video length
366 --get-filename Simulate, quiet but print output filename
367 --get-format Simulate, quiet but print output format
c4af7684 368 -j, --dump-json Simulate, quiet but print JSON information.
cb1e6d89
S
369 See the "OUTPUT TEMPLATE" for a description
370 of available keys.
c4af7684
PH
371 -J, --dump-single-json Simulate, quiet but print JSON information
372 for each command-line argument. If the URL
373 refers to a playlist, dump the whole
374 playlist information in a single line.
375 --print-json Be quiet and print the video information as
376 JSON (video is still being downloaded).
2d30509f 377 --force-write-archive Force download archive entries to be written
378 as far as no errors occur, even if -s or
379 another simulation switch is used.
380 (Same as --force-download-archive)
1dc2726f
PH
381 --newline Output progress bar as new lines
382 --no-progress Do not print progress bar
383 --console-title Display progress in console titlebar
384 -v, --verbose Print various debugging information
c4af7684
PH
385 --dump-pages Print downloaded pages encoded using base64
386 to debug problems (very verbose)
387 --write-pages Write downloaded intermediary pages to
388 files in the current directory to debug
389 problems
780083db 390 --print-traffic Display sent and read HTTP traffic
6623ac34 391 -C, --call-home Contact the youtube-dlc server for debugging
392 --no-call-home Do not contact the youtube-dlc server for
393 debugging (default)
6bcd846b 394
36f35428
PH
395## Workarounds:
396 --encoding ENCODING Force the specified encoding (experimental)
1dc2726f 397 --no-check-certificate Suppress HTTPS certificate validation
c4af7684 398 --prefer-insecure Use an unencrypted connection to retrieve
05a7ffb1
S
399 information about the video. (Currently
400 supported only for YouTube)
1dc2726f 401 --user-agent UA Specify a custom user agent
c4af7684
PH
402 --referer URL Specify a custom referer, use if the video
403 access is restricted to one domain
404 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
405 separated by a colon ':'. You can use this
406 option multiple times
407 --bidi-workaround Work around terminals that lack
408 bidirectional text support. Requires bidiv
409 or fribidi executable in PATH
410 --sleep-interval SECONDS Number of seconds to sleep before each
b1ce2ba1
S
411 download when used alone or a lower bound
412 of a range for randomized sleep before each
413 download (minimum possible number of
414 seconds to sleep) when used along with
415 --max-sleep-interval.
416 --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
417 before each download (maximum possible
418 number of seconds to sleep). Must only be
419 used along with --min-sleep-interval.
7e6790e2
TOH
420 --sleep-subtitles Enforce sleep interval on subtitles as well.
421
36f35428 422
cfcec693 423## Video Format Options:
eb8a4433 424 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
425 for more details
426 -S, --format-sort SORTORDER Sort the formats by the fields given, see
427 "Sorting Formats" for more details
428 --S-force, --format-sort-force Force user specified sort order to have
429 precedence over all fields, see "Sorting
430 Formats" for more details
431 --no-format-sort-force Some fields have precedence over the user
432 specified sort order, see "Sorting Formats"
433 for more details (default)
6623ac34 434 --video-multistreams Allow multiple video streams to be merged into
435 a single file (default)
436 --no-video-multistreams Only one video stream is downloaded for each
437 output file
438 --audio-multistreams Allow multiple audio streams to be merged into
439 a single file (default)
440 --no-audio-multistreams Only one audio stream is downloaded for each
441 output file
1dc2726f 442 --all-formats Download all available video formats
c4af7684
PH
443 --prefer-free-formats Prefer free video formats unless a specific
444 one is requested
535d7b68 445 -F, --list-formats List all available formats of requested
bb6ac836 446 videos
76d321f6 447 --list-formats-as-table Present the output of -F in a more tabular form
6623ac34 448 --list-formats-old Present the output of -F in older form (default)
449 (Same as --no-list-formats-as-table)
c4af7684
PH
450 --youtube-skip-dash-manifest Do not download the DASH manifests and
451 related data on YouTube videos
6623ac34 452 (Same as --no-youtube-include-dash-manifest)
453 --youtube-include-dash-manifest Download the DASH manifests and related data
454 on YouTube videos (default)
455 (Same as --no-youtube-skip-dash-manifest)
78895bd3
U
456 --youtube-skip-hls-manifest Do not download the HLS manifests and
457 related data on YouTube videos
6623ac34 458 (Same as --no-youtube-include-hls-manifest)
459 --youtube-include-hls-manifest Download the HLS manifests and related data
460 on YouTube videos (default)
461 (Same as --no-youtube-skip-hls-manifest)
c4af7684
PH
462 --merge-output-format FORMAT If a merge is required (e.g.
463 bestvideo+bestaudio), output to given
464 container format. One of mkv, mp4, ogg,
465 webm, flv. Ignored if no merge is required
8ae7be3e
PH
466
467## Subtitle Options:
1dc2726f 468 --write-sub Write subtitle file
6623ac34 469 --no-write-sub Do not write subtitle file (default)
741dd8ea
RB
470 --write-auto-sub Write automatically generated subtitle file
471 (YouTube only)
6623ac34 472 --no-write-auto-sub Do not write automatically generated
473 subtitle file (default)
c4af7684
PH
474 --all-subs Download all the available subtitles of the
475 video
1dc2726f 476 --list-subs List all available subtitles for the video
c4af7684
PH
477 --sub-format FORMAT Subtitle format, accepts formats
478 preference, for example: "srt" or
479 "ass/srt/best"
480 --sub-lang LANGS Languages of the subtitles to download
f733b053
PH
481 (optional) separated by commas, use --list-
482 subs for available language tags
6bcd846b 483
cfcec693 484## Authentication Options:
1dc2726f 485 -u, --username USERNAME Login with this account ID
c4af7684 486 -p, --password PASSWORD Account password. If this option is left
cefecac1 487 out, youtube-dlc will ask interactively.
dc48a354 488 -2, --twofactor TWOFACTOR Two-factor authentication code
1dc2726f 489 -n, --netrc Use .netrc authentication data
804c343a 490 --video-password PASSWORD Video password (vimeo, smotri, youku)
6bcd846b 491
f5e008d1
S
492## Adobe Pass Options:
493 --ap-mso MSO Adobe Pass multiple-system operator (TV
909d24dd 494 provider) identifier, use --ap-list-mso for
495 a list of available MSOs
f5e008d1
S
496 --ap-username USERNAME Multiple-system operator account login
497 --ap-password PASSWORD Multiple-system operator account password.
e3671279
U
498 If this option is left out, youtube-dlc
499 will ask interactively.
f5e008d1
S
500 --ap-list-mso List all supported multiple-system
501 operators
502
cfcec693 503## Post-processing Options:
c4af7684
PH
504 -x, --extract-audio Convert video files to audio-only files
505 (requires ffmpeg or avconv and ffprobe or
506 avprobe)
507 --audio-format FORMAT Specify audio format: "best", "aac",
7d539ee1
S
508 "flac", "mp3", "m4a", "opus", "vorbis", or
509 "wav"; "best" by default; No effect without
510 -x
c4af7684
PH
511 --audio-quality QUALITY Specify ffmpeg/avconv audio quality, insert
512 a value between 0 (better) and 9 (worse)
513 for VBR or a specific bitrate like 128K
514 (default 5)
efe87a10
FS
515 --remux-video FORMAT Remux the video to another container format
516 if necessary (currently supported: mp4|mkv,
517 target container format must support video
518 / audio encoding, remuxing may fail)
c4af7684
PH
519 --recode-video FORMAT Encode the video to another format if
520 necessary (currently supported:
521 mp4|flv|ogg|webm|mkv|avi)
f72b0a60 522 --postprocessor-args ARGS Give these arguments to the postprocessor
6623ac34 523 -k, --keep-video Keep the intermediate video file on disk
524 after post-processing
525 --no-keep-video Delete the intermediate video file after
526 post-processing (default)
527 --post-overwrites Overwrite post-processed files (default)
528 --no-post-overwrites Do not overwrite post-processed files
0be8314d
PH
529 --embed-subs Embed subtitles in the video (only for mp4,
530 webm and mkv videos)
6623ac34 531 --no-embed-subs Do not embed subtitles in the video (default)
1dc2726f 532 --embed-thumbnail Embed thumbnail in the audio as cover art
6623ac34 533 --no-embed-thumbnail Do not embed thumbnail (default)
1dc2726f 534 --add-metadata Write metadata to the video file
6623ac34 535 --no-add-metadata Do not write metadata (default)
c4af7684
PH
536 --metadata-from-title FORMAT Parse additional metadata like song title /
537 artist from the video title. The format
6f3c632c
S
538 syntax is the same as --output. Regular
539 expression with named capture groups may
540 also be used. The parsed parameters replace
541 existing values. Example: --metadata-from-
542 title "%(artist)s - %(title)s" matches a
543 title like "Coldplay - Paradise". Example
544 (regex): --metadata-from-title
545 "(?P<artist>.+?) - (?P<title>.+)"
c4af7684
PH
546 --xattrs Write metadata to the video file's xattrs
547 (using dublin core and xdg standards)
548 --fixup POLICY Automatically correct known faults of the
549 file. One of never (do nothing), warn (only
550 emit a warning), detect_or_warn (the
551 default; fix file if we can, warn
552 otherwise)
553 --prefer-avconv Prefer avconv over ffmpeg for running the
6623ac34 554 postprocessors (Same as --no-prefer-ffmpeg)
689af496
S
555 --prefer-ffmpeg Prefer ffmpeg over avconv for running the
556 postprocessors (default)
6623ac34 557 (Same as --no-prefer-avconv)
c4af7684
PH
558 --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
559 either the path to the binary or its
560 containing directory.
561 --exec CMD Execute a command on the file after
00a41ca4
S
562 downloading and post-processing, similar to
563 find's -exec syntax. Example: --exec 'adb
564 push {} /sdcard/Music/ && rm {}'
7de81fcc 565 --convert-subs FORMAT Convert the subtitles to other format
9fc41bcb 566 (currently supported: srt|ass|vtt|lrc)
6bcd846b 567
a9e7f546 568## SponSkrub Options (SponsorBlock)
6623ac34 569 --sponskrub Use sponskrub to mark sponsored sections with
570 the data available in SponsorBlock API. This
571 is enabled by default if the sponskrub binary
572 exists (Youtube only)
a9e7f546 573 --sponskrub-cut Cut out the sponsor sections instead of
574 simply marking them
6623ac34 575 --no-sponskrub-cut Simply mark the sponsor sections, not cut
576 them out (default)
577 --sponskrub-force Allow cutting out the sponsor sections even
578 if the video was already downloaded.
579 --no-sponskrub-force Do not cut out the sponsor sections if the
580 video was already downloaded (default)
a9e7f546 581 --sponskrub-location Location of the sponskrub binary;
582 either the path to the binary or its
583 containing directory
584 --sponskrub-args Give these arguments to sponskrub
585
78895bd3 586## Extractor Options:
17cb02d0 587 --ignore-dynamic-mpd Do not process dynamic DASH manifests
6623ac34 588 (Same as --no-allow-dynamic-mpd)
589 --allow-dynamic-mpd Process dynamic DASH manifests (default)
590 (Same as --no-ignore-dynamic-mpd)
17cb02d0 591
b7770046
U
592# CONFIGURATION
593
594You can configure youtube-dlc by placing any supported command line option to a configuration file. On Linux and macOS, the system wide configuration file is located at `/etc/youtube-dlc.conf` and the user wide configuration file at `~/.config/youtube-dlc/config`. On Windows, the user wide configuration file locations are `%APPDATA%\youtube-dlc\config.txt` or `C:\Users\<user name>\youtube-dlc.conf`. Note that by default configuration file may not exist so you may need to create it yourself.
595
596For 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 `Movies` directory in your home directory:
597```
598# Lines starting with # are comments
599
600# Always extract audio
601-x
602
603# Do not copy the mtime
604--no-mtime
605
606# Use this proxy
607--proxy 127.0.0.1:3128
608
609# Save all videos under Movies directory in your home directory
610-o ~/Movies/%(title)s.%(ext)s
611```
612
613Note 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`.
614
615You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dlc run.
616
617You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dlc run.
618
619### Authentication with `.netrc` file
620
621You 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:
622```
623touch $HOME/.netrc
624chmod a-rwx,u+rw $HOME/.netrc
625```
626After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
627```
628machine <extractor> login <login> password <password>
629```
630For example:
631```
632machine youtube login myaccount@gmail.com password my_youtube_password
633machine twitch login my_twitch_account_name password my_twitch_password
634```
635To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dlc or place it in the [configuration file](#configuration).
636
637On Windows you may also need to setup the `%HOME%` environment variable manually. For example:
638```
639set HOME=%USERPROFILE%
640```
641
642# OUTPUT TEMPLATE
643
644The `-o` option allows users to indicate a template for the output file names.
645
646**tl;dr:** [navigate me to examples](#output-template-examples).
647
648The basic usage 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. Allowed names along with sequence type are:
649
650 - `id` (string): Video identifier
651 - `title` (string): Video title
652 - `url` (string): Video URL
653 - `ext` (string): Video filename extension
654 - `alt_title` (string): A secondary title of the video
655 - `display_id` (string): An alternative identifier for the video
656 - `uploader` (string): Full name of the video uploader
657 - `license` (string): License name the video is licensed under
658 - `creator` (string): The creator of the video
659 - `release_date` (string): The date (YYYYMMDD) when the video was released
660 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
661 - `upload_date` (string): Video upload date (YYYYMMDD)
662 - `uploader_id` (string): Nickname or id of the video uploader
663 - `channel` (string): Full name of the channel the video is uploaded on
664 - `channel_id` (string): Id of the channel
665 - `location` (string): Physical location where the video was filmed
666 - `duration` (numeric): Length of the video in seconds
667 - `view_count` (numeric): How many users have watched the video on the platform
668 - `like_count` (numeric): Number of positive ratings of the video
669 - `dislike_count` (numeric): Number of negative ratings of the video
670 - `repost_count` (numeric): Number of reposts of the video
671 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
672 - `comment_count` (numeric): Number of comments on the video
673 - `age_limit` (numeric): Age restriction for the video (years)
674 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
675 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
676 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
677 - `format` (string): A human-readable description of the format
678 - `format_id` (string): Format code specified by `--format`
679 - `format_note` (string): Additional info about the format
680 - `width` (numeric): Width of the video
681 - `height` (numeric): Height of the video
682 - `resolution` (string): Textual description of width and height
683 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
684 - `abr` (numeric): Average audio bitrate in KBit/s
685 - `acodec` (string): Name of the audio codec in use
686 - `asr` (numeric): Audio sampling rate in Hertz
687 - `vbr` (numeric): Average video bitrate in KBit/s
688 - `fps` (numeric): Frame rate
689 - `vcodec` (string): Name of the video codec in use
690 - `container` (string): Name of the container format
691 - `filesize` (numeric): The number of bytes, if known in advance
692 - `filesize_approx` (numeric): An estimate for the number of bytes
693 - `protocol` (string): The protocol that will be used for the actual download
694 - `extractor` (string): Name of the extractor
695 - `extractor_key` (string): Key name of the extractor
696 - `epoch` (numeric): Unix epoch when creating the file
697 - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
698 - `playlist` (string): Name or id of the playlist that contains the video
699 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
700 - `playlist_id` (string): Playlist identifier
701 - `playlist_title` (string): Playlist title
702 - `playlist_uploader` (string): Full name of the playlist uploader
703 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
704
705Available for the video that belongs to some logical chapter or section:
706
707 - `chapter` (string): Name or title of the chapter the video belongs to
708 - `chapter_number` (numeric): Number of the chapter the video belongs to
709 - `chapter_id` (string): Id of the chapter the video belongs to
710
711Available for the video that is an episode of some series or programme:
712
713 - `series` (string): Title of the series or programme the video episode belongs to
714 - `season` (string): Title of the season the video episode belongs to
715 - `season_number` (numeric): Number of the season the video episode belongs to
716 - `season_id` (string): Id of the season the video episode belongs to
717 - `episode` (string): Title of the video episode
718 - `episode_number` (numeric): Number of the video episode within a season
719 - `episode_id` (string): Id of the video episode
720
721Available for the media that is a track or a part of a music album:
722
723 - `track` (string): Title of the track
724 - `track_number` (numeric): Number of the track within an album or a disc
725 - `track_id` (string): Id of the track
726 - `artist` (string): Artist(s) of the track
727 - `genre` (string): Genre(s) of the track
728 - `album` (string): Title of the album the track belongs to
729 - `album_type` (string): Type of the album
730 - `album_artist` (string): List of all artists appeared on the album
731 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
732 - `release_year` (numeric): Year (YYYY) when the album was released
733
734Each 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 `NA`.
735
736For 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.
737
738For 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`.
739
740Output 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.
741
742To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
743
744The current default template is `%(title)s-%(id)s.%(ext)s`.
745
746In 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:
747
748#### Output template and Windows batch files
749
750If 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"`.
751
752#### Output template examples
753
754Note that on Windows you may need to use double quotes instead of single.
755
756```bash
757$ youtube-dlc --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
758youtube-dlc test video ''_ä↭𝕐.mp4 # All kinds of weird characters
759
760$ youtube-dlc --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
761youtube-dlc_test_video_.mp4 # A simple file name
762
763# Download YouTube playlist videos in separate directory indexed by video order in a playlist
764$ youtube-dlc -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
765
766# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
767$ youtube-dlc -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
768
769# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
770$ youtube-dlc -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
771
772# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
773$ youtube-dlc -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" https://videomore.ru/kino_v_detalayah/5_sezon/367617
774
775# Stream the video being downloaded to stdout
776$ youtube-dlc -o - BaW_jenozKc
777```
778
779# FORMAT SELECTION
780
781By default youtube-dlc tries to download the best available quality, i.e. if you want the best quality you **don't need** to pass any special options, youtube-dlc will guess it for you by **default**.
782
783But sometimes you may want to download in a different format, for example when you are on a slow or intermittent connection. The key mechanism for achieving this is so-called *format selection* based on which you can explicitly specify desired format, select formats based on some criterion or criteria, setup precedence and much more.
784
785The general syntax for format selection is `--format FORMAT` or shorter `-f FORMAT` where `FORMAT` is a *selector expression*, i.e. an expression that describes format or formats you would like to download.
786
787**tl;dr:** [navigate me to examples](#format-selection-examples).
788
789The 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.
790
791You 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.
792
793You can also use special names to select particular edge case formats:
794
909d24dd 795 - `b*`, `best*`: Select the best quality format irrespective of whether it contains video or audio.
796 - `w*`, `worst*`: Select the worst quality format irrespective of whether it contains video or audio.
797
798 - `b`, `best`: Select the best quality format that contains both video and audio. Equivalent to `best*[vcodec!=none][acodec!=none]`
799 - `w`, `worst`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]`
800
801 - `bv`, `bestvideo`: Select the best quality video-only format. Equivalent to `best*[acodec=none]`
802 - `wv`, `worstvideo`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]`
803
804 - `bv*`, `bestvideo*`: Select the best quality format that contains video. It may also contain audio. Equivalent to `best*[vcodec!=none]`
805 - `wv*`, `worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]`
806
807 - `ba`, `bestaudio`: Select the best quality audio-only format. Equivalent to `best*[vcodec=none]`
808 - `wa`, `worstaudio`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]`
809
810 - `ba*`, `bestaudio*`: Select the best quality format that contains audio. It may also contain video. Equivalent to `best*[acodec!=none]`
811 - `wa*`, `worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]`
b7770046 812
eb8a4433 813For 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. See [sorting formats](#sorting-formats) for more details.
b7770046 814
eb8a4433 815If 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.
b7770046
U
816
817If 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`.
818
909d24dd 819You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg/avconv. 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`.
eb8a4433 820
821## Filtering Formats
822
b7770046
U
823You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
824
825The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
826
827 - `filesize`: The number of bytes, if known in advance
828 - `width`: Width of the video, if known
829 - `height`: Height of the video, if known
830 - `tbr`: Average bitrate of audio and video in KBit/s
831 - `abr`: Average audio bitrate in KBit/s
832 - `vbr`: Average video bitrate in KBit/s
833 - `asr`: Audio sampling rate in Hertz
834 - `fps`: Frame rate
835
836Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
837
838 - `ext`: File extension
839 - `acodec`: Name of the audio codec in use
840 - `vcodec`: Name of the video codec in use
841 - `container`: Name of the container format
842 - `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`)
843 - `format_id`: A short description of the format
844
845Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
846
f96bff99 847Note 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.
b7770046
U
848
849Formats 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.
850
b7770046
U
851Format 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]'`.
852
eb8a4433 853## Sorting Formats
854
855You 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:
856
857 - `video`, `has_video`: Gives priority to formats that has a video stream
858 - `audio`, `has_audio`: Gives priority to formats that has a audio stream
859 - `extractor`, `preference`, `extractor_preference`: The format preference as given by the extractor
860 - `lang`, `language_preference`: Language preference as given by the extractor
861 - `quality`: The quality of the format. This is a metadata field available in some websites
862 - `source`, `source_preference`: Preference of the source as given by the extractor
863 - `proto`, `protocol`: Protocol used for download (`https`/`ftps` > `http`/`ftp` > `m3u8-native` > `m3u8` > `http-dash-segments` > other > `mms`/`rtsp` > unknown > `f4f`/`f4m`)
864 - `vcodec`, `video_codec`: Video Codec (`av01` > `vp9` > `h265` > `h264` > `vp8` > `h263` > `theora` > other > unknown)
865 - `acodec`, `audio_codec`: Audio Codec (`opus` > `vorbis` > `aac` > `mp4a` > `mp3` > `ac3` > `dts` > other > unknown)
866 - `codec`: Equivalent to `vcodec,acodec`
867 - `vext`, `video_ext`: Video Extension (`mp4` > `flv` > `webm` > other > unknown). If `--prefer-free-formats` is used, `webm` is prefered.
868 - `aext`, `audio_ext`: 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`.
869 - `ext`, `extension`: Equivalent to `vext,aext`
870 - `filesize`: Exact filesize, if know in advance. This will be unavailable for mu38 and DASH formats.
871 - `filesize_approx`: Approximate filesize calculated the manifests
872 - `size`, `filesize_estimate`: Exact filesize if available, otherwise approximate filesize
873 - `height`: Height of video
874 - `width`: Width of video
875 - `res`, `dimension`: Video resolution, calculated as the smallest dimension.
876 - `fps`, `framerate`: Framerate of video
877 - `tbr`, `total_bitrate`: Total average bitrate in KBit/s
878 - `vbr`, `video_bitrate`: Average video bitrate in KBit/s
879 - `abr`, `audio_bitrate`: Average audio bitrate in KBit/s
880 - `br`, `bitrate`: Equivalent to using `tbr,vbr,abr`
881 - `samplerate`, `asr`: Audio sample rate in Hz
882
883All fields, unless specified otherwise, are sorted in decending order. To reverse this, prefix the field with a `+`. Eg: `+res` prefers the smallest resolution format. 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` > `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. Eg: `filesize~1G` prefers the format with filesize closest to 1 GiB.
884
909d24dd 885The fields `has_video`, `extractor_preference`, `language_preference`, `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 by youtube-dlc is: `tbr,filesize,vbr,height,width,protocol,vext,abr,aext,fps,filesize_approx,source_preference,format_id`. Note that the extractors may override this default order (currently no extractor does this), but not the user-provided order.
eb8a4433 886
887If 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`.
888
889**Tip**: You can use the `-v -F` to see how the formats have been sorted (worst to best).
890
891## Default Format Selection
892
893Since the end of April 2015 and version 2015.04.26, youtube-dlc uses `-f bestvideo+bestaudio/best` as the default format selection (see [#5447](https://github.com/ytdl-org/youtube-dl/issues/5447), [#5456](https://github.com/ytdl-org/youtube-dl/issues/5456)). If ffmpeg or avconv are installed this results in downloading `bestvideo` and `bestaudio` separately and muxing them together into a single file giving the best overall quality available. Otherwise it falls back to `best` and results in downloading the best available quality served as a single file. `best` is also needed for videos that don't come from YouTube because they don't provide the audio and video in two different files. Note that if you use youtube-dlc to stream to `stdout` (and most likely to pipe it to your media player then), i.e. you explicitly specify output template as `-o -`, youtube-dlc still uses `-f best` format selection in order to start content delivery immediately to your player and not to wait until `bestvideo` and `bestaudio` are downloaded and muxed.
b7770046
U
894
895If you want to preserve the old format selection behavior (prior to youtube-dlc 2015.04.26), i.e. you want to download the best available quality media served as a single file, you should explicitly specify your choice with `-f best`. You may want to add it to the [configuration file](#configuration) in order not to type it every time you run youtube-dlc.
896
eb8a4433 897## Format Selection examples
b7770046
U
898
899Note that on Windows you may need to use double quotes instead of single.
900
901```bash
909d24dd 902# Download and merge the best best video-only format and the best audio-only format,
903# or download the best combined format if video-only format is not available
904$ youtube-dlc
905
906# Same as above
907$ youtube-dlc -f 'bestvideo+bestaudio/best'
908
909# Download best format that contains video,
910# and if it doesn't already have an audio stream, merge it with best audio-only format
911$ youtube-dlc -f 'bestvideo*+bestaudio/best' --no-audio-multistreams
912
913
914
eb8a4433 915# Download the worst video available
916$ youtube-dlc -f 'worstvideo+worstaudio/worst'
917
918# Download the best video available but with the smallest resolution
919$ youtube-dlc -S '+res'
920
921# Download the smallest video available
922$ youtube-dlc -S '+size,+bitrate'
923
924
909d24dd 925
eb8a4433 926# Download the best mp4 video available, or the best video if no mp4 available
927$ youtube-dlc -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/bestvideo+bestaudio / best'
928
929# Download the best video with the best extension
930# (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
931$ youtube-dlc -S 'ext'
932
933
909d24dd 934
eb8a4433 935# Download the best video available but no better than 480p,
936# or the worst video if there is no video under 480p
937$ youtube-dlc -f 'bestvideo[height<=480]+bestaudio/best[height<=480] / worstvideo+bestaudio/worst'
b7770046 938
eb8a4433 939# Download the best video available with the largest height but no better than 480p,
940# or the best video with the smallest resolution if there is no video under 480p
941$ youtube-dlc -S 'height:480'
b7770046 942
eb8a4433 943# Download the best video available with the largest resolution but no better than 480p,
944# or the best video with the smallest resolution if there is no video under 480p
945# Resolution is determined by using the smallest dimension.
946# So this works correctly for vertical videos as well
947$ youtube-dlc -S 'res:480'
b7770046 948
b7770046 949
909d24dd 950
eb8a4433 951# Download the best video (that also has audio) but no bigger than 50 MB,
952# or the worst video (that also has audio) if there is no video under 50 MB
953$ youtube-dlc -f 'best[filesize<50M] / worst'
954
955# Download largest video (that also has audio) but no bigger than 50 MB,
956# or the smallest video (that also has audio) if there is no video under 50 MB
957$ youtube-dlc -f 'best' -S 'filesize:50M'
958
959# Download best video (that also has audio) that is closest in size to 50 MB
960$ youtube-dlc -f 'best' -S 'filesize~50M'
961
962
909d24dd 963
eb8a4433 964# Download best video available via direct link over HTTP/HTTPS protocol,
965# or the best video available via any protocol if there is no such video
966$ youtube-dlc -f '(bestvideo+bestaudio/best)[protocol^=http][protocol!*=dash] / bestvideo+bestaudio/best'
967
968# Download best video available via the best protocol
969# (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
970$ youtube-dlc -S 'protocol'
971
972
909d24dd 973
eb8a4433 974# Download the best video-only format and the best audio-only format without merging them
975# For this case, an output template should be used since
976# by default, bestvideo and bestaudio will have the same file name.
b7770046 977$ youtube-dlc -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
eb8a4433 978
979
909d24dd 980
eb8a4433 981# Download the best video with h264 codec, or the best video if there is no such video
982$ youtube-dlc -f '(bestvideo+bestaudio/best)[vcodec^=avc1] / bestvideo+bestaudio/best'
983
984# Download the best video with best codec no better than h264,
985# or the best video with worst codec if there is no such video
986$ youtube-dlc -S 'codec:h264'
987
988# Download the best video with worst codec no worse than h264,
989# or the best video with best codec if there is no such video
990$ youtube-dlc -S '+codec:h264'
991
992
993
994# More complex examples
995
996# Download the best video no better than 720p prefering framerate greater than 30,
997# or the worst video (prefering framerate greater than 30) if there is no such video
998$ youtube-dlc -f '((bestvideo[fps>30]/bestvideo)[height<=720]/(worstvideo[fps>30]/worstvideo)) + bestaudio / (best[fps>30]/best)[height<=720]/(worst[fps>30]/worst)'
999
1000# Download the video with the largest resolution no better than 720p,
1001# or the video with the smallest resolution available if there is no such video,
1002# prefering larger framerate for formats with the same resolution
1003$ youtube-dlc -S 'res:720,fps'
1004
1005
909d24dd 1006
eb8a4433 1007# Download the video with smallest resolution no worse than 480p,
1008# or the video with the largest resolution available if there is no such video,
1009# prefering better codec and then larger total bitrate for the same resolution
1010$ youtube-dlc -S '+res:480,codec,br'
b7770046 1011```
eb8a4433 1012
b7770046
U
1013
1014
1015# VIDEO SELECTION
1016
1017Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
1018
1019 - Absolute dates: Dates in the format `YYYYMMDD`.
1020 - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
1021
1022Examples:
1023
1024```bash
1025# Download only the videos uploaded in the last 6 months
1026$ youtube-dlc --dateafter now-6months
1027
1028# Download only the videos uploaded on January 1, 1970
1029$ youtube-dlc --date 19700101
1030
1031$ # Download only the videos uploaded in the 200x decade
1032$ youtube-dlc --dateafter 20000101 --datebefore 20091231
07892b3f 1033```