README.md 91.5 KB
Newer Older
Sergey M․'s avatar
Sergey M․ committed
1
[![Build Status](https://travis-ci.org/ytdl-org/youtube-dl.svg?branch=master)](https://travis-ci.org/ytdl-org/youtube-dl)
2

David Haberthür's avatar
David Haberthür committed
3
youtube-dl - download videos from youtube.com or other video platforms
Daniel Bolton's avatar
Daniel Bolton committed
4

5
6
7
8
9
- [INSTALLATION](#installation)
- [DESCRIPTION](#description)
- [OPTIONS](#options)
- [CONFIGURATION](#configuration)
- [OUTPUT TEMPLATE](#output-template)
10
- [FORMAT SELECTION](#format-selection)
11
12
13
- [VIDEO SELECTION](#video-selection)
- [FAQ](#faq)
- [DEVELOPER INSTRUCTIONS](#developer-instructions)
14
- [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
15
16
- [BUGS](#bugs)
- [COPYRIGHT](#copyright)
17

18
19
# INSTALLATION

20
To install it right away for all UNIX users (Linux, macOS, etc.), type:
21

22
    sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl
23
    sudo chmod a+rx /usr/local/bin/youtube-dl
24
25
26

If you do not have curl, you can alternatively use a recent wget:

27
    sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
28
    sudo chmod a+rx /usr/local/bin/youtube-dl
29

Alan Yee's avatar
Alan Yee committed
30
Windows users can [download an .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in any location on their [PATH](https://en.wikipedia.org/wiki/PATH_%28variable%29) except for `%SYSTEMROOT%\System32` (e.g. **do not** put in `C:\Windows\System32`).
31

32
33
You can also use pip:

34
    sudo -H pip install --upgrade youtube-dl
35
36
37
    
This command will update youtube-dl if you have already installed it. See the [pypi page](https://pypi.python.org/pypi/youtube_dl) for more information.

38
macOS users can install youtube-dl with [Homebrew](https://brew.sh/):
39
40
41

    brew install youtube-dl

42
43
44
45
Or with [MacPorts](https://www.macports.org/):

    sudo port install youtube-dl

Sergey M․'s avatar
Sergey M․ committed
46
Alternatively, refer to the [developer instructions](#developer-instructions) for how to check out and work with the git repository. For further options, including PGP signatures, see the [youtube-dl Download Page](https://ytdl-org.github.io/youtube-dl/download.html).
47

48
# DESCRIPTION
Reto Kromer's avatar
Reto Kromer committed
49
**youtube-dl** 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.
Daniel Bolton's avatar
Daniel Bolton committed
50

51
52
    youtube-dl [OPTIONS] URL [URL...]

53
# OPTIONS
Philipp Hagemeister's avatar
Philipp Hagemeister committed
54
55
    -h, --help                       Print this help text and exit
    --version                        Print program version and exit
Philipp Hagemeister's avatar
Philipp Hagemeister committed
56
57
58
59
60
61
62
63
    -U, --update                     Update this program to latest version. Make
                                     sure that you have sufficient permissions
                                     (run with sudo if needed)
    -i, --ignore-errors              Continue on download errors, for example to
                                     skip unavailable videos in a playlist
    --abort-on-error                 Abort downloading of further videos (in the
                                     playlist or the command line) if an error
                                     occurs
Philipp Hagemeister's avatar
Philipp Hagemeister committed
64
    --dump-user-agent                Display the current browser identification
Philipp Hagemeister's avatar
Philipp Hagemeister committed
65
    --list-extractors                List all supported extractors
Philipp Hagemeister's avatar
Philipp Hagemeister committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
    --extractor-descriptions         Output descriptions of all supported
                                     extractors
    --force-generic-extractor        Force extraction to use the generic
                                     extractor
    --default-search PREFIX          Use this prefix for unqualified URLs. For
                                     example "gvsearch2:" downloads two videos
                                     from google videos for youtube-dl "large
                                     apple". Use the value "auto" to let
                                     youtube-dl guess ("auto_warning" to emit a
                                     warning when guessing). "error" just throws
                                     an error. The default value "fixup_error"
                                     repairs broken URLs, but emits an error if
                                     this is not possible instead of searching.
    --ignore-config                  Do not read configuration files. When given
Sergey M․'s avatar
Sergey M․ committed
80
81
                                     in the global configuration file
                                     /etc/youtube-dl.conf: Do not read the user
Philipp Hagemeister's avatar
Philipp Hagemeister committed
82
83
84
                                     configuration in ~/.config/youtube-
                                     dl/config (%APPDATA%/youtube-dl/config.txt
                                     on Windows)
Sergey M․'s avatar
Sergey M․ committed
85
86
87
    --config-location PATH           Location of the configuration file; either
                                     the path to the config or its containing
                                     directory.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
88
89
    --flat-playlist                  Do not extract the videos of a playlist,
                                     only list them.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
90
91
    --mark-watched                   Mark videos watched (YouTube only)
    --no-mark-watched                Do not mark videos watched (YouTube only)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
92
    --no-color                       Do not emit color codes in output
Philipp Hagemeister's avatar
Philipp Hagemeister committed
93

Philipp Hagemeister's avatar
Philipp Hagemeister committed
94
## Network Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
95
    --proxy URL                      Use the specified HTTP/HTTPS/SOCKS proxy.
Sergey M․'s avatar
Sergey M․ committed
96
97
                                     To enable SOCKS proxy, specify a proper
                                     scheme. For example
Philipp Hagemeister's avatar
Philipp Hagemeister committed
98
99
                                     socks5://127.0.0.1:1080/. Pass in an empty
                                     string (--proxy "") for direct connection
Philipp Hagemeister's avatar
Philipp Hagemeister committed
100
    --socket-timeout SECONDS         Time to wait before giving up, in seconds
Philipp Hagemeister's avatar
Philipp Hagemeister committed
101
102
103
    --source-address IP              Client-side IP address to bind to
    -4, --force-ipv4                 Make all connections via IPv4
    -6, --force-ipv6                 Make all connections via IPv6
Sergey M․'s avatar
Sergey M․ committed
104
105

## Geo Restriction:
Sergey M․'s avatar
Sergey M․ committed
106
107
108
    --geo-verification-proxy URL     Use this proxy to verify the IP address for
                                     some geo-restricted sites. The default
                                     proxy specified by --proxy (or none, if the
Sergey M․'s avatar
Sergey M․ committed
109
                                     option is not present) is used for the
Sergey M․'s avatar
Sergey M․ committed
110
                                     actual downloading.
Sergey M․'s avatar
Sergey M․ committed
111
    --geo-bypass                     Bypass geographic restriction via faking
Sergey M․'s avatar
Sergey M․ committed
112
                                     X-Forwarded-For HTTP header
Sergey M․'s avatar
Sergey M․ committed
113
114
115
116
    --no-geo-bypass                  Do not bypass geographic restriction via
                                     faking X-Forwarded-For HTTP header
    --geo-bypass-country CODE        Force bypass geographic restriction with
                                     explicitly provided two-letter ISO 3166-2
Sergey M․'s avatar
Sergey M․ committed
117
                                     country code
Sergey M․'s avatar
Sergey M․ committed
118
119
    --geo-bypass-ip-block IP_BLOCK   Force bypass geographic restriction with
                                     explicitly provided IP block in CIDR
Sergey M․'s avatar
Sergey M․ committed
120
                                     notation
Philipp Hagemeister's avatar
Philipp Hagemeister committed
121

122
## Video Selection:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
123
124
    --playlist-start NUMBER          Playlist video to start at (default is 1)
    --playlist-end NUMBER            Playlist video to end at (default is last)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
125
126
127
128
129
130
131
132
133
134
135
136
    --playlist-items ITEM_SPEC       Playlist video items to download. Specify
                                     indices of the videos in the playlist
                                     separated by commas like: "--playlist-items
                                     1,2,5,8" if you want to download videos
                                     indexed 1, 2, 5, 8 in the playlist. You can
                                     specify range: "--playlist-items
                                     1-3,7,10-13", it will download the videos
                                     at index 1, 2, 3, 7, 10, 11, 12 and 13.
    --match-title REGEX              Download only matching titles (regex or
                                     caseless sub-string)
    --reject-title REGEX             Skip download for matching titles (regex or
                                     caseless sub-string)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
137
    --max-downloads NUMBER           Abort after downloading NUMBER files
Philipp Hagemeister's avatar
Philipp Hagemeister committed
138
139
140
141
    --min-filesize SIZE              Do not download any videos smaller than
                                     SIZE (e.g. 50k or 44.6m)
    --max-filesize SIZE              Do not download any videos larger than SIZE
                                     (e.g. 50k or 44.6m)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
142
    --date DATE                      Download only videos uploaded in this date
Philipp Hagemeister's avatar
Philipp Hagemeister committed
143
144
145
146
147
148
149
150
    --datebefore DATE                Download only videos uploaded on or before
                                     this date (i.e. inclusive)
    --dateafter DATE                 Download only videos uploaded on or after
                                     this date (i.e. inclusive)
    --min-views COUNT                Do not download any videos with less than
                                     COUNT views
    --max-views COUNT                Do not download any videos with more than
                                     COUNT views
Sergey M․'s avatar
Sergey M․ committed
151
    --match-filter FILTER            Generic video filter. Specify any key (see
Sergey M․'s avatar
Sergey M․ committed
152
153
154
155
156
157
158
159
160
161
162
163
                                     the "OUTPUT TEMPLATE" for a list of
                                     available keys) to match if the key is
                                     present, !key to check if the key is not
                                     present, key > NUMBER (like "comment_count
                                     > 12", also works with >=, <, <=, !=, =) to
                                     compare against a number, key = 'LITERAL'
                                     (like "uploader = 'Mike Smith'", also works
                                     with !=) to match against a string literal
                                     and & to require multiple matches. Values
                                     which are not known are excluded unless you
                                     put a question mark (?) after the operator.
                                     For example, to only match videos that have
Sergey M․'s avatar
Sergey M․ committed
164
165
166
167
168
169
                                     been liked more than 100 times and disliked
                                     less than 50 times (or the dislike
                                     functionality is not available at the given
                                     service), but who also have a description,
                                     use --match-filter "like_count > 100 &
                                     dislike_count <? 50 & description" .
Philipp Hagemeister's avatar
Philipp Hagemeister committed
170
171
172
173
174
175
176
177
178
179
180
    --no-playlist                    Download only the video, if the URL refers
                                     to a video and a playlist.
    --yes-playlist                   Download the playlist, if the URL refers to
                                     a video and a playlist.
    --age-limit YEARS                Download only videos suitable for the given
                                     age
    --download-archive FILE          Download only videos not listed in the
                                     archive file. Record the IDs of all
                                     downloaded videos in it.
    --include-ads                    Download advertisements as well
                                     (experimental)
Daniel Bolton's avatar
Daniel Bolton committed
181

Philipp Hagemeister's avatar
Philipp Hagemeister committed
182
## Download Options:
Sergey M․'s avatar
Sergey M․ committed
183
    -r, --limit-rate RATE            Maximum download rate in bytes per second
Philipp Hagemeister's avatar
Philipp Hagemeister committed
184
185
186
                                     (e.g. 50K or 4.2M)
    -R, --retries RETRIES            Number of retries (default is 10), or
                                     "infinite".
Philipp Hagemeister's avatar
Philipp Hagemeister committed
187
    --fragment-retries RETRIES       Number of retries for a fragment (default
Sergey M․'s avatar
Sergey M․ committed
188
189
190
191
                                     is 10), or "infinite" (DASH, hlsnative and
                                     ISM)
    --skip-unavailable-fragments     Skip unavailable fragments (DASH, hlsnative
                                     and ISM)
Sergey M․'s avatar
Sergey M․ committed
192
193
    --abort-on-unavailable-fragment  Abort downloading when some fragment is not
                                     available
Sergey M․'s avatar
Sergey M․ committed
194
195
196
    --keep-fragments                 Keep downloaded fragments on disk after
                                     downloading is finished; fragments are
                                     erased by default
Philipp Hagemeister's avatar
Philipp Hagemeister committed
197
198
199
200
201
202
    --buffer-size SIZE               Size of download buffer (e.g. 1024 or 16K)
                                     (default is 1024)
    --no-resize-buffer               Do not automatically adjust the buffer
                                     size. By default, the buffer size is
                                     automatically resized from an initial value
                                     of SIZE.
Sergey M․'s avatar
Sergey M․ committed
203
204
205
206
207
    --http-chunk-size SIZE           Size of a chunk for chunk-based HTTP
                                     downloading (e.g. 10485760 or 10M) (default
                                     is disabled). May be useful for bypassing
                                     bandwidth throttling imposed by a webserver
                                     (experimental)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
208
    --playlist-reverse               Download playlist videos in reverse order
Sergey M․'s avatar
Sergey M․ committed
209
    --playlist-random                Download playlist videos in random order
Philipp Hagemeister's avatar
Philipp Hagemeister committed
210
    --xattr-set-filesize             Set file xattribute ytdl.filesize with
Sergey M․'s avatar
Sergey M․ committed
211
                                     expected file size
Philipp Hagemeister's avatar
Philipp Hagemeister committed
212
    --hls-prefer-native              Use the native HLS downloader instead of
Philipp Hagemeister's avatar
Philipp Hagemeister committed
213
214
215
                                     ffmpeg
    --hls-prefer-ffmpeg              Use ffmpeg instead of the native HLS
                                     downloader
Philipp Hagemeister's avatar
Philipp Hagemeister committed
216
217
218
219
    --hls-use-mpegts                 Use the mpegts container for HLS videos,
                                     allowing to play the video while
                                     downloading (some players may not be able
                                     to play it)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
220
221
    --external-downloader COMMAND    Use the specified external downloader.
                                     Currently supports
Philipp Hagemeister's avatar
Philipp Hagemeister committed
222
                                     aria2c,avconv,axel,curl,ffmpeg,httpie,wget
Philipp Hagemeister's avatar
Philipp Hagemeister committed
223
224
    --external-downloader-args ARGS  Give these arguments to the external
                                     downloader
Philipp Hagemeister's avatar
Philipp Hagemeister committed
225

226
## Filesystem Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
227
    -a, --batch-file FILE            File containing URLs to download ('-' for
Sergey M․'s avatar
Sergey M․ committed
228
229
230
                                     stdin), one URL per line. Lines starting
                                     with '#', ';' or ']' are considered as
                                     comments and ignored.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
231
    --id                             Use only video ID in file name
Sergey M․'s avatar
Sergey M․ committed
232
233
    -o, --output TEMPLATE            Output filename template, see the "OUTPUT
                                     TEMPLATE" for all the info
Sergey M․'s avatar
Sergey M․ committed
234
235
    --autonumber-start NUMBER        Specify the start value for %(autonumber)s
                                     (default is 1)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
236
237
238
    --restrict-filenames             Restrict filenames to only ASCII
                                     characters, and avoid "&" and spaces in
                                     filenames
Philipp Hagemeister's avatar
Philipp Hagemeister committed
239
    -w, --no-overwrites              Do not overwrite files
Philipp Hagemeister's avatar
Philipp Hagemeister committed
240
241
242
243
244
245
246
247
248
249
250
    -c, --continue                   Force resume of partially downloaded files.
                                     By default, youtube-dl will resume
                                     downloads if possible.
    --no-continue                    Do not resume partially downloaded files
                                     (restart from beginning)
    --no-part                        Do not use .part files - write directly
                                     into output file
    --no-mtime                       Do not use the Last-modified header to set
                                     the file modification time
    --write-description              Write video description to a .description
                                     file
Philipp Hagemeister's avatar
Philipp Hagemeister committed
251
    --write-info-json                Write video metadata to a .info.json file
Philipp Hagemeister's avatar
Philipp Hagemeister committed
252
253
    --write-annotations              Write video annotations to a
                                     .annotations.xml file
Sergey M․'s avatar
Sergey M․ committed
254
    --load-info-json FILE            JSON file containing the video information
Philipp Hagemeister's avatar
Philipp Hagemeister committed
255
256
257
258
259
260
                                     (created with the "--write-info-json"
                                     option)
    --cookies FILE                   File to read cookies from and dump cookie
                                     jar in
    --cache-dir DIR                  Location in the filesystem where youtube-dl
                                     can store some downloaded information
Sergey M․'s avatar
Sergey M․ committed
261
262
263
264
265
266
                                     permanently. By default
                                     $XDG_CACHE_HOME/youtube-dl or
                                     ~/.cache/youtube-dl . At the moment, only
                                     YouTube player files (for videos with
                                     obfuscated signatures) are cached, but that
                                     may change.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
267
268
    --no-cache-dir                   Disable filesystem caching
    --rm-cache-dir                   Delete all filesystem cache files
Daniel Bolton's avatar
Daniel Bolton committed
269

Philipp Hagemeister's avatar
Philipp Hagemeister committed
270
## Thumbnail images:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
271
272
    --write-thumbnail                Write thumbnail image to disk
    --write-all-thumbnails           Write all thumbnail image formats to disk
Philipp Hagemeister's avatar
Philipp Hagemeister committed
273
274
    --list-thumbnails                Simulate and list all available thumbnail
                                     formats
Philipp Hagemeister's avatar
Philipp Hagemeister committed
275

276
## Verbosity / Simulation Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
277
    -q, --quiet                      Activate quiet mode
Philipp Hagemeister's avatar
Philipp Hagemeister committed
278
    --no-warnings                    Ignore warnings
Philipp Hagemeister's avatar
Philipp Hagemeister committed
279
280
    -s, --simulate                   Do not download the video and do not write
                                     anything to disk
Philipp Hagemeister's avatar
Philipp Hagemeister committed
281
282
283
284
285
286
287
288
289
    --skip-download                  Do not download the video
    -g, --get-url                    Simulate, quiet but print URL
    -e, --get-title                  Simulate, quiet but print title
    --get-id                         Simulate, quiet but print id
    --get-thumbnail                  Simulate, quiet but print thumbnail URL
    --get-description                Simulate, quiet but print video description
    --get-duration                   Simulate, quiet but print video length
    --get-filename                   Simulate, quiet but print output filename
    --get-format                     Simulate, quiet but print output format
Philipp Hagemeister's avatar
Philipp Hagemeister committed
290
    -j, --dump-json                  Simulate, quiet but print JSON information.
Sergey M․'s avatar
Sergey M․ committed
291
292
                                     See the "OUTPUT TEMPLATE" for a description
                                     of available keys.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
293
294
295
296
297
298
    -J, --dump-single-json           Simulate, quiet but print JSON information
                                     for each command-line argument. If the URL
                                     refers to a playlist, dump the whole
                                     playlist information in a single line.
    --print-json                     Be quiet and print the video information as
                                     JSON (video is still being downloaded).
Philipp Hagemeister's avatar
Philipp Hagemeister committed
299
300
301
302
    --newline                        Output progress bar as new lines
    --no-progress                    Do not print progress bar
    --console-title                  Display progress in console titlebar
    -v, --verbose                    Print various debugging information
Philipp Hagemeister's avatar
Philipp Hagemeister committed
303
304
305
306
307
    --dump-pages                     Print downloaded pages encoded using base64
                                     to debug problems (very verbose)
    --write-pages                    Write downloaded intermediary pages to
                                     files in the current directory to debug
                                     problems
Philipp Hagemeister's avatar
Philipp Hagemeister committed
308
    --print-traffic                  Display sent and read HTTP traffic
Philipp Hagemeister's avatar
Philipp Hagemeister committed
309
    -C, --call-home                  Contact the youtube-dl server for debugging
Philipp Hagemeister's avatar
Philipp Hagemeister committed
310
311
    --no-call-home                   Do NOT contact the youtube-dl server for
                                     debugging
Daniel Bolton's avatar
Daniel Bolton committed
312

Philipp Hagemeister's avatar
Philipp Hagemeister committed
313
314
## Workarounds:
    --encoding ENCODING              Force the specified encoding (experimental)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
315
    --no-check-certificate           Suppress HTTPS certificate validation
Philipp Hagemeister's avatar
Philipp Hagemeister committed
316
    --prefer-insecure                Use an unencrypted connection to retrieve
Sergey M․'s avatar
Sergey M․ committed
317
318
                                     information about the video. (Currently
                                     supported only for YouTube)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
319
    --user-agent UA                  Specify a custom user agent
Philipp Hagemeister's avatar
Philipp Hagemeister committed
320
321
322
323
324
325
326
327
328
    --referer URL                    Specify a custom referer, use if the video
                                     access is restricted to one domain
    --add-header FIELD:VALUE         Specify a custom HTTP header and its value,
                                     separated by a colon ':'. You can use this
                                     option multiple times
    --bidi-workaround                Work around terminals that lack
                                     bidirectional text support. Requires bidiv
                                     or fribidi executable in PATH
    --sleep-interval SECONDS         Number of seconds to sleep before each
Sergey M․'s avatar
Sergey M․ committed
329
330
331
332
333
334
335
336
337
                                     download when used alone or a lower bound
                                     of a range for randomized sleep before each
                                     download (minimum possible number of
                                     seconds to sleep) when used along with
                                     --max-sleep-interval.
    --max-sleep-interval SECONDS     Upper bound of a range for randomized sleep
                                     before each download (maximum possible
                                     number of seconds to sleep). Must only be
                                     used along with --min-sleep-interval.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
338

339
## Video Format Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
340
341
    -f, --format FORMAT              Video format code, see the "FORMAT
                                     SELECTION" for all the info
Philipp Hagemeister's avatar
Philipp Hagemeister committed
342
    --all-formats                    Download all available video formats
Philipp Hagemeister's avatar
Philipp Hagemeister committed
343
344
    --prefer-free-formats            Prefer free video formats unless a specific
                                     one is requested
Philipp Hagemeister's avatar
Philipp Hagemeister committed
345
    -F, --list-formats               List all available formats of requested
Philipp Hagemeister's avatar
Philipp Hagemeister committed
346
                                     videos
Philipp Hagemeister's avatar
Philipp Hagemeister committed
347
348
349
350
351
352
    --youtube-skip-dash-manifest     Do not download the DASH manifests and
                                     related data on YouTube videos
    --merge-output-format FORMAT     If a merge is required (e.g.
                                     bestvideo+bestaudio), output to given
                                     container format. One of mkv, mp4, ogg,
                                     webm, flv. Ignored if no merge is required
Philipp Hagemeister's avatar
Philipp Hagemeister committed
353
354

## Subtitle Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
355
    --write-sub                      Write subtitle file
356
357
    --write-auto-sub                 Write automatically generated subtitle file
                                     (YouTube only)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
358
359
    --all-subs                       Download all the available subtitles of the
                                     video
Philipp Hagemeister's avatar
Philipp Hagemeister committed
360
    --list-subs                      List all available subtitles for the video
Philipp Hagemeister's avatar
Philipp Hagemeister committed
361
362
363
364
    --sub-format FORMAT              Subtitle format, accepts formats
                                     preference, for example: "srt" or
                                     "ass/srt/best"
    --sub-lang LANGS                 Languages of the subtitles to download
Philipp Hagemeister's avatar
Philipp Hagemeister committed
365
366
                                     (optional) separated by commas, use --list-
                                     subs for available language tags
Daniel Bolton's avatar
Daniel Bolton committed
367

368
## Authentication Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
369
    -u, --username USERNAME          Login with this account ID
Philipp Hagemeister's avatar
Philipp Hagemeister committed
370
371
    -p, --password PASSWORD          Account password. If this option is left
                                     out, youtube-dl will ask interactively.
Sergey M․'s avatar
Sergey M․ committed
372
    -2, --twofactor TWOFACTOR        Two-factor authentication code
Philipp Hagemeister's avatar
Philipp Hagemeister committed
373
    -n, --netrc                      Use .netrc authentication data
374
    --video-password PASSWORD        Video password (vimeo, smotri, youku)
Daniel Bolton's avatar
Daniel Bolton committed
375

Sergey M․'s avatar
Sergey M․ committed
376
377
378
379
380
381
382
383
384
385
386
## Adobe Pass Options:
    --ap-mso MSO                     Adobe Pass multiple-system operator (TV
                                     provider) identifier, use --ap-list-mso for
                                     a list of available MSOs
    --ap-username USERNAME           Multiple-system operator account login
    --ap-password PASSWORD           Multiple-system operator account password.
                                     If this option is left out, youtube-dl will
                                     ask interactively.
    --ap-list-mso                    List all supported multiple-system
                                     operators

387
## Post-processing Options:
Philipp Hagemeister's avatar
Philipp Hagemeister committed
388
389
390
391
    -x, --extract-audio              Convert video files to audio-only files
                                     (requires ffmpeg or avconv and ffprobe or
                                     avprobe)
    --audio-format FORMAT            Specify audio format: "best", "aac",
Sergey M․'s avatar
Sergey M․ committed
392
393
394
                                     "flac", "mp3", "m4a", "opus", "vorbis", or
                                     "wav"; "best" by default; No effect without
                                     -x
Philipp Hagemeister's avatar
Philipp Hagemeister committed
395
396
397
398
399
400
401
    --audio-quality QUALITY          Specify ffmpeg/avconv audio quality, insert
                                     a value between 0 (better) and 9 (worse)
                                     for VBR or a specific bitrate like 128K
                                     (default 5)
    --recode-video FORMAT            Encode the video to another format if
                                     necessary (currently supported:
                                     mp4|flv|ogg|webm|mkv|avi)
402
    --postprocessor-args ARGS        Give these arguments to the postprocessor
Philipp Hagemeister's avatar
Philipp Hagemeister committed
403
404
405
406
407
    -k, --keep-video                 Keep the video file on disk after the post-
                                     processing; the video is erased by default
    --no-post-overwrites             Do not overwrite post-processed files; the
                                     post-processed files are overwritten by
                                     default
Philipp Hagemeister's avatar
Philipp Hagemeister committed
408
409
    --embed-subs                     Embed subtitles in the video (only for mp4,
                                     webm and mkv videos)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
410
411
    --embed-thumbnail                Embed thumbnail in the audio as cover art
    --add-metadata                   Write metadata to the video file
Philipp Hagemeister's avatar
Philipp Hagemeister committed
412
413
    --metadata-from-title FORMAT     Parse additional metadata like song title /
                                     artist from the video title. The format
Sergey M․'s avatar
Sergey M․ committed
414
415
416
417
418
419
420
421
                                     syntax is the same as --output. Regular
                                     expression with named capture groups may
                                     also be used. The parsed parameters replace
                                     existing values. Example: --metadata-from-
                                     title "%(artist)s - %(title)s" matches a
                                     title like "Coldplay - Paradise". Example
                                     (regex): --metadata-from-title
                                     "(?P<artist>.+?) - (?P<title>.+)"
Philipp Hagemeister's avatar
Philipp Hagemeister committed
422
423
424
425
426
427
428
429
430
    --xattrs                         Write metadata to the video file's xattrs
                                     (using dublin core and xdg standards)
    --fixup POLICY                   Automatically correct known faults of the
                                     file. One of never (do nothing), warn (only
                                     emit a warning), detect_or_warn (the
                                     default; fix file if we can, warn
                                     otherwise)
    --prefer-avconv                  Prefer avconv over ffmpeg for running the
                                     postprocessors
Sergey M․'s avatar
Sergey M․ committed
431
432
    --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
                                     postprocessors (default)
Philipp Hagemeister's avatar
Philipp Hagemeister committed
433
434
435
436
    --ffmpeg-location PATH           Location of the ffmpeg/avconv binary;
                                     either the path to the binary or its
                                     containing directory.
    --exec CMD                       Execute a command on the file after
Sergey M․'s avatar
Sergey M․ committed
437
438
439
                                     downloading and post-processing, similar to
                                     find's -exec syntax. Example: --exec 'adb
                                     push {} /sdcard/Music/ && rm {}'
Philipp Hagemeister's avatar
Philipp Hagemeister committed
440
    --convert-subs FORMAT            Convert the subtitles to other format
Sergey M․'s avatar
Sergey M․ committed
441
                                     (currently supported: srt|ass|vtt|lrc)
Daniel Bolton's avatar
Daniel Bolton committed
442

Philipp Hagemeister's avatar
Philipp Hagemeister committed
443
444
# CONFIGURATION

445
You can configure youtube-dl 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-dl.conf` and the user wide configuration file at `~/.config/youtube-dl/config`. On Windows, the user wide configuration file locations are `%APPDATA%\youtube-dl\config.txt` or `C:\Users\<user name>\youtube-dl.conf`. Note that by default configuration file may not exist so you may need to create it yourself.
446

447
For example, with the following configuration file youtube-dl will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory:
448
```
449
450
451
# Lines starting with # are comments

# Always extract audio
452
-x
453
454

# Do not copy the mtime
455
--no-mtime
456
457

# Use this proxy
458
--proxy 127.0.0.1:3128
459
460

# Save all videos under Movies directory in your home directory
461
-o ~/Movies/%(title)s.%(ext)s
462
463
```

464
465
Note that options in configuration file are just the same options aka switches used in regular command line calls thus there **must be no whitespace** after `-` or `--`, e.g. `-o` or `--proxy` but not `- o` or `-- proxy`.

David Haberthür's avatar
David Haberthür committed
466
You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
467

468
469
You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dl run.

David Haberthür's avatar
David Haberthür committed
470
### Authentication with `.netrc` file
471

Alan Yee's avatar
Alan Yee committed
472
You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every youtube-dl 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:
473
474
475
476
```
touch $HOME/.netrc
chmod a-rwx,u+rw $HOME/.netrc
```
Simon Morgan's avatar
Simon Morgan committed
477
After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
478
479
480
481
482
483
484
485
```
machine <extractor> login <login> password <password>
```
For example:
```
machine youtube login myaccount@gmail.com password my_youtube_password
machine twitch login my_twitch_account_name password my_twitch_password
```
David Haberthür's avatar
David Haberthür committed
486
To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
487

488
489
490
491
On Windows you may also need to setup the `%HOME%` environment variable manually. For example:
```
set HOME=%USERPROFILE%
```
492

493
494
# OUTPUT TEMPLATE

495
496
497
498
The `-o` option allows users to indicate a template for the output file names.

**tl;dr:** [navigate me to examples](#output-template-examples).

Atlas Sullivan's avatar
Atlas Sullivan committed
499
The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -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:
500
501
502
503
504
505
506
507
508
509
510
511
512
513

 - `id` (string): Video identifier
 - `title` (string): Video title
 - `url` (string): Video URL
 - `ext` (string): Video filename extension
 - `alt_title` (string): A secondary title of the video
 - `display_id` (string): An alternative identifier for the video
 - `uploader` (string): Full name of the video uploader
 - `license` (string): License name the video is licensed under
 - `creator` (string): The creator of the video
 - `release_date` (string): The date (YYYYMMDD) when the video was released
 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
 - `upload_date` (string): Video upload date (YYYYMMDD)
 - `uploader_id` (string): Nickname or id of the video uploader
514
515
 - `channel` (string): Full name of the channel the video is uploaded on
 - `channel_id` (string): Id of the channel
516
517
518
519
520
521
522
523
524
 - `location` (string): Physical location where the video was filmed
 - `duration` (numeric): Length of the video in seconds
 - `view_count` (numeric): How many users have watched the video on the platform
 - `like_count` (numeric): Number of positive ratings of the video
 - `dislike_count` (numeric): Number of negative ratings of the video
 - `repost_count` (numeric): Number of reposts of the video
 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
 - `comment_count` (numeric): Number of comments on the video
 - `age_limit` (numeric): Age restriction for the video (years)
525
526
527
 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 - `format` (string): A human-readable description of the format 
 - `format_id` (string): Format code specified by `--format`
 - `format_note` (string): Additional info about the format
 - `width` (numeric): Width of the video
 - `height` (numeric): Height of the video
 - `resolution` (string): Textual description of width and height
 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
 - `abr` (numeric): Average audio bitrate in KBit/s
 - `acodec` (string): Name of the audio codec in use
 - `asr` (numeric): Audio sampling rate in Hertz
 - `vbr` (numeric): Average video bitrate in KBit/s
 - `fps` (numeric): Frame rate
 - `vcodec` (string): Name of the video codec in use
 - `container` (string): Name of the container format
 - `filesize` (numeric): The number of bytes, if known in advance
 - `filesize_approx` (numeric): An estimate for the number of bytes
 - `protocol` (string): The protocol that will be used for the actual download
 - `extractor` (string): Name of the extractor
 - `extractor_key` (string): Key name of the extractor
 - `epoch` (numeric): Unix epoch when creating the file
548
 - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
549
550
551
552
 - `playlist` (string): Name or id of the playlist that contains the video
 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
 - `playlist_id` (string): Playlist identifier
 - `playlist_title` (string): Playlist title
553
554
 - `playlist_uploader` (string): Full name of the playlist uploader
 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
555

Sergey M's avatar
Sergey M committed
556
Available for the video that belongs to some logical chapter or section:
557

558
559
560
 - `chapter` (string): Name or title of the chapter the video belongs to
 - `chapter_number` (numeric): Number of the chapter the video belongs to
 - `chapter_id` (string): Id of the chapter the video belongs to
561
562

Available for the video that is an episode of some series or programme:
563

564
565
566
567
568
569
570
 - `series` (string): Title of the series or programme the video episode belongs to
 - `season` (string): Title of the season the video episode belongs to
 - `season_number` (numeric): Number of the season the video episode belongs to
 - `season_id` (string): Id of the season the video episode belongs to
 - `episode` (string): Title of the video episode
 - `episode_number` (numeric): Number of the video episode within a season
 - `episode_id` (string): Id of the video episode
571

572
Available for the media that is a track or a part of a music album:
573

574
575
576
577
578
579
580
581
582
583
 - `track` (string): Title of the track
 - `track_number` (numeric): Number of the track within an album or a disc
 - `track_id` (string): Id of the track
 - `artist` (string): Artist(s) of the track
 - `genre` (string): Genre(s) of the track
 - `album` (string): Title of the album the track belongs to
 - `album_type` (string): Type of the album
 - `album_artist` (string): List of all artists appeared on the album
 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
 - `release_year` (numeric): Year (YYYY) when the album was released
584

Simon Morgan's avatar
Simon Morgan committed
585
Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with `NA`.
586

Simon Morgan's avatar
Simon Morgan committed
587
For example for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `youtube-dl test video` and id `BaW_jenozKcj`, this will result in a `youtube-dl test video-BaW_jenozKcj.mp4` file created in the current directory.
588

589
590
For numeric sequences you can use numeric related formatting, for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.

Simon Morgan's avatar
Simon Morgan committed
591
Output templates can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
592

Simon Morgan's avatar
Simon Morgan committed
593
To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
594

595
The current default template is `%(title)s-%(id)s.%(ext)s`.
596
597
598

In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:

599
600
#### Output template and Windows batch files

Simon Morgan's avatar
Simon Morgan committed
601
If you are using an output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
602

603
#### Output template examples
604

Justin Quan's avatar
Justin Quan committed
605
Note that on Windows you may need to use double quotes instead of single.
606

607
```bash
608
$ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
609
youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
610

611
$ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
612
youtube-dl_test_video_.mp4          # A simple file name
613
614
615
616

# Download YouTube playlist videos in separate directory indexed by video order in a playlist
$ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re

617
618
619
# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
$ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists

620
621
622
623
# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
$ youtube-dl -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/

# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
Alan Yee's avatar
Alan Yee committed
624
$ youtube-dl -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
625
626
627

# Stream the video being downloaded to stdout
$ youtube-dl -o - BaW_jenozKc
628
```
629

630
631
# FORMAT SELECTION

632
By default youtube-dl 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-dl will guess it for you by **default**.
633

Simon Morgan's avatar
Simon Morgan committed
634
But 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.
635

636
637
The 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.

638
639
**tl;dr:** [navigate me to examples](#format-selection-examples).

640
641
The simplest case is requesting a specific format, for example with `-f 22` you can download the format with format code equal to 22. You can get the list of available format codes for particular video using `--list-formats` or `-F`. Note that these format codes are extractor specific. 

Simon Morgan's avatar
Simon Morgan committed
642
You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
643

Simon Morgan's avatar
Simon Morgan committed
644
You can also use special names to select particular edge case formats:
645

Simon Morgan's avatar
Simon Morgan committed
646
647
648
649
650
651
 - `best`: Select the best quality format represented by a single file with video and audio.
 - `worst`: Select the worst quality format represented by a single file with video and audio.
 - `bestvideo`: Select the best quality video-only format (e.g. DASH video). May not be available.
 - `worstvideo`: Select the worst quality video-only format. May not be available.
 - `bestaudio`: Select the best quality audio only-format. May not be available.
 - `worstaudio`: Select the worst quality audio only-format. May not be available.
652

Simon Morgan's avatar
Simon Morgan committed
653
For example, to download the worst quality video-only format you can use `-f worstvideo`.
654
655
656

If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that slash is left-associative, i.e. 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.

Simon Morgan's avatar
Simon Morgan committed
657
If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
658
659
660
661

You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).

The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
662

663
664
665
666
667
668
669
670
671
 - `filesize`: The number of bytes, if known in advance
 - `width`: Width of the video, if known
 - `height`: Height of the video, if known
 - `tbr`: Average bitrate of audio and video in KBit/s
 - `abr`: Average audio bitrate in KBit/s
 - `vbr`: Average video bitrate in KBit/s
 - `asr`: Audio sampling rate in Hertz
 - `fps`: Frame rate

672
Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
673

674
675
676
677
 - `ext`: File extension
 - `acodec`: Name of the audio codec in use
 - `vcodec`: Name of the video codec in use
 - `container`: Name of the container format
678
 - `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`)
679
 - `format_id`: A short description of the format
Sergey M's avatar
Sergey M committed
680

681
Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
682

Simon Morgan's avatar
Simon Morgan committed
683
Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the video hoster.
684
685
686

Formats for which the value is not known are excluded unless you put a question mark (`?`) after the operator. You can combine format filters, so `-f "[height <=? 720][tbr>500]"` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s.

Simon Morgan's avatar
Simon Morgan committed
687
You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (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.
688
689
690

Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than 480 you can use `-f '(mp4,webm)[height<480]'`.

Sergey M․'s avatar
Sergey M․ committed
691
Since the end of April 2015 and version 2015.04.26, youtube-dl 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. If you want to only download some DASH formats (for example if you are not interested in getting videos with a resolution higher than 1080p), you can add `-f bestvideo[height<=?1080]+bestaudio/best` to your configuration file. Note that if you use youtube-dl 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-dl 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.
692

David Haberthür's avatar
David Haberthür committed
693
If you want to preserve the old format selection behavior (prior to youtube-dl 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-dl.
694

695
#### Format selection examples
696

Justin Quan's avatar
Justin Quan committed
697
Note that on Windows you may need to use double quotes instead of single.
698

699
700
701
702
```bash
# Download best mp4 format available or any other best if no mp4 available
$ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'

703
# Download best format available but no better than 480p
704
705
$ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'

Laneone's avatar
Laneone committed
706
# Download best video only format but no bigger than 50 MB
707
$ youtube-dl -f 'best[filesize<50M]'
708
709
710

# Download best format available via direct link over HTTP/HTTPS protocol
$ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
711
712
713

# Download the best video format and the best audio format without merging them
$ youtube-dl -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
714
```
715
Note that in the last example, an output template is recommended as bestvideo and bestaudio may have the same file name.
716
717


718
719
# VIDEO SELECTION

720
Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
721
722
723
724
725
726

 - Absolute dates: Dates in the format `YYYYMMDD`.
 - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
 
Examples:

727
728
729
```bash
# Download only the videos uploaded in the last 6 months
$ youtube-dl --dateafter now-6months
Philipp Hagemeister's avatar
Philipp Hagemeister committed
730

731
732
# Download only the videos uploaded on January 1, 1970
$ youtube-dl --date 19700101
Philipp Hagemeister's avatar
Philipp Hagemeister committed
733

734
$ # Download only the videos uploaded in the 200x decade
735
736
$ youtube-dl --dateafter 20000101 --datebefore 20091231
```
737

738
# FAQ
Philipp Hagemeister's avatar
Philipp Hagemeister committed
739

740
### How do I update youtube-dl?
741

Sergey M․'s avatar
Sergey M․ committed
742
If you've followed [our manual installation instructions](https://ytdl-org.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
743
744

If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
745

Alan Yee's avatar
Alan Yee committed
746
If you have installed youtube-dl using a package manager like *apt-get* or *yum*, use the standard system update mechanism to update. Note that distribution packages are often outdated. As a rule of thumb, youtube-dl releases at least once a month, and often weekly or even daily. Simply go to https://yt-dl.org to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
747

748
749
750
751
As a last resort, you can also uninstall the version installed by your package manager and follow our manual installation instructions. For that, remove the distribution's package, with a line like

    sudo apt-get remove -y youtube-dl

Sergey M․'s avatar
Sergey M․ committed
752
Afterwards, simply follow [our manual installation instructions](https://ytdl-org.github.io/youtube-dl/download.html):
753
754

```
755
756
sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
sudo chmod a+rx /usr/local/bin/youtube-dl
757
758
759
hash -r
```

760
761
Again, from then on you'll be able to update with `sudo youtube-dl -U`.

762
763
764
765
### youtube-dl is extremely slow to start on Windows

Add a file exclusion for `youtube-dl.exe` in Windows Defender settings.

766
767
### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists

David Haberthür's avatar
David Haberthür committed
768
YouTube changed their playlist format in March 2014 and later on, so you'll need at least youtube-dl 2014.07.25 to download all YouTube videos.
769

770
If you have installed youtube-dl with a package manager, pip, setup.py or a tarball, please use that to update. Note that Ubuntu packages do not seem to get updated anymore. Since we are not affiliated with Ubuntu, there is little we can do. Feel free to [report bugs](https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to the [Ubuntu packaging people](mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl) - all they have to do is update the package to a somewhat recent version. See above for a way to update.
771

772
773
774
775
### I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`

Make sure you are not using `-o` with any of these options `-t`, `--title`, `--id`, `-A` or `--auto-number` set in command line or in a configuration file. Remove the latter if any.

776
### Do I always have to pass `-citw`?
777

David Haberthür's avatar
David Haberthür committed
778
By default, youtube-dl intends to have the best options (incidentally, if you have a convincing case that these should be different, [please file an issue where you explain that](https://yt-dl.org/bug)). Therefore, it is unnecessary and sometimes harmful to copy long option strings from webpages. In particular, the only option out of `-citw` that is regularly useful is `-i`.
779

Sergey M's avatar
Sergey M committed
780
### Can you please put the `-b` option back?
Philipp Hagemeister's avatar
Philipp Hagemeister committed
781

David Haberthür's avatar
David Haberthür committed
782
Most people asking this question are not aware that youtube-dl now defaults to downloading the highest available quality as reported by YouTube, which will be 1080p or 720p in some cases, so you no longer need the `-b` option. For some specific videos, maybe YouTube does not report them to be available in a specific high quality format you're interested in. In that case, simply request it with the `-f` option and youtube-dl will try to download it.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
783

Philipp Hagemeister's avatar
Philipp Hagemeister committed
784
### I get HTTP error 402 when trying to download a video. What's this?
Philipp Hagemeister's avatar
Philipp Hagemeister committed
785

Sergey M․'s avatar
Sergey M․ committed
786
Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/ytdl-org/youtube-dl/issues/154), but at the moment, your best course of action is pointing a web browser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
787

788
789
### Do I need any other programs?

David Haberthür's avatar
David Haberthür committed
790
youtube-dl works fine on its own on most sites. However, if you want to convert video/audio, you'll need [avconv](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/). On some sites - most notably YouTube - videos can be retrieved in a higher quality format without sound. youtube-dl will detect whether avconv/ffmpeg is present and automatically pick the best option.
791

Alan Yee's avatar
Alan Yee committed
792
Videos or video formats streamed via RTMP protocol can only be downloaded when [rtmpdump](https://rtmpdump.mplayerhq.hu/) is installed. Downloading MMS and RTSP videos requires either [mplayer](https://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
793

Philipp Hagemeister's avatar
Philipp Hagemeister committed
794
795
### I have downloaded a video but how can I play it?

Alan Yee's avatar
Alan Yee committed
796
Once the video is fully downloaded, use any video player, such as [mpv](https://mpv.io/), [vlc](https://www.videolan.org/) or [mplayer](https://www.mplayerhq.hu/).
Philipp Hagemeister's avatar
Philipp Hagemeister committed
797

798
### I extracted a video URL with `-g`, but it does not play on another machine / in my web browser.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
799

800
It depends a lot on the service. In many cases, requests for the video (to download/play it) must come from the same IP address and with the same cookies and/or HTTP headers. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl. You can also get necessary cookies and HTTP headers from JSON output obtained with `--dump-json`.
801
802
803

It may be beneficial to use IPv6; in some cases, the restrictions are only applied to IPv4. Some services (sometimes only for a subset of videos) do not restrict the video URL by IP address, cookie, or user-agent, but these are the exception rather than the rule.

Sergey M's avatar
Sergey M committed
804
Please bear in mind that some URL protocols are **not** supported by browsers out of the box, including RTMP. If you are using `-g`, your own downloader must support these as well.
805

David Haberthür's avatar
David Haberthür committed
806
If you want to play the video on a machine that is not running youtube-dl, you can relay the video content from the machine that runs youtube-dl. You can use `-o -` to let youtube-dl stream a video to stdout, or simply allow the player to download the files written by youtube-dl in turn.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
807

808
809
### ERROR: no fmt_url_map or conn information found in video info

David Haberthür's avatar
David Haberthür committed
810
YouTube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
811

David Haberthür's avatar
David Haberthür committed
812
### ERROR: unable to download video
813

David Haberthür's avatar
David Haberthür committed
814
YouTube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
815

David Haberthür's avatar
David Haberthür committed
816
### Video URL contains an ampersand and I'm getting some strange output `[1] 2839` or `'v' is not recognized as an internal or external command`
817

David Haberthür's avatar
David Haberthür committed
818
That's actually the output from your shell. Since ampersand is one of the special shell characters it's interpreted by the shell preventing you from passing the whole URL to youtube-dl. To disable your shell from interpreting the ampersands (or any other special characters) you have to either put the whole URL in quotes or escape them with a backslash (which approach will work depends on your shell).
819

820
For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
821

822
```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
823
824
825

or

826
```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
827
828
829

For Windows you have to use the double quotes:

830
```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
831

832
833
### ExtractorError: Could not find JS function u'OF'

David Haberthür's avatar
David Haberthür committed
834
In February 2015, the new YouTube player contained a character sequence in a string that was misinterpreted by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
835

836
837
### HTTP Error 429: Too Many Requests or 402: Payment Required

Sergey M․'s avatar
Sergey M․ committed
838
839
840
These two error codes indicate that the service is blocking your IP address because of overuse. Usually this is a soft block meaning that you can gain access again after solving CAPTCHA. Just open a browser and solve a CAPTCHA the service suggests you and after that [pass cookies](#how-do-i-pass-cookies-to-youtube-dl) to youtube-dl. Note that if your machine has multiple external IPs then you should also pass exactly the same IP you've used for solving CAPTCHA with [`--source-address`](#network-options). Also you may need to pass a `User-Agent` HTTP header of your browser with [`--user-agent`](#workarounds).

If this is not the case (no CAPTCHA suggested to solve by the service) then you can contact the service and ask them to unblock your IP address, or - if you have acquired a whitelisted IP address already - use the [`--proxy` or `--source-address` options](#network-options) to select another IP address.
841

David Haberthür's avatar
David Haberthür committed
842
### SyntaxError: Non-ASCII character
843
844
845
846
847
848
849
850

The error

    File "youtube-dl", line 2
    SyntaxError: Non-ASCII character '\x93' ...

means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.

851
852
### What is this binary file? Where has the code gone?

Sergey M․'s avatar
Sergey M․ committed
853
Since June 2012 ([#342](https://github.com/ytdl-org/youtube-dl/issues/342)) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
854

855
### The exe throws an error due to missing `MSVCR100.dll`
856

857
To run the exe you need to install first the [Microsoft Visual C++ 2010 Redistributable Package (x86)](https://www.microsoft.com/en-US/download/details.aspx?id=5555).
858

859
860
### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?

David Haberthür's avatar
David Haberthür committed
861
If you put youtube-dl and ffmpeg in the same directory that you're running the command from, it will work, but that's rather cumbersome.
862

David Haberthür's avatar
David Haberthür committed
863
To make a different directory work - either for ffmpeg, or for youtube-dl, or for both - simply create the directory (say, `C:\bin`, or `C:\Users\<User name>\bin`), put all the executables directly in there, and then [set your PATH environment variable](https://www.java.com/en/download/help/path.xml) to include that directory.
864

David Haberthür's avatar
David Haberthür committed
865
From then on, after restarting your shell, you will be able to access both youtube-dl and ffmpeg (and youtube-dl will be able to find ffmpeg) by simply typing `youtube-dl` or `ffmpeg`, no matter what directory you're in.
866

867
868
869
870
### How do I put downloads into a specific folder?

Use the `-o` to specify an [output template](#output-template), for example `-o "/home/user/videos/%(title)s-%(id)s.%(ext)s"`. If you want this for all of your downloads, put the option into your [configuration file](#configuration).

David Haberthür's avatar
David Haberthür committed
871
### How do I download a video starting with a `-`?
872

Alan Yee's avatar
Alan Yee committed
873
Either prepend `https://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
874
875

    youtube-dl -- -wNyEUrxzFU
Alan Yee's avatar
Alan Yee committed
876
    youtube-dl "https://www.youtube.com/watch?v=-wNyEUrxzFU"
877

Sergey M.'s avatar
Sergey M. committed
878
879
### How do I pass cookies to youtube-dl?

880
881
Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`.

882
In order to extract cookies from browser use any conforming browser extension for exporting cookies. For example, [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg) (for Chrome) or [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/) (for Firefox).
883

Reto Kromer's avatar
Reto Kromer committed
884
Note that the cookies file must be in Mozilla/Netscape format and the first line of the cookies file must be either `# HTTP Cookie File` or `# Netscape HTTP Cookie File`. Make sure you have correct [newline format](https://en.wikipedia.org/wiki/Newline) in the cookies file and convert newlines if necessary to correspond with your OS, namely `CRLF` (`\r\n`) for Windows and `LF` (`\n`) for Unix and Unix-like systems (Linux, macOS, etc.). `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
Sergey M.'s avatar
Sergey M. committed
885

Sergey M's avatar
Sergey M committed
886
Passing cookies to youtube-dl is a good way to workaround login when a particular extractor does not implement it explicitly. Another use case is working around [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) some websites require you to solve in particular cases in order to get access (e.g. YouTube, CloudFlare).
Sergey M.'s avatar
Sergey M. committed
887

888
889
### How do I stream directly to media player?

Alan Yee's avatar
Alan Yee committed
890
You will first need to tell youtube-dl to stream media to stdout with `-o -`, and also tell your media player to read from stdin (it must be capable of this for streaming) and then pipe former to latter. For example, streaming to [vlc](https://www.videolan.org/) can be achieved with:
891

Alan Yee's avatar
Alan Yee committed
892
    youtube-dl -o - "https://www.youtube.com/watch?v=BaW_jenozKcj" | vlc -
893

894
### How do I download only new videos from a playlist?
895

896
Use download-archive feature. With this feature you should initially download the complete playlist with `--download-archive /path/to/download/archive/file.txt` that will record identifiers of all the videos in a special file. Each subsequent run with the same `--download-archive` will download only new videos and skip all videos that have been downloaded before. Note that only successful downloads are recorded in the file.
897

898
For example, at first,
899
900
901

    youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"

902
will download the complete `PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re` playlist and create a file `archive.txt`. Each subsequent run will only download new videos if any:
903
904
905

    youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"

906
907
908
909
910
911
### Should I add `--hls-prefer-native` into my config?

When youtube-dl detects an HLS video, it can download it either with the built-in downloader or ffmpeg. Since many HLS streams are slightly invalid and ffmpeg/youtube-dl each handle some invalid cases better than the other, there is an option to switch the downloader if needed.

When youtube-dl knows that one particular downloader works better for a given website, that downloader will be picked. Otherwise, youtube-dl will pick the best downloader for general compatibility, which at the moment happens to be ffmpeg. This choice may change in future versions of youtube-dl, with improvements of the built-in downloader and/or ffmpeg.

Sergey M․'s avatar
Sergey M․ committed
912
In particular, the generic extractor (used when your website is not in the [list of supported sites by youtube-dl](https://ytdl-org.github.io/youtube-dl/supportedsites.html) cannot mandate one specific downloader.
913
914
915

If you put either `--hls-prefer-native` or `--hls-prefer-ffmpeg` into your configuration, a different subset of videos will fail to download correctly. Instead, it is much better to [file an issue](https://yt-dl.org/bug) or a pull request which details why the native or the ffmpeg HLS downloader is a better choice for your use case.

916
917
### Can you add support for this anime video site, or site which shows current movies for free?

David Haberthür's avatar
David Haberthür committed
918
As a matter of policy (as well as legality), youtube-dl does not include support for services that specialize in infringing copyright. As a rule of thumb, if you cannot easily find a video that the service is quite obviously allowed to distribute (i.e. that has been uploaded by the creator, the creator's distributor, or is published under a free license), the service is probably unfit for inclusion to youtube-dl.
919

David Haberthür's avatar
David Haberthür committed
920
A note on the service that they don't host the infringing content, but just link to those who do, is evidence that the service should **not** be included into youtube-dl. The same goes for any DMCA note when the whole front page of the service is filled with videos they are not allowed to distribute. A "fair use" note is equally unconvincing if the service shows copyright-protected videos in full without authorization.
921
922
923

Support requests for services that **do** purchase the rights to distribute their content are perfectly fine though. If in doubt, you can simply include a source that mentions the legitimate purchase of content.

924
925
### How can I speed up work on my issue?

David Haberthür's avatar
David Haberthür committed
926
(Also known as: Help, my important issue not being solved!) The youtube-dl core developer team is quite small. While we do our best to solve as many issues as possible, sometimes that can take quite a while. To speed up your issue, here's what you can do:
927

David Haberthür's avatar
David Haberthür committed
928
First of all, please do report the issue [at our issue tracker](https://yt-dl.org/bugs). That allows us to coordinate all efforts by users and developers, and serves as a unified point. Unfortunately, the youtube-dl project has grown too large to use personal email as an effective communication channel.
929

David Haberthür's avatar
David Haberthür committed
930
Please read the [bug reporting instructions](#bugs) below. A lot of bugs lack all the necessary information. If you can, offer proxy, VPN, or shell access to the youtube-dl developers. If you are able to, test the issue from multiple computers in multiple countries to exclude local censorship or misconfiguration issues.
931
932
933

If nobody is interested in solving your issue, you are welcome to take matters into your own hands and submit a pull request (or coerce/pay somebody else to do so).

David Haberthür's avatar
David Haberthür committed
934
Feel free to bump the issue from time to time by writing a small comment ("Issue is still present in youtube-dl version ...from France, but fixed from Belgium"), but please not more than once a month. Please do not declare your issue as `important` or `urgent`.
935

936
937
### How can I detect whether a given URL is supported by youtube-dl?

Alan Yee's avatar
Alan Yee committed
938
For one, have a look at the [list of supported sites](docs/supportedsites.md). Note that it can sometimes happen that the site changes its URL scheme (say, from https://example.com/video/1234567 to https://example.com/v/1234567 ) and youtube-dl reports an URL of a service in that list as unsupported. In that case, simply report a bug.
939

David Haberthür's avatar
David Haberthür committed
940
It is *not* possible to detect whether a URL is supported or not. That's because youtube-dl contains a generic extractor which matches **all** URLs. You may be tempted to disable, exclude, or remove the generic extractor, but the generic extractor not only allows users to extract videos from lots of websites that embed a video from another service, but may also be used to extract video from a service that it's hosting itself. Therefore, we neither recommend nor support disabling, excluding, or removing the generic extractor.
941

David Haberthür's avatar
David Haberthür committed
942
If you want to find out whether a given URL is supported, simply call youtube-dl with it. If you get no videos back, chances are the URL is either not referring to a video or unsupported. You can find out which by examining the output (if you run youtube-dl on the console) or catching an `UnsupportedError` exception if you run it from a Python program.
943

Philipp Hagemeister's avatar
Philipp Hagemeister committed
944
945
# Why do I need to go through that much red tape when filing bugs?

Vítor Galvão's avatar
Vítor Galvão committed
946
Before we had the issue template, despite our extensive [bug reporting instructions](#bugs), about 80% of the issue reports we got were useless, for instance because people used ancient versions hundreds of releases old, because of simple syntactic errors (not in youtube-dl but in general shell usage), because the problem was already reported multiple times before, because people did not actually read an error message, even if it said "please install ffmpeg", because people did not mention the URL they were trying to download and many more simple, easy-to-avoid problems, many of whom were totally unrelated to youtube-dl.
Philipp Hagemeister's avatar
Philipp Hagemeister committed
947
948
949

youtube-dl is an open-source project manned by too few volunteers, so we'd rather spend time fixing bugs where we are certain none of those simple problems apply, and where we can be reasonably confident to be able to reproduce the issue without asking the reporter repeatedly. As such, the output of `youtube-dl -v YOUR_URL_HERE` is really all that's required to file an issue. The issue template also guides you through some basic steps you can do, such as checking that your version of youtube-dl is current.

950
# DEVELOPER INSTRUCTIONS
951

Sergey M․'s avatar
Sergey M․ committed
952
Most users do not need to build youtube-dl and can [download the builds](https://ytdl-org.github.io/youtube-dl/download.html) or get them from their distribution.
953

David Haberthür's avatar