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