]> git.bitcoin.ninja Git - youtube-dl/blob - README.md
Merge pull request #5556 from jaimeMF/best-format-nodash
[youtube-dl] / README.md
1 youtube-dl - download videos from youtube.com or other video platforms
2
3 - [INSTALLATION](#installation)
4 - [DESCRIPTION](#description)
5 - [OPTIONS](#options)
6 - [CONFIGURATION](#configuration)
7 - [OUTPUT TEMPLATE](#output-template)
8 - [FORMAT SELECTION](#format-selection)
9 - [VIDEO SELECTION](#video-selection)
10 - [FAQ](#faq)
11 - [DEVELOPER INSTRUCTIONS](#developer-instructions)
12 - [BUGS](#bugs)
13 - [COPYRIGHT](#copyright)
14
15 # INSTALLATION
16
17 To install it right away for all UNIX users (Linux, OS X, etc.), type:
18
19     sudo curl https://yt-dl.org/latest/youtube-dl -o /usr/local/bin/youtube-dl
20     sudo chmod a+x /usr/local/bin/youtube-dl
21
22 If you do not have curl, you can alternatively use a recent wget:
23
24     sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
25     sudo chmod a+x /usr/local/bin/youtube-dl
26
27 Windows users can [download a .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in their home directory or any other location on their [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
28
29 OS X users can install **youtube-dl** with [Homebrew](http://brew.sh/).
30
31     brew install youtube-dl
32
33 You can also use pip:
34
35     sudo pip install youtube-dl
36
37 Alternatively, refer to the developer instructions below for how to check out and work with the git repository. For further options, including PGP signatures, see https://rg3.github.io/youtube-dl/download.html .
38
39 # DESCRIPTION
40 **youtube-dl** is a small command-line program to download videos from
41 YouTube.com and a few more sites. It requires the Python interpreter, version
42 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on
43 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
44 which means you can modify it, redistribute it or use it however you like.
45
46     youtube-dl [OPTIONS] URL [URL...]
47
48 # OPTIONS
49     -h, --help                       Print this help text and exit
50     --version                        Print program version and exit
51     -U, --update                     Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)
52     -i, --ignore-errors              Continue on download errors, for example to skip unavailable videos in a playlist
53     --abort-on-error                 Abort downloading of further videos (in the playlist or the command line) if an error occurs
54     --dump-user-agent                Display the current browser identification
55     --list-extractors                List all supported extractors and the URLs they would handle
56     --extractor-descriptions         Output descriptions of all supported extractors
57     --default-search PREFIX          Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple".
58                                      Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The
59                                      default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.
60     --ignore-config                  Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: Do not read the user configuration
61                                      in ~/.config/youtube-dl/config (%APPDATA%/youtube-dl/config.txt on Windows)
62     --flat-playlist                  Do not extract the videos of a playlist, only list them.
63     --no-color                       Do not emit color codes in output
64
65 ## Network Options:
66     --proxy URL                      Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection
67     --socket-timeout SECONDS         Time to wait before giving up, in seconds
68     --source-address IP              Client-side IP address to bind to (experimental)
69     -4, --force-ipv4                 Make all connections via IPv4 (experimental)
70     -6, --force-ipv6                 Make all connections via IPv6 (experimental)
71     --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
72                                      not present) is used for the actual downloading. (experimental)
73
74 ## Video Selection:
75     --playlist-start NUMBER          Playlist video to start at (default is 1)
76     --playlist-end NUMBER            Playlist video to end at (default is last)
77     --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"
78                                      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
79                                      download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.
80     --match-title REGEX              Download only matching titles (regex or caseless sub-string)
81     --reject-title REGEX             Skip download for matching titles (regex or caseless sub-string)
82     --max-downloads NUMBER           Abort after downloading NUMBER files
83     --min-filesize SIZE              Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)
84     --max-filesize SIZE              Do not download any videos larger than SIZE (e.g. 50k or 44.6m)
85     --date DATE                      Download only videos uploaded in this date
86     --datebefore DATE                Download only videos uploaded on or before this date (i.e. inclusive)
87     --dateafter DATE                 Download only videos uploaded on or after this date (i.e. inclusive)
88     --min-views COUNT                Do not download any videos with less than COUNT views
89     --max-views COUNT                Do not download any videos with more than COUNT views
90     --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,
91                                      !key to check if the key is not present,key > NUMBER (like "comment_count > 12", also works with >=, <, <=, !=, =) to compare against
92                                      a number, and & to require multiple matches. Values which are not known are excluded unless you put a question mark (?) after the
93                                      operator.For example, to only match videos that have been liked more than 100 times and disliked less than 50 times (or the dislike
94                                      functionality is not available at the given service), but who also have a description, use  --match-filter "like_count > 100 &
95                                      dislike_count <? 50 & description" .
96     --no-playlist                    Download only the video, if the URL refers to a video and a playlist.
97     --yes-playlist                   Download the playlist, if the URL refers to a video and a playlist.
98     --age-limit YEARS                Download only videos suitable for the given age
99     --download-archive FILE          Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.
100     --include-ads                    Download advertisements as well (experimental)
101
102 ## Download Options:
103     -r, --rate-limit LIMIT           Maximum download rate in bytes per second (e.g. 50K or 4.2M)
104     -R, --retries RETRIES            Number of retries (default is 10), or "infinite".
105     --buffer-size SIZE               Size of download buffer (e.g. 1024 or 16K) (default is 1024)
106     --no-resize-buffer               Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.
107     --playlist-reverse               Download playlist videos in reverse order
108     --xattr-set-filesize             Set file xattribute ytdl.filesize with expected filesize (experimental)
109     --hls-prefer-native              Use the native HLS downloader instead of ffmpeg (experimental)
110     --external-downloader COMMAND    Use the specified external downloader. Currently supports aria2c,curl,wget
111     --external-downloader-args ARGS  Give these arguments to the external downloader
112
113 ## Filesystem Options:
114     -a, --batch-file FILE            File containing URLs to download ('-' for stdin)
115     --id                             Use only video ID in file name
116     -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
117                                      nickname if different, %(autonumber)s to get an automatically incremented number, %(ext)s for the filename extension, %(format)s for
118                                      the format description (like "22 - 1280x720" or "HD"), %(format_id)s for the unique id of the format (like YouTube's itags: "137"),
119                                      %(upload_date)s for the upload date (YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), %(id)s for the video id,
120                                      %(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in,
121                                      %(playlist_index)s for the position in the playlist. %(height)s and %(width)s for the width and height of the video format.
122                                      %(resolution)s for a textual description of the resolution of the video format. %% for a literal percent. Use - to output to stdout.
123                                      Can also be used to download to a different directory, for example with -o '/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
124     --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
125     --restrict-filenames             Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
126     -A, --auto-number                [deprecated; use  -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000
127     -t, --title                      [deprecated] Use title in file name (default)
128     -l, --literal                    [deprecated] Alias of --title
129     -w, --no-overwrites              Do not overwrite files
130     -c, --continue                   Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
131     --no-continue                    Do not resume partially downloaded files (restart from beginning)
132     --no-part                        Do not use .part files - write directly into output file
133     --no-mtime                       Do not use the Last-modified header to set the file modification time
134     --write-description              Write video description to a .description file
135     --write-info-json                Write video metadata to a .info.json file
136     --write-annotations              Write video annotations to a .annotation file
137     --load-info FILE                 JSON file containing the video information (created with the "--write-info-json" option)
138     --cookies FILE                   File to read cookies from and dump cookie jar in
139     --cache-dir DIR                  Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl
140                                      or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may
141                                      change.
142     --no-cache-dir                   Disable filesystem caching
143     --rm-cache-dir                   Delete all filesystem cache files
144
145 ## Thumbnail images:
146     --write-thumbnail                Write thumbnail image to disk
147     --write-all-thumbnails           Write all thumbnail image formats to disk
148     --list-thumbnails                Simulate and list all available thumbnail formats
149
150 ## Verbosity / Simulation Options:
151     -q, --quiet                      Activate quiet mode
152     --no-warnings                    Ignore warnings
153     -s, --simulate                   Do not download the video and do not write anything to disk
154     --skip-download                  Do not download the video
155     -g, --get-url                    Simulate, quiet but print URL
156     -e, --get-title                  Simulate, quiet but print title
157     --get-id                         Simulate, quiet but print id
158     --get-thumbnail                  Simulate, quiet but print thumbnail URL
159     --get-description                Simulate, quiet but print video description
160     --get-duration                   Simulate, quiet but print video length
161     --get-filename                   Simulate, quiet but print output filename
162     --get-format                     Simulate, quiet but print output format
163     -j, --dump-json                  Simulate, quiet but print JSON information. See --output for a description of available keys.
164     -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
165                                      information in a single line.
166     --print-json                     Be quiet and print the video information as JSON (video is still being downloaded).
167     --newline                        Output progress bar as new lines
168     --no-progress                    Do not print progress bar
169     --console-title                  Display progress in console titlebar
170     -v, --verbose                    Print various debugging information
171     --dump-pages                     Print downloaded pages to debug problems (very verbose)
172     --write-pages                    Write downloaded intermediary pages to files in the current directory to debug problems
173     --print-traffic                  Display sent and read HTTP traffic
174     -C, --call-home                  Contact the youtube-dl server for debugging
175     --no-call-home                   Do NOT contact the youtube-dl server for debugging
176
177 ## Workarounds:
178     --encoding ENCODING              Force the specified encoding (experimental)
179     --no-check-certificate           Suppress HTTPS certificate validation
180     --prefer-insecure                Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)
181     --user-agent UA                  Specify a custom user agent
182     --referer URL                    Specify a custom referer, use if the video access is restricted to one domain
183     --add-header FIELD:VALUE         Specify a custom HTTP header and its value, separated by a colon ':'. You can use this option multiple times
184     --bidi-workaround                Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH
185     --sleep-interval SECONDS         Number of seconds to sleep before each download.
186
187 ## Video Format Options:
188     -f, --format FORMAT              Video format code, see the "FORMAT SELECTION" for all the info
189     --all-formats                    Download all available video formats
190     --prefer-free-formats            Prefer free video formats unless a specific one is requested
191     -F, --list-formats               List all available formats
192     --youtube-skip-dash-manifest     Do not download the DASH manifest on YouTube videos
193     --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
194                                      merge is required
195
196 ## Subtitle Options:
197     --write-sub                      Write subtitle file
198     --write-auto-sub                 Write automatic subtitle file (YouTube only)
199     --all-subs                       Download all the available subtitles of the video
200     --list-subs                      List all available subtitles for the video
201     --sub-format FORMAT              Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"
202     --sub-lang LANGS                 Languages of the subtitles to download (optional) separated by commas, use IETF language tags like 'en,pt'
203
204 ## Authentication Options:
205     -u, --username USERNAME          Login with this account ID
206     -p, --password PASSWORD          Account password. If this option is left out, youtube-dl will ask interactively.
207     -2, --twofactor TWOFACTOR        Two-factor auth code
208     -n, --netrc                      Use .netrc authentication data
209     --video-password PASSWORD        Video password (vimeo, smotri)
210
211 ## Post-processing Options:
212     -x, --extract-audio              Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)
213     --audio-format FORMAT            Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "best" by default
214     --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
215                                      5)
216     --recode-video FORMAT            Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)
217     -k, --keep-video                 Keep the video file on disk after the post-processing; the video is erased by default
218     --no-post-overwrites             Do not overwrite post-processed files; the post-processed files are overwritten by default
219     --embed-subs                     Embed subtitles in the video (only for mp4 videos)
220     --embed-thumbnail                Embed thumbnail in the audio as cover art
221     --add-metadata                   Write metadata to the video file
222     --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
223                                      parameters replace existing values. Additional templates: %(album), %(artist). Example: --metadata-from-title "%(artist)s -
224                                      %(title)s" matches a title like "Coldplay - Paradise"
225     --xattrs                         Write metadata to the video file's xattrs (using dublin core and xdg standards)
226     --fixup POLICY                   Automatically correct known faults of the file. One of never (do nothing), warn (only emit a warning), detect_or_warn(the default;
227                                      fix file if we can, warn otherwise)
228     --prefer-avconv                  Prefer avconv over ffmpeg for running the postprocessors (default)
229     --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the postprocessors
230     --ffmpeg-location PATH           Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.
231     --exec CMD                       Execute a command on the file after downloading, similar to find's -exec syntax. Example: --exec 'adb push {} /sdcard/Music/ && rm
232                                      {}'
233     --convert-subtitles FORMAT       Convert the subtitles to other format (currently supported: srt|ass|vtt)
234
235 # CONFIGURATION
236
237 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\<user name>\youtube-dl.conf`.
238
239 # OUTPUT TEMPLATE
240
241 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:
242
243  - `id`: The sequence will be replaced by the video identifier.
244  - `url`: The sequence will be replaced by the video URL.
245  - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
246  - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
247  - `title`: The sequence will be replaced by the video title.
248  - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
249  - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
250  - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
251  - `playlist`: The name or the id of the playlist that contains the video.
252  - `playlist_index`: The index of the video in the playlist, a five-digit number.
253
254 The current default template is `%(title)s-%(id)s.%(ext)s`.
255
256 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:
257
258 ```bash
259 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
260 youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
261 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
262 youtube-dl_test_video_.mp4          # A simple file name
263 ```
264
265 # FORMAT SELECTION
266
267 By default youtube-dl tries to download the best quality, but sometimes you may want to download other format.
268 The simplest case is requesting a specific format, for example `-f 22`. You can get the list of available formats using `--list-formats`, you can also use a file extension (currently it supports aac, m4a, mp3, mp4, ogg, wav, webm) or the special names `best`, `bestvideo`, `bestaudio` and `worst`.
269
270 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, as in `-f 22/17/18`. You can also filter the video results by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).  This works for filesize, height, width, tbr, abr, vbr, asr, and fps and the comparisons <, <=, >, >=, =, != and for ext, acodec, vcodec, container, and protocol and the comparisons =, != . 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. Use commas to download multiple formats, such as `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`. You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (requires ffmpeg or avconv), for example `-f bestvideo+bestaudio`.
271
272 Since the end of April 2015 and version 2015.04.26 youtube-dl uses `-f bestvideo+bestaudio/best` as default format selection (see #5447, #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 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.
273
274 If you want to preserve the old format selection behavior (prior to youtube-dl 2015.04.26), i.e. you want to download 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.
275
276 # VIDEO SELECTION
277
278 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
279
280  - Absolute dates: Dates in the format `YYYYMMDD`.
281  - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
282  
283 Examples:
284
285 ```bash
286 # Download only the videos uploaded in the last 6 months
287 $ youtube-dl --dateafter now-6months
288
289 # Download only the videos uploaded on January 1, 1970
290 $ youtube-dl --date 19700101
291
292 $ # will only download the videos uploaded in the 200x decade
293 $ youtube-dl --dateafter 20000101 --datebefore 20091231
294 ```
295
296 # FAQ
297
298 ### How do I update youtube-dl?
299
300 If you've followed [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
301
302 If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
303
304 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 http://yt-dl.org/ to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distributions serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
305
306 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
307
308     sudo apt-get remove -y youtube-dl
309
310 Afterwards, simply follow [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html):
311
312 ```
313 sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
314 sudo chmod a+x /usr/local/bin/youtube-dl
315 hash -r
316 ```
317
318 Again, from then on you'll be able to update with `sudo youtube-dl -U`.
319
320 ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
321
322 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.
323
324 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 guys](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.
325
326 ### Do I always have to pass `-citw`?
327
328 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`.
329
330 ### Can you please put the -b option back?
331
332 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.
333
334 ### I get HTTP error 402 when trying to download a video. What's this?
335
336 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.
337
338 ### I have downloaded a video but how can I play it?
339
340 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
341
342 ### I extracted a video URL with -g, but it does not play on another machine / in my webbrowser.
343
344 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.  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.
345
346 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.
347
348 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.
349
350 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.
351
352 ### ERROR: no fmt_url_map or conn information found in video info
353
354 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.
355
356 ### ERROR: unable to download video ###
357
358 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.
359
360 ### 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` ###
361
362 That's actually the output from your shell. Since ampersand is one of the special shell characters it's interpreted by 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).
363
364 For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
365
366 ```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
367
368 or
369
370 ```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
371
372 For Windows you have to use the double quotes:
373
374 ```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
375
376 ### ExtractorError: Could not find JS function u'OF'
377
378 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.
379
380 ### HTTP Error 429: Too Many Requests or 402: Payment Required
381
382 These two error codes indicate that the service is blocking your IP address because of overuse. 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 `--network-address` options](#network-options) to select another IP address.
383
384 ### SyntaxError: Non-ASCII character ###
385
386 The error
387
388     File "youtube-dl", line 2
389     SyntaxError: Non-ASCII character '\x93' ...
390
391 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
392
393 ### What is this binary file? Where has the code gone?
394
395 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`.
396
397 ### The exe throws a *Runtime error from Visual C++*
398
399 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).
400
401 ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
402
403 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.
404
405 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.
406
407 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.
408
409 ### How do I put downloads into a specific folder?
410
411 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).
412
413 ### How do I download a video starting with a `-` ?
414
415 Either prepend `http://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
416
417     youtube-dl -- -wNyEUrxzFU
418     youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
419
420 ### Can you add support for this anime video site, or site which shows current movies for free?
421
422 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.
423
424 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.
425
426 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.
427
428 ### How can I speed up work on my issue?
429
430 (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:
431
432 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.
433
434 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.
435
436 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).
437
438 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`.
439
440 ### How can I detect whether a given URL is supported by youtube-dl?
441
442 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 http://example.com/video/1234567 to http://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.
443
444 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.
445
446 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.
447
448 # DEVELOPER INSTRUCTIONS
449
450 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.
451
452 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
453
454     python -m youtube_dl
455
456 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
457
458     python -m unittest discover
459     python test/test_download.py
460     nosetests
461
462 If you want to create a build of youtube-dl yourself, you'll need
463
464 * python
465 * make
466 * pandoc
467 * zip
468 * nosetests
469
470 ### Adding support for a new site
471
472 If you want to add support for a new site, you can follow this quick list (assuming your service is called `yourextractor`):
473
474 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
475 2. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
476 3. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
477 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
478     ```python
479     # coding: utf-8
480     from __future__ import unicode_literals
481
482     from .common import InfoExtractor
483
484
485     class YourExtractorIE(InfoExtractor):
486         _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
487         _TEST = {
488             'url': 'http://yourextractor.com/watch/42',
489             'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
490             'info_dict': {
491                 'id': '42',
492                 'ext': 'mp4',
493                 'title': 'Video title goes here',
494                 'thumbnail': 're:^https?://.*\.jpg$',
495                 # TODO more properties, either as:
496                 # * A value
497                 # * MD5 checksum; start the string with md5:
498                 # * A regular expression; start the string with re:
499                 # * Any Python type (for example int or float)
500             }
501         }
502
503         def _real_extract(self, url):
504             video_id = self._match_id(url)
505             webpage = self._download_webpage(url, video_id)
506
507             # TODO more code goes here, for example ...
508             title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
509
510             return {
511                 'id': video_id,
512                 'title': title,
513                 'description': self._og_search_description(webpage),
514                 # TODO more properties (see youtube_dl/extractor/common.py)
515             }
516     ```
517 5. Add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py).
518 6. Run `python test/test_download.py TestDownload.test_YourExtractor`. This *should fail* at first, but you can continually re-run it until you're done. If you decide to add more than one test, then rename ``_TEST`` to ``_TESTS`` and make it into a list of dictionaries. The tests will be then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc.
519 7. 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). Add tests and code for as many as you want.
520 8. If you can, check the code with [flake8](https://pypi.python.org/pypi/flake8).
521 9. When the tests pass, [add](http://git-scm.com/docs/git-add) the new files and [commit](http://git-scm.com/docs/git-commit) them and [push](http://git-scm.com/docs/git-push) the result, like this:
522
523         $ git add youtube_dl/extractor/__init__.py
524         $ git add youtube_dl/extractor/yourextractor.py
525         $ git commit -m '[yourextractor] Add new extractor'
526         $ git push origin yourextractor
527
528 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
529
530 In any case, thank you very much for your contributions!
531
532 # EMBEDDING YOUTUBE-DL
533
534 youtube-dl makes the best effort to be a good command-line program, and thus should be callable from any programming language. If you encounter any problems parsing its output, feel free to [create a report](https://github.com/rg3/youtube-dl/issues/new).
535
536 From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
537
538 ```python
539 from __future__ import unicode_literals
540 import youtube_dl
541
542 ydl_opts = {}
543 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
544     ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
545 ```
546
547 Most likely, you'll want to use various options. For a list of what can be done, have a look at [youtube_dl/YoutubeDL.py](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L69). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
548
549 Here's a more complete example of a program that outputs only errors (and a short message after the download is finished), and downloads/converts the video to an mp3 file:
550
551 ```python
552 from __future__ import unicode_literals
553 import youtube_dl
554
555
556 class MyLogger(object):
557     def debug(self, msg):
558         pass
559
560     def warning(self, msg):
561         pass
562
563     def error(self, msg):
564         print(msg)
565
566
567 def my_hook(d):
568     if d['status'] == 'finished':
569         print('Done downloading, now converting ...')
570
571
572 ydl_opts = {
573     'format': 'bestaudio/best',
574     'postprocessors': [{
575         'key': 'FFmpegExtractAudio',
576         'preferredcodec': 'mp3',
577         'preferredquality': '192',
578     }],
579     'logger': MyLogger(),
580     'progress_hooks': [my_hook],
581 }
582 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
583     ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
584 ```
585
586 # BUGS
587
588 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. For discussions, join us in the irc channel #youtube-dl on freenode.
589
590 **Please include the full output of youtube-dl when run with `-v`**.
591
592 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.
593
594 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
595
596 ### Is the description of the issue itself sufficient?
597
598 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.
599
600 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
601
602 - What the problem is
603 - How it could be fixed
604 - How your proposed solution would look like
605
606 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.
607
608 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.
609
610 If your server has multiple IPs or you suspect censorship, adding --call-home may be a good idea to get more diagnostics. If the error is `ERROR: Unable to extract ...` and you cannot reproduce it from multiple countries, add `--dump-pages` (warning: this will yield a rather large output, redirect it to the file `log.txt` by adding `>log.txt 2>&1` to your command-line) or upload the `.dump` files you get when you add `--write-pages` [somewhere](https://gist.github.com/).
611
612 **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.
613
614 ###  Are you using the latest version?
615
616 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.
617
618 ###  Is the issue already documented?
619
620 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.
621
622 ###  Why are existing options not enough?
623
624 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.
625
626 ###  Is there enough context in your bug report?
627
628 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).
629
630 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.
631
632 ###  Does the issue involve one problem, and one problem only?
633
634 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.
635
636 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.
637
638 ###  Is anyone going to need the feature?
639
640 Only post features that you (or an incapacitated 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.
641
642 ###  Is your question about youtube-dl?
643
644 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.
645
646 # COPYRIGHT
647
648 youtube-dl is released into the public domain by the copyright holders.
649
650 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.