4 youtube-dl - download videos from youtube.com or other video platforms
7 **youtube-dl** [OPTIONS] URL [URL...]
10 **youtube-dl** is a small command-line program to download videos from
11 YouTube.com and a few more sites. It requires the Python interpreter, version
12 2.6, 2.7, or 3.3+, and it is not platform specific. It should work on
13 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
14 which means you can modify it, redistribute it or use it however you like.
17 -h, --help print this help text and exit
18 --version print program version and exit
19 -U, --update update this program to latest version. Make
20 sure that you have sufficient permissions
21 (run with sudo if needed)
22 -i, --ignore-errors continue on download errors, for example to
23 skip unavailable videos in a playlist
24 --abort-on-error Abort downloading of further videos (in the
25 playlist or the command line) if an error
27 --dump-user-agent display the current browser identification
28 --user-agent UA specify a custom user agent
29 --referer REF specify a custom referer, use if the video
30 access is restricted to one domain
31 --add-header FIELD:VALUE specify a custom HTTP header and its value,
32 separated by a colon ':'. You can use this
34 --list-extractors List all supported extractors and the URLs
36 --extractor-descriptions Output descriptions of all supported
38 --proxy URL Use the specified HTTP/HTTPS proxy. Pass in
39 an empty string (--proxy "") for direct
41 --no-check-certificate Suppress HTTPS certificate validation.
42 --prefer-insecure Use an unencrypted connection to retrieve
43 information about the video. (Currently
44 supported only for YouTube)
45 --cache-dir DIR Location in the filesystem where youtube-dl
46 can store some downloaded information
47 permanently. By default $XDG_CACHE_HOME
48 /youtube-dl or ~/.cache/youtube-dl . At the
49 moment, only YouTube player files (for
50 videos with obfuscated signatures) are
51 cached, but that may change.
52 --no-cache-dir Disable filesystem caching
53 --socket-timeout None Time to wait before giving up, in seconds
54 --bidi-workaround Work around terminals that lack
55 bidirectional text support. Requires bidiv
56 or fribidi executable in PATH
57 --default-search PREFIX Use this prefix for unqualified URLs. For
58 example "gvsearch2:" downloads two videos
59 from google videos for youtube-dl "large
60 apple". By default (with value "auto")
62 --ignore-config Do not read configuration files. When given
63 in the global configuration file /etc
64 /youtube-dl.conf: do not read the user
65 configuration in ~/.config/youtube-dl.conf
66 (%APPDATA%/youtube-dl/config.txt on
68 --encoding ENCODING Force the specified encoding (experimental)
71 --playlist-start NUMBER playlist video to start at (default is 1)
72 --playlist-end NUMBER playlist video to end at (default is last)
73 --match-title REGEX download only matching titles (regex or
75 --reject-title REGEX skip download for matching titles (regex or
77 --max-downloads NUMBER Abort after downloading NUMBER files
78 --min-filesize SIZE Do not download any videos smaller than
79 SIZE (e.g. 50k or 44.6m)
80 --max-filesize SIZE Do not download any videos larger than SIZE
82 --date DATE download only videos uploaded in this date
83 --datebefore DATE download only videos uploaded on or before
84 this date (i.e. inclusive)
85 --dateafter DATE download only videos uploaded on or after
86 this date (i.e. inclusive)
87 --min-views COUNT Do not download any videos with less than
89 --max-views COUNT Do not download any videos with more than
91 --no-playlist download only the currently playing video
92 --age-limit YEARS download only videos suitable for the given
94 --download-archive FILE Download only videos not listed in the
95 archive file. Record the IDs of all
96 downloaded videos in it.
97 --include-ads Download advertisements as well
99 --youtube-include-dash-manifest Try to download the DASH manifest on
100 YouTube videos (experimental)
103 -r, --rate-limit LIMIT maximum download rate in bytes per second
105 -R, --retries RETRIES number of retries (default is 10)
106 --buffer-size SIZE size of download buffer (e.g. 1024 or 16K)
108 --no-resize-buffer do not automatically adjust the buffer
109 size. By default, the buffer size is
110 automatically resized from an initial value
113 ## Filesystem Options:
114 -t, --title use title in file name (default)
115 --id use only video ID in file name
116 -l, --literal [deprecated] alias of --title
117 -A, --auto-number number downloaded files starting from 00000
118 -o, --output TEMPLATE output filename template. Use %(title)s to
119 get the title, %(uploader)s for the
120 uploader name, %(uploader_id)s for the
121 uploader nickname if different,
122 %(autonumber)s to get an automatically
123 incremented number, %(ext)s for the
124 filename extension, %(format)s for the
125 format description (like "22 - 1280x720" or
126 "HD"), %(format_id)s for the unique id of
127 the format (like Youtube's itags: "137"),
128 %(upload_date)s for the upload date
129 (YYYYMMDD), %(extractor)s for the provider
130 (youtube, metacafe, etc), %(id)s for the
131 video id, %(playlist)s for the playlist the
132 video is in, %(playlist_index)s for the
133 position in the playlist and %% for a
134 literal percent. %(height)s and %(width)s
135 for the width and height of the video
136 format. %(resolution)s for a textual
137 description of the resolution of the video
138 format. Use - to output to stdout. Can also
139 be used to download to a different
140 directory, for example with -o '/my/downloa
141 ds/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
142 --autonumber-size NUMBER Specifies the number of digits in
143 %(autonumber)s when it is present in output
144 filename template or --auto-number option
146 --restrict-filenames Restrict filenames to only ASCII
147 characters, and avoid "&" and spaces in
149 -a, --batch-file FILE file containing URLs to download ('-' for
151 --load-info FILE json file containing the video information
152 (created with the "--write-json" option)
153 -w, --no-overwrites do not overwrite files
154 -c, --continue force resume of partially downloaded files.
155 By default, youtube-dl will resume
156 downloads if possible.
157 --no-continue do not resume partially downloaded files
158 (restart from beginning)
159 --cookies FILE file to read cookies from and dump cookie
161 --no-part do not use .part files
162 --no-mtime do not use the Last-modified header to set
163 the file modification time
164 --write-description write video description to a .description
166 --write-info-json write video metadata to a .info.json file
167 --write-annotations write video annotations to a .annotation
169 --write-thumbnail write thumbnail image to disk
171 ## Verbosity / Simulation Options:
172 -q, --quiet activates quiet mode
173 --no-warnings Ignore warnings
174 -s, --simulate do not download the video and do not write
176 --skip-download do not download the video
177 -g, --get-url simulate, quiet but print URL
178 -e, --get-title simulate, quiet but print title
179 --get-id simulate, quiet but print id
180 --get-thumbnail simulate, quiet but print thumbnail URL
181 --get-description simulate, quiet but print video description
182 --get-duration simulate, quiet but print video length
183 --get-filename simulate, quiet but print output filename
184 --get-format simulate, quiet but print output format
185 -j, --dump-json simulate, quiet but print JSON information.
186 See --output for a description of available
188 --newline output progress bar as new lines
189 --no-progress do not print progress bar
190 --console-title display progress in console titlebar
191 -v, --verbose print various debugging information
192 --dump-intermediate-pages print downloaded pages to debug problems
194 --write-pages Write downloaded intermediary pages to
195 files in the current directory to debug
197 --print-traffic Display sent and read HTTP traffic
199 ## Video Format Options:
200 -f, --format FORMAT video format code, specify the order of
201 preference using slashes: "-f 22/17/18".
202 "-f mp4" and "-f flv" are also supported.
203 You can also use the special names "best",
204 "bestvideo", "bestaudio", "worst",
205 "worstvideo" and "worstaudio". By default,
206 youtube-dl will pick the best quality.
207 --all-formats download all available video formats
208 --prefer-free-formats prefer free video formats unless a specific
210 --max-quality FORMAT highest quality format to download
211 -F, --list-formats list all available formats
214 --write-sub write subtitle file
215 --write-auto-sub write automatic subtitle file (youtube
217 --all-subs downloads all the available subtitles of
219 --list-subs lists all available subtitles for the video
220 --sub-format FORMAT subtitle format (default=srt) ([sbv/vtt]
222 --sub-lang LANGS languages of the subtitles to download
223 (optional) separated by commas, use IETF
224 language tags like 'en,pt'
226 ## Authentication Options:
227 -u, --username USERNAME account username
228 -p, --password PASSWORD account password
229 -n, --netrc use .netrc authentication data
230 --video-password PASSWORD video password (vimeo, smotri)
232 ## Post-processing Options:
233 -x, --extract-audio convert video files to audio-only files
234 (requires ffmpeg or avconv and ffprobe or
236 --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a",
237 "opus", or "wav"; best by default
238 --audio-quality QUALITY ffmpeg/avconv audio quality specification,
239 insert a value between 0 (better) and 9
240 (worse) for VBR or a specific bitrate like
242 --recode-video FORMAT Encode the video to another format if
243 necessary (currently supported:
245 -k, --keep-video keeps the video file on disk after the
246 post-processing; the video is erased by
248 --no-post-overwrites do not overwrite post-processed files; the
249 post-processed files are overwritten by
251 --embed-subs embed subtitles in the video (only for mp4
253 --embed-thumbnail embed thumbnail in the audio as cover art
254 --add-metadata write metadata to the video file
255 --xattrs write metadata to the video file's xattrs
256 (using dublin core and xdg standards)
257 --prefer-avconv Prefer avconv over ffmpeg for running the
258 postprocessors (default)
259 --prefer-ffmpeg Prefer ffmpeg over avconv for running the
264 You can configure youtube-dl by placing default arguments (such as `--extract-audio --no-mtime` to always extract the audio and not copy the mtime) into `/etc/youtube-dl.conf` and/or `~/.config/youtube-dl/config`. On Windows, the configuration file locations are `%APPDATA%\youtube-dl\config.txt` and `C:\Users\<Yourname>\youtube-dl.conf`.
268 The `-o` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parenthesis, followed by a lowercase S. Allowed names are:
270 - `id`: The sequence will be replaced by the video identifier.
271 - `url`: The sequence will be replaced by the video URL.
272 - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
273 - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
274 - `title`: The sequence will be replaced by the video title.
275 - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
276 - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
277 - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
278 - `playlist`: The name or the id of the playlist that contains the video.
279 - `playlist_index`: The index of the video in the playlist, a five-digit number.
281 The current default template is `%(title)s-%(id)s.%(ext)s`.
283 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:
285 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
286 youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
287 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
288 youtube-dl_test_video_.mp4 # A simple file name
292 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
294 - Absolute dates: Dates in the format `YYYYMMDD`.
295 - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
299 # Download only the videos uploaded in the last 6 months
300 $ youtube-dl --dateafter now-6months
302 # Download only the videos uploaded on January 1, 1970
303 $ youtube-dl --date 19700101
305 $ # will only download the videos uploaded in the 200x decade
306 $ youtube-dl --dateafter 20000101 --datebefore 20091231
310 ### Can you please put the -b option back?
312 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.
314 ### I get HTTP error 402 when trying to download a video. What's this?
316 Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
318 ### I have downloaded a video but how can I play it?
320 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
322 ### The links provided by youtube-dl -g are not working anymore
324 The URLs youtube-dl outputs require the downloader to have the correct 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.
326 ### ERROR: no fmt_url_map or conn information found in video info
328 youtube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
330 ### ERROR: unable to download video ###
332 youtube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
334 ### SyntaxError: Non-ASCII character ###
338 File "youtube-dl", line 2
339 SyntaxError: Non-ASCII character '\x93' ...
341 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
343 ### What is this binary file? Where has the code gone?
345 Since June 2012 (#342) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
347 ### The exe throws a *Runtime error from Visual C++*
349 To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29).
351 # DEVELOPER INSTRUCTIONS
353 Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
355 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
359 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
361 python -m unittest discover
362 python test/test_download.py
365 If you want to create a build of youtube-dl yourself, you'll need
373 ### Adding support for a new site
375 If you want to add support for a new site, you can follow this quick list (assuming your service is called `yourextractor`):
377 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
378 2. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
379 3. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
380 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
383 from __future__ import unicode_literals
387 from .common import InfoExtractor
390 class YourExtractorIE(InfoExtractor):
391 _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
393 'url': 'http://yourextractor.com/watch/42',
394 'md5': 'TODO: md5 sum of the first 10KiB of the video file',
398 'title': 'Video title goes here',
399 # TODO more properties, either as:
401 # * MD5 checksum; start the string with md5:
402 # * A regular expression; start the string with re:
403 # * Any Python type (for example int or float)
407 def _real_extract(self, url):
408 mobj = re.match(self._VALID_URL, url)
409 video_id = mobj.group('id')
411 # TODO more code goes here, for example ...
412 webpage = self._download_webpage(url, video_id)
413 title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
418 # TODO more properties (see youtube_dl/extractor/common.py)
422 5. Add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py).
423 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.
424 7. Have a look at [`youtube_dl/common/extractor/common.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should return](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L38). Add tests and code for as many as you want.
425 8. If you can, check the code with [pyflakes](https://pypi.python.org/pypi/pyflakes) (a good idea) and [pep8](https://pypi.python.org/pypi/pep8) (optional, ignore E501).
426 9. When the tests pass, [add](https://www.kernel.org/pub/software/scm/git/docs/git-add.html) the new files and [commit](https://www.kernel.org/pub/software/scm/git/docs/git-commit.html) them and [push](https://www.kernel.org/pub/software/scm/git/docs/git-push.html) the result, like this:
428 $ git add youtube_dl/extractor/__init__.py
429 $ git add youtube_dl/extractor/yourextractor.py
430 $ git commit -m '[yourextractor] Add new extractor'
431 $ git push origin yourextractor
433 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
435 In any case, thank you very much for your contributions!
439 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues> . Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email.
441 Please include the full output of the command when run with `--verbose`. The output (including the first lines) contain important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
443 For discussions, join us in the irc channel #youtube-dl on freenode.
445 When you submit a request, please re-read it once to avoid a couple of mistakes (you can and should use this as a checklist):
447 ### Is the description of the issue itself sufficient?
449 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.
451 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
453 - What the problem is
454 - How it could be fixed
455 - How your proposed solution would look like
457 If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a commiter myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
459 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.
461 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.
463 ### Are you using the latest version?
465 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.
467 ### Is the issue already documented?
469 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or at https://github.com/rg3/youtube-dl/search?type=Issues . If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
471 ### Why are existing options not enough?
473 Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#synopsis). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
475 ### Is there enough context in your bug report?
477 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).
479 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.
481 ### Does the issue involve one problem, and one problem only?
483 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.
485 In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
487 ### Is anyone going to need the feature?
489 Only post features that you (or an incapicated 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.
491 ### Is your question about youtube-dl?
493 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.
497 youtube-dl is released into the public domain by the copyright holders.
499 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.