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