Merge remote-tracking branch 'origin/master'
[ytdl] / README.md
1 % YOUTUBE-DL(1)
2
3 # NAME
4 youtube-dl - download videos from youtube.com or other video platforms
5
6 # SYNOPSIS
7 **youtube-dl** [OPTIONS] URL [URL...]
8
9 # DESCRIPTION
10 **youtube-dl** is a small command-line program to download videos from
11 YouTube.com and a few more sites. It requires the Python interpreter, version
12 2.6, 2.7, or 3.3+, and it is not platform specific. It should work on
13 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
14 which means you can modify it, redistribute it or use it however you like.
15
16 # OPTIONS
17     -h, --help                       print this help text and exit
18     --version                        print program version and exit
19     -U, --update                     update this program to latest version. Make
20                                      sure that you have sufficient permissions
21                                      (run with sudo if needed)
22     -i, --ignore-errors              continue on download errors, for example to
23                                      skip unavailable videos in a playlist
24     --abort-on-error                 Abort downloading of further videos (in the
25                                      playlist or the command line) if an error
26                                      occurs
27     --dump-user-agent                display the current browser identification
28     --user-agent UA                  specify a custom user agent
29     --referer REF                    specify a custom referer, use if the video
30                                      access is restricted to one domain
31     --list-extractors                List all supported extractors and the URLs
32                                      they would handle
33     --extractor-descriptions         Output descriptions of all supported
34                                      extractors
35     --proxy URL                      Use the specified HTTP/HTTPS proxy. Pass in
36                                      an empty string (--proxy "") for direct
37                                      connection
38     --no-check-certificate           Suppress HTTPS certificate validation.
39     --prefer-insecure                Use an unencrypted connection to retrieve
40                                      information about the video. (Currently
41                                      supported only for YouTube)
42     --cache-dir DIR                  Location in the filesystem where youtube-dl
43                                      can store some downloaded information
44                                      permanently. By default $XDG_CACHE_HOME
45                                      /youtube-dl or ~/.cache/youtube-dl . At the
46                                      moment, only YouTube player files (for
47                                      videos with obfuscated signatures) are
48                                      cached, but that may change.
49     --no-cache-dir                   Disable filesystem caching
50     --socket-timeout None            Time to wait before giving up, in seconds
51     --bidi-workaround                Work around terminals that lack
52                                      bidirectional text support. Requires bidiv
53                                      or fribidi executable in PATH
54     --default-search PREFIX          Use this prefix for unqualified URLs. For
55                                      example "gvsearch2:" downloads two videos
56                                      from google videos for  youtube-dl "large
57                                      apple". By default (with value "auto")
58                                      youtube-dl guesses.
59     --ignore-config                  Do not read configuration files. When given
60                                      in the global configuration file /etc
61                                      /youtube-dl.conf: do not read the user
62                                      configuration in ~/.config/youtube-dl.conf
63                                      (%APPDATA%/youtube-dl/config.txt on
64                                      Windows)
65
66 ## Video Selection:
67     --playlist-start NUMBER          playlist video to start at (default is 1)
68     --playlist-end NUMBER            playlist video to end at (default is last)
69     --match-title REGEX              download only matching titles (regex or
70                                      caseless sub-string)
71     --reject-title REGEX             skip download for matching titles (regex or
72                                      caseless sub-string)
73     --max-downloads NUMBER           Abort after downloading NUMBER files
74     --min-filesize SIZE              Do not download any videos smaller than
75                                      SIZE (e.g. 50k or 44.6m)
76     --max-filesize SIZE              Do not download any videos larger than SIZE
77                                      (e.g. 50k or 44.6m)
78     --date DATE                      download only videos uploaded in this date
79     --datebefore DATE                download only videos uploaded on or before
80                                      this date (i.e. inclusive)
81     --dateafter DATE                 download only videos uploaded on or after
82                                      this date (i.e. inclusive)
83     --min-views COUNT                Do not download any videos with less than
84                                      COUNT views
85     --max-views COUNT                Do not download any videos with more than
86                                      COUNT views
87     --no-playlist                    download only the currently playing video
88     --age-limit YEARS                download only videos suitable for the given
89                                      age
90     --download-archive FILE          Download only videos not listed in the
91                                      archive file. Record the IDs of all
92                                      downloaded videos in it.
93     --include-ads                    Download advertisements as well
94                                      (experimental)
95     --youtube-include-dash-manifest  Try to download the DASH manifest on
96                                      YouTube videos (experimental)
97
98 ## Download Options:
99     -r, --rate-limit LIMIT           maximum download rate in bytes per second
100                                      (e.g. 50K or 4.2M)
101     -R, --retries RETRIES            number of retries (default is 10)
102     --buffer-size SIZE               size of download buffer (e.g. 1024 or 16K)
103                                      (default is 1024)
104     --no-resize-buffer               do not automatically adjust the buffer
105                                      size. By default, the buffer size is
106                                      automatically resized from an initial value
107                                      of SIZE.
108
109 ## Filesystem Options:
110     -t, --title                      use title in file name (default)
111     --id                             use only video ID in file name
112     -l, --literal                    [deprecated] alias of --title
113     -A, --auto-number                number downloaded files starting from 00000
114     -o, --output TEMPLATE            output filename template. Use %(title)s to
115                                      get the title, %(uploader)s for the
116                                      uploader name, %(uploader_id)s for the
117                                      uploader nickname if different,
118                                      %(autonumber)s to get an automatically
119                                      incremented number, %(ext)s for the
120                                      filename extension, %(format)s for the
121                                      format description (like "22 - 1280x720" or
122                                      "HD"), %(format_id)s for the unique id of
123                                      the format (like Youtube's itags: "137"),
124                                      %(upload_date)s for the upload date
125                                      (YYYYMMDD), %(extractor)s for the provider
126                                      (youtube, metacafe, etc), %(id)s for the
127                                      video id, %(playlist)s for the playlist the
128                                      video is in, %(playlist_index)s for the
129                                      position in the playlist and %% for a
130                                      literal percent. %(height)s and %(width)s
131                                      for the width and height of the video
132                                      format. %(resolution)s for a textual
133                                      description of the resolution of the video
134                                      format. Use - to output to stdout. Can also
135                                      be used to download to a different
136                                      directory, for example with -o '/my/downloa
137                                      ds/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
138     --autonumber-size NUMBER         Specifies the number of digits in
139                                      %(autonumber)s when it is present in output
140                                      filename template or --auto-number option
141                                      is given
142     --restrict-filenames             Restrict filenames to only ASCII
143                                      characters, and avoid "&" and spaces in
144                                      filenames
145     -a, --batch-file FILE            file containing URLs to download ('-' for
146                                      stdin)
147     --load-info FILE                 json file containing the video information
148                                      (created with the "--write-json" option)
149     -w, --no-overwrites              do not overwrite files
150     -c, --continue                   force resume of partially downloaded files.
151                                      By default, youtube-dl will resume
152                                      downloads if possible.
153     --no-continue                    do not resume partially downloaded files
154                                      (restart from beginning)
155     --cookies FILE                   file to read cookies from and dump cookie
156                                      jar in
157     --no-part                        do not use .part files
158     --no-mtime                       do not use the Last-modified header to set
159                                      the file modification time
160     --write-description              write video description to a .description
161                                      file
162     --write-info-json                write video metadata to a .info.json file
163     --write-annotations              write video annotations to a .annotation
164                                      file
165     --write-thumbnail                write thumbnail image to disk
166
167 ## Verbosity / Simulation Options:
168     -q, --quiet                      activates quiet mode
169     -s, --simulate                   do not download the video and do not write
170                                      anything to disk
171     --skip-download                  do not download the video
172     -g, --get-url                    simulate, quiet but print URL
173     -e, --get-title                  simulate, quiet but print title
174     --get-id                         simulate, quiet but print id
175     --get-thumbnail                  simulate, quiet but print thumbnail URL
176     --get-description                simulate, quiet but print video description
177     --get-duration                   simulate, quiet but print video length
178     --get-filename                   simulate, quiet but print output filename
179     --get-format                     simulate, quiet but print output format
180     -j, --dump-json                  simulate, quiet but print JSON information
181     --newline                        output progress bar as new lines
182     --no-progress                    do not print progress bar
183     --console-title                  display progress in console titlebar
184     -v, --verbose                    print various debugging information
185     --dump-intermediate-pages        print downloaded pages to debug problems
186                                      (very verbose)
187     --write-pages                    Write downloaded intermediary pages to
188                                      files in the current directory to debug
189                                      problems
190     --print-traffic                  Display sent and read HTTP traffic
191
192 ## Video Format Options:
193     -f, --format FORMAT              video format code, specify the order of
194                                      preference using slashes: "-f 22/17/18".
195                                      "-f mp4" and "-f flv" are also supported.
196                                      You can also use the special names "best",
197                                      "bestvideo", "bestaudio", "worst",
198                                      "worstvideo" and "worstaudio". By default,
199                                      youtube-dl will pick the best quality.
200     --all-formats                    download all available video formats
201     --prefer-free-formats            prefer free video formats unless a specific
202                                      one is requested
203     --max-quality FORMAT             highest quality format to download
204     -F, --list-formats               list all available formats
205
206 ## Subtitle Options:
207     --write-sub                      write subtitle file
208     --write-auto-sub                 write automatic subtitle file (youtube
209                                      only)
210     --all-subs                       downloads all the available subtitles of
211                                      the video
212     --list-subs                      lists all available subtitles for the video
213     --sub-format FORMAT              subtitle format (default=srt) ([sbv/vtt]
214                                      youtube only)
215     --sub-lang LANGS                 languages of the subtitles to download
216                                      (optional) separated by commas, use IETF
217                                      language tags like 'en,pt'
218
219 ## Authentication Options:
220     -u, --username USERNAME          account username
221     -p, --password PASSWORD          account password
222     -n, --netrc                      use .netrc authentication data
223     --video-password PASSWORD        video password (vimeo, smotri)
224
225 ## Post-processing Options:
226     -x, --extract-audio              convert video files to audio-only files
227                                      (requires ffmpeg or avconv and ffprobe or
228                                      avprobe)
229     --audio-format FORMAT            "best", "aac", "vorbis", "mp3", "m4a",
230                                      "opus", or "wav"; best by default
231     --audio-quality QUALITY          ffmpeg/avconv audio quality specification,
232                                      insert a value between 0 (better) and 9
233                                      (worse) for VBR or a specific bitrate like
234                                      128K (default 5)
235     --recode-video FORMAT            Encode the video to another format if
236                                      necessary (currently supported:
237                                      mp4|flv|ogg|webm)
238     -k, --keep-video                 keeps the video file on disk after the
239                                      post-processing; the video is erased by
240                                      default
241     --no-post-overwrites             do not overwrite post-processed files; the
242                                      post-processed files are overwritten by
243                                      default
244     --embed-subs                     embed subtitles in the video (only for mp4
245                                      videos)
246     --add-metadata                   write metadata to the video file
247     --xattrs                         write metadata to the video file's xattrs
248                                      (using dublin core and xdg standards)
249     --prefer-avconv                  Prefer avconv over ffmpeg for running the
250                                      postprocessors (default)
251     --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
252                                      postprocessors
253
254 # CONFIGURATION
255
256 You can configure youtube-dl by placing default arguments (such as `--extract-audio --no-mtime` to always extract the audio and not copy the mtime) into `/etc/youtube-dl.conf` and/or `~/.config/youtube-dl/config`. On Windows, the configuration file locations are `%APPDATA%\youtube-dl\config.txt` and `C:\Users\<Yourname>\youtube-dl.conf`.
257
258 # OUTPUT TEMPLATE
259
260 The `-o` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parenthesis, followed by a lowercase S. Allowed names are:
261
262  - `id`: The sequence will be replaced by the video identifier.
263  - `url`: The sequence will be replaced by the video URL.
264  - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
265  - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
266  - `title`: The sequence will be replaced by the video title.
267  - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
268  - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
269  - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
270  - `playlist`: The name or the id of the playlist that contains the video.
271  - `playlist_index`: The index of the video in the playlist, a five-digit number.
272
273 The current default template is `%(title)s-%(id)s.%(ext)s`.
274
275 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:
276
277     $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
278     youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
279     $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
280     youtube-dl_test_video_.mp4          # A simple file name
281
282 # VIDEO SELECTION
283
284 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
285
286  - Absolute dates: Dates in the format `YYYYMMDD`.
287  - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
288  
289 Examples:
290
291     # Download only the videos uploaded in the last 6 months
292     $ youtube-dl --dateafter now-6months
293
294     # Download only the videos uploaded on January 1, 1970
295     $ youtube-dl --date 19700101
296
297     $ # will only download the videos uploaded in the 200x decade
298     $ youtube-dl --dateafter 20000101 --datebefore 20091231
299
300 # FAQ
301
302 ### Can you please put the -b option back?
303
304 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.
305
306 ### I get HTTP error 402 when trying to download a video. What's this?
307
308 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/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
309
310 ### I have downloaded a video but how can I play it?
311
312 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
313
314 ### The links provided by youtube-dl -g are not working anymore
315
316 The URLs youtube-dl outputs require the downloader to have the correct cookies. 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.
317
318 ### ERROR: no fmt_url_map or conn information found in video info
319
320 youtube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
321
322 ### ERROR: unable to download video ###
323
324 youtube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
325
326 ### SyntaxError: Non-ASCII character ###
327
328 The error
329
330     File "youtube-dl", line 2
331     SyntaxError: Non-ASCII character '\x93' ...
332
333 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
334
335 ### What is this binary file? Where has the code gone?
336
337 Since June 2012 (#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`.
338
339 ### The exe throws a *Runtime error from Visual C++*
340
341 To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29).
342
343 # DEVELOPER INSTRUCTIONS
344
345 Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
346
347 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
348
349     python -m youtube_dl
350
351 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
352
353     python -m unittest discover
354     python test/test_download.py
355     nosetests
356
357 If you want to create a build of youtube-dl yourself, you'll need
358
359 * python
360 * make
361 * pandoc
362 * zip
363 * nosetests
364
365 ### Adding support for a new site
366
367 If you want to add support for a new site, copy *any* [recently modified](https://github.com/rg3/youtube-dl/commits/master/youtube_dl/extractor) file in `youtube_dl/extractor`, add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py). Have a look at [`youtube_dl/common/extractor/common.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should return](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L38). Don't forget to run the tests with `python test/test_download.py TestDownload.test_YourExtractor`! For a detailed tutorial, refer to [this blog post](http://filippo.io/add-support-for-a-new-video-site-to-youtube-dl/).
368
369 # BUGS
370
371 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues> . Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email.
372
373 Please include the full output of the command when run with `--verbose`. The output (including the first lines) contain important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
374
375 For discussions, join us in the irc channel #youtube-dl on freenode.
376
377 When you submit a request, please re-read it once to avoid a couple of mistakes (you can and should use this as a checklist):
378
379 ### Is the description of the issue itself sufficient?
380
381 We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources. Many contributors, including myself, are also not native speakers, so we may misread some parts.
382
383 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
384
385 - What the problem is
386 - How it could be fixed
387 - How your proposed solution would look like
388
389 If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a commiter myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
390
391 For bug reports, this means that your report should contain the *complete* output of youtube-dl when called with the -v flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
392
393 Site support requests must contain an example URL. An example URL is a URL you might want to download, like http://www.youtube.com/watch?v=BaW_jenozKc . There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. http://www.youtube.com/ ) is *not* an example URL.
394
395 ###  Are you using the latest version?
396
397 Before reporting any issue, type youtube-dl -U. This should report that you're up-to-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. This goes for feature requests as well.
398
399 ###  Is the issue already documented?
400
401 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or at https://github.com/rg3/youtube-dl/search?type=Issues . If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
402
403 ###  Why are existing options not enough?
404
405 Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#synopsis). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
406
407 ###  Is there enough context in your bug report?
408
409 People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
410
411 We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
412
413 ###  Does the issue involve one problem, and one problem only?
414
415 Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
416
417 In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
418
419 ###  Is anyone going to need the feature?
420
421 Only post features that you (or an incapicated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
422
423 ###  Is your question about youtube-dl?
424
425 It may sound strange, but some bug reports we receive are completely unrelated to youtube-dl and relate to a different or even the reporter's own application. Please make sure that you are actually using youtube-dl. If you are using a UI for youtube-dl, report the bug to the maintainer of the actual application providing the UI. On the other hand, if your UI for youtube-dl fails in some way you believe is related to youtube-dl, by all means, go ahead and report the bug.
426
427 # COPYRIGHT
428
429 youtube-dl is released into the public domain by the copyright holders.
430
431 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.