]> jfr.im git - yt-dlp.git/blame - README.md
[srgssr] use flv as ext for rtmp formats
[yt-dlp.git] / README.md
CommitLineData
a1b8d815 1youtube-dl - download videos from youtube.com or other video platforms
6bcd846b 2
b50e3bc6
PH
3- [INSTALLATION](#installation)
4- [DESCRIPTION](#description)
5- [OPTIONS](#options)
6- [CONFIGURATION](#configuration)
7- [OUTPUT TEMPLATE](#output-template)
a3805092 8- [FORMAT SELECTION](#format-selection)
b50e3bc6
PH
9- [VIDEO SELECTION](#video-selection)
10- [FAQ](#faq)
11- [DEVELOPER INSTRUCTIONS](#developer-instructions)
0391bc81 12- [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
b50e3bc6
PH
13- [BUGS](#bugs)
14- [COPYRIGHT](#copyright)
cfcec693 15
d19bb9c0
PH
16# INSTALLATION
17
18To install it right away for all UNIX users (Linux, OS X, etc.), type:
19
20 sudo curl https://yt-dl.org/latest/youtube-dl -o /usr/local/bin/youtube-dl
23905927 21 sudo chmod a+rx /usr/local/bin/youtube-dl
d19bb9c0
PH
22
23If you do not have curl, you can alternatively use a recent wget:
24
6e74521d 25 sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
23905927 26 sudo chmod a+rx /usr/local/bin/youtube-dl
d19bb9c0
PH
27
28Windows users can [download a .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in their home directory or any other location on their [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
29
3b95347b
PH
30OS X users can install **youtube-dl** with [Homebrew](http://brew.sh/).
31
32 brew install youtube-dl
33
34You can also use pip:
35
36 sudo pip install youtube-dl
37
a1b8d815 38Alternatively, 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).
d19bb9c0 39
cfcec693 40# DESCRIPTION
6bcd846b
DB
41**youtube-dl** is a small command-line program to download videos from
42YouTube.com and a few more sites. It requires the Python interpreter, version
a03aaaed 432.6, 2.7, or 3.2+, and it is not platform specific. It should work on
280d6789 44your Unix box, on Windows or on Mac OS X. It is released to the public domain,
6bcd846b
DB
45which means you can modify it, redistribute it or use it however you like.
46
b50e3bc6
PH
47 youtube-dl [OPTIONS] URL [URL...]
48
cfcec693 49# OPTIONS
1dc2726f
PH
50 -h, --help Print this help text and exit
51 --version Print program version and exit
c4af7684
PH
52 -U, --update Update this program to latest version. Make
53 sure that you have sufficient permissions
54 (run with sudo if needed)
55 -i, --ignore-errors Continue on download errors, for example to
56 skip unavailable videos in a playlist
57 --abort-on-error Abort downloading of further videos (in the
58 playlist or the command line) if an error
59 occurs
1dc2726f 60 --dump-user-agent Display the current browser identification
4b9f9010 61 --list-extractors List all supported extractors
c4af7684
PH
62 --extractor-descriptions Output descriptions of all supported
63 extractors
64 --force-generic-extractor Force extraction to use the generic
65 extractor
66 --default-search PREFIX Use this prefix for unqualified URLs. For
67 example "gvsearch2:" downloads two videos
68 from google videos for youtube-dl "large
69 apple". Use the value "auto" to let
70 youtube-dl guess ("auto_warning" to emit a
71 warning when guessing). "error" just throws
72 an error. The default value "fixup_error"
73 repairs broken URLs, but emits an error if
74 this is not possible instead of searching.
75 --ignore-config Do not read configuration files. When given
76 in the global configuration file /etc
77 /youtube-dl.conf: Do not read the user
78 configuration in ~/.config/youtube-
79 dl/config (%APPDATA%/youtube-dl/config.txt
80 on Windows)
81 --flat-playlist Do not extract the videos of a playlist,
82 only list them.
1dc2726f 83 --no-color Do not emit color codes in output
08c1d0d3 84
149f05c7 85## Network Options:
c4af7684
PH
86 --proxy URL Use the specified HTTP/HTTPS proxy. Pass in
87 an empty string (--proxy "") for direct
88 connection
149f05c7 89 --socket-timeout SECONDS Time to wait before giving up, in seconds
c4af7684
PH
90 --source-address IP Client-side IP address to bind to
91 (experimental)
92 -4, --force-ipv4 Make all connections via IPv4
93 (experimental)
94 -6, --force-ipv6 Make all connections via IPv6
95 (experimental)
96 --cn-verification-proxy URL Use this proxy to verify the IP address for
97 some Chinese sites. The default proxy
98 specified by --proxy (or none, if the
99 options is not present) is used for the
100 actual downloading. (experimental)
149f05c7 101
cfcec693 102## Video Selection:
1dc2726f
PH
103 --playlist-start NUMBER Playlist video to start at (default is 1)
104 --playlist-end NUMBER Playlist video to end at (default is last)
c4af7684
PH
105 --playlist-items ITEM_SPEC Playlist video items to download. Specify
106 indices of the videos in the playlist
107 separated by commas like: "--playlist-items
108 1,2,5,8" if you want to download videos
109 indexed 1, 2, 5, 8 in the playlist. You can
110 specify range: "--playlist-items
111 1-3,7,10-13", it will download the videos
112 at index 1, 2, 3, 7, 10, 11, 12 and 13.
113 --match-title REGEX Download only matching titles (regex or
114 caseless sub-string)
115 --reject-title REGEX Skip download for matching titles (regex or
116 caseless sub-string)
780083db 117 --max-downloads NUMBER Abort after downloading NUMBER files
c4af7684
PH
118 --min-filesize SIZE Do not download any videos smaller than
119 SIZE (e.g. 50k or 44.6m)
120 --max-filesize SIZE Do not download any videos larger than SIZE
121 (e.g. 50k or 44.6m)
1dc2726f 122 --date DATE Download only videos uploaded in this date
c4af7684
PH
123 --datebefore DATE Download only videos uploaded on or before
124 this date (i.e. inclusive)
125 --dateafter DATE Download only videos uploaded on or after
126 this date (i.e. inclusive)
127 --min-views COUNT Do not download any videos with less than
128 COUNT views
129 --max-views COUNT Do not download any videos with more than
130 COUNT views
131 --match-filter FILTER Generic video filter (experimental).
132 Specify any key (see help for -o for a list
133 of available keys) to match if the key is
134 present, !key to check if the key is not
135 present,key > NUMBER (like "comment_count >
136 12", also works with >=, <, <=, !=, =) to
137 compare against a number, and & to require
138 multiple matches. Values which are not
139 known are excluded unless you put a
140 question mark (?) after the operator.For
141 example, to only match videos that have
142 been liked more than 100 times and disliked
143 less than 50 times (or the dislike
144 functionality is not available at the given
145 service), but who also have a description,
146 use --match-filter "like_count > 100 &
84573477 147 dislike_count <? 50 & description" .
c4af7684
PH
148 --no-playlist Download only the video, if the URL refers
149 to a video and a playlist.
150 --yes-playlist Download the playlist, if the URL refers to
151 a video and a playlist.
152 --age-limit YEARS Download only videos suitable for the given
153 age
154 --download-archive FILE Download only videos not listed in the
155 archive file. Record the IDs of all
156 downloaded videos in it.
157 --include-ads Download advertisements as well
158 (experimental)
6bcd846b 159
d5a62e4f 160## Download Options:
c4af7684
PH
161 -r, --rate-limit LIMIT Maximum download rate in bytes per second
162 (e.g. 50K or 4.2M)
163 -R, --retries RETRIES Number of retries (default is 10), or
164 "infinite".
165 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
166 (default is 1024)
167 --no-resize-buffer Do not automatically adjust the buffer
168 size. By default, the buffer size is
169 automatically resized from an initial value
170 of SIZE.
2101f5d4 171 --playlist-reverse Download playlist videos in reverse order
c4af7684
PH
172 --xattr-set-filesize Set file xattribute ytdl.filesize with
173 expected filesize (experimental)
174 --hls-prefer-native Use the native HLS downloader instead of
175 ffmpeg (experimental)
a69bee47
PH
176 --hls-use-mpegts Use the mpegts container for HLS videos,
177 allowing to play the video while
178 downloading (some players may not be able
179 to play it)
c4af7684
PH
180 --external-downloader COMMAND Use the specified external downloader.
181 Currently supports
182 aria2c,axel,curl,httpie,wget
183 --external-downloader-args ARGS Give these arguments to the external
184 downloader
d5a62e4f 185
cfcec693 186## Filesystem Options:
c4af7684
PH
187 -a, --batch-file FILE File containing URLs to download ('-' for
188 stdin)
1dc2726f 189 --id Use only video ID in file name
c4af7684
PH
190 -o, --output TEMPLATE Output filename template. Use %(title)s to
191 get the title, %(uploader)s for the
192 uploader name, %(uploader_id)s for the
193 uploader nickname if different,
194 %(autonumber)s to get an automatically
195 incremented number, %(ext)s for the
196 filename extension, %(format)s for the
197 format description (like "22 - 1280x720" or
198 "HD"), %(format_id)s for the unique id of
199 the format (like YouTube's itags: "137"),
200 %(upload_date)s for the upload date
201 (YYYYMMDD), %(extractor)s for the provider
202 (youtube, metacafe, etc), %(id)s for the
203 video id, %(playlist_title)s,
204 %(playlist_id)s, or %(playlist)s (=title if
205 present, ID otherwise) for the playlist the
206 video is in, %(playlist_index)s for the
207 position in the playlist. %(height)s and
208 %(width)s for the width and height of the
209 video format. %(resolution)s for a textual
210 description of the resolution of the video
211 format. %% for a literal percent. Use - to
212 output to stdout. Can also be used to
213 download to a different directory, for
214 example with -o '/my/downloads/%(uploader)s
215 /%(title)s-%(id)s.%(ext)s' .
216 --autonumber-size NUMBER Specify the number of digits in
217 %(autonumber)s when it is present in output
218 filename template or --auto-number option
219 is given
220 --restrict-filenames Restrict filenames to only ASCII
221 characters, and avoid "&" and spaces in
222 filenames
223 -A, --auto-number [deprecated; use -o
224 "%(autonumber)s-%(title)s.%(ext)s" ] Number
225 downloaded files starting from 00000
226 -t, --title [deprecated] Use title in file name
227 (default)
1dc2726f
PH
228 -l, --literal [deprecated] Alias of --title
229 -w, --no-overwrites Do not overwrite files
c4af7684
PH
230 -c, --continue Force resume of partially downloaded files.
231 By default, youtube-dl will resume
232 downloads if possible.
233 --no-continue Do not resume partially downloaded files
234 (restart from beginning)
235 --no-part Do not use .part files - write directly
236 into output file
237 --no-mtime Do not use the Last-modified header to set
238 the file modification time
239 --write-description Write video description to a .description
240 file
1dc2726f 241 --write-info-json Write video metadata to a .info.json file
c4af7684
PH
242 --write-annotations Write video annotations to a
243 .annotations.xml file
244 --load-info FILE JSON file containing the video information
245 (created with the "--write-info-json"
246 option)
247 --cookies FILE File to read cookies from and dump cookie
248 jar in
249 --cache-dir DIR Location in the filesystem where youtube-dl
250 can store some downloaded information
251 permanently. By default $XDG_CACHE_HOME
252 /youtube-dl or ~/.cache/youtube-dl . At the
253 moment, only YouTube player files (for
254 videos with obfuscated signatures) are
255 cached, but that may change.
36f35428
PH
256 --no-cache-dir Disable filesystem caching
257 --rm-cache-dir Delete all filesystem cache files
6bcd846b 258
2b1bd292 259## Thumbnail images:
1dc2726f
PH
260 --write-thumbnail Write thumbnail image to disk
261 --write-all-thumbnails Write all thumbnail image formats to disk
c4af7684
PH
262 --list-thumbnails Simulate and list all available thumbnail
263 formats
2b1bd292 264
cfcec693 265## Verbosity / Simulation Options:
1dc2726f 266 -q, --quiet Activate quiet mode
6c072e7d 267 --no-warnings Ignore warnings
c4af7684
PH
268 -s, --simulate Do not download the video and do not write
269 anything to disk
1dc2726f
PH
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
c4af7684
PH
279 -j, --dump-json Simulate, quiet but print JSON information.
280 See --output for a description of available
281 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).
1dc2726f
PH
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
c4af7684
PH
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
780083db 297 --print-traffic Display sent and read HTTP traffic
1dc2726f 298 -C, --call-home Contact the youtube-dl server for debugging
c4af7684
PH
299 --no-call-home Do NOT contact the youtube-dl server for
300 debugging
6bcd846b 301
36f35428
PH
302## Workarounds:
303 --encoding ENCODING Force the specified encoding (experimental)
1dc2726f 304 --no-check-certificate Suppress HTTPS certificate validation
c4af7684
PH
305 --prefer-insecure Use an unencrypted connection to retrieve
306 information about the video. (Currently
307 supported only for YouTube)
1dc2726f 308 --user-agent UA Specify a custom user agent
c4af7684
PH
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.
36f35428 319
cfcec693 320## Video Format Options:
c4af7684
PH
321 -f, --format FORMAT Video format code, see the "FORMAT
322 SELECTION" for all the info
1dc2726f 323 --all-formats Download all available video formats
c4af7684
PH
324 --prefer-free-formats Prefer free video formats unless a specific
325 one is requested
535d7b68 326 -F, --list-formats List all available formats of requested
bb6ac836 327 videos
c4af7684
PH
328 --youtube-skip-dash-manifest Do not download the DASH manifests and
329 related data on YouTube videos
330 --merge-output-format FORMAT If a merge is required (e.g.
331 bestvideo+bestaudio), output to given
332 container format. One of mkv, mp4, ogg,
333 webm, flv. Ignored if no merge is required
8ae7be3e
PH
334
335## Subtitle Options:
1dc2726f 336 --write-sub Write subtitle file
741dd8ea
RB
337 --write-auto-sub Write automatically generated subtitle file
338 (YouTube only)
c4af7684
PH
339 --all-subs Download all the available subtitles of the
340 video
1dc2726f 341 --list-subs List all available subtitles for the video
c4af7684
PH
342 --sub-format FORMAT Subtitle format, accepts formats
343 preference, for example: "srt" or
344 "ass/srt/best"
345 --sub-lang LANGS Languages of the subtitles to download
f733b053
PH
346 (optional) separated by commas, use --list-
347 subs for available language tags
6bcd846b 348
cfcec693 349## Authentication Options:
1dc2726f 350 -u, --username USERNAME Login with this account ID
c4af7684
PH
351 -p, --password PASSWORD Account password. If this option is left
352 out, youtube-dl will ask interactively.
1dc2726f
PH
353 -2, --twofactor TWOFACTOR Two-factor auth code
354 -n, --netrc Use .netrc authentication data
804c343a 355 --video-password PASSWORD Video password (vimeo, smotri, youku)
6bcd846b 356
cfcec693 357## Post-processing Options:
c4af7684
PH
358 -x, --extract-audio Convert video files to audio-only files
359 (requires ffmpeg or avconv and ffprobe or
360 avprobe)
361 --audio-format FORMAT Specify audio format: "best", "aac",
362 "vorbis", "mp3", "m4a", "opus", or "wav";
363 "best" by default
364 --audio-quality QUALITY Specify ffmpeg/avconv audio quality, insert
365 a value between 0 (better) and 9 (worse)
366 for VBR or a specific bitrate like 128K
367 (default 5)
368 --recode-video FORMAT Encode the video to another format if
369 necessary (currently supported:
370 mp4|flv|ogg|webm|mkv|avi)
f72b0a60 371 --postprocessor-args ARGS Give these arguments to the postprocessor
c4af7684
PH
372 -k, --keep-video Keep the video file on disk after the post-
373 processing; the video is erased by default
374 --no-post-overwrites Do not overwrite post-processed files; the
375 post-processed files are overwritten by
376 default
377 --embed-subs Embed subtitles in the video (only for mkv
378 and mp4 videos)
1dc2726f
PH
379 --embed-thumbnail Embed thumbnail in the audio as cover art
380 --add-metadata Write metadata to the video file
c4af7684
PH
381 --metadata-from-title FORMAT Parse additional metadata like song title /
382 artist from the video title. The format
383 syntax is the same as --output, the parsed
384 parameters replace existing values.
385 Additional templates: %(album)s,
386 %(artist)s. Example: --metadata-from-title
387 "%(artist)s - %(title)s" matches a title
388 like "Coldplay - Paradise"
389 --xattrs Write metadata to the video file's xattrs
390 (using dublin core and xdg standards)
391 --fixup POLICY Automatically correct known faults of the
392 file. One of never (do nothing), warn (only
393 emit a warning), detect_or_warn (the
394 default; fix file if we can, warn
395 otherwise)
396 --prefer-avconv Prefer avconv over ffmpeg for running the
397 postprocessors (default)
398 --prefer-ffmpeg Prefer ffmpeg over avconv for running the
399 postprocessors
400 --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
401 either the path to the binary or its
402 containing directory.
403 --exec CMD Execute a command on the file after
404 downloading, similar to find's -exec
405 syntax. Example: --exec 'adb push {}
406 /sdcard/Music/ && rm {}'
7de81fcc 407 --convert-subs FORMAT Convert the subtitles to other format
c4af7684 408 (currently supported: srt|ass|vtt)
6bcd846b 409
df4bad32
PH
410# CONFIGURATION
411
a1b8d815 412You can configure youtube-dl by placing any supported command line option to a configuration file. On Linux, 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`. For example, with the following configuration file youtube-dl will always extract the audio, not copy the mtime and use a proxy:
eaa56464
S
413```
414--extract-audio
415--no-mtime
416--proxy 127.0.0.1:3128
417```
418
a1b8d815 419You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
df4bad32 420
46047c58 421### Authentication with `.netrc` file
b062d94e 422
a1b8d815 423You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every youtube-dl execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](http://stackoverflow.com/tags/.netrc/info) on per extractor basis. For that you will need to create a`.netrc` file in your `$HOME` and restrict permissions to read/write by you only:
b062d94e
S
424```
425touch $HOME/.netrc
426chmod a-rwx,u+rw $HOME/.netrc
427```
428After that you can add credentials for extractor in the following format, where *extractor* is the name of extractor in lowercase:
429```
430machine <extractor> login <login> password <password>
431```
432For example:
433```
434machine youtube login myaccount@gmail.com password my_youtube_password
435machine twitch login my_twitch_account_name password my_twitch_password
436```
a1b8d815 437To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
b062d94e 438
bd5376c1 439On Windows you may also need to setup the `%HOME%` environment variable manually.
b062d94e 440
02531431
PH
441# OUTPUT TEMPLATE
442
bd5376c1 443The `-o` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parentheses, followed by a lowercase S. Allowed names are:
02531431
PH
444
445 - `id`: The sequence will be replaced by the video identifier.
446 - `url`: The sequence will be replaced by the video URL.
447 - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
448 - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
449 - `title`: The sequence will be replaced by the video title.
877f4c45
PH
450 - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
451 - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
452 - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
31208a07 453 - `playlist`: The sequence will be replaced by the name or the id of the playlist that contains the video.
ac7a1b0d 454 - `playlist_index`: The sequence will be replaced by the index of the video in the playlist padded with leading zeros according to the total length of the playlist.
4d2ad866 455 - `format_id`: The sequence will be replaced by the format code specified by `--format`.
4c917d03 456 - `duration`: The sequence will be replaced by the length of the video in seconds.
02531431 457
1083705f 458The current default template is `%(title)s-%(id)s.%(ext)s`.
02531431
PH
459
460In 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:
461
1ce464ab
EJ
462```bash
463$ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
464youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
465$ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
466youtube-dl_test_video_.mp4 # A simple file name
467```
02531431 468
a3805092
JMF
469# FORMAT SELECTION
470
b2dca40d 471By 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**.
a3805092 472
b2dca40d 473But 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.
a3805092 474
b2dca40d
S
475The 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.
476
477The 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.
478
479You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download best quality format of particular file extension served as a single file, e.g. `-f webm` will download best quality format with `webm` extension served as a single file.
480
481You can also use special names to select particular edge case format:
482 - `best`: Select best quality format represented by single file with video and audio
483 - `worst`: Select worst quality format represented by single file with video and audio
484 - `bestvideo`: Select best quality video only format (e.g. DASH video), may not be available
485 - `worstvideo`: Select worst quality video only format, may not be available
486 - `bestaudio`: Select best quality audio only format, may not be available
487 - `worstaudio`: Select worst quality audio only format, may not be available
488
489For example, to download worst quality video only format you can use `-f worstvideo`.
490
491If 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.
492
493If you want to download several formats of the same video use comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or more sophisticated example combined with precedence feature `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
494
495You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
496
497The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
498 - `filesize`: The number of bytes, if known in advance
499 - `width`: Width of the video, if known
500 - `height`: Height of the video, if known
501 - `tbr`: Average bitrate of audio and video in KBit/s
502 - `abr`: Average audio bitrate in KBit/s
503 - `vbr`: Average video bitrate in KBit/s
504 - `asr`: Audio sampling rate in Hertz
505 - `fps`: Frame rate
506
507Also filtering work for comparisons `=` (equals), `!=` (not equals), `^=` (begins with), `$=` (ends with), `*=` (contains) and following string meta fields:
508 - `ext`: File extension
509 - `acodec`: Name of the audio codec in use
510 - `vcodec`: Name of the video codec in use
511 - `container`: Name of the container format
512 - `protocol`: The protocol that will be used for the actual download, lower-case. `http`, `https`, `rtsp`, `rtmp`, `rtmpe`, `m3u8`, or `m3u8_native`
513
514Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by video hoster.
515
516Formats 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.
517
518You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download best video only format, best audio only format and mux them together with ffmpeg/avconv.
519
520Format 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]'`.
521
522Since the end of April 2015 and version 2015.04.26 youtube-dl uses `-f bestvideo+bestaudio/best` as default format selection (see #5447, #5456). If ffmpeg or avconv are installed this results in downloading `bestvideo` and `bestaudio` separately and muxing them together into a single file giving the best overall quality available. Otherwise it falls back to `best` and results in downloading 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.
02f502f4 523
a1b8d815 524If 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.
7b071e31 525
b2dca40d
S
526Examples (note on Windows you may need to use double quotes instead of single):
527```bash
528# Download best mp4 format available or any other best if no mp4 available
529$ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
530
531# Download best format available but not better that 480p
532$ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
533
534# Download best video only format but no bigger that 50 MB
535$ youtube-dl -f 'best[filesize<50M]'
6be16ed2
S
536
537# Download best format available via direct link over HTTP/HTTPS protocol
538$ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
b2dca40d
S
539```
540
541
e31852ab
JMF
542# VIDEO SELECTION
543
bd5376c1 544Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
e31852ab
JMF
545
546 - Absolute dates: Dates in the format `YYYYMMDD`.
547 - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
548
549Examples:
550
1ce464ab
EJ
551```bash
552# Download only the videos uploaded in the last 6 months
553$ youtube-dl --dateafter now-6months
09c4d509 554
1ce464ab
EJ
555# Download only the videos uploaded on January 1, 1970
556$ youtube-dl --date 19700101
09c4d509 557
bd5376c1 558$ # Download only the videos uploaded in the 200x decade
1ce464ab
EJ
559$ youtube-dl --dateafter 20000101 --datebefore 20091231
560```
e31852ab 561
cfcec693 562# FAQ
447b1d71 563
89294b5f 564### How do I update youtube-dl?
573585c2 565
89294b5f
PH
566If you've followed [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
567
568If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
573585c2 569
a1b8d815 570If you have installed youtube-dl using a package manager like *apt-get* or *yum*, use the standard system update mechanism to update. Note that distribution packages are often outdated. As a rule of thumb, youtube-dl releases at least once a month, and often weekly or even daily. Simply go to http://yt-dl.org/ to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
573585c2 571
89294b5f
PH
572As 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
573
574 sudo apt-get remove -y youtube-dl
575
576Afterwards, simply follow [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html):
573585c2
PH
577
578```
573585c2
PH
579sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
580sudo chmod a+x /usr/local/bin/youtube-dl
581hash -r
582```
583
89294b5f
PH
584Again, from then on you'll be able to update with `sudo youtube-dl -U`.
585
586### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
587
a1b8d815 588YouTube 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.
89294b5f 589
a1b8d815 590If you have installed youtube-dl with a package manager, pip, setup.py or a tarball, please use that to update. Note that Ubuntu packages do not seem to get updated anymore. Since we are not affiliated with Ubuntu, there is little we can do. Feel free to [report bugs](https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to the [Ubuntu packaging guys](mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl) - all they have to do is update the package to a somewhat recent version. See above for a way to update.
89294b5f 591
0d1bd5d6 592### Do I always have to pass `-citw`?
573585c2 593
a1b8d815 594By 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`.
573585c2 595
fcc25462 596### Can you please put the `-b` option back?
447b1d71 597
a1b8d815 598Most 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.
447b1d71 599
f2a3a352 600### I get HTTP error 402 when trying to download a video. What's this?
447b1d71 601
a1b8d815 602Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
447b1d71 603
032f2f26
PH
604### Do I need any other programs?
605
a1b8d815 606youtube-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.
032f2f26 607
7689413e 608Videos or video formats streamed via RTMP protocol can only be downloaded when [rtmpdump](https://rtmpdump.mplayerhq.hu/) is installed. Downloading MMS and RTSP videos requires either [mplayer](http://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
032f2f26 609
447b1d71
PH
610### I have downloaded a video but how can I play it?
611
612Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
613
fcc25462 614### I extracted a video URL with `-g`, but it does not play on another machine / in my webbrowser.
447b1d71 615
a1b8d815 616It depends a lot on the service. In many cases, requests for the video (to download/play it) must come from the same IP address and with the same cookies. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl.
fbef83f3
PH
617
618It 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.
619
fcc25462 620Please 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.
fbef83f3 621
a1b8d815 622If 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.
447b1d71 623
454d6691
PH
624### ERROR: no fmt_url_map or conn information found in video info
625
a1b8d815 626YouTube 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.
454d6691 627
46047c58 628### ERROR: unable to download video
6c5b442a 629
a1b8d815 630YouTube 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.
b8b928d5 631
46047c58 632### 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`
c8183e66 633
a1b8d815 634That'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).
c8183e66 635
189ba909 636For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
c8183e66 637
189ba909 638```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
c8183e66
S
639
640or
641
189ba909 642```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
c8183e66
S
643
644For Windows you have to use the double quotes:
645
189ba909 646```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
c8183e66 647
b8b928d5
PH
648### ExtractorError: Could not find JS function u'OF'
649
a1b8d815 650In 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.
6c5b442a 651
66dc9a37
PH
652### HTTP Error 429: Too Many Requests or 402: Payment Required
653
12e9e844 654These 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.
66dc9a37 655
46047c58 656### SyntaxError: Non-ASCII character
6c5b442a
PH
657
658The error
659
660 File "youtube-dl", line 2
661 SyntaxError: Non-ASCII character '\x93' ...
662
663means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
664
5cdfaeb3
FV
665### What is this binary file? Where has the code gone?
666
a1b8d815 667Since June 2012 (#342) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
5cdfaeb3 668
ce367443
FV
669### The exe throws a *Runtime error from Visual C++*
670
671To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29).
672
5e416647
PH
673### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
674
a1b8d815 675If 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.
5e416647 676
a1b8d815 677To 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.
5e416647 678
a1b8d815 679From 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.
5e416647 680
b4a64c59
PH
681### How do I put downloads into a specific folder?
682
683Use 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).
684
46047c58 685### How do I download a video starting with a `-`?
e2a08185
PH
686
687Either prepend `http://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
688
689 youtube-dl -- -wNyEUrxzFU
690 youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
691
8de92272
S
692### How do I pass cookies to youtube-dl?
693
bd5376c1 694Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`. Note that the cookies file must be in Mozilla/Netscape format and the first line of the cookies file must be either `# HTTP Cookie File` or `# Netscape HTTP Cookie File`. Make sure you have correct [newline format](https://en.wikipedia.org/wiki/Newline) in the cookies file and convert newlines if necessary to correspond with your OS, namely `CRLF` (`\r\n`) for Windows, `LF` (`\n`) for Linux and `CR` (`\r`) for Mac OS. `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
8de92272 695
40f79628 696Passing 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).
8de92272 697
12f0454c
PH
698### Can you add support for this anime video site, or site which shows current movies for free?
699
a1b8d815 700As 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.
12f0454c 701
a1b8d815 702A 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.
12f0454c
PH
703
704Support 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.
705
d475b338
PH
706### How can I speed up work on my issue?
707
a1b8d815 708(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:
d475b338 709
a1b8d815 710First 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.
d475b338 711
a1b8d815 712Please 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.
d475b338
PH
713
714If 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).
715
a1b8d815 716Feel 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`.
d475b338 717
416c7fcb
PH
718### How can I detect whether a given URL is supported by youtube-dl?
719
a1b8d815 720For one, have a look at the [list of supported sites](docs/supportedsites.md). Note that it can sometimes happen that the site changes its URL scheme (say, from http://example.com/video/1234567 to http://example.com/v/1234567 ) and youtube-dl reports an URL of a service in that list as unsupported. In that case, simply report a bug.
416c7fcb 721
a1b8d815 722It 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.
416c7fcb 723
a1b8d815 724If 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.
416c7fcb 725
a96ed916 726# DEVELOPER INSTRUCTIONS
803abae2 727
a1b8d815 728Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
803abae2 729
a1b8d815 730To run youtube-dl as a developer, you don't need to build anything either. Simply execute
63ef36e8
PH
731
732 python -m youtube_dl
733
734To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
735
736 python -m unittest discover
737 python test/test_download.py
738 nosetests
739
a1b8d815 740If you want to create a build of youtube-dl yourself, you'll need
63ef36e8
PH
741
742* python
743* make
744* pandoc
745* zip
746* nosetests
6bcd846b 747
a96ed916
PH
748### Adding support for a new site
749
5fbd672c
PH
750If you want to add support for a new site, you can follow this quick list (assuming your service is called `yourextractor`):
751
7521. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
7532. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
7543. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
7554. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
1ce464ab
EJ
756 ```python
757 # coding: utf-8
758 from __future__ import unicode_literals
759
1ce464ab
EJ
760 from .common import InfoExtractor
761
762
763 class YourExtractorIE(InfoExtractor):
764 _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
765 _TEST = {
766 'url': 'http://yourextractor.com/watch/42',
7f5c0c4a 767 'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
1ce464ab
EJ
768 'info_dict': {
769 'id': '42',
770 'ext': 'mp4',
771 'title': 'Video title goes here',
218f7549 772 'thumbnail': 're:^https?://.*\.jpg$',
1ce464ab
EJ
773 # TODO more properties, either as:
774 # * A value
775 # * MD5 checksum; start the string with md5:
776 # * A regular expression; start the string with re:
777 # * Any Python type (for example int or float)
5fbd672c 778 }
1ce464ab 779 }
5fbd672c 780
1ce464ab 781 def _real_extract(self, url):
4bc77c84 782 video_id = self._match_id(url)
c920d7f0 783 webpage = self._download_webpage(url, video_id)
5fbd672c 784
1ce464ab 785 # TODO more code goes here, for example ...
2038ad6e 786 title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
d1b3e3dd 787
1ce464ab
EJ
788 return {
789 'id': video_id,
790 'title': title,
c3e74731 791 'description': self._og_search_description(webpage),
2038ad6e 792 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
1ce464ab
EJ
793 # TODO more properties (see youtube_dl/extractor/common.py)
794 }
795 ```
5fbd672c 7965. Add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py).
bd5376c1 7976. 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.
ebf4ca39 7987. 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#L62-L200). Add tests and code for as many as you want.
fdaaaaa8 7998. If you can, check the code with [flake8](https://pypi.python.org/pypi/flake8).
982a58d0 8009. When the tests pass, [add](http://git-scm.com/docs/git-add) the new files and [commit](http://git-scm.com/docs/git-commit) them and [push](http://git-scm.com/docs/git-push) the result, like this:
5fbd672c
PH
801
802 $ git add youtube_dl/extractor/__init__.py
803 $ git add youtube_dl/extractor/yourextractor.py
804 $ git commit -m '[yourextractor] Add new extractor'
805 $ git push origin yourextractor
806
80710. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
808
809In any case, thank you very much for your contributions!
a96ed916 810
03df7baa
PH
811# EMBEDDING YOUTUBE-DL
812
a1b8d815 813youtube-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).
03df7baa 814
a1b8d815 815From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
03df7baa 816
caff5949 817```python
486dd09e 818from __future__ import unicode_literals
caff5949 819import youtube_dl
03df7baa 820
caff5949
PH
821ydl_opts = {}
822with youtube_dl.YoutubeDL(ydl_opts) as ydl:
823 ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
824```
03df7baa 825
45dad8ba 826Most likely, you'll want to use various options. For a list of what can be done, have a look at [`youtube_dl/YoutubeDL.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L121-L269). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
03df7baa 827
71b640cc 828Here'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:
4f026faf 829
caff5949 830```python
486dd09e 831from __future__ import unicode_literals
caff5949 832import youtube_dl
4f026faf
PH
833
834
caff5949
PH
835class MyLogger(object):
836 def debug(self, msg):
837 pass
4f026faf 838
caff5949
PH
839 def warning(self, msg):
840 pass
4f026faf 841
caff5949
PH
842 def error(self, msg):
843 print(msg)
4f026faf 844
71b640cc 845
caff5949
PH
846def my_hook(d):
847 if d['status'] == 'finished':
848 print('Done downloading, now converting ...')
71b640cc
PH
849
850
caff5949
PH
851ydl_opts = {
852 'format': 'bestaudio/best',
853 'postprocessors': [{
854 'key': 'FFmpegExtractAudio',
855 'preferredcodec': 'mp3',
856 'preferredquality': '192',
857 }],
858 'logger': MyLogger(),
859 'progress_hooks': [my_hook],
860}
861with youtube_dl.YoutubeDL(ydl_opts) as ydl:
862 ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
863```
4f026faf 864
cfcec693 865# BUGS
e133e121 866
46047c58 867Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>. Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email. For discussions, join us in the IRC channel [#youtube-dl](irc://chat.freenode.net/#youtube-dl) on freenode ([webchat](http://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
e133e121 868
3348243b
S
869**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:
870```
871$ youtube-dl -v http://www.youtube.com/watch?v=BaW_jenozKcj
872[debug] System config: []
873[debug] User config: []
874[debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj']
875[debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
876[debug] youtube-dl version 2015.12.06
877[debug] Git HEAD: 135392e
878[debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
879[debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
880[debug] Proxy map: {}
881...
882```
883**Do not post screenshots of verbose log only plain text is acceptable.**
c071733f 884
edeb3e7c 885The 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.
4b235346 886
b3efb3eb 887Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
2a18bc9a
PH
888
889### Is the description of the issue itself sufficient?
890
891We 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.
892
893So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
894
895- What the problem is
896- How it could be fixed
897- How your proposed solution would look like
898
fc383f19 899If 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.
2a18bc9a 900
a1b8d815 901For 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.
2a18bc9a 902
fcc25462 903If 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/).
d475b338 904
46047c58 905**Site support requests must contain an example URL**. An example URL is a URL you might want to download, like `http://www.youtube.com/watch?v=BaW_jenozKc`. There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. `http://www.youtube.com/`) is *not* an example URL.
2a18bc9a
PH
906
907### Are you using the latest version?
908
fcc25462 909Before 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.
2a18bc9a
PH
910
911### Is the issue already documented?
912
46047c58 913Make 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.
2a18bc9a
PH
914
915### Why are existing options not enough?
916
917Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#synopsis). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
918
919### Is there enough context in your bug report?
920
921People 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).
922
923We 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.
924
925### Does the issue involve one problem, and one problem only?
926
927Some 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.
928
a1b8d815 929In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
2a18bc9a
PH
930
931### Is anyone going to need the feature?
932
330537d0 933Only 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.
a17c95f5
PH
934
935### Is your question about youtube-dl?
936
a1b8d815 937It 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.
63ef36e8
PH
938
939# COPYRIGHT
940
a1b8d815 941youtube-dl is released into the public domain by the copyright holders.
63ef36e8 942
46047c58 943This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.