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