7dba5775d9d910d396175eeefb51f38b71c6c831
[ytdl] / README.md
1 [![Build Status](https://travis-ci.org/rg3/youtube-dl.svg?branch=master)](https://travis-ci.org/rg3/youtube-dl)
2
3 youtube-dl - download videos from youtube.com or other video platforms
4
5 - [INSTALLATION](#installation)
6 - [DESCRIPTION](#description)
7 - [OPTIONS](#options)
8 - [CONFIGURATION](#configuration)
9 - [OUTPUT TEMPLATE](#output-template)
10 - [FORMAT SELECTION](#format-selection)
11 - [VIDEO SELECTION](#video-selection)
12 - [FAQ](#faq)
13 - [DEVELOPER INSTRUCTIONS](#developer-instructions)
14 - [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
15 - [BUGS](#bugs)
16 - [COPYRIGHT](#copyright)
17
18 # INSTALLATION
19
20 To install it right away for all UNIX users (Linux, OS X, etc.), type:
21
22     sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl
23     sudo chmod a+rx /usr/local/bin/youtube-dl
24
25 If you do not have curl, you can alternatively use a recent wget:
26
27     sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
28     sudo chmod a+rx /usr/local/bin/youtube-dl
29
30 Windows users can [download an .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in any location on their [PATH](https://en.wikipedia.org/wiki/PATH_%28variable%29) except for `%SYSTEMROOT%\System32` (e.g. **do not** put in `C:\Windows\System32`).
31
32 You can also use pip:
33
34     sudo -H pip install --upgrade youtube-dl
35     
36 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.
37
38 OS X users can install youtube-dl with [Homebrew](https://brew.sh/):
39
40     brew install youtube-dl
41
42 Or with [MacPorts](https://www.macports.org/):
43
44     sudo port install youtube-dl
45
46 Alternatively, refer to the [developer instructions](#developer-instructions) for how to check out and work with the git repository. For further options, including PGP signatures, see the [youtube-dl Download Page](https://rg3.github.io/youtube-dl/download.html).
47
48 # DESCRIPTION
49 **youtube-dl** is a command-line program to download videos from YouTube.com and a few more sites. It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.
50
51     youtube-dl [OPTIONS] URL [URL...]
52
53 # OPTIONS
54     -h, --help                       Print this help text and exit
55     --version                        Print program version and exit
56     -U, --update                     Update this program to latest version. Make
57                                      sure that you have sufficient permissions
58                                      (run with sudo if needed)
59     -i, --ignore-errors              Continue on download errors, for example to
60                                      skip unavailable videos in a playlist
61     --abort-on-error                 Abort downloading of further videos (in the
62                                      playlist or the command line) if an error
63                                      occurs
64     --dump-user-agent                Display the current browser identification
65     --list-extractors                List all supported extractors
66     --extractor-descriptions         Output descriptions of all supported
67                                      extractors
68     --force-generic-extractor        Force extraction to use the generic
69                                      extractor
70     --default-search PREFIX          Use this prefix for unqualified URLs. For
71                                      example "gvsearch2:" downloads two videos
72                                      from google videos for youtube-dl "large
73                                      apple". Use the value "auto" to let
74                                      youtube-dl guess ("auto_warning" to emit a
75                                      warning when guessing). "error" just throws
76                                      an error. The default value "fixup_error"
77                                      repairs broken URLs, but emits an error if
78                                      this is not possible instead of searching.
79     --ignore-config                  Do not read configuration files. When given
80                                      in the global configuration file
81                                      /etc/youtube-dl.conf: Do not read the user
82                                      configuration in ~/.config/youtube-
83                                      dl/config (%APPDATA%/youtube-dl/config.txt
84                                      on Windows)
85     --config-location PATH           Location of the configuration file; either
86                                      the path to the config or its containing
87                                      directory.
88     --flat-playlist                  Do not extract the videos of a playlist,
89                                      only list them.
90     --mark-watched                   Mark videos watched (YouTube only)
91     --no-mark-watched                Do not mark videos watched (YouTube only)
92     --no-color                       Do not emit color codes in output
93
94 ## Network Options:
95     --proxy URL                      Use the specified HTTP/HTTPS/SOCKS proxy.
96                                      To enable experimental SOCKS proxy, specify
97                                      a proper scheme. For example
98                                      socks5://127.0.0.1:1080/. Pass in an empty
99                                      string (--proxy "") for direct connection
100     --socket-timeout SECONDS         Time to wait before giving up, in seconds
101     --source-address IP              Client-side IP address to bind to
102     -4, --force-ipv4                 Make all connections via IPv4
103     -6, --force-ipv6                 Make all connections via IPv6
104
105 ## Geo Restriction:
106     --geo-verification-proxy URL     Use this proxy to verify the IP address for
107                                      some geo-restricted sites. The default
108                                      proxy specified by --proxy (or none, if the
109                                      options is not present) is used for the
110                                      actual downloading.
111     --geo-bypass                     Bypass geographic restriction via faking
112                                      X-Forwarded-For HTTP header (experimental)
113     --no-geo-bypass                  Do not bypass geographic restriction via
114                                      faking X-Forwarded-For HTTP header
115                                      (experimental)
116     --geo-bypass-country CODE        Force bypass geographic restriction with
117                                      explicitly provided two-letter ISO 3166-2
118                                      country code (experimental)
119
120 ## Video Selection:
121     --playlist-start NUMBER          Playlist video to start at (default is 1)
122     --playlist-end NUMBER            Playlist video to end at (default is last)
123     --playlist-items ITEM_SPEC       Playlist video items to download. Specify
124                                      indices of the videos in the playlist
125                                      separated by commas like: "--playlist-items
126                                      1,2,5,8" if you want to download videos
127                                      indexed 1, 2, 5, 8 in the playlist. You can
128                                      specify range: "--playlist-items
129                                      1-3,7,10-13", it will download the videos
130                                      at index 1, 2, 3, 7, 10, 11, 12 and 13.
131     --match-title REGEX              Download only matching titles (regex or
132                                      caseless sub-string)
133     --reject-title REGEX             Skip download for matching titles (regex or
134                                      caseless sub-string)
135     --max-downloads NUMBER           Abort after downloading NUMBER files
136     --min-filesize SIZE              Do not download any videos smaller than
137                                      SIZE (e.g. 50k or 44.6m)
138     --max-filesize SIZE              Do not download any videos larger than SIZE
139                                      (e.g. 50k or 44.6m)
140     --date DATE                      Download only videos uploaded in this date
141     --datebefore DATE                Download only videos uploaded on or before
142                                      this date (i.e. inclusive)
143     --dateafter DATE                 Download only videos uploaded on or after
144                                      this date (i.e. inclusive)
145     --min-views COUNT                Do not download any videos with less than
146                                      COUNT views
147     --max-views COUNT                Do not download any videos with more than
148                                      COUNT views
149     --match-filter FILTER            Generic video filter. Specify any key (see
150                                      the "OUTPUT TEMPLATE" for a list of
151                                      available keys) to match if the key is
152                                      present, !key to check if the key is not
153                                      present, key > NUMBER (like "comment_count
154                                      > 12", also works with >=, <, <=, !=, =) to
155                                      compare against a number, key = 'LITERAL'
156                                      (like "uploader = 'Mike Smith'", also works
157                                      with !=) to match against a string literal
158                                      and & to require multiple matches. Values
159                                      which are not known are excluded unless you
160                                      put a question mark (?) after the operator.
161                                      For example, to only match videos that have
162                                      been liked more than 100 times and disliked
163                                      less than 50 times (or the dislike
164                                      functionality is not available at the given
165                                      service), but who also have a description,
166                                      use --match-filter "like_count > 100 &
167                                      dislike_count <? 50 & description" .
168     --no-playlist                    Download only the video, if the URL refers
169                                      to a video and a playlist.
170     --yes-playlist                   Download the playlist, if the URL refers to
171                                      a video and a playlist.
172     --age-limit YEARS                Download only videos suitable for the given
173                                      age
174     --download-archive FILE          Download only videos not listed in the
175                                      archive file. Record the IDs of all
176                                      downloaded videos in it.
177     --include-ads                    Download advertisements as well
178                                      (experimental)
179
180 ## Download Options:
181     -r, --limit-rate RATE            Maximum download rate in bytes per second
182                                      (e.g. 50K or 4.2M)
183     -R, --retries RETRIES            Number of retries (default is 10), or
184                                      "infinite".
185     --fragment-retries RETRIES       Number of retries for a fragment (default
186                                      is 10), or "infinite" (DASH, hlsnative and
187                                      ISM)
188     --skip-unavailable-fragments     Skip unavailable fragments (DASH, hlsnative
189                                      and ISM)
190     --abort-on-unavailable-fragment  Abort downloading when some fragment is not
191                                      available
192     --keep-fragments                 Keep downloaded fragments on disk after
193                                      downloading is finished; fragments are
194                                      erased by default
195     --buffer-size SIZE               Size of download buffer (e.g. 1024 or 16K)
196                                      (default is 1024)
197     --no-resize-buffer               Do not automatically adjust the buffer
198                                      size. By default, the buffer size is
199                                      automatically resized from an initial value
200                                      of SIZE.
201     --http-chunk-size SIZE           Size of a chunk for chunk-based HTTP
202                                      downloading (e.g. 10485760 or 10M) (default
203                                      is disabled). May be useful for bypassing
204                                      bandwidth throttling imposed by a webserver
205                                      (experimental)
206     --playlist-reverse               Download playlist videos in reverse order
207     --playlist-random                Download playlist videos in random order
208     --xattr-set-filesize             Set file xattribute ytdl.filesize with
209                                      expected file size (experimental)
210     --hls-prefer-native              Use the native HLS downloader instead of
211                                      ffmpeg
212     --hls-prefer-ffmpeg              Use ffmpeg instead of the native HLS
213                                      downloader
214     --hls-use-mpegts                 Use the mpegts container for HLS videos,
215                                      allowing to play the video while
216                                      downloading (some players may not be able
217                                      to play it)
218     --external-downloader COMMAND    Use the specified external downloader.
219                                      Currently supports
220                                      aria2c,avconv,axel,curl,ffmpeg,httpie,wget
221     --external-downloader-args ARGS  Give these arguments to the external
222                                      downloader
223
224 ## Filesystem Options:
225     -a, --batch-file FILE            File containing URLs to download ('-' for
226                                      stdin)
227     --id                             Use only video ID in file name
228     -o, --output TEMPLATE            Output filename template, see the "OUTPUT
229                                      TEMPLATE" for all the info
230     --autonumber-start NUMBER        Specify the start value for %(autonumber)s
231                                      (default is 1)
232     --restrict-filenames             Restrict filenames to only ASCII
233                                      characters, and avoid "&" and spaces in
234                                      filenames
235     -w, --no-overwrites              Do not overwrite files
236     -c, --continue                   Force resume of partially downloaded files.
237                                      By default, youtube-dl will resume
238                                      downloads if possible.
239     --no-continue                    Do not resume partially downloaded files
240                                      (restart from beginning)
241     --no-part                        Do not use .part files - write directly
242                                      into output file
243     --no-mtime                       Do not use the Last-modified header to set
244                                      the file modification time
245     --write-description              Write video description to a .description
246                                      file
247     --write-info-json                Write video metadata to a .info.json file
248     --write-annotations              Write video annotations to a
249                                      .annotations.xml file
250     --load-info-json FILE            JSON file containing the video information
251                                      (created with the "--write-info-json"
252                                      option)
253     --cookies FILE                   File to read cookies from and dump cookie
254                                      jar in
255     --cache-dir DIR                  Location in the filesystem where youtube-dl
256                                      can store some downloaded information
257                                      permanently. By default
258                                      $XDG_CACHE_HOME/youtube-dl or
259                                      ~/.cache/youtube-dl . At the moment, only
260                                      YouTube player files (for videos with
261                                      obfuscated signatures) are cached, but that
262                                      may change.
263     --no-cache-dir                   Disable filesystem caching
264     --rm-cache-dir                   Delete all filesystem cache files
265
266 ## Thumbnail images:
267     --write-thumbnail                Write thumbnail image to disk
268     --write-all-thumbnails           Write all thumbnail image formats to disk
269     --list-thumbnails                Simulate and list all available thumbnail
270                                      formats
271
272 ## Verbosity / Simulation Options:
273     -q, --quiet                      Activate quiet mode
274     --no-warnings                    Ignore warnings
275     -s, --simulate                   Do not download the video and do not write
276                                      anything to disk
277     --skip-download                  Do not download the video
278     -g, --get-url                    Simulate, quiet but print URL
279     -e, --get-title                  Simulate, quiet but print title
280     --get-id                         Simulate, quiet but print id
281     --get-thumbnail                  Simulate, quiet but print thumbnail URL
282     --get-description                Simulate, quiet but print video description
283     --get-duration                   Simulate, quiet but print video length
284     --get-filename                   Simulate, quiet but print output filename
285     --get-format                     Simulate, quiet but print output format
286     -j, --dump-json                  Simulate, quiet but print JSON information.
287                                      See the "OUTPUT TEMPLATE" for a description
288                                      of available keys.
289     -J, --dump-single-json           Simulate, quiet but print JSON information
290                                      for each command-line argument. If the URL
291                                      refers to a playlist, dump the whole
292                                      playlist information in a single line.
293     --print-json                     Be quiet and print the video information as
294                                      JSON (video is still being downloaded).
295     --newline                        Output progress bar as new lines
296     --no-progress                    Do not print progress bar
297     --console-title                  Display progress in console titlebar
298     -v, --verbose                    Print various debugging information
299     --dump-pages                     Print downloaded pages encoded using base64
300                                      to debug problems (very verbose)
301     --write-pages                    Write downloaded intermediary pages to
302                                      files in the current directory to debug
303                                      problems
304     --print-traffic                  Display sent and read HTTP traffic
305     -C, --call-home                  Contact the youtube-dl server for debugging
306     --no-call-home                   Do NOT contact the youtube-dl server for
307                                      debugging
308
309 ## Workarounds:
310     --encoding ENCODING              Force the specified encoding (experimental)
311     --no-check-certificate           Suppress HTTPS certificate validation
312     --prefer-insecure                Use an unencrypted connection to retrieve
313                                      information about the video. (Currently
314                                      supported only for YouTube)
315     --user-agent UA                  Specify a custom user agent
316     --referer URL                    Specify a custom referer, use if the video
317                                      access is restricted to one domain
318     --add-header FIELD:VALUE         Specify a custom HTTP header and its value,
319                                      separated by a colon ':'. You can use this
320                                      option multiple times
321     --bidi-workaround                Work around terminals that lack
322                                      bidirectional text support. Requires bidiv
323                                      or fribidi executable in PATH
324     --sleep-interval SECONDS         Number of seconds to sleep before each
325                                      download when used alone or a lower bound
326                                      of a range for randomized sleep before each
327                                      download (minimum possible number of
328                                      seconds to sleep) when used along with
329                                      --max-sleep-interval.
330     --max-sleep-interval SECONDS     Upper bound of a range for randomized sleep
331                                      before each download (maximum possible
332                                      number of seconds to sleep). Must only be
333                                      used along with --min-sleep-interval.
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 authentication code
369     -n, --netrc                      Use .netrc authentication data
370     --video-password PASSWORD        Video password (vimeo, smotri, youku)
371
372 ## Adobe Pass Options:
373     --ap-mso MSO                     Adobe Pass multiple-system operator (TV
374                                      provider) identifier, use --ap-list-mso for
375                                      a list of available MSOs
376     --ap-username USERNAME           Multiple-system operator account login
377     --ap-password PASSWORD           Multiple-system operator account password.
378                                      If this option is left out, youtube-dl will
379                                      ask interactively.
380     --ap-list-mso                    List all supported multiple-system
381                                      operators
382
383 ## Post-processing Options:
384     -x, --extract-audio              Convert video files to audio-only files
385                                      (requires ffmpeg or avconv and ffprobe or
386                                      avprobe)
387     --audio-format FORMAT            Specify audio format: "best", "aac",
388                                      "flac", "mp3", "m4a", "opus", "vorbis", or
389                                      "wav"; "best" by default; No effect without
390                                      -x
391     --audio-quality QUALITY          Specify ffmpeg/avconv audio quality, insert
392                                      a value between 0 (better) and 9 (worse)
393                                      for VBR or a specific bitrate like 128K
394                                      (default 5)
395     --recode-video FORMAT            Encode the video to another format if
396                                      necessary (currently supported:
397                                      mp4|flv|ogg|webm|mkv|avi)
398     --postprocessor-args ARGS        Give these arguments to the postprocessor
399     -k, --keep-video                 Keep the video file on disk after the post-
400                                      processing; the video is erased by default
401     --no-post-overwrites             Do not overwrite post-processed files; the
402                                      post-processed files are overwritten by
403                                      default
404     --embed-subs                     Embed subtitles in the video (only for mp4,
405                                      webm and mkv videos)
406     --embed-thumbnail                Embed thumbnail in the audio as cover art
407     --add-metadata                   Write metadata to the video file
408     --metadata-from-title FORMAT     Parse additional metadata like song title /
409                                      artist from the video title. The format
410                                      syntax is the same as --output. Regular
411                                      expression with named capture groups may
412                                      also be used. The parsed parameters replace
413                                      existing values. Example: --metadata-from-
414                                      title "%(artist)s - %(title)s" matches a
415                                      title like "Coldplay - Paradise". Example
416                                      (regex): --metadata-from-title
417                                      "(?P<artist>.+?) - (?P<title>.+)"
418     --xattrs                         Write metadata to the video file's xattrs
419                                      (using dublin core and xdg standards)
420     --fixup POLICY                   Automatically correct known faults of the
421                                      file. One of never (do nothing), warn (only
422                                      emit a warning), detect_or_warn (the
423                                      default; fix file if we can, warn
424                                      otherwise)
425     --prefer-avconv                  Prefer avconv over ffmpeg for running the
426                                      postprocessors (default)
427     --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
428                                      postprocessors
429     --ffmpeg-location PATH           Location of the ffmpeg/avconv binary;
430                                      either the path to the binary or its
431                                      containing directory.
432     --exec CMD                       Execute a command on the file after
433                                      downloading, similar to find's -exec
434                                      syntax. Example: --exec 'adb push {}
435                                      /sdcard/Music/ && rm {}'
436     --convert-subs FORMAT            Convert the subtitles to other format
437                                      (currently supported: srt|ass|vtt|lrc)
438
439 # CONFIGURATION
440
441 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`. Note that by default configuration file may not exist so you may need to create it yourself.
442
443 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:
444 ```
445 # Lines starting with # are comments
446
447 # Always extract audio
448 -x
449
450 # Do not copy the mtime
451 --no-mtime
452
453 # Use this proxy
454 --proxy 127.0.0.1:3128
455
456 # Save all videos under Movies directory in your home directory
457 -o ~/Movies/%(title)s.%(ext)s
458 ```
459
460 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`.
461
462 You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
463
464 You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dl run.
465
466 ### Authentication with `.netrc` file
467
468 You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every youtube-dl execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](https://stackoverflow.com/tags/.netrc/info) on a per extractor basis. For that you will need to create a `.netrc` file in your `$HOME` and restrict permissions to read/write by only you:
469 ```
470 touch $HOME/.netrc
471 chmod a-rwx,u+rw $HOME/.netrc
472 ```
473 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
474 ```
475 machine <extractor> login <login> password <password>
476 ```
477 For example:
478 ```
479 machine youtube login myaccount@gmail.com password my_youtube_password
480 machine twitch login my_twitch_account_name password my_twitch_password
481 ```
482 To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
483
484 On Windows you may also need to setup the `%HOME%` environment variable manually. For example:
485 ```
486 set HOME=%USERPROFILE%
487 ```
488
489 # OUTPUT TEMPLATE
490
491 The `-o` option allows users to indicate a template for the output file names.
492
493 **tl;dr:** [navigate me to examples](#output-template-examples).
494
495 The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "https://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [python string formatting operations](https://docs.python.org/2/library/stdtypes.html#string-formatting). For example, `%(NAME)s` or `%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by a formatting operations. Allowed names along with sequence type are:
496
497  - `id` (string): Video identifier
498  - `title` (string): Video title
499  - `url` (string): Video URL
500  - `ext` (string): Video filename extension
501  - `alt_title` (string): A secondary title of the video
502  - `display_id` (string): An alternative identifier for the video
503  - `uploader` (string): Full name of the video uploader
504  - `license` (string): License name the video is licensed under
505  - `creator` (string): The creator of the video
506  - `release_date` (string): The date (YYYYMMDD) when the video was released
507  - `timestamp` (numeric): UNIX timestamp of the moment the video became available
508  - `upload_date` (string): Video upload date (YYYYMMDD)
509  - `uploader_id` (string): Nickname or id of the video uploader
510  - `location` (string): Physical location where the video was filmed
511  - `duration` (numeric): Length of the video in seconds
512  - `view_count` (numeric): How many users have watched the video on the platform
513  - `like_count` (numeric): Number of positive ratings of the video
514  - `dislike_count` (numeric): Number of negative ratings of the video
515  - `repost_count` (numeric): Number of reposts of the video
516  - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
517  - `comment_count` (numeric): Number of comments on the video
518  - `age_limit` (numeric): Age restriction for the video (years)
519  - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
520  - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
521  - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
522  - `format` (string): A human-readable description of the format 
523  - `format_id` (string): Format code specified by `--format`
524  - `format_note` (string): Additional info about the format
525  - `width` (numeric): Width of the video
526  - `height` (numeric): Height of the video
527  - `resolution` (string): Textual description of width and height
528  - `tbr` (numeric): Average bitrate of audio and video in KBit/s
529  - `abr` (numeric): Average audio bitrate in KBit/s
530  - `acodec` (string): Name of the audio codec in use
531  - `asr` (numeric): Audio sampling rate in Hertz
532  - `vbr` (numeric): Average video bitrate in KBit/s
533  - `fps` (numeric): Frame rate
534  - `vcodec` (string): Name of the video codec in use
535  - `container` (string): Name of the container format
536  - `filesize` (numeric): The number of bytes, if known in advance
537  - `filesize_approx` (numeric): An estimate for the number of bytes
538  - `protocol` (string): The protocol that will be used for the actual download
539  - `extractor` (string): Name of the extractor
540  - `extractor_key` (string): Key name of the extractor
541  - `epoch` (numeric): Unix epoch when creating the file
542  - `autonumber` (numeric): Five-digit number that will be increased with each download, starting at zero
543  - `playlist` (string): Name or id of the playlist that contains the video
544  - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
545  - `playlist_id` (string): Playlist identifier
546  - `playlist_title` (string): Playlist title
547  - `playlist_uploader` (string): Full name of the playlist uploader
548  - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
549
550 Available for the video that belongs to some logical chapter or section:
551
552  - `chapter` (string): Name or title of the chapter the video belongs to
553  - `chapter_number` (numeric): Number of the chapter the video belongs to
554  - `chapter_id` (string): Id of the chapter the video belongs to
555
556 Available for the video that is an episode of some series or programme:
557
558  - `series` (string): Title of the series or programme the video episode belongs to
559  - `season` (string): Title of the season the video episode belongs to
560  - `season_number` (numeric): Number of the season the video episode belongs to
561  - `season_id` (string): Id of the season the video episode belongs to
562  - `episode` (string): Title of the video episode
563  - `episode_number` (numeric): Number of the video episode within a season
564  - `episode_id` (string): Id of the video episode
565
566 Available for the media that is a track or a part of a music album:
567
568  - `track` (string): Title of the track
569  - `track_number` (numeric): Number of the track within an album or a disc
570  - `track_id` (string): Id of the track
571  - `artist` (string): Artist(s) of the track
572  - `genre` (string): Genre(s) of the track
573  - `album` (string): Title of the album the track belongs to
574  - `album_type` (string): Type of the album
575  - `album_artist` (string): List of all artists appeared on the album
576  - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
577  - `release_year` (numeric): Year (YYYY) when the album was released
578
579 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with `NA`.
580
581 For example for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `youtube-dl test video` and id `BaW_jenozKcj`, this will result in a `youtube-dl test video-BaW_jenozKcj.mp4` file created in the current directory.
582
583 For numeric sequences you can use numeric related formatting, for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.
584
585 Output templates can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
586
587 To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
588
589 The current default template is `%(title)s-%(id)s.%(ext)s`.
590
591 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:
592
593 #### Output template and Windows batch files
594
595 If you are using an output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
596
597 #### Output template examples
598
599 Note that on Windows you may need to use double quotes instead of single.
600
601 ```bash
602 $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
603 youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
604
605 $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
606 youtube-dl_test_video_.mp4          # A simple file name
607
608 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
609 $ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
610
611 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
612 $ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
613
614 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
615 $ 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/
616
617 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
618 $ youtube-dl -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" https://videomore.ru/kino_v_detalayah/5_sezon/367617
619
620 # Stream the video being downloaded to stdout
621 $ youtube-dl -o - BaW_jenozKc
622 ```
623
624 # FORMAT SELECTION
625
626 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**.
627
628 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.
629
630 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.
631
632 **tl;dr:** [navigate me to examples](#format-selection-examples).
633
634 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. 
635
636 You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
637
638 You can also use special names to select particular edge case formats:
639  - `best`: Select the best quality format represented by a single file with video and audio.
640  - `worst`: Select the worst quality format represented by a single file with video and audio.
641  - `bestvideo`: Select the best quality video-only format (e.g. DASH video). May not be available.
642  - `worstvideo`: Select the worst quality video-only format. May not be available.
643  - `bestaudio`: Select the best quality audio only-format. May not be available.
644  - `worstaudio`: Select the worst quality audio only-format. May not be available.
645
646 For example, to download the worst quality video-only format you can use `-f worstvideo`.
647
648 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.
649
650 If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
651
652 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
653
654 The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
655  - `filesize`: The number of bytes, if known in advance
656  - `width`: Width of the video, if known
657  - `height`: Height of the video, if known
658  - `tbr`: Average bitrate of audio and video in KBit/s
659  - `abr`: Average audio bitrate in KBit/s
660  - `vbr`: Average video bitrate in KBit/s
661  - `asr`: Audio sampling rate in Hertz
662  - `fps`: Frame rate
663
664 Also filtering work for comparisons `=` (equals), `!=` (not equals), `^=` (begins with), `$=` (ends with), `*=` (contains) and following string meta fields:
665  - `ext`: File extension
666  - `acodec`: Name of the audio codec in use
667  - `vcodec`: Name of the video codec in use
668  - `container`: Name of the container format
669  - `protocol`: The protocol that will be used for the actual download, lower-case (`http`, `https`, `rtsp`, `rtmp`, `rtmpe`, `mms`, `f4m`, `ism`, `http_dash_segments`, `m3u8`, or `m3u8_native`)
670  - `format_id`: A short description of the format
671
672 Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the video hoster.
673
674 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.
675
676 You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg/avconv.
677
678 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]'`.
679
680 Since the end of April 2015 and version 2015.04.26, youtube-dl uses `-f bestvideo+bestaudio/best` as the default format selection (see [#5447](https://github.com/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.
681
682 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.
683
684 #### Format selection examples
685
686 Note that on Windows you may need to use double quotes instead of single.
687
688 ```bash
689 # Download best mp4 format available or any other best if no mp4 available
690 $ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
691
692 # Download best format available but not better that 480p
693 $ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
694
695 # Download best video only format but no bigger than 50 MB
696 $ youtube-dl -f 'best[filesize<50M]'
697
698 # Download best format available via direct link over HTTP/HTTPS protocol
699 $ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
700
701 # Download the best video format and the best audio format without merging them
702 $ youtube-dl -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
703 ```
704 Note that in the last example, an output template is recommended as bestvideo and bestaudio may have the same file name.
705
706
707 # VIDEO SELECTION
708
709 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
710
711  - Absolute dates: Dates in the format `YYYYMMDD`.
712  - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
713  
714 Examples:
715
716 ```bash
717 # Download only the videos uploaded in the last 6 months
718 $ youtube-dl --dateafter now-6months
719
720 # Download only the videos uploaded on January 1, 1970
721 $ youtube-dl --date 19700101
722
723 $ # Download only the videos uploaded in the 200x decade
724 $ youtube-dl --dateafter 20000101 --datebefore 20091231
725 ```
726
727 # FAQ
728
729 ### How do I update youtube-dl?
730
731 If you've followed [our manual installation instructions](https://rg3.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
732
733 If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
734
735 If you have installed youtube-dl using a package manager like *apt-get* or *yum*, use the standard system update mechanism to update. Note that distribution packages are often outdated. As a rule of thumb, youtube-dl releases at least once a month, and often weekly or even daily. Simply go to https://yt-dl.org to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
736
737 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
738
739     sudo apt-get remove -y youtube-dl
740
741 Afterwards, simply follow [our manual installation instructions](https://rg3.github.io/youtube-dl/download.html):
742
743 ```
744 sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
745 sudo chmod a+x /usr/local/bin/youtube-dl
746 hash -r
747 ```
748
749 Again, from then on you'll be able to update with `sudo youtube-dl -U`.
750
751 ### youtube-dl is extremely slow to start on Windows
752
753 Add a file exclusion for `youtube-dl.exe` in Windows Defender settings.
754
755 ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
756
757 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.
758
759 If you have installed youtube-dl with a package manager, pip, setup.py or a tarball, please use that to update. Note that Ubuntu packages do not seem to get updated anymore. Since we are not affiliated with Ubuntu, there is little we can do. Feel free to [report bugs](https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to the [Ubuntu packaging people](mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl) - all they have to do is update the package to a somewhat recent version. See above for a way to update.
760
761 ### I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`
762
763 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.
764
765 ### Do I always have to pass `-citw`?
766
767 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`.
768
769 ### Can you please put the `-b` option back?
770
771 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.
772
773 ### I get HTTP error 402 when trying to download a video. What's this?
774
775 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 web browser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
776
777 ### Do I need any other programs?
778
779 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.
780
781 Videos or video formats streamed via RTMP protocol can only be downloaded when [rtmpdump](https://rtmpdump.mplayerhq.hu/) is installed. Downloading MMS and RTSP videos requires either [mplayer](https://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
782
783 ### I have downloaded a video but how can I play it?
784
785 Once the video is fully downloaded, use any video player, such as [mpv](https://mpv.io/), [vlc](https://www.videolan.org/) or [mplayer](https://www.mplayerhq.hu/).
786
787 ### I extracted a video URL with `-g`, but it does not play on another machine / in my web browser.
788
789 It depends a lot on the service. In many cases, requests for the video (to download/play it) must come from the same IP address and with the same cookies and/or HTTP headers. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl. You can also get necessary cookies and HTTP headers from JSON output obtained with `--dump-json`.
790
791 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.
792
793 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.
794
795 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.
796
797 ### ERROR: no fmt_url_map or conn information found in video info
798
799 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.
800
801 ### ERROR: unable to download video
802
803 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.
804
805 ### 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`
806
807 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).
808
809 For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
810
811 ```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
812
813 or
814
815 ```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
816
817 For Windows you have to use the double quotes:
818
819 ```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
820
821 ### ExtractorError: Could not find JS function u'OF'
822
823 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.
824
825 ### HTTP Error 429: Too Many Requests or 402: Payment Required
826
827 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.
828
829 ### SyntaxError: Non-ASCII character
830
831 The error
832
833     File "youtube-dl", line 2
834     SyntaxError: Non-ASCII character '\x93' ...
835
836 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
837
838 ### What is this binary file? Where has the code gone?
839
840 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`.
841
842 ### The exe throws an error due to missing `MSVCR100.dll`
843
844 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).
845
846 ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
847
848 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.
849
850 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.
851
852 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.
853
854 ### How do I put downloads into a specific folder?
855
856 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).
857
858 ### How do I download a video starting with a `-`?
859
860 Either prepend `https://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
861
862     youtube-dl -- -wNyEUrxzFU
863     youtube-dl "https://www.youtube.com/watch?v=-wNyEUrxzFU"
864
865 ### How do I pass cookies to youtube-dl?
866
867 Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`.
868
869 In order to extract cookies from browser use any conforming browser extension for exporting cookies. For example, [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg) (for Chrome) or [Export Cookies](https://addons.mozilla.org/en-US/firefox/addon/export-cookies/) (for Firefox).
870
871 Note that the cookies file must be in Mozilla/Netscape format and the first line of the cookies file must be either `# HTTP Cookie File` or `# Netscape HTTP Cookie File`. Make sure you have correct [newline format](https://en.wikipedia.org/wiki/Newline) in the cookies file and convert newlines if necessary to correspond with your OS, namely `CRLF` (`\r\n`) for Windows and `LF` (`\n`) for Unix and Unix-like systems (Linux, macOS, etc.). `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
872
873 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).
874
875 ### How do I stream directly to media player?
876
877 You will first need to tell youtube-dl to stream media to stdout with `-o -`, and also tell your media player to read from stdin (it must be capable of this for streaming) and then pipe former to latter. For example, streaming to [vlc](https://www.videolan.org/) can be achieved with:
878
879     youtube-dl -o - "https://www.youtube.com/watch?v=BaW_jenozKcj" | vlc -
880
881 ### How do I download only new videos from a playlist?
882
883 Use download-archive feature. With this feature you should initially download the complete playlist with `--download-archive /path/to/download/archive/file.txt` that will record identifiers of all the videos in a special file. Each subsequent run with the same `--download-archive` will download only new videos and skip all videos that have been downloaded before. Note that only successful downloads are recorded in the file.
884
885 For example, at first,
886
887     youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
888
889 will download the complete `PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re` playlist and create a file `archive.txt`. Each subsequent run will only download new videos if any:
890
891     youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
892
893 ### Should I add `--hls-prefer-native` into my config?
894
895 When youtube-dl detects an HLS video, it can download it either with the built-in downloader or ffmpeg. Since many HLS streams are slightly invalid and ffmpeg/youtube-dl each handle some invalid cases better than the other, there is an option to switch the downloader if needed.
896
897 When youtube-dl knows that one particular downloader works better for a given website, that downloader will be picked. Otherwise, youtube-dl will pick the best downloader for general compatibility, which at the moment happens to be ffmpeg. This choice may change in future versions of youtube-dl, with improvements of the built-in downloader and/or ffmpeg.
898
899 In particular, the generic extractor (used when your website is not in the [list of supported sites by youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) cannot mandate one specific downloader.
900
901 If you put either `--hls-prefer-native` or `--hls-prefer-ffmpeg` into your configuration, a different subset of videos will fail to download correctly. Instead, it is much better to [file an issue](https://yt-dl.org/bug) or a pull request which details why the native or the ffmpeg HLS downloader is a better choice for your use case.
902
903 ### Can you add support for this anime video site, or site which shows current movies for free?
904
905 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.
906
907 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.
908
909 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.
910
911 ### How can I speed up work on my issue?
912
913 (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:
914
915 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.
916
917 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.
918
919 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).
920
921 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`.
922
923 ### How can I detect whether a given URL is supported by youtube-dl?
924
925 For one, have a look at the [list of supported sites](docs/supportedsites.md). Note that it can sometimes happen that the site changes its URL scheme (say, from https://example.com/video/1234567 to https://example.com/v/1234567 ) and youtube-dl reports an URL of a service in that list as unsupported. In that case, simply report a bug.
926
927 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.
928
929 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.
930
931 # Why do I need to go through that much red tape when filing bugs?
932
933 Before we had the issue template, despite our extensive [bug reporting instructions](#bugs), about 80% of the issue reports we got were useless, for instance because people used ancient versions hundreds of releases old, because of simple syntactic errors (not in youtube-dl but in general shell usage), because the problem was already reported multiple times before, because people did not actually read an error message, even if it said "please install ffmpeg", because people did not mention the URL they were trying to download and many more simple, easy-to-avoid problems, many of whom were totally unrelated to youtube-dl.
934
935 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.
936
937 # DEVELOPER INSTRUCTIONS
938
939 Most users do not need to build youtube-dl and can [download the builds](https://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
940
941 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
942
943     python -m youtube_dl
944
945 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
946
947     python -m unittest discover
948     python test/test_download.py
949     nosetests
950
951 See item 6 of [new extractor tutorial](#adding-support-for-a-new-site) for how to run extractor specific test cases.
952
953 If you want to create a build of youtube-dl yourself, you'll need
954
955 * python
956 * make (only GNU make is supported)
957 * pandoc
958 * zip
959 * nosetests
960
961 ### Adding support for a new site
962
963 If you want to add support for a new site, first of all **make sure** this site is **not dedicated to [copyright infringement](README.md#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**.
964
965 After you have ensured this site is distributing its content legally, you can follow this quick list (assuming your service is called `yourextractor`):
966
967 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
968 2. Check out the source code with:
969
970         git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
971
972 3. Start a new git branch with
973
974         cd youtube-dl
975         git checkout -b yourextractor
976
977 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
978
979     ```python
980     # coding: utf-8
981     from __future__ import unicode_literals
982
983     from .common import InfoExtractor
984
985
986     class YourExtractorIE(InfoExtractor):
987         _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
988         _TEST = {
989             'url': 'https://yourextractor.com/watch/42',
990             'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
991             'info_dict': {
992                 'id': '42',
993                 'ext': 'mp4',
994                 'title': 'Video title goes here',
995                 'thumbnail': r're:^https?://.*\.jpg$',
996                 # TODO more properties, either as:
997                 # * A value
998                 # * MD5 checksum; start the string with md5:
999                 # * A regular expression; start the string with re:
1000                 # * Any Python type (for example int or float)
1001             }
1002         }
1003
1004         def _real_extract(self, url):
1005             video_id = self._match_id(url)
1006             webpage = self._download_webpage(url, video_id)
1007
1008             # TODO more code goes here, for example ...
1009             title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
1010
1011             return {
1012                 'id': video_id,
1013                 'title': title,
1014                 'description': self._og_search_description(webpage),
1015                 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
1016                 # TODO more properties (see youtube_dl/extractor/common.py)
1017             }
1018     ```
1019 5. Add an import in [`youtube_dl/extractor/extractors.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
1020 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. Note that tests with `only_matching` key in test's dict are not counted in.
1021 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/master/youtube_dl/extractor/common.py#L74-L252). Add tests and code for as many as you want.
1022 8. Make sure your code follows [youtube-dl coding conventions](#youtube-dl-coding-conventions) and check the code with [flake8](https://pypi.python.org/pypi/flake8). Also make sure your code works under all [Python](https://www.python.org/) versions claimed supported by youtube-dl, namely 2.6, 2.7, and 3.2+.
1023 9. When the tests pass, [add](https://git-scm.com/docs/git-add) the new files and [commit](https://git-scm.com/docs/git-commit) them and [push](https://git-scm.com/docs/git-push) the result, like this:
1024
1025         $ git add youtube_dl/extractor/extractors.py
1026         $ git add youtube_dl/extractor/yourextractor.py
1027         $ git commit -m '[yourextractor] Add new extractor'
1028         $ git push origin yourextractor
1029
1030 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
1031
1032 In any case, thank you very much for your contributions!
1033
1034 ## youtube-dl coding conventions
1035
1036 This section introduces a guide lines for writing idiomatic, robust and future-proof extractor code.
1037
1038 Extractors are very fragile by nature since they depend on the layout of the source data provided by 3rd party media hosters out of your control and this layout tends to change. As an extractor implementer your task is not only to write code that will extract media links and metadata correctly but also to minimize dependency on the source's layout and even to make the code foresee potential future changes and be ready for that. This is important because it will allow the extractor not to break on minor layout changes thus keeping old youtube-dl versions working. Even though this breakage issue is easily fixed by emitting a new version of youtube-dl with a fix incorporated, all the previous versions become broken in all repositories and distros' packages that may not be so prompt in fetching the update from us. Needless to say, some non rolling release distros may never receive an update at all.
1039
1040 ### Mandatory and optional metafields
1041
1042 For extraction to work youtube-dl relies on metadata your extractor extracts and provides to youtube-dl expressed by an [information dictionary](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L75-L257) or simply *info dict*. Only the following meta fields in the *info dict* are considered mandatory for a successful extraction process by youtube-dl:
1043
1044  - `id` (media identifier)
1045  - `title` (media title)
1046  - `url` (media download URL) or `formats`
1047
1048 In fact only the last option is technically mandatory (i.e. if you can't figure out the download location of the media the extraction does not make any sense). But by convention youtube-dl also treats `id` and `title` as mandatory. Thus the aforementioned metafields are the critical data that the extraction does not make any sense without and if any of them fail to be extracted then the extractor is considered completely broken.
1049
1050 [Any field](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L149-L257) apart from the aforementioned ones are considered **optional**. That means that extraction should be **tolerant** to situations when sources for these fields can potentially be unavailable (even if they are always available at the moment) and **future-proof** in order not to break the extraction of general purpose mandatory fields.
1051
1052 #### Example
1053
1054 Say you have some source dictionary `meta` that you've fetched as JSON with HTTP request and it has a key `summary`:
1055
1056 ```python
1057 meta = self._download_json(url, video_id)
1058 ```
1059     
1060 Assume at this point `meta`'s layout is:
1061
1062 ```python
1063 {
1064     ...
1065     "summary": "some fancy summary text",
1066     ...
1067 }
1068 ```
1069
1070 Assume you want to extract `summary` and put it into the resulting info dict as `description`. Since `description` is an optional meta field you should be ready that this key may be missing from the `meta` dict, so that you should extract it like:
1071
1072 ```python
1073 description = meta.get('summary')  # correct
1074 ```
1075
1076 and not like:
1077
1078 ```python
1079 description = meta['summary']  # incorrect
1080 ```
1081
1082 The latter will break extraction process with `KeyError` if `summary` disappears from `meta` at some later time but with the former approach extraction will just go ahead with `description` set to `None` which is perfectly fine (remember `None` is equivalent to the absence of data).
1083
1084 Similarly, you should pass `fatal=False` when extracting optional data from a webpage with `_search_regex`, `_html_search_regex` or similar methods, for instance:
1085
1086 ```python
1087 description = self._search_regex(
1088     r'<span[^>]+id="title"[^>]*>([^<]+)<',
1089     webpage, 'description', fatal=False)
1090 ```
1091
1092 With `fatal` set to `False` if `_search_regex` fails to extract `description` it will emit a warning and continue extraction.
1093
1094 You can also pass `default=<some fallback value>`, for example:
1095
1096 ```python
1097 description = self._search_regex(
1098     r'<span[^>]+id="title"[^>]*>([^<]+)<',
1099     webpage, 'description', default=None)
1100 ```
1101
1102 On failure this code will silently continue the extraction with `description` set to `None`. That is useful for metafields that may or may not be present.
1103  
1104 ### Provide fallbacks
1105
1106 When extracting metadata try to do so from multiple sources. For example if `title` is present in several places, try extracting from at least some of them. This makes it more future-proof in case some of the sources become unavailable.
1107
1108 #### Example
1109
1110 Say `meta` from the previous example has a `title` and you are about to extract it. Since `title` is a mandatory meta field you should end up with something like:
1111
1112 ```python
1113 title = meta['title']
1114 ```
1115
1116 If `title` disappears from `meta` in future due to some changes on the hoster's side the extraction would fail since `title` is mandatory. That's expected.
1117
1118 Assume that you have some another source you can extract `title` from, for example `og:title` HTML meta of a `webpage`. In this case you can provide a fallback scenario:
1119
1120 ```python
1121 title = meta.get('title') or self._og_search_title(webpage)
1122 ```
1123
1124 This code will try to extract from `meta` first and if it fails it will try extracting `og:title` from a `webpage`.
1125
1126 ### Make regular expressions flexible
1127
1128 When using regular expressions try to write them fuzzy and flexible.
1129  
1130 #### Example
1131
1132 Say you need to extract `title` from the following HTML code:
1133
1134 ```html
1135 <span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">some fancy title</span>
1136 ```
1137
1138 The code for that task should look similar to:
1139
1140 ```python
1141 title = self._search_regex(
1142     r'<span[^>]+class="title"[^>]*>([^<]+)', webpage, 'title')
1143 ```
1144
1145 Or even better:
1146
1147 ```python
1148 title = self._search_regex(
1149     r'<span[^>]+class=(["\'])title\1[^>]*>(?P<title>[^<]+)',
1150     webpage, 'title', group='title')
1151 ```
1152
1153 Note how you tolerate potential changes in the `style` attribute's value or switch from using double quotes to single for `class` attribute: 
1154
1155 The code definitely should not look like:
1156
1157 ```python
1158 title = self._search_regex(
1159     r'<span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">(.*?)</span>',
1160     webpage, 'title', group='title')
1161 ```
1162
1163 ### Use safe conversion functions
1164
1165 Wrap all extracted numeric data into safe functions from `utils`: `int_or_none`, `float_or_none`. Use them for string to number conversions as well.
1166
1167 # EMBEDDING YOUTUBE-DL
1168
1169 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).
1170
1171 From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
1172
1173 ```python
1174 from __future__ import unicode_literals
1175 import youtube_dl
1176
1177 ydl_opts = {}
1178 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
1179     ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
1180 ```
1181
1182 Most likely, you'll want to use various options. For a list of options available, have a look at [`youtube_dl/YoutubeDL.py`](https://github.com/rg3/youtube-dl/blob/3e4cedf9e8cd3157df2457df7274d0c842421945/youtube_dl/YoutubeDL.py#L137-L312). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
1183
1184 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:
1185
1186 ```python
1187 from __future__ import unicode_literals
1188 import youtube_dl
1189
1190
1191 class MyLogger(object):
1192     def debug(self, msg):
1193         pass
1194
1195     def warning(self, msg):
1196         pass
1197
1198     def error(self, msg):
1199         print(msg)
1200
1201
1202 def my_hook(d):
1203     if d['status'] == 'finished':
1204         print('Done downloading, now converting ...')
1205
1206
1207 ydl_opts = {
1208     'format': 'bestaudio/best',
1209     'postprocessors': [{
1210         'key': 'FFmpegExtractAudio',
1211         'preferredcodec': 'mp3',
1212         'preferredquality': '192',
1213     }],
1214     'logger': MyLogger(),
1215     'progress_hooks': [my_hook],
1216 }
1217 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
1218     ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
1219 ```
1220
1221 # BUGS
1222
1223 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>. Unless you were prompted to 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](https://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
1224
1225 **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:
1226 ```
1227 $ youtube-dl -v <your command line>
1228 [debug] System config: []
1229 [debug] User config: []
1230 [debug] Command-line args: [u'-v', u'https://www.youtube.com/watch?v=BaW_jenozKcj']
1231 [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
1232 [debug] youtube-dl version 2015.12.06
1233 [debug] Git HEAD: 135392e
1234 [debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
1235 [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
1236 [debug] Proxy map: {}
1237 ...
1238 ```
1239 **Do not post screenshots of verbose logs; only plain text is acceptable.**
1240
1241 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.
1242
1243 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
1244
1245 ### Is the description of the issue itself sufficient?
1246
1247 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.
1248
1249 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
1250
1251 - What the problem is
1252 - How it could be fixed
1253 - How your proposed solution would look like
1254
1255 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.
1256
1257 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.
1258
1259 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/).
1260
1261 **Site support requests must contain an example URL**. An example URL is a URL you might want to download, like `https://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. `https://www.youtube.com/`) is *not* an example URL.
1262
1263 ###  Are you using the latest version?
1264
1265 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.
1266
1267 ###  Is the issue already documented?
1268
1269 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.
1270
1271 ###  Why are existing options not enough?
1272
1273 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#options). 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.
1274
1275 ###  Is there enough context in your bug report?
1276
1277 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).
1278
1279 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.
1280
1281 ###  Does the issue involve one problem, and one problem only?
1282
1283 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.
1284
1285 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, White house 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.
1286
1287 ###  Is anyone going to need the feature?
1288
1289 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.
1290
1291 ###  Is your question about youtube-dl?
1292
1293 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.
1294
1295 # COPYRIGHT
1296
1297 youtube-dl is released into the public domain by the copyright holders.
1298
1299 This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.