]> gitweb @ CieloNegro.org - youtube-dl.git/blob - README.md
[limelight] Fix _VALID_URLs
[youtube-dl.git] / 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 - [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
13 - [BUGS](#bugs)
14 - [COPYRIGHT](#copyright)
15
16 # INSTALLATION
17
18 To install it right away for all UNIX users (Linux, OS X, etc.), type:
19
20     sudo curl -L https://yt-dl.org/latest/youtube-dl -o /usr/local/bin/youtube-dl
21     sudo chmod a+rx /usr/local/bin/youtube-dl
22
23 If you do not have curl, you can alternatively use a recent wget:
24
25     sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
26     sudo chmod a+rx /usr/local/bin/youtube-dl
27
28 Windows users can [download an .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in any location on their [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29) except for `%SYSTEMROOT%\System32` (e.g. **do not** put in `C:\Windows\System32`).
29
30 You can also use pip:
31
32     sudo pip install --upgrade youtube-dl
33     
34 This command will update youtube-dl if you have already installed it. See the [pypi page](https://pypi.python.org/pypi/youtube_dl) for more information.
35
36 OS X users can install youtube-dl with [Homebrew](http://brew.sh/):
37
38     brew install youtube-dl
39
40 Or with [MacPorts](https://www.macports.org/):
41
42     sudo port install youtube-dl
43
44 Alternatively, refer to the [developer instructions](#developer-instructions) for how to check out and work with the git repository. For further options, including PGP signatures, see the [youtube-dl Download Page](https://rg3.github.io/youtube-dl/download.html).
45
46 # DESCRIPTION
47 **youtube-dl** is a small command-line program to download videos from
48 YouTube.com and a few more sites. It requires the Python interpreter, version
49 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on
50 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
51 which means you can modify it, redistribute it or use it however you like.
52
53     youtube-dl [OPTIONS] URL [URL...]
54
55 # OPTIONS
56     -h, --help                       Print this help text and exit
57     --version                        Print program version and exit
58     -U, --update                     Update this program to latest version. Make
59                                      sure that you have sufficient permissions
60                                      (run with sudo if needed)
61     -i, --ignore-errors              Continue on download errors, for example to
62                                      skip unavailable videos in a playlist
63     --abort-on-error                 Abort downloading of further videos (in the
64                                      playlist or the command line) if an error
65                                      occurs
66     --dump-user-agent                Display the current browser identification
67     --list-extractors                List all supported extractors
68     --extractor-descriptions         Output descriptions of all supported
69                                      extractors
70     --force-generic-extractor        Force extraction to use the generic
71                                      extractor
72     --default-search PREFIX          Use this prefix for unqualified URLs. For
73                                      example "gvsearch2:" downloads two videos
74                                      from google videos for youtube-dl "large
75                                      apple". Use the value "auto" to let
76                                      youtube-dl guess ("auto_warning" to emit a
77                                      warning when guessing). "error" just throws
78                                      an error. The default value "fixup_error"
79                                      repairs broken URLs, but emits an error if
80                                      this is not possible instead of searching.
81     --ignore-config                  Do not read configuration files. When given
82                                      in the global configuration file
83                                      /etc/youtube-dl.conf: Do not read the user
84                                      configuration in ~/.config/youtube-
85                                      dl/config (%APPDATA%/youtube-dl/config.txt
86                                      on Windows)
87     --flat-playlist                  Do not extract the videos of a playlist,
88                                      only list them.
89     --mark-watched                   Mark videos watched (YouTube only)
90     --no-mark-watched                Do not mark videos watched (YouTube only)
91     --no-color                       Do not emit color codes in output
92
93 ## Network Options:
94     --proxy URL                      Use the specified HTTP/HTTPS/SOCKS proxy.
95                                      To enable experimental SOCKS proxy, specify
96                                      a proper scheme. For example
97                                      socks5://127.0.0.1:1080/. Pass in an empty
98                                      string (--proxy "") for direct connection
99     --socket-timeout SECONDS         Time to wait before giving up, in seconds
100     --source-address IP              Client-side IP address to bind to
101                                      (experimental)
102     -4, --force-ipv4                 Make all connections via IPv4
103                                      (experimental)
104     -6, --force-ipv6                 Make all connections via IPv6
105                                      (experimental)
106     --cn-verification-proxy URL      Use this proxy to verify the IP address for
107                                      some Chinese sites. The default proxy
108                                      specified by --proxy (or none, if the
109                                      options is not present) is used for the
110                                      actual downloading. (experimental)
111
112 ## Video Selection:
113     --playlist-start NUMBER          Playlist video to start at (default is 1)
114     --playlist-end NUMBER            Playlist video to end at (default is last)
115     --playlist-items ITEM_SPEC       Playlist video items to download. Specify
116                                      indices of the videos in the playlist
117                                      separated by commas like: "--playlist-items
118                                      1,2,5,8" if you want to download videos
119                                      indexed 1, 2, 5, 8 in the playlist. You can
120                                      specify range: "--playlist-items
121                                      1-3,7,10-13", it will download the videos
122                                      at index 1, 2, 3, 7, 10, 11, 12 and 13.
123     --match-title REGEX              Download only matching titles (regex or
124                                      caseless sub-string)
125     --reject-title REGEX             Skip download for matching titles (regex or
126                                      caseless sub-string)
127     --max-downloads NUMBER           Abort after downloading NUMBER files
128     --min-filesize SIZE              Do not download any videos smaller than
129                                      SIZE (e.g. 50k or 44.6m)
130     --max-filesize SIZE              Do not download any videos larger than SIZE
131                                      (e.g. 50k or 44.6m)
132     --date DATE                      Download only videos uploaded in this date
133     --datebefore DATE                Download only videos uploaded on or before
134                                      this date (i.e. inclusive)
135     --dateafter DATE                 Download only videos uploaded on or after
136                                      this date (i.e. inclusive)
137     --min-views COUNT                Do not download any videos with less than
138                                      COUNT views
139     --max-views COUNT                Do not download any videos with more than
140                                      COUNT views
141     --match-filter FILTER            Generic video filter (experimental).
142                                      Specify any key (see help for -o for a list
143                                      of available keys) to match if the key is
144                                      present, !key to check if the key is not
145                                      present,key > NUMBER (like "comment_count >
146                                      12", also works with >=, <, <=, !=, =) to
147                                      compare against a number, and & to require
148                                      multiple matches. Values which are not
149                                      known are excluded unless you put a
150                                      question mark (?) after the operator.For
151                                      example, to only match videos that have
152                                      been liked more than 100 times and disliked
153                                      less than 50 times (or the dislike
154                                      functionality is not available at the given
155                                      service), but who also have a description,
156                                      use --match-filter "like_count > 100 &
157                                      dislike_count <? 50 & description" .
158     --no-playlist                    Download only the video, if the URL refers
159                                      to a video and a playlist.
160     --yes-playlist                   Download the playlist, if the URL refers to
161                                      a video and a playlist.
162     --age-limit YEARS                Download only videos suitable for the given
163                                      age
164     --download-archive FILE          Download only videos not listed in the
165                                      archive file. Record the IDs of all
166                                      downloaded videos in it.
167     --include-ads                    Download advertisements as well
168                                      (experimental)
169
170 ## Download Options:
171     -r, --limit-rate RATE            Maximum download rate in bytes per second
172                                      (e.g. 50K or 4.2M)
173     -R, --retries RETRIES            Number of retries (default is 10), or
174                                      "infinite".
175     --fragment-retries RETRIES       Number of retries for a fragment (default
176                                      is 10), or "infinite" (DASH only)
177     --buffer-size SIZE               Size of download buffer (e.g. 1024 or 16K)
178                                      (default is 1024)
179     --no-resize-buffer               Do not automatically adjust the buffer
180                                      size. By default, the buffer size is
181                                      automatically resized from an initial value
182                                      of SIZE.
183     --playlist-reverse               Download playlist videos in reverse order
184     --xattr-set-filesize             Set file xattribute ytdl.filesize with
185                                      expected filesize (experimental)
186     --hls-prefer-native              Use the native HLS downloader instead of
187                                      ffmpeg
188     --hls-prefer-ffmpeg              Use ffmpeg instead of the native HLS
189                                      downloader
190     --hls-use-mpegts                 Use the mpegts container for HLS videos,
191                                      allowing to play the video while
192                                      downloading (some players may not be able
193                                      to play it)
194     --external-downloader COMMAND    Use the specified external downloader.
195                                      Currently supports
196                                      aria2c,avconv,axel,curl,ffmpeg,httpie,wget
197     --external-downloader-args ARGS  Give these arguments to the external
198                                      downloader
199
200 ## Filesystem Options:
201     -a, --batch-file FILE            File containing URLs to download ('-' for
202                                      stdin)
203     --id                             Use only video ID in file name
204     -o, --output TEMPLATE            Output filename template. Use %(title)s to
205                                      get the title, %(uploader)s for the
206                                      uploader name, %(uploader_id)s for the
207                                      uploader nickname if different,
208                                      %(autonumber)s to get an automatically
209                                      incremented number, %(ext)s for the
210                                      filename extension, %(format)s for the
211                                      format description (like "22 - 1280x720" or
212                                      "HD"), %(format_id)s for the unique id of
213                                      the format (like YouTube's itags: "137"),
214                                      %(upload_date)s for the upload date
215                                      (YYYYMMDD), %(extractor)s for the provider
216                                      (youtube, metacafe, etc), %(id)s for the
217                                      video id, %(playlist_title)s,
218                                      %(playlist_id)s, or %(playlist)s (=title if
219                                      present, ID otherwise) for the playlist the
220                                      video is in, %(playlist_index)s for the
221                                      position in the playlist. %(height)s and
222                                      %(width)s for the width and height of the
223                                      video format. %(resolution)s for a textual
224                                      description of the resolution of the video
225                                      format. %% for a literal percent. Use - to
226                                      output to stdout. Can also be used to
227                                      download to a different directory, for
228                                      example with -o '/my/downloads/%(uploader)s
229                                      /%(title)s-%(id)s.%(ext)s' .
230     --autonumber-size NUMBER         Specify the number of digits in
231                                      %(autonumber)s when it is present in output
232                                      filename template or --auto-number option
233                                      is given
234     --restrict-filenames             Restrict filenames to only ASCII
235                                      characters, and avoid "&" and spaces in
236                                      filenames
237     -A, --auto-number                [deprecated; use -o
238                                      "%(autonumber)s-%(title)s.%(ext)s" ] Number
239                                      downloaded files starting from 00000
240     -t, --title                      [deprecated] Use title in file name
241                                      (default)
242     -l, --literal                    [deprecated] Alias of --title
243     -w, --no-overwrites              Do not overwrite files
244     -c, --continue                   Force resume of partially downloaded files.
245                                      By default, youtube-dl will resume
246                                      downloads if possible.
247     --no-continue                    Do not resume partially downloaded files
248                                      (restart from beginning)
249     --no-part                        Do not use .part files - write directly
250                                      into output file
251     --no-mtime                       Do not use the Last-modified header to set
252                                      the file modification time
253     --write-description              Write video description to a .description
254                                      file
255     --write-info-json                Write video metadata to a .info.json file
256     --write-annotations              Write video annotations to a
257                                      .annotations.xml file
258     --load-info-json FILE            JSON file containing the video information
259                                      (created with the "--write-info-json"
260                                      option)
261     --cookies FILE                   File to read cookies from and dump cookie
262                                      jar in
263     --cache-dir DIR                  Location in the filesystem where youtube-dl
264                                      can store some downloaded information
265                                      permanently. By default
266                                      $XDG_CACHE_HOME/youtube-dl or
267                                      ~/.cache/youtube-dl . At the moment, only
268                                      YouTube player files (for videos with
269                                      obfuscated signatures) are cached, but that
270                                      may change.
271     --no-cache-dir                   Disable filesystem caching
272     --rm-cache-dir                   Delete all filesystem cache files
273
274 ## Thumbnail images:
275     --write-thumbnail                Write thumbnail image to disk
276     --write-all-thumbnails           Write all thumbnail image formats to disk
277     --list-thumbnails                Simulate and list all available thumbnail
278                                      formats
279
280 ## Verbosity / Simulation Options:
281     -q, --quiet                      Activate quiet mode
282     --no-warnings                    Ignore warnings
283     -s, --simulate                   Do not download the video and do not write
284                                      anything to disk
285     --skip-download                  Do not download the video
286     -g, --get-url                    Simulate, quiet but print URL
287     -e, --get-title                  Simulate, quiet but print title
288     --get-id                         Simulate, quiet but print id
289     --get-thumbnail                  Simulate, quiet but print thumbnail URL
290     --get-description                Simulate, quiet but print video description
291     --get-duration                   Simulate, quiet but print video length
292     --get-filename                   Simulate, quiet but print output filename
293     --get-format                     Simulate, quiet but print output format
294     -j, --dump-json                  Simulate, quiet but print JSON information.
295                                      See --output for a description of available
296                                      keys.
297     -J, --dump-single-json           Simulate, quiet but print JSON information
298                                      for each command-line argument. If the URL
299                                      refers to a playlist, dump the whole
300                                      playlist information in a single line.
301     --print-json                     Be quiet and print the video information as
302                                      JSON (video is still being downloaded).
303     --newline                        Output progress bar as new lines
304     --no-progress                    Do not print progress bar
305     --console-title                  Display progress in console titlebar
306     -v, --verbose                    Print various debugging information
307     --dump-pages                     Print downloaded pages encoded using base64
308                                      to debug problems (very verbose)
309     --write-pages                    Write downloaded intermediary pages to
310                                      files in the current directory to debug
311                                      problems
312     --print-traffic                  Display sent and read HTTP traffic
313     -C, --call-home                  Contact the youtube-dl server for debugging
314     --no-call-home                   Do NOT contact the youtube-dl server for
315                                      debugging
316
317 ## Workarounds:
318     --encoding ENCODING              Force the specified encoding (experimental)
319     --no-check-certificate           Suppress HTTPS certificate validation
320     --prefer-insecure                Use an unencrypted connection to retrieve
321                                      information about the video. (Currently
322                                      supported only for YouTube)
323     --user-agent UA                  Specify a custom user agent
324     --referer URL                    Specify a custom referer, use if the video
325                                      access is restricted to one domain
326     --add-header FIELD:VALUE         Specify a custom HTTP header and its value,
327                                      separated by a colon ':'. You can use this
328                                      option multiple times
329     --bidi-workaround                Work around terminals that lack
330                                      bidirectional text support. Requires bidiv
331                                      or fribidi executable in PATH
332     --sleep-interval SECONDS         Number of seconds to sleep before each
333                                      download.
334
335 ## Video Format Options:
336     -f, --format FORMAT              Video format code, see the "FORMAT
337                                      SELECTION" for all the info
338     --all-formats                    Download all available video formats
339     --prefer-free-formats            Prefer free video formats unless a specific
340                                      one is requested
341     -F, --list-formats               List all available formats of requested
342                                      videos
343     --youtube-skip-dash-manifest     Do not download the DASH manifests and
344                                      related data on YouTube videos
345     --merge-output-format FORMAT     If a merge is required (e.g.
346                                      bestvideo+bestaudio), output to given
347                                      container format. One of mkv, mp4, ogg,
348                                      webm, flv. Ignored if no merge is required
349
350 ## Subtitle Options:
351     --write-sub                      Write subtitle file
352     --write-auto-sub                 Write automatically generated subtitle file
353                                      (YouTube only)
354     --all-subs                       Download all the available subtitles of the
355                                      video
356     --list-subs                      List all available subtitles for the video
357     --sub-format FORMAT              Subtitle format, accepts formats
358                                      preference, for example: "srt" or
359                                      "ass/srt/best"
360     --sub-lang LANGS                 Languages of the subtitles to download
361                                      (optional) separated by commas, use --list-
362                                      subs for available language tags
363
364 ## Authentication Options:
365     -u, --username USERNAME          Login with this account ID
366     -p, --password PASSWORD          Account password. If this option is left
367                                      out, youtube-dl will ask interactively.
368     -2, --twofactor TWOFACTOR        Two-factor auth code
369     -n, --netrc                      Use .netrc authentication data
370     --video-password PASSWORD        Video password (vimeo, smotri, youku)
371
372 ## Post-processing Options:
373     -x, --extract-audio              Convert video files to audio-only files
374                                      (requires ffmpeg or avconv and ffprobe or
375                                      avprobe)
376     --audio-format FORMAT            Specify audio format: "best", "aac",
377                                      "vorbis", "mp3", "m4a", "opus", or "wav";
378                                      "best" by default
379     --audio-quality QUALITY          Specify ffmpeg/avconv audio quality, insert
380                                      a value between 0 (better) and 9 (worse)
381                                      for VBR or a specific bitrate like 128K
382                                      (default 5)
383     --recode-video FORMAT            Encode the video to another format if
384                                      necessary (currently supported:
385                                      mp4|flv|ogg|webm|mkv|avi)
386     --postprocessor-args ARGS        Give these arguments to the postprocessor
387     -k, --keep-video                 Keep the video file on disk after the post-
388                                      processing; the video is erased by default
389     --no-post-overwrites             Do not overwrite post-processed files; the
390                                      post-processed files are overwritten by
391                                      default
392     --embed-subs                     Embed subtitles in the video (only for mp4,
393                                      webm and mkv videos)
394     --embed-thumbnail                Embed thumbnail in the audio as cover art
395     --add-metadata                   Write metadata to the video file
396     --metadata-from-title FORMAT     Parse additional metadata like song title /
397                                      artist from the video title. The format
398                                      syntax is the same as --output, the parsed
399                                      parameters replace existing values.
400                                      Additional templates: %(album)s,
401                                      %(artist)s. Example: --metadata-from-title
402                                      "%(artist)s - %(title)s" matches a title
403                                      like "Coldplay - Paradise"
404     --xattrs                         Write metadata to the video file's xattrs
405                                      (using dublin core and xdg standards)
406     --fixup POLICY                   Automatically correct known faults of the
407                                      file. One of never (do nothing), warn (only
408                                      emit a warning), detect_or_warn (the
409                                      default; fix file if we can, warn
410                                      otherwise)
411     --prefer-avconv                  Prefer avconv over ffmpeg for running the
412                                      postprocessors (default)
413     --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
414                                      postprocessors
415     --ffmpeg-location PATH           Location of the ffmpeg/avconv binary;
416                                      either the path to the binary or its
417                                      containing directory.
418     --exec CMD                       Execute a command on the file after
419                                      downloading, similar to find's -exec
420                                      syntax. Example: --exec 'adb push {}
421                                      /sdcard/Music/ && rm {}'
422     --convert-subs FORMAT            Convert the subtitles to other format
423                                      (currently supported: srt|ass|vtt)
424
425 # CONFIGURATION
426
427 You can configure youtube-dl by placing any supported command line option to a configuration file. On Linux and OS X, the system wide configuration file is located at `/etc/youtube-dl.conf` and the user wide configuration file at `~/.config/youtube-dl/config`. On Windows, the user wide configuration file locations are `%APPDATA%\youtube-dl\config.txt` or `C:\Users\<user name>\youtube-dl.conf`.
428
429 For example, with the following configuration file youtube-dl will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory:
430 ```
431 -x
432 --no-mtime
433 --proxy 127.0.0.1:3128
434 -o ~/Movies/%(title)s.%(ext)s
435 ```
436
437 Note that options in configuration file are just the same options aka switches used in regular command line calls thus there **must be no whitespace** after `-` or `--`, e.g. `-o` or `--proxy` but not `- o` or `-- proxy`.
438
439 You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
440
441 ### Authentication with `.netrc` file
442
443 You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every youtube-dl execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](http://stackoverflow.com/tags/.netrc/info) on per extractor basis. For that you will need to create a `.netrc` file in your `$HOME` and restrict permissions to read/write by you only:
444 ```
445 touch $HOME/.netrc
446 chmod a-rwx,u+rw $HOME/.netrc
447 ```
448 After that you can add credentials for extractor in the following format, where *extractor* is the name of extractor in lowercase:
449 ```
450 machine <extractor> login <login> password <password>
451 ```
452 For example:
453 ```
454 machine youtube login myaccount@gmail.com password my_youtube_password
455 machine twitch login my_twitch_account_name password my_twitch_password
456 ```
457 To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
458
459 On Windows you may also need to setup the `%HOME%` environment variable manually.
460
461 # OUTPUT TEMPLATE
462
463 The `-o` option allows users to indicate a template for the output file names.
464
465 **tl;dr:** [navigate me to examples](#output-template-examples).
466
467 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 parentheses, followed by a lowercase S. Allowed names are:
468
469  - `id`: Video identifier
470  - `title`: Video title
471  - `url`: Video URL
472  - `ext`: Video filename extension
473  - `alt_title`: A secondary title of the video
474  - `display_id`: An alternative identifier for the video
475  - `uploader`: Full name of the video uploader
476  - `license`: License name the video is licensed under
477  - `creator`: The creator of the video
478  - `release_date`: The date (YYYYMMDD) when the video was released
479  - `timestamp`: UNIX timestamp of the moment the video became available
480  - `upload_date`: Video upload date (YYYYMMDD)
481  - `uploader_id`: Nickname or id of the video uploader
482  - `location`: Physical location where the video was filmed
483  - `duration`: Length of the video in seconds
484  - `view_count`: How many users have watched the video on the platform
485  - `like_count`: Number of positive ratings of the video
486  - `dislike_count`: Number of negative ratings of the video
487  - `repost_count`: Number of reposts of the video
488  - `average_rating`: Average rating give by users, the scale used depends on the webpage
489  - `comment_count`: Number of comments on the video
490  - `age_limit`: Age restriction for the video (years)
491  - `format`: A human-readable description of the format 
492  - `format_id`: Format code specified by `--format`
493  - `format_note`: Additional info about the format
494  - `width`: Width of the video
495  - `height`: Height of the video
496  - `resolution`: Textual description of width and height
497  - `tbr`: Average bitrate of audio and video in KBit/s
498  - `abr`: Average audio bitrate in KBit/s
499  - `acodec`: Name of the audio codec in use
500  - `asr`: Audio sampling rate in Hertz
501  - `vbr`: Average video bitrate in KBit/s
502  - `fps`: Frame rate
503  - `vcodec`: Name of the video codec in use
504  - `container`: Name of the container format
505  - `filesize`: The number of bytes, if known in advance
506  - `filesize_approx`: An estimate for the number of bytes
507  - `protocol`: The protocol that will be used for the actual download
508  - `extractor`: Name of the extractor
509  - `extractor_key`: Key name of the extractor
510  - `epoch`: Unix epoch when creating the file
511  - `autonumber`: Five-digit number that will be increased with each download, starting at zero
512  - `playlist`: Name or id of the playlist that contains the video
513  - `playlist_index`: Index of the video in the playlist padded with leading zeros according to the total length of the playlist
514  - `playlist_id`: Playlist identifier
515  - `playlist_title`: Playlist title
516
517
518 Available for the video that belongs to some logical chapter or section:
519  - `chapter`: Name or title of the chapter the video belongs to
520  - `chapter_number`: Number of the chapter the video belongs to
521  - `chapter_id`: Id of the chapter the video belongs to
522
523 Available for the video that is an episode of some series or programme:
524  - `series`: Title of the series or programme the video episode belongs to
525  - `season`: Title of the season the video episode belongs to
526  - `season_number`: Number of the season the video episode belongs to
527  - `season_id`: Id of the season the video episode belongs to
528  - `episode`: Title of the video episode
529  - `episode_number`: Number of the video episode within a season
530  - `episode_id`: Id of the video episode
531
532 Available for the media that is a track or a part of a music album:
533  - `track`: Title of the track
534  - `track_number`: Number of the track within an album or a disc
535  - `track_id`: Id of the track
536  - `artist`: Artist(s) of the track
537  - `genre`: Genre(s) of the track
538  - `album`: Title of the album the track belongs to
539  - `album_type`: Type of the album
540  - `album_artist`: List of all artists appeared on the album
541  - `disc_number`: Number of the disc or other physical medium the track belongs to
542  - `release_year`: Year (YYYY) when the album was released
543
544 Each aforementioned sequence when referenced in output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by particular extractor, such sequences will be replaced with `NA`.
545
546 For example for `-o %(title)s-%(id)s.%(ext)s` and mp4 video with title `youtube-dl test video` and id `BaW_jenozKcj` this will result in a `youtube-dl test video-BaW_jenozKcj.mp4` file created in the current directory.
547
548 Output template can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` that will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
549
550 To specify percent literal in output template use `%%`. To output to stdout use `-o -`.
551
552 The current default template is `%(title)s-%(id)s.%(ext)s`.
553
554 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:
555
556 #### Output template examples
557
558 Note on Windows you may need to use double quotes instead of single.
559
560 ```bash
561 $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
562 youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
563
564 $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
565 youtube-dl_test_video_.mp4          # A simple file name
566
567 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
568 $ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
569
570 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
571 $ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
572
573 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
574 $ youtube-dl -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
575
576 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
577 $ youtube-dl -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" http://videomore.ru/kino_v_detalayah/5_sezon/367617
578
579 # Stream the video being downloaded to stdout
580 $ youtube-dl -o - BaW_jenozKc
581 ```
582
583 # FORMAT SELECTION
584
585 By default youtube-dl tries to download the best available quality, i.e. if you want the best quality you **don't need** to pass any special options, youtube-dl will guess it for you by **default**.
586
587 But sometimes you may want to download in a different format, for example when you are on a slow or intermittent connection. The key mechanism for achieving this is so called *format selection* based on which you can explicitly specify desired format, select formats based on some criterion or criteria, setup precedence and much more.
588
589 The general syntax for format selection is `--format FORMAT` or shorter `-f FORMAT` where `FORMAT` is a *selector expression*, i.e. an expression that describes format or formats you would like to download.
590
591 **tl;dr:** [navigate me to examples](#format-selection-examples).
592
593 The simplest case is requesting a specific format, for example with `-f 22` you can download the format with format code equal to 22. You can get the list of available format codes for particular video using `--list-formats` or `-F`. Note that these format codes are extractor specific. 
594
595 You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download best quality format of particular file extension served as a single file, e.g. `-f webm` will download best quality format with `webm` extension served as a single file.
596
597 You can also use special names to select particular edge case format:
598  - `best`: Select best quality format represented by single file with video and audio
599  - `worst`: Select worst quality format represented by single file with video and audio
600  - `bestvideo`: Select best quality video only format (e.g. DASH video), may not be available
601  - `worstvideo`: Select worst quality video only format, may not be available
602  - `bestaudio`: Select best quality audio only format, may not be available
603  - `worstaudio`: Select worst quality audio only format, may not be available
604
605 For example, to download worst quality video only format you can use `-f worstvideo`.
606
607 If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that slash is left-associative, i.e. formats on the left hand side are preferred, for example `-f 22/17/18` will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
608
609 If you want to download several formats of the same video use comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or more sophisticated example combined with precedence feature `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
610
611 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
612
613 The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
614  - `filesize`: The number of bytes, if known in advance
615  - `width`: Width of the video, if known
616  - `height`: Height of the video, if known
617  - `tbr`: Average bitrate of audio and video in KBit/s
618  - `abr`: Average audio bitrate in KBit/s
619  - `vbr`: Average video bitrate in KBit/s
620  - `asr`: Audio sampling rate in Hertz
621  - `fps`: Frame rate
622
623 Also filtering work for comparisons `=` (equals), `!=` (not equals), `^=` (begins with), `$=` (ends with), `*=` (contains) and following string meta fields:
624  - `ext`: File extension
625  - `acodec`: Name of the audio codec in use
626  - `vcodec`: Name of the video codec in use
627  - `container`: Name of the container format
628  - `protocol`: The protocol that will be used for the actual download, lower-case. `http`, `https`, `rtsp`, `rtmp`, `rtmpe`, `m3u8`, or `m3u8_native`
629  - `format_id`: A short description of the format
630
631 Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by video hoster.
632
633 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.
634
635 You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download best video only format, best audio only format and mux them together with ffmpeg/avconv.
636
637 Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than 480 you can use `-f '(mp4,webm)[height<480]'`.
638
639 Since the end of April 2015 and version 2015.04.26 youtube-dl uses `-f bestvideo+bestaudio/best` as default format selection (see [#5447](https://github.com/rg3/youtube-dl/issues/5447), [#5456](https://github.com/rg3/youtube-dl/issues/5456)). If ffmpeg or avconv are installed this results in downloading `bestvideo` and `bestaudio` separately and muxing them together into a single file giving the best overall quality available. Otherwise it falls back to `best` and results in downloading the best available quality served as a single file. `best` is also needed for videos that don't come from YouTube because they don't provide the audio and video in two different files. If you want to only download some DASH formats (for example if you are not interested in getting videos with a resolution higher than 1080p), you can add `-f bestvideo[height<=?1080]+bestaudio/best` to your configuration file. Note that if you use youtube-dl to stream to `stdout` (and most likely to pipe it to your media player then), i.e. you explicitly specify output template as `-o -`, youtube-dl still uses `-f best` format selection in order to start content delivery immediately to your player and not to wait until `bestvideo` and `bestaudio` are downloaded and muxed.
640
641 If you want to preserve the old format selection behavior (prior to youtube-dl 2015.04.26), i.e. you want to download the best available quality media served as a single file, you should explicitly specify your choice with `-f best`. You may want to add it to the [configuration file](#configuration) in order not to type it every time you run youtube-dl.
642
643 #### Format selection examples
644
645 Note on Windows you may need to use double quotes instead of single.
646
647 ```bash
648 # Download best mp4 format available or any other best if no mp4 available
649 $ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
650
651 # Download best format available but not better that 480p
652 $ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
653
654 # Download best video only format but no bigger that 50 MB
655 $ youtube-dl -f 'best[filesize<50M]'
656
657 # Download best format available via direct link over HTTP/HTTPS protocol
658 $ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
659 ```
660
661
662 # VIDEO SELECTION
663
664 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
665
666  - Absolute dates: Dates in the format `YYYYMMDD`.
667  - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
668  
669 Examples:
670
671 ```bash
672 # Download only the videos uploaded in the last 6 months
673 $ youtube-dl --dateafter now-6months
674
675 # Download only the videos uploaded on January 1, 1970
676 $ youtube-dl --date 19700101
677
678 $ # Download only the videos uploaded in the 200x decade
679 $ youtube-dl --dateafter 20000101 --datebefore 20091231
680 ```
681
682 # FAQ
683
684 ### How do I update youtube-dl?
685
686 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`).
687
688 If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
689
690 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 distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
691
692 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
693
694     sudo apt-get remove -y youtube-dl
695
696 Afterwards, simply follow [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html):
697
698 ```
699 sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
700 sudo chmod a+x /usr/local/bin/youtube-dl
701 hash -r
702 ```
703
704 Again, from then on you'll be able to update with `sudo youtube-dl -U`.
705
706 ### youtube-dl is extremely slow to start on Windows
707
708 Add a file exclusion for `youtube-dl.exe` in Windows Defender settings.
709
710 ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
711
712 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.
713
714 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.
715
716 ### I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`
717
718 Make sure you are not using `-o` with any of these options `-t`, `--title`, `--id`, `-A` or `--auto-number` set in command line or in a configuration file. Remove the latter if any.
719
720 ### Do I always have to pass `-citw`?
721
722 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`.
723
724 ### Can you please put the `-b` option back?
725
726 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.
727
728 ### I get HTTP error 402 when trying to download a video. What's this?
729
730 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.
731
732 ### Do I need any other programs?
733
734 youtube-dl works fine on its own on most sites. However, if you want to convert video/audio, you'll need [avconv](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/). On some sites - most notably YouTube - videos can be retrieved in a higher quality format without sound. youtube-dl will detect whether avconv/ffmpeg is present and automatically pick the best option.
735
736 Videos or video formats streamed via RTMP protocol can only be downloaded when [rtmpdump](https://rtmpdump.mplayerhq.hu/) is installed. Downloading MMS and RTSP videos requires either [mplayer](http://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
737
738 ### I have downloaded a video but how can I play it?
739
740 Once the video is fully downloaded, use any video player, such as [mpv](https://mpv.io/), [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
741
742 ### I extracted a video URL with `-g`, but it does not play on another machine / in my webbrowser.
743
744 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.
745
746 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.
747
748 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.
749
750 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.
751
752 ### ERROR: no fmt_url_map or conn information found in video info
753
754 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.
755
756 ### ERROR: unable to download video
757
758 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.
759
760 ### 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`
761
762 That's actually the output from your shell. Since ampersand is one of the special shell characters it's interpreted by the shell preventing you from passing the whole URL to youtube-dl. To disable your shell from interpreting the ampersands (or any other special characters) you have to either put the whole URL in quotes or escape them with a backslash (which approach will work depends on your shell).
763
764 For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
765
766 ```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
767
768 or
769
770 ```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
771
772 For Windows you have to use the double quotes:
773
774 ```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
775
776 ### ExtractorError: Could not find JS function u'OF'
777
778 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.
779
780 ### HTTP Error 429: Too Many Requests or 402: Payment Required
781
782 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 `--source-address` options](#network-options) to select another IP address.
783
784 ### SyntaxError: Non-ASCII character
785
786 The error
787
788     File "youtube-dl", line 2
789     SyntaxError: Non-ASCII character '\x93' ...
790
791 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
792
793 ### What is this binary file? Where has the code gone?
794
795 Since June 2012 ([#342](https://github.com/rg3/youtube-dl/issues/342)) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
796
797 ### The exe throws an error due to missing `MSVCR100.dll`
798
799 To run the exe you need to install first the [Microsoft Visual C++ 2010 Redistributable Package (x86)](https://www.microsoft.com/en-US/download/details.aspx?id=5555).
800
801 ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
802
803 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.
804
805 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.
806
807 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.
808
809 ### How do I put downloads into a specific folder?
810
811 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).
812
813 ### How do I download a video starting with a `-`?
814
815 Either prepend `http://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
816
817     youtube-dl -- -wNyEUrxzFU
818     youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
819
820 ### How do I pass cookies to youtube-dl?
821
822 Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`. Note that the cookies file must be in Mozilla/Netscape format and the first line of the cookies file must be either `# HTTP Cookie File` or `# Netscape HTTP Cookie File`. Make sure you have correct [newline format](https://en.wikipedia.org/wiki/Newline) in the cookies file and convert newlines if necessary to correspond with your OS, namely `CRLF` (`\r\n`) for Windows, `LF` (`\n`) for Linux and `CR` (`\r`) for Mac OS. `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
823
824 Passing cookies to youtube-dl is a good way to workaround login when a particular extractor does not implement it explicitly. Another use case is working around [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) some websites require you to solve in particular cases in order to get access (e.g. YouTube, CloudFlare).
825
826 ### Can you add support for this anime video site, or site which shows current movies for free?
827
828 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.
829
830 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.
831
832 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.
833
834 ### How can I speed up work on my issue?
835
836 (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:
837
838 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.
839
840 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.
841
842 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).
843
844 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`.
845
846 ### How can I detect whether a given URL is supported by youtube-dl?
847
848 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.
849
850 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.
851
852 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.
853
854 # Why do I need to go through that much red tape when filing bugs?
855
856 Before we had the issue template, despite our extensive [bug reporting instructions](#bugs), about 80% of the issue reports we got were useless, for instance because people used ancient versions hundreds of releases old, because of simple syntactic errors (not in youtube-dl but in general shell usage), because the problem was alrady reported multiple times before, because people did not actually read an error message, even if it said "please install ffmpeg", because people did not mention the URL they were trying to download and many more simple, easy-to-avoid problems, many of whom were totally unrelated to youtube-dl.
857
858 youtube-dl is an open-source project manned by too few volunteers, so we'd rather spend time fixing bugs where we are certain none of those simple problems apply, and where we can be reasonably confident to be able to reproduce the issue without asking the reporter repeatedly. As such, the output of `youtube-dl -v YOUR_URL_HERE` is really all that's required to file an issue. The issue template also guides you through some basic steps you can do, such as checking that your version of youtube-dl is current.
859
860 # DEVELOPER INSTRUCTIONS
861
862 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.
863
864 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
865
866     python -m youtube_dl
867
868 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
869
870     python -m unittest discover
871     python test/test_download.py
872     nosetests
873
874 If you want to create a build of youtube-dl yourself, you'll need
875
876 * python
877 * make (both GNU make and BSD make are supported)
878 * pandoc
879 * zip
880 * nosetests
881
882 ### Adding support for a new site
883
884 If you want to add support for a new site, first of all **make sure** this site is **not dedicated to [copyright infringement](#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)**. youtube-dl does **not support** such sites thus pull requests adding support for them **will be rejected**.
885
886 After you have ensured this site is distributing it's content legally, you can follow this quick list (assuming your service is called `yourextractor`):
887
888 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
889 2. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
890 3. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
891 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
892     ```python
893     # coding: utf-8
894     from __future__ import unicode_literals
895
896     from .common import InfoExtractor
897
898
899     class YourExtractorIE(InfoExtractor):
900         _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
901         _TEST = {
902             'url': 'http://yourextractor.com/watch/42',
903             'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
904             'info_dict': {
905                 'id': '42',
906                 'ext': 'mp4',
907                 'title': 'Video title goes here',
908                 'thumbnail': 're:^https?://.*\.jpg$',
909                 # TODO more properties, either as:
910                 # * A value
911                 # * MD5 checksum; start the string with md5:
912                 # * A regular expression; start the string with re:
913                 # * Any Python type (for example int or float)
914             }
915         }
916
917         def _real_extract(self, url):
918             video_id = self._match_id(url)
919             webpage = self._download_webpage(url, video_id)
920
921             # TODO more code goes here, for example ...
922             title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
923
924             return {
925                 'id': video_id,
926                 'title': title,
927                 'description': self._og_search_description(webpage),
928                 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
929                 # TODO more properties (see youtube_dl/extractor/common.py)
930             }
931     ```
932 5. Add an import in [`youtube_dl/extractor/extractors.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
933 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 then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc.
934 7. Have a look at [`youtube_dl/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 and may return](https://github.com/rg3/youtube-dl/blob/58525c94d547be1c8167d16c298bdd75506db328/youtube_dl/extractor/common.py#L68-L226). Add tests and code for as many as you want.
935 8. Keep in mind that the only mandatory fields in info dict for successful extraction process are `id`, `title` and either `url` or `formats`, i.e. these are the critical data the extraction does not make any sense without. This means that [any field](https://github.com/rg3/youtube-dl/blob/58525c94d547be1c8167d16c298bdd75506db328/youtube_dl/extractor/common.py#L138-L226) apart from aforementioned mandatory ones should be treated **as optional** and extraction should be **tolerate** to situations when sources for these fields can potentially be unavailable (even if they always available at the moment) and **future-proof** in order not to break the extraction of general purpose mandatory fields. For example, if you have some intermediate dict `meta` that is a source of metadata and it has a key `summary` that you want to extract and put into resulting info dict as `description`, you should be ready that this key may be missing from the `meta` dict, i.e. you should extract it as `meta.get('summary')` and not `meta['summary']`. Similarly, you should pass `fatal=False` when extracting data from a webpage with `_search_regex/_html_search_regex`.
936 9. Check the code with [flake8](https://pypi.python.org/pypi/flake8).
937 10. 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:
938
939         $ git add youtube_dl/extractor/extractors.py
940         $ git add youtube_dl/extractor/yourextractor.py
941         $ git commit -m '[yourextractor] Add new extractor'
942         $ git push origin yourextractor
943
944 11. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
945
946 In any case, thank you very much for your contributions!
947
948 # EMBEDDING YOUTUBE-DL
949
950 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).
951
952 From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
953
954 ```python
955 from __future__ import unicode_literals
956 import youtube_dl
957
958 ydl_opts = {}
959 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
960     ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
961 ```
962
963 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#L121-L269). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
964
965 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:
966
967 ```python
968 from __future__ import unicode_literals
969 import youtube_dl
970
971
972 class MyLogger(object):
973     def debug(self, msg):
974         pass
975
976     def warning(self, msg):
977         pass
978
979     def error(self, msg):
980         print(msg)
981
982
983 def my_hook(d):
984     if d['status'] == 'finished':
985         print('Done downloading, now converting ...')
986
987
988 ydl_opts = {
989     'format': 'bestaudio/best',
990     'postprocessors': [{
991         'key': 'FFmpegExtractAudio',
992         'preferredcodec': 'mp3',
993         'preferredquality': '192',
994     }],
995     'logger': MyLogger(),
996     'progress_hooks': [my_hook],
997 }
998 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
999     ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
1000 ```
1001
1002 # BUGS
1003
1004 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](irc://chat.freenode.net/#youtube-dl) on freenode ([webchat](http://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
1005
1006 **Please include the full output of youtube-dl when run with `-v`**, i.e. **add** `-v` flag to **your command line**, copy the **whole** output and post it in the issue body wrapped in \`\`\` for better formatting. It should look similar to this:
1007 ```
1008 $ youtube-dl -v <your command line>
1009 [debug] System config: []
1010 [debug] User config: []
1011 [debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj']
1012 [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
1013 [debug] youtube-dl version 2015.12.06
1014 [debug] Git HEAD: 135392e
1015 [debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
1016 [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
1017 [debug] Proxy map: {}
1018 ...
1019 ```
1020 **Do not post screenshots of verbose log only plain text is acceptable.**
1021
1022 The output (including the first lines) contains important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
1023
1024 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
1025
1026 ### Is the description of the issue itself sufficient?
1027
1028 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.
1029
1030 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
1031
1032 - What the problem is
1033 - How it could be fixed
1034 - How your proposed solution would look like
1035
1036 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 committer 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.
1037
1038 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.
1039
1040 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/).
1041
1042 **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.
1043
1044 ###  Are you using the latest version?
1045
1046 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.
1047
1048 ###  Is the issue already documented?
1049
1050 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or browse the [GitHub Issues](https://github.com/rg3/youtube-dl/search?type=Issues) of this repository. 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.
1051
1052 ###  Why are existing options not enough?
1053
1054 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.
1055
1056 ###  Is there enough context in your bug report?
1057
1058 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).
1059
1060 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.
1061
1062 ###  Does the issue involve one problem, and one problem only?
1063
1064 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.
1065
1066 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.
1067
1068 ###  Is anyone going to need the feature?
1069
1070 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.
1071
1072 ###  Is your question about youtube-dl?
1073
1074 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.
1075
1076 # COPYRIGHT
1077
1078 youtube-dl is released into the public domain by the copyright holders.
1079
1080 This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.