]> Raphaƫl G. Git Repositories - youtubedl/blob - README.txt
bc4f294d922e5b53d0c4d0f2e9662de1b9be6677
[youtubedl] / README.txt
1 youtube-dl - download videos from youtube.com or other video platforms
2
3 - INSTALLATION
4 - DESCRIPTION
5 - OPTIONS
6 - CONFIGURATION
7 - OUTPUT TEMPLATE
8 - FORMAT SELECTION
9 - VIDEO SELECTION
10 - FAQ
11 - DEVELOPER INSTRUCTIONS
12 - BUGS
13 - COPYRIGHT
14
15
16
17 INSTALLATION
18
19
20 To install it right away for all UNIX users (Linux, OS X, etc.), type:
21
22 sudo curl https://yt-dl.org/latest/youtube-dl -o /usr/local/bin/youtube-dl
23 sudo chmod a+rx /usr/local/bin/youtube-dl
24
25 If you do not have curl, you can alternatively use a recent wget:
26
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
30 Windows users can download a .exe file and place it in their home
31 directory or any other location on their PATH.
32
33 OS X users can install YOUTUBE-DL with Homebrew.
34
35 brew install youtube-dl
36
37 You can also use pip:
38
39 sudo pip install youtube-dl
40
41 Alternatively, refer to the developer instructions below for how to
42 check out and work with the git repository. For further options,
43 including PGP signatures, see
44 https://rg3.github.io/youtube-dl/download.html .
45
46
47
48 DESCRIPTION
49
50
51 YOUTUBE-DL is a small command-line program to download videos from
52 YouTube.com and a few more sites. It requires the Python interpreter,
53 version 2.6, 2.7, or 3.2+, and it is not platform specific. It should
54 work on your Unix box, on Windows or on Mac OS X. It is released to the
55 public domain, which means you can modify it, redistribute it or use it
56 however you like.
57
58 youtube-dl [OPTIONS] URL [URL...]
59
60
61
62 OPTIONS
63
64
65 -h, --help Print this help text and exit
66 --version Print program version and exit
67 -U, --update Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)
68 -i, --ignore-errors Continue on download errors, for example to skip unavailable videos in a playlist
69 --abort-on-error Abort downloading of further videos (in the playlist or the command line) if an error occurs
70 --dump-user-agent Display the current browser identification
71 --list-extractors List all supported extractors and the URLs they would handle
72 --extractor-descriptions Output descriptions of all supported extractors
73 --default-search PREFIX Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple".
74 Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The
75 default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.
76 --ignore-config Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: Do not read the user configuration
77 in ~/.config/youtube-dl/config (%APPDATA%/youtube-dl/config.txt on Windows)
78 --flat-playlist Do not extract the videos of a playlist, only list them.
79 --no-color Do not emit color codes in output
80
81
82 Network Options:
83
84 --proxy URL Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection
85 --socket-timeout SECONDS Time to wait before giving up, in seconds
86 --source-address IP Client-side IP address to bind to (experimental)
87 -4, --force-ipv4 Make all connections via IPv4 (experimental)
88 -6, --force-ipv6 Make all connections via IPv6 (experimental)
89 --cn-verification-proxy URL Use this proxy to verify the IP address for some Chinese sites. The default proxy specified by --proxy (or none, if the options is
90 not present) is used for the actual downloading. (experimental)
91
92
93 Video Selection:
94
95 --playlist-start NUMBER Playlist video to start at (default is 1)
96 --playlist-end NUMBER Playlist video to end at (default is last)
97 --playlist-items ITEM_SPEC Playlist video items to download. Specify indices of the videos in the playlist seperated by commas like: "--playlist-items 1,2,5,8"
98 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
99 download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.
100 --match-title REGEX Download only matching titles (regex or caseless sub-string)
101 --reject-title REGEX Skip download for matching titles (regex or caseless sub-string)
102 --max-downloads NUMBER Abort after downloading NUMBER files
103 --min-filesize SIZE Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)
104 --max-filesize SIZE Do not download any videos larger than SIZE (e.g. 50k or 44.6m)
105 --date DATE Download only videos uploaded in this date
106 --datebefore DATE Download only videos uploaded on or before this date (i.e. inclusive)
107 --dateafter DATE Download only videos uploaded on or after this date (i.e. inclusive)
108 --min-views COUNT Do not download any videos with less than COUNT views
109 --max-views COUNT Do not download any videos with more than COUNT views
110 --match-filter FILTER Generic video filter (experimental). Specify any key (see help for -o for a list of available keys) to match if the key is present,
111 !key to check if the key is not present,key > NUMBER (like "comment_count > 12", also works with >=, <, <=, !=, =) to compare against
112 a number, and & to require multiple matches. Values which are not known are excluded unless you put a question mark (?) after the
113 operator.For example, to only match videos that have been liked more than 100 times and disliked less than 50 times (or the dislike
114 functionality is not available at the given service), but who also have a description, use --match-filter "like_count > 100 &
115 dislike_count <? 50 & description" .
116 --no-playlist Download only the video, if the URL refers to a video and a playlist.
117 --yes-playlist Download the playlist, if the URL refers to a video and a playlist.
118 --age-limit YEARS Download only videos suitable for the given age
119 --download-archive FILE Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.
120 --include-ads Download advertisements as well (experimental)
121
122
123 Download Options:
124
125 -r, --rate-limit LIMIT Maximum download rate in bytes per second (e.g. 50K or 4.2M)
126 -R, --retries RETRIES Number of retries (default is 10), or "infinite".
127 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K) (default is 1024)
128 --no-resize-buffer Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.
129 --playlist-reverse Download playlist videos in reverse order
130 --xattr-set-filesize Set file xattribute ytdl.filesize with expected filesize (experimental)
131 --hls-prefer-native Use the native HLS downloader instead of ffmpeg (experimental)
132 --external-downloader COMMAND Use the specified external downloader. Currently supports aria2c,curl,wget
133 --external-downloader-args ARGS Give these arguments to the external downloader
134
135
136 Filesystem Options:
137
138 -a, --batch-file FILE File containing URLs to download ('-' for stdin)
139 --id Use only video ID in file name
140 -o, --output TEMPLATE Output filename template. Use %(title)s to get the title, %(uploader)s for the uploader name, %(uploader_id)s for the uploader
141 nickname if different, %(autonumber)s to get an automatically incremented number, %(ext)s for the filename extension, %(format)s for
142 the format description (like "22 - 1280x720" or "HD"), %(format_id)s for the unique id of the format (like YouTube's itags: "137"),
143 %(upload_date)s for the upload date (YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), %(id)s for the video id,
144 %(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in,
145 %(playlist_index)s for the position in the playlist. %(height)s and %(width)s for the width and height of the video format.
146 %(resolution)s for a textual description of the resolution of the video format. %% for a literal percent. Use - to output to stdout.
147 Can also be used to download to a different directory, for example with -o '/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
148 --autonumber-size NUMBER Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given
149 --restrict-filenames Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
150 -A, --auto-number [deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000
151 -t, --title [deprecated] Use title in file name (default)
152 -l, --literal [deprecated] Alias of --title
153 -w, --no-overwrites Do not overwrite files
154 -c, --continue Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
155 --no-continue Do not resume partially downloaded files (restart from beginning)
156 --no-part Do not use .part files - write directly into output file
157 --no-mtime Do not use the Last-modified header to set the file modification time
158 --write-description Write video description to a .description file
159 --write-info-json Write video metadata to a .info.json file
160 --write-annotations Write video annotations to a .annotations.xml file
161 --load-info FILE JSON file containing the video information (created with the "--write-info-json" option)
162 --cookies FILE File to read cookies from and dump cookie jar in
163 --cache-dir DIR Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl
164 or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may
165 change.
166 --no-cache-dir Disable filesystem caching
167 --rm-cache-dir Delete all filesystem cache files
168
169
170 Thumbnail images:
171
172 --write-thumbnail Write thumbnail image to disk
173 --write-all-thumbnails Write all thumbnail image formats to disk
174 --list-thumbnails Simulate and list all available thumbnail formats
175
176
177 Verbosity / Simulation Options:
178
179 -q, --quiet Activate quiet mode
180 --no-warnings Ignore warnings
181 -s, --simulate Do not download the video and do not write anything to disk
182 --skip-download Do not download the video
183 -g, --get-url Simulate, quiet but print URL
184 -e, --get-title Simulate, quiet but print title
185 --get-id Simulate, quiet but print id
186 --get-thumbnail Simulate, quiet but print thumbnail URL
187 --get-description Simulate, quiet but print video description
188 --get-duration Simulate, quiet but print video length
189 --get-filename Simulate, quiet but print output filename
190 --get-format Simulate, quiet but print output format
191 -j, --dump-json Simulate, quiet but print JSON information. See --output for a description of available keys.
192 -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
193 information in a single line.
194 --print-json Be quiet and print the video information as JSON (video is still being downloaded).
195 --newline Output progress bar as new lines
196 --no-progress Do not print progress bar
197 --console-title Display progress in console titlebar
198 -v, --verbose Print various debugging information
199 --dump-pages Print downloaded pages encoded using base64 to debug problems (very verbose)
200 --write-pages Write downloaded intermediary pages to files in the current directory to debug problems
201 --print-traffic Display sent and read HTTP traffic
202 -C, --call-home Contact the youtube-dl server for debugging
203 --no-call-home Do NOT contact the youtube-dl server for debugging
204
205
206 Workarounds:
207
208 --encoding ENCODING Force the specified encoding (experimental)
209 --no-check-certificate Suppress HTTPS certificate validation
210 --prefer-insecure Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)
211 --user-agent UA Specify a custom user agent
212 --referer URL Specify a custom referer, use if the video access is restricted to one domain
213 --add-header FIELD:VALUE Specify a custom HTTP header and its value, separated by a colon ':'. You can use this option multiple times
214 --bidi-workaround Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH
215 --sleep-interval SECONDS Number of seconds to sleep before each download.
216
217
218 Video Format Options:
219
220 -f, --format FORMAT Video format code, see the "FORMAT SELECTION" for all the info
221 --all-formats Download all available video formats
222 --prefer-free-formats Prefer free video formats unless a specific one is requested
223 -F, --list-formats List all available formats
224 --youtube-skip-dash-manifest Do not download the DASH manifest on YouTube videos
225 --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
226 merge is required
227
228
229 Subtitle Options:
230
231 --write-sub Write subtitle file
232 --write-auto-sub Write automatic subtitle file (YouTube only)
233 --all-subs Download all the available subtitles of the video
234 --list-subs List all available subtitles for the video
235 --sub-format FORMAT Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"
236 --sub-lang LANGS Languages of the subtitles to download (optional) separated by commas, use IETF language tags like 'en,pt'
237
238
239 Authentication Options:
240
241 -u, --username USERNAME Login with this account ID
242 -p, --password PASSWORD Account password. If this option is left out, youtube-dl will ask interactively.
243 -2, --twofactor TWOFACTOR Two-factor auth code
244 -n, --netrc Use .netrc authentication data
245 --video-password PASSWORD Video password (vimeo, smotri)
246
247
248 Post-processing Options:
249
250 -x, --extract-audio Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)
251 --audio-format FORMAT Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "best" by default
252 --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
253 5)
254 --recode-video FORMAT Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)
255 -k, --keep-video Keep the video file on disk after the post-processing; the video is erased by default
256 --no-post-overwrites Do not overwrite post-processed files; the post-processed files are overwritten by default
257 --embed-subs Embed subtitles in the video (only for mkv and mp4 videos)
258 --embed-thumbnail Embed thumbnail in the audio as cover art
259 --add-metadata Write metadata to the video file
260 --metadata-from-title FORMAT Parse additional metadata like song title / artist from the video title. The format syntax is the same as --output, the parsed
261 parameters replace existing values. Additional templates: %(album)s, %(artist)s. Example: --metadata-from-title "%(artist)s -
262 %(title)s" matches a title like "Coldplay - Paradise"
263 --xattrs Write metadata to the video file's xattrs (using dublin core and xdg standards)
264 --fixup POLICY Automatically correct known faults of the file. One of never (do nothing), warn (only emit a warning), detect_or_warn(the default;
265 fix file if we can, warn otherwise)
266 --prefer-avconv Prefer avconv over ffmpeg for running the postprocessors (default)
267 --prefer-ffmpeg Prefer ffmpeg over avconv for running the postprocessors
268 --ffmpeg-location PATH Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.
269 --exec CMD Execute a command on the file after downloading, similar to find's -exec syntax. Example: --exec 'adb push {} /sdcard/Music/ && rm
270 {}'
271 --convert-subtitles FORMAT Convert the subtitles to other format (currently supported: srt|ass|vtt)
272
273
274
275 CONFIGURATION
276
277
278 You can configure youtube-dl by placing default arguments (such as
279 --extract-audio --no-mtime to always extract the audio and not copy the
280 mtime) into /etc/youtube-dl.conf and/or ~/.config/youtube-dl/config. On
281 Windows, the configuration file locations are
282 %APPDATA%\youtube-dl\config.txt and
283 C:\Users\<user name>\youtube-dl.conf.
284
285
286
287 OUTPUT TEMPLATE
288
289
290 The -o option allows users to indicate a template for the output file
291 names. The basic usage is not to set any template arguments when
292 downloading a single file, like in
293 youtube-dl -o funny_video.flv "http://some/video". However, it may
294 contain special sequences that will be replaced when downloading each
295 video. The special sequences have the format %(NAME)s. To clarify, that
296 is a percent symbol followed by a name in parenthesis, followed by a
297 lowercase S. Allowed names are:
298
299 - id: The sequence will be replaced by the video identifier.
300 - url: The sequence will be replaced by the video URL.
301 - uploader: The sequence will be replaced by the nickname of the
302 person who uploaded the video.
303 - upload_date: The sequence will be replaced by the upload date in
304 YYYYMMDD format.
305 - title: The sequence will be replaced by the video title.
306 - ext: The sequence will be replaced by the appropriate extension
307 (like flv or mp4).
308 - epoch: The sequence will be replaced by the Unix epoch when creating
309 the file.
310 - autonumber: The sequence will be replaced by a five-digit number
311 that will be increased with each download, starting at zero.
312 - playlist: The name or the id of the playlist that contains the
313 video.
314 - playlist_index: The index of the video in the playlist, a five-digit
315 number.
316
317 The current default template is %(title)s-%(id)s.%(ext)s.
318
319 In some cases, you don't want special characters such as äø­, spaces, or
320 &, such as when transferring the downloaded filename to a Windows system
321 or the filename through an 8bit-unsafe channel. In these cases, add the
322 --restrict-filenames flag to get a shorter title:
323
324 ``` {.bash}
325 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
326 youtube-dl test video ''_Ƥā†­š•.mp4 # All kinds of weird characters
327 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
328 youtube-dl_test_video_.mp4 # A simple file name
329 ```
330
331
332
333 FORMAT SELECTION
334
335
336 By default youtube-dl tries to download the best quality, but sometimes
337 you may want to download other format. The simplest case is requesting a
338 specific format, for example -f 22. You can get the list of available
339 formats using --list-formats, you can also use a file extension
340 (currently it supports aac, m4a, mp3, mp4, ogg, wav, webm) or the
341 special names best, bestvideo, bestaudio and worst.
342
343 If you want to download multiple videos and they don't have the same
344 formats available, you can specify the order of preference using
345 slashes, as in -f 22/17/18. You can also filter the video results by
346 putting a condition in brackets, as in -f "best[height=720]" (or
347 -f "[filesize>10M]"). This works for filesize, height, width, tbr, abr,
348 vbr, asr, and fps and the comparisons <, <=, >, >=, =, != and for ext,
349 acodec, vcodec, container, and protocol and the comparisons =, != .
350 Formats for which the value is not known are excluded unless you put a
351 question mark (?) after the operator. You can combine format filters, so
352 -f "[height <=? 720][tbr>500]" selects up to 720p videos (or videos
353 where the height is not known) with a bitrate of at least 500 KBit/s.
354 Use commas to download multiple formats, such as
355 -f 136/137/mp4/bestvideo,140/m4a/bestaudio. You can merge the video and
356 audio of two formats into a single file using
357 -f <video-format>+<audio-format> (requires ffmpeg or avconv), for
358 example -f bestvideo+bestaudio.
359
360 Since the end of April 2015 and version 2015.04.26 youtube-dl uses
361 -f bestvideo+bestaudio/best as default format selection (see #5447,
362 #5456). If ffmpeg or avconv are installed this results in downloading
363 bestvideo and bestaudio separately and muxing them together into a
364 single file giving the best overall quality available. Otherwise it
365 falls back to best and results in downloading best available quality
366 served as a single file. best is also needed for videos that don't come
367 from YouTube because they don't provide the audio and video in two
368 different files. If you want to only download some dash formats (for
369 example if you are not interested in getting videos with a resolution
370 higher than 1080p), you can add
371 -f bestvideo[height<=?1080]+bestaudio/best to your configuration file.
372 Note that if you use youtube-dl to stream to stdout (and most likely to
373 pipe it to your media player then), i.e. you explicitly specify output
374 template as -o -, youtube-dl still uses -f best format selection in
375 order to start content delivery immediately to your player and not to
376 wait until bestvideo and bestaudio are downloaded and muxed.
377
378 If you want to preserve the old format selection behavior (prior to
379 youtube-dl 2015.04.26), i.e. you want to download best available quality
380 media served as a single file, you should explicitly specify your choice
381 with -f best. You may want to add it to the configuration file in order
382 not to type it every time you run youtube-dl.
383
384
385
386 VIDEO SELECTION
387
388
389 Videos can be filtered by their upload date using the options --date,
390 --datebefore or --dateafter, they accept dates in two formats:
391
392 - Absolute dates: Dates in the format YYYYMMDD.
393 - Relative dates: Dates in the format
394 (now|today)[+-][0-9](day|week|month|year)(s)?
395
396 Examples:
397
398 ``` {.bash}
399 # Download only the videos uploaded in the last 6 months
400 $ youtube-dl --dateafter now-6months
401
402 # Download only the videos uploaded on January 1, 1970
403 $ youtube-dl --date 19700101
404
405 $ # will only download the videos uploaded in the 200x decade
406 $ youtube-dl --dateafter 20000101 --datebefore 20091231
407 ```
408
409
410
411 FAQ
412
413
414 How do I update youtube-dl?
415
416 If you've followed our manual installation instructions, you can simply
417 run youtube-dl -U (or, on Linux, sudo youtube-dl -U).
418
419 If you have used pip, a simple sudo pip install -U youtube-dl is
420 sufficient to update.
421
422 If you have installed youtube-dl using a package manager like _apt-get_
423 or _yum_, use the standard system update mechanism to update. Note that
424 distribution packages are often outdated. As a rule of thumb, youtube-dl
425 releases at least once a month, and often weekly or even daily. Simply
426 go to http://yt-dl.org/ to find out the current version. Unfortunately,
427 there is nothing we youtube-dl developers can do if your distributions
428 serves a really outdated version. You can (and should) complain to your
429 distribution in their bugtracker or support forum.
430
431 As a last resort, you can also uninstall the version installed by your
432 package manager and follow our manual installation instructions. For
433 that, remove the distribution's package, with a line like
434
435 sudo apt-get remove -y youtube-dl
436
437 Afterwards, simply follow our manual installation instructions:
438
439 sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
440 sudo chmod a+x /usr/local/bin/youtube-dl
441 hash -r
442
443 Again, from then on you'll be able to update with sudo youtube-dl -U.
444
445 I'm getting an error Unable to extract OpenGraph title on YouTube playlists
446
447 YouTube changed their playlist format in March 2014 and later on, so
448 you'll need at least youtube-dl 2014.07.25 to download all YouTube
449 videos.
450
451 If you have installed youtube-dl with a package manager, pip, setup.py
452 or a tarball, please use that to update. Note that Ubuntu packages do
453 not seem to get updated anymore. Since we are not affiliated with
454 Ubuntu, there is little we can do. Feel free to report bugs to the
455 Ubuntu packaging guys - all they have to do is update the package to a
456 somewhat recent version. See above for a way to update.
457
458 Do I always have to pass -citw?
459
460 By default, youtube-dl intends to have the best options (incidentally,
461 if you have a convincing case that these should be different, please
462 file an issue where you explain that). Therefore, it is unnecessary and
463 sometimes harmful to copy long option strings from webpages. In
464 particular, the only option out of -citw that is regularly useful is -i.
465
466 Can you please put the -b option back?
467
468 Most people asking this question are not aware that youtube-dl now
469 defaults to downloading the highest available quality as reported by
470 YouTube, which will be 1080p or 720p in some cases, so you no longer
471 need the -b option. For some specific videos, maybe YouTube does not
472 report them to be available in a specific high quality format you're
473 interested in. In that case, simply request it with the -f option and
474 youtube-dl will try to download it.
475
476 I get HTTP error 402 when trying to download a video. What's this?
477
478 Apparently YouTube requires you to pass a CAPTCHA test if you download
479 too much. We're considering to provide a way to let you solve the
480 CAPTCHA, but at the moment, your best course of action is pointing a
481 webbrowser to the youtube URL, solving the CAPTCHA, and restart
482 youtube-dl.
483
484 I have downloaded a video but how can I play it?
485
486 Once the video is fully downloaded, use any video player, such as vlc or
487 mplayer.
488
489 I extracted a video URL with -g, but it does not play on another machine / in my webbrowser.
490
491 It depends a lot on the service. In many cases, requests for the video
492 (to download/play it) must come from the same IP address and with the
493 same cookies. Use the --cookies option to write the required cookies
494 into a file, and advise your downloader to read cookies from that file.
495 Some sites also require a common user agent to be used, use
496 --dump-user-agent to see the one in use by youtube-dl.
497
498 It may be beneficial to use IPv6; in some cases, the restrictions are
499 only applied to IPv4. Some services (sometimes only for a subset of
500 videos) do not restrict the video URL by IP address, cookie, or
501 user-agent, but these are the exception rather than the rule.
502
503 Please bear in mind that some URL protocols are NOT supported by
504 browsers out of the box, including RTMP. If you are using -g, your own
505 downloader must support these as well.
506
507 If you want to play the video on a machine that is not running
508 youtube-dl, you can relay the video content from the machine that runs
509 youtube-dl. You can use -o - to let youtube-dl stream a video to stdout,
510 or simply allow the player to download the files written by youtube-dl
511 in turn.
512
513 ERROR: no fmt_url_map or conn information found in video info
514
515 YouTube has switched to a new video info format in July 2011 which is
516 not supported by old versions of youtube-dl. See above for how to update
517 youtube-dl.
518
519 ERROR: unable to download video
520
521 YouTube requires an additional signature since September 2012 which is
522 not supported by old versions of youtube-dl. See above for how to update
523 youtube-dl.
524
525 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
526
527 That's actually the output from your shell. Since ampersand is one of
528 the special shell characters it's interpreted by shell preventing you
529 from passing the whole URL to youtube-dl. To disable your shell from
530 interpreting the ampersands (or any other special characters) you have
531 to either put the whole URL in quotes or escape them with a backslash
532 (which approach will work depends on your shell).
533
534 For example if your URL is
535 https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with
536 following command:
537
538 youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'
539
540 or
541
542 youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc
543
544 For Windows you have to use the double quotes:
545
546 youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"
547
548 ExtractorError: Could not find JS function u'OF'
549
550 In February 2015, the new YouTube player contained a character sequence
551 in a string that was misinterpreted by old versions of youtube-dl. See
552 above for how to update youtube-dl.
553
554 HTTP Error 429: Too Many Requests or 402: Payment Required
555
556 These two error codes indicate that the service is blocking your IP
557 address because of overuse. Contact the service and ask them to unblock
558 your IP address, or - if you have acquired a whitelisted IP address
559 already - use the --proxy or --network-address options to select another
560 IP address.
561
562 SyntaxError: Non-ASCII character
563
564 The error
565
566 File "youtube-dl", line 2
567 SyntaxError: Non-ASCII character '\x93' ...
568
569 means you're using an outdated version of Python. Please update to
570 Python 2.6 or 2.7.
571
572 What is this binary file? Where has the code gone?
573
574 Since June 2012 (#342) youtube-dl is packed as an executable zipfile,
575 simply unzip it (might need renaming to youtube-dl.zip first on some
576 systems) or clone the git repository, as laid out above. If you modify
577 the code, you can run it by executing the __main__.py file. To recompile
578 the executable, run make youtube-dl.
579
580 The exe throws a _Runtime error from Visual C++_
581
582 To run the exe you need to install first the Microsoft Visual C++ 2008
583 Redistributable Package.
584
585 On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
586
587 If you put youtube-dl and ffmpeg in the same directory that you're
588 running the command from, it will work, but that's rather cumbersome.
589
590 To make a different directory work - either for ffmpeg, or for
591 youtube-dl, or for both - simply create the directory (say, C:\bin, or
592 C:\Users\<User name>\bin), put all the executables directly in there,
593 and then set your PATH environment variable to include that directory.
594
595 From then on, after restarting your shell, you will be able to access
596 both youtube-dl and ffmpeg (and youtube-dl will be able to find ffmpeg)
597 by simply typing youtube-dl or ffmpeg, no matter what directory you're
598 in.
599
600 How do I put downloads into a specific folder?
601
602 Use the -o to specify an output template, for example
603 -o "/home/user/videos/%(title)s-%(id)s.%(ext)s". If you want this for
604 all of your downloads, put the option into your configuration file.
605
606 How do I download a video starting with a - ?
607
608 Either prepend http://www.youtube.com/watch?v= or separate the ID from
609 the options with --:
610
611 youtube-dl -- -wNyEUrxzFU
612 youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
613
614 Can you add support for this anime video site, or site which shows current movies for free?
615
616 As a matter of policy (as well as legality), youtube-dl does not include
617 support for services that specialize in infringing copyright. As a rule
618 of thumb, if you cannot easily find a video that the service is quite
619 obviously allowed to distribute (i.e. that has been uploaded by the
620 creator, the creator's distributor, or is published under a free
621 license), the service is probably unfit for inclusion to youtube-dl.
622
623 A note on the service that they don't host the infringing content, but
624 just link to those who do, is evidence that the service should NOT be
625 included into youtube-dl. The same goes for any DMCA note when the whole
626 front page of the service is filled with videos they are not allowed to
627 distribute. A "fair use" note is equally unconvincing if the service
628 shows copyright-protected videos in full without authorization.
629
630 Support requests for services that DO purchase the rights to distribute
631 their content are perfectly fine though. If in doubt, you can simply
632 include a source that mentions the legitimate purchase of content.
633
634 How can I speed up work on my issue?
635
636 (Also known as: Help, my important issue not being solved!) The
637 youtube-dl core developer team is quite small. While we do our best to
638 solve as many issues as possible, sometimes that can take quite a while.
639 To speed up your issue, here's what you can do:
640
641 First of all, please do report the issue at our issue tracker. That
642 allows us to coordinate all efforts by users and developers, and serves
643 as a unified point. Unfortunately, the youtube-dl project has grown too
644 large to use personal email as an effective communication channel.
645
646 Please read the bug reporting instructions below. A lot of bugs lack all
647 the necessary information. If you can, offer proxy, VPN, or shell access
648 to the youtube-dl developers. If you are able to, test the issue from
649 multiple computers in multiple countries to exclude local censorship or
650 misconfiguration issues.
651
652 If nobody is interested in solving your issue, you are welcome to take
653 matters into your own hands and submit a pull request (or coerce/pay
654 somebody else to do so).
655
656 Feel free to bump the issue from time to time by writing a small comment
657 ("Issue is still present in youtube-dl version ...from France, but fixed
658 from Belgium"), but please not more than once a month. Please do not
659 declare your issue as important or urgent.
660
661 How can I detect whether a given URL is supported by youtube-dl?
662
663 For one, have a look at the list of supported sites. Note that it can
664 sometimes happen that the site changes its URL scheme (say, from
665 http://example.com/video/1234567 to http://example.com/v/1234567 ) and
666 youtube-dl reports an URL of a service in that list as unsupported. In
667 that case, simply report a bug.
668
669 It is _not_ possible to detect whether a URL is supported or not. That's
670 because youtube-dl contains a generic extractor which matches ALL URLs.
671 You may be tempted to disable, exclude, or remove the generic extractor,
672 but the generic extractor not only allows users to extract videos from
673 lots of websites that embed a video from another service, but may also
674 be used to extract video from a service that it's hosting itself.
675 Therefore, we neither recommend nor support disabling, excluding, or
676 removing the generic extractor.
677
678 If you want to find out whether a given URL is supported, simply call
679 youtube-dl with it. If you get no videos back, chances are the URL is
680 either not referring to a video or unsupported. You can find out which
681 by examining the output (if you run youtube-dl on the console) or
682 catching an UnsupportedError exception if you run it from a Python
683 program.
684
685
686
687 DEVELOPER INSTRUCTIONS
688
689
690 Most users do not need to build youtube-dl and can download the builds
691 or get them from their distribution.
692
693 To run youtube-dl as a developer, you don't need to build anything
694 either. Simply execute
695
696 python -m youtube_dl
697
698 To run the test, simply invoke your favorite test runner, or execute a
699 test file directly; any of the following work:
700
701 python -m unittest discover
702 python test/test_download.py
703 nosetests
704
705 If you want to create a build of youtube-dl yourself, you'll need
706
707 - python
708 - make
709 - pandoc
710 - zip
711 - nosetests
712
713 Adding support for a new site
714
715 If you want to add support for a new site, you can follow this quick
716 list (assuming your service is called yourextractor):
717
718 1. Fork this repository
719 2. Check out the source code with
720 git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
721 3. Start a new git branch with
722 cd youtube-dl; git checkout -b yourextractor
723 4. Start with this simple template and save it to
724 youtube_dl/extractor/yourextractor.py:
725
726 ``` {.python}
727 # coding: utf-8
728 from __future__ import unicode_literals
729
730 from .common import InfoExtractor
731
732
733 class YourExtractorIE(InfoExtractor):
734 _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
735 _TEST = {
736 'url': 'http://yourextractor.com/watch/42',
737 'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
738 'info_dict': {
739 'id': '42',
740 'ext': 'mp4',
741 'title': 'Video title goes here',
742 'thumbnail': 're:^https?://.*\.jpg$',
743 # TODO more properties, either as:
744 # * A value
745 # * MD5 checksum; start the string with md5:
746 # * A regular expression; start the string with re:
747 # * Any Python type (for example int or float)
748 }
749 }
750
751 def _real_extract(self, url):
752 video_id = self._match_id(url)
753 webpage = self._download_webpage(url, video_id)
754
755 # TODO more code goes here, for example ...
756 title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
757
758 return {
759 'id': video_id,
760 'title': title,
761 'description': self._og_search_description(webpage),
762 # TODO more properties (see youtube_dl/extractor/common.py)
763 }
764 ```
765
766 5. Add an import in youtube_dl/extractor/__init__.py.
767 6. Run python test/test_download.py TestDownload.test_YourExtractor.
768 This _should fail_ at first, but you can continually re-run it until
769 you're done. If you decide to add more than one test, then rename
770 _TEST to _TESTS and make it into a list of dictionaries. The tests
771 will be then be named TestDownload.test_YourExtractor,
772 TestDownload.test_YourExtractor_1,
773 TestDownload.test_YourExtractor_2, etc.
774 7. Have a look at youtube_dl/common/extractor/common.py for possible
775 helper methods and a detailed description of what your extractor
776 should return. Add tests and code for as many as you want.
777 8. If you can, check the code with flake8.
778 9. When the tests pass, add the new files and commit them and push the
779 result, like this:
780
781 $ git add youtube_dl/extractor/__init__.py
782 $ git add youtube_dl/extractor/yourextractor.py
783 $ git commit -m '[yourextractor] Add new extractor'
784 $ git push origin yourextractor
785
786 10. Finally, create a pull request. We'll then review and merge it.
787
788 In any case, thank you very much for your contributions!
789
790
791
792 EMBEDDING YOUTUBE-DL
793
794
795 youtube-dl makes the best effort to be a good command-line program, and
796 thus should be callable from any programming language. If you encounter
797 any problems parsing its output, feel free to create a report.
798
799 From a Python program, you can embed youtube-dl in a more powerful
800 fashion, like this:
801
802 ``` {.python}
803 from __future__ import unicode_literals
804 import youtube_dl
805
806 ydl_opts = {}
807 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
808 ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
809 ```
810
811 Most likely, you'll want to use various options. For a list of what can
812 be done, have a look at youtube_dl/YoutubeDL.py. For a start, if you
813 want to intercept youtube-dl's output, set a logger object.
814
815 Here's a more complete example of a program that outputs only errors
816 (and a short message after the download is finished), and
817 downloads/converts the video to an mp3 file:
818
819 ``` {.python}
820 from __future__ import unicode_literals
821 import youtube_dl
822
823
824 class MyLogger(object):
825 def debug(self, msg):
826 pass
827
828 def warning(self, msg):
829 pass
830
831 def error(self, msg):
832 print(msg)
833
834
835 def my_hook(d):
836 if d['status'] == 'finished':
837 print('Done downloading, now converting ...')
838
839
840 ydl_opts = {
841 'format': 'bestaudio/best',
842 'postprocessors': [{
843 'key': 'FFmpegExtractAudio',
844 'preferredcodec': 'mp3',
845 'preferredquality': '192',
846 }],
847 'logger': MyLogger(),
848 'progress_hooks': [my_hook],
849 }
850 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
851 ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
852 ```
853
854
855
856 BUGS
857
858
859 Bugs and suggestions should be reported at:
860 https://github.com/rg3/youtube-dl/issues . Unless you were prompted so
861 or there is another pertinent reason (e.g. GitHub fails to accept the
862 bug report), please do not send bug reports via personal email. For
863 discussions, join us in the irc channel #youtube-dl on freenode.
864
865 PLEASE INCLUDE THE FULL OUTPUT OF YOUTUBE-DL WHEN RUN WITH -v.
866
867 The output (including the first lines) contain important debugging
868 information. Issues without the full output are often not reproducible
869 and therefore do not get solved in short order, if ever.
870
871 Please re-read your issue once again to avoid a couple of common
872 mistakes (you can and should use this as a checklist):
873
874 Is the description of the issue itself sufficient?
875
876 We often get issue reports that we cannot really decipher. While in most
877 cases we eventually get the required information after asking back
878 multiple times, this poses an unnecessary drain on our resources. Many
879 contributors, including myself, are also not native speakers, so we may
880 misread some parts.
881
882 So please elaborate on what feature you are requesting, or what bug you
883 want to be fixed. Make sure that it's obvious
884
885 - What the problem is
886 - How it could be fixed
887 - How your proposed solution would look like
888
889 If your report is shorter than two lines, it is almost certainly missing
890 some of these, which makes it hard for us to respond to it. We're often
891 too polite to close the issue outright, but the missing info makes
892 misinterpretation likely. As a commiter myself, I often get frustrated
893 by these issues, since the only possible way for me to move forward on
894 them is to ask for clarification over and over.
895
896 For bug reports, this means that your report should contain the
897 _complete_ output of youtube-dl when called with the -v flag. The error
898 message you get for (most) bugs even says so, but you would not believe
899 how many of our bug reports do not contain this information.
900
901 If your server has multiple IPs or you suspect censorship,
902 adding --call-home may be a good idea to get more diagnostics. If the
903 error is ERROR: Unable to extract ... and you cannot reproduce it from
904 multiple countries, add --dump-pages (warning: this will yield a rather
905 large output, redirect it to the file log.txt by adding >log.txt 2>&1 to
906 your command-line) or upload the .dump files you get when you add
907 --write-pages somewhere.
908
909 SITE SUPPORT REQUESTS MUST CONTAIN AN EXAMPLE URL. An example URL is a
910 URL you might want to download, like
911 http://www.youtube.com/watch?v=BaW_jenozKc . There should be an obvious
912 video present. Except under very special circumstances, the main page of
913 a video service (e.g. http://www.youtube.com/ ) is _not_ an example URL.
914
915 Are you using the latest version?
916
917 Before reporting any issue, type youtube-dl -U. This should report that
918 you're up-to-date. About 20% of the reports we receive are already
919 fixed, but people are using outdated versions. This goes for feature
920 requests as well.
921
922 Is the issue already documented?
923
924 Make sure that someone has not already opened the issue you're trying to
925 open. Search at the top of the window or at
926 https://github.com/rg3/youtube-dl/search?type=Issues . If there is an
927 issue, feel free to write something along the lines of "This affects me
928 as well, with version 2015.01.01. Here is some more information on the
929 issue: ...". While some issues may be old, a new post into them often
930 spurs rapid activity.
931
932 Why are existing options not enough?
933
934 Before requesting a new feature, please have a quick peek at the list of
935 supported options. Many feature requests are for features that actually
936 exist already! Please, absolutely do show off your work in the issue
937 report and detail how the existing similar options do _not_ solve your
938 problem.
939
940 Is there enough context in your bug report?
941
942 People want to solve problems, and often think they do us a favor by
943 breaking down their larger problems (e.g. wanting to skip already
944 downloaded files) to a specific request (e.g. requesting us to look
945 whether the file exists before downloading the info page). However, what
946 often happens is that they break down the problem into two steps: One
947 simple, and one impossible (or extremely complicated one).
948
949 We are then presented with a very complicated request when the original
950 problem could be solved far easier, e.g. by recording the downloaded
951 video IDs in a separate file. To avoid this, you must include the
952 greater context where it is non-obvious. In particular, every feature
953 request that does not consist of adding support for a new site should
954 contain a use case scenario that explains in what situation the missing
955 feature would be useful.
956
957 Does the issue involve one problem, and one problem only?
958
959 Some of our users seem to think there is a limit of issues they can or
960 should open. There is no limit of issues they can or should open. While
961 it may seem appealing to be able to dump all your issues into one
962 ticket, that means that someone who solves one of your issues cannot
963 mark the issue as closed. Typically, reporting a bunch of issues leads
964 to the ticket lingering since nobody wants to attack that behemoth,
965 until someone mercifully splits the issue into multiple ones.
966
967 In particular, every site support request issue should only pertain to
968 services at one site (generally under a common domain, but always using
969 the same backend technology). Do not request support for vimeo user
970 videos, Whitehouse podcasts, and Google Plus pages in the same issue.
971 Also, make sure that you don't post bug reports alongside feature
972 requests. As a rule of thumb, a feature request does not include outputs
973 of youtube-dl that are not immediately related to the feature at hand.
974 Do not post reports of a network error alongside the request for a new
975 video service.
976
977 Is anyone going to need the feature?
978
979 Only post features that you (or an incapacitated friend you can
980 personally talk to) require. Do not post features because they seem like
981 a good idea. If they are really useful, they will be requested by
982 someone who requires them.
983
984 Is your question about youtube-dl?
985
986 It may sound strange, but some bug reports we receive are completely
987 unrelated to youtube-dl and relate to a different or even the reporter's
988 own application. Please make sure that you are actually using
989 youtube-dl. If you are using a UI for youtube-dl, report the bug to the
990 maintainer of the actual application providing the UI. On the other
991 hand, if your UI for youtube-dl fails in some way you believe is related
992 to youtube-dl, by all means, go ahead and report the bug.
993
994
995
996 COPYRIGHT
997
998
999 youtube-dl is released into the public domain by the copyright holders.
1000
1001 This README file was originally written by Daniel Bolton
1002 (https://github.com/dbbolton) and is likewise released into the public
1003 domain.