2012-11-27 23:58:50 +08:00
% YOUTUBE-DL(1)
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
# NAME
2013-06-23 06:03:28 +08:00
youtube-dl - download videos from youtube.com or other video platforms
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
# SYNOPSIS
**youtube-dl** [OPTIONS] URL [URL...]
# DESCRIPTION
2011-08-06 07:14:13 +08:00
**youtube-dl** is a small command-line program to download videos from
YouTube.com and a few more sites. It requires the Python interpreter, version
2013-01-11 06:20:26 +08:00
2.6, 2.7, or 3.3+, 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,
2011-08-06 07:14:13 +08:00
which means you can modify it, redistribute it or use it however you like.
2012-08-01 17:53:17 +08:00
# OPTIONS
2013-04-12 00:42:57 +08:00
-h, --help print this help text and exit
--version print program version and exit
2013-07-20 05:42:29 +08:00
-U, --update update this program to latest version. Make sure
that you have sufficient permissions (run with
sudo if needed)
2013-09-20 16:24:48 +08:00
-i, --ignore-errors continue on download errors, for example to to
skip unavailable videos in a playlist
2013-10-19 05:22:54 +08:00
--abort-on-error Abort downloading of further videos (in the
playlist or the command line) if an error occurs
2013-04-12 00:42:57 +08:00
--dump-user-agent display the current browser identification
--user-agent UA specify a custom user agent
2013-04-27 01:25:17 +08:00
--referer REF specify a custom referer, use if the video access
is restricted to one domain
2013-04-12 00:42:57 +08:00
--list-extractors List all supported extractors and the URLs they
would handle
2013-07-02 15:14:09 +08:00
--extractor-descriptions Output descriptions of all supported extractors
2013-05-01 00:27:54 +08:00
--proxy URL Use the specified HTTP/HTTPS proxy
2013-05-04 18:31:17 +08:00
--no-check-certificate Suppress HTTPS certificate validation.
2013-10-19 05:22:54 +08:00
--cache-dir DIR Location in the filesystem where youtube-dl can
2013-10-04 06:38:19 +08:00
store downloaded information permanently. By
default $XDG_CACHE_HOME/youtube-dl or ~/.cache
/youtube-dl .
2013-09-25 03:40:47 +08:00
--no-cache-dir Disable filesystem caching
2011-09-15 04:55:09 +08:00
2012-08-01 17:53:17 +08:00
## Video Selection:
2013-04-12 00:42:57 +08:00
--playlist-start NUMBER playlist video to start at (default is 1)
--playlist-end NUMBER playlist video to end at (default is last)
--match-title REGEX download only matching titles (regex or caseless
sub-string)
--reject-title REGEX skip download for matching titles (regex or
caseless sub-string)
--max-downloads NUMBER Abort after downloading NUMBER files
--min-filesize SIZE Do not download any videos smaller than SIZE
(e.g. 50k or 44.6m)
--max-filesize SIZE Do not download any videos larger than SIZE (e.g.
50k or 44.6m)
2013-04-28 21:53:14 +08:00
--date DATE download only videos uploaded in this date
--datebefore DATE download only videos uploaded before this date
--dateafter DATE download only videos uploaded after this date
2013-10-01 04:26:25 +08:00
--no-playlist download only the currently playing video
2013-10-07 20:34:19 +08:00
--age-limit YEARS download only videos suitable for the given age
2013-12-03 20:13:09 +08:00
--download-archive FILE Download only videos not listed in the archive
2013-12-02 20:37:26 +08:00
file. Record the IDs of all downloaded videos in
it.
2011-08-06 07:14:13 +08:00
2013-07-02 15:14:09 +08:00
## Download Options:
2013-10-15 18:06:45 +08:00
-r, --rate-limit LIMIT maximum download rate in bytes per second (e.g.
50K or 4.2M)
2013-07-02 15:14:09 +08:00
-R, --retries RETRIES number of retries (default is 10)
2013-10-15 18:06:45 +08:00
--buffer-size SIZE size of download buffer (e.g. 1024 or 16K)
2013-07-02 15:14:09 +08:00
(default is 1024)
--no-resize-buffer do not automatically adjust the buffer size. By
default, the buffer size is automatically resized
from an initial value of SIZE.
2012-08-01 17:53:17 +08:00
## Filesystem Options:
2013-04-28 22:32:05 +08:00
-t, --title use title in file name (default)
--id use only video ID in file name
2013-04-12 00:42:57 +08:00
-l, --literal [deprecated] alias of --title
-A, --auto-number number downloaded files starting from 00000
-o, --output TEMPLATE output filename template. Use %(title)s to get
the title, %(uploader)s for the uploader name,
%(uploader_id)s for the uploader nickname if
different, %(autonumber)s to get an automatically
incremented number, %(ext)s for the filename
2013-10-19 05:22:54 +08:00
extension, %(format)s for the format description
2013-10-28 18:34:21 +08:00
(like "22 - 1280x720" or "HD"),%(format_id)s for
the unique id of the format (like Youtube's
itags: "137"),%(upload_date)s for the upload date
(YYYYMMDD), %(extractor)s for the provider
(youtube, metacafe, etc), %(id)s for the video id
, %(playlist)s for the playlist the video is in,
%(playlist_index)s for the position in the
playlist and %% for a literal percent. Use - to
output to stdout. Can also be used to download to
a different directory, for example with -o '/my/d
ownloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
2013-04-12 00:42:57 +08:00
--autonumber-size NUMBER Specifies the number of digits in %(autonumber)s
when it is present in output filename template or
2013-11-12 01:28:17 +08:00
--auto-number option is given
2013-04-12 00:42:57 +08:00
--restrict-filenames Restrict filenames to only ASCII characters, and
avoid "& " and spaces in filenames
-a, --batch-file FILE file containing URLs to download ('-' for stdin)
-w, --no-overwrites do not overwrite files
2013-11-12 01:28:17 +08:00
-c, --continue force resume of partially downloaded files. By
default, youtube-dl will resume downloads if
possible.
2013-04-12 00:42:57 +08:00
--no-continue do not resume partially downloaded files (restart
from beginning)
--cookies FILE file to read cookies from and dump cookie jar in
--no-part do not use .part files
--no-mtime do not use the Last-modified header to set the
file modification time
--write-description write video description to a .description file
--write-info-json write video metadata to a .info.json file
2013-10-15 18:06:45 +08:00
--write-annotations write video annotations to a .annotation file
2013-05-01 20:07:23 +08:00
--write-thumbnail write thumbnail image to disk
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
## Verbosity / Simulation Options:
2013-04-12 00:42:57 +08:00
-q, --quiet activates quiet mode
-s, --simulate do not download the video and do not write
anything to disk
--skip-download do not download the video
-g, --get-url simulate, quiet but print URL
-e, --get-title simulate, quiet but print title
2013-05-06 13:30:07 +08:00
--get-id simulate, quiet but print id
2013-04-12 00:42:57 +08:00
--get-thumbnail simulate, quiet but print thumbnail URL
--get-description simulate, quiet but print video description
--get-filename simulate, quiet but print output filename
--get-format simulate, quiet but print output format
2013-11-20 14:25:17 +08:00
-j, --dump-json simulate, quiet but print JSON information
2013-04-12 00:42:57 +08:00
--newline output progress bar as new lines
--no-progress do not print progress bar
--console-title display progress in console titlebar
-v, --verbose print various debugging information
--dump-intermediate-pages print downloaded pages to debug problems(very
verbose)
2013-12-02 20:37:26 +08:00
--write-pages Write downloaded intermediary pages to files in
the current directory to debug problems
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
## Video Format Options:
2013-11-29 16:44:05 +08:00
-f, --format FORMAT video format code, specify the order of
2013-09-04 20:33:32 +08:00
preference using slashes: "-f 22/17/18". "-f mp4"
and "-f flv" are also supported
2013-04-12 00:42:57 +08:00
--all-formats download all available video formats
--prefer-free-formats prefer free video formats unless a specific one
is requested
--max-quality FORMAT highest quality format to download
-F, --list-formats list all available formats (currently youtube
only)
2013-08-24 05:09:53 +08:00
## Subtitle Options:
2013-09-12 17:26:44 +08:00
--write-sub write subtitle file
--write-auto-sub write automatic subtitle file (youtube only)
2013-04-12 00:42:57 +08:00
--all-subs downloads all the available subtitles of the
2013-08-24 05:09:53 +08:00
video
2013-04-12 00:42:57 +08:00
--list-subs lists all available subtitles for the video
2013-08-24 05:09:53 +08:00
--sub-format FORMAT subtitle format (default=srt) ([sbv/vtt] youtube
only)
--sub-lang LANGS languages of the subtitles to download (optional)
separated by commas, use IETF language tags like
'en,pt'
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
## Authentication Options:
2013-04-12 00:42:57 +08:00
-u, --username USERNAME account username
-p, --password PASSWORD account password
-n, --netrc use .netrc authentication data
2013-06-26 04:42:02 +08:00
--video-password PASSWORD video password (vimeo only)
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
## Post-processing Options:
2013-04-12 00:42:57 +08:00
-x, --extract-audio convert video files to audio-only files (requires
ffmpeg or avconv and ffprobe or avprobe)
--audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a", "opus", or
"wav"; best by default
--audio-quality QUALITY ffmpeg/avconv audio quality specification, insert
a value between 0 (better) and 9 (worse) for VBR
or a specific bitrate like 128K (default 5)
--recode-video FORMAT Encode the video to another format if necessary
(currently supported: mp4|flv|ogg|webm)
-k, --keep-video keeps the video file on disk after the post-
processing; the video is erased by default
--no-post-overwrites do not overwrite post-processed files; the post-
processed files are overwritten by default
2013-08-24 05:09:53 +08:00
--embed-subs embed subtitles in the video (only for mp4
videos)
2013-10-15 18:06:45 +08:00
--add-metadata add metadata to the files
2011-08-06 07:14:13 +08:00
2012-11-27 06:24:55 +08:00
# CONFIGURATION
2013-12-03 20:09:48 +08:00
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.conf` . On Windows, the configuration file locations are `%APPDATA%\youtube-dl\config.txt` and `C:\Users\<Yourname>\youtube-dl.conf` .
2012-11-27 06:24:55 +08:00
2012-11-27 23:27:35 +08:00
# OUTPUT TEMPLATE
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:
- `id` : The sequence will be replaced by the video identifier.
- `url` : The sequence will be replaced by the video URL.
- `uploader` : The sequence will be replaced by the nickname of the person who uploaded the video.
- `upload_date` : The sequence will be replaced by the upload date in YYYYMMDD format.
- `title` : The sequence will be replaced by the video title.
2012-11-27 23:28:21 +08:00
- `ext` : The sequence will be replaced by the appropriate extension (like flv or mp4).
- `epoch` : The sequence will be replaced by the Unix epoch when creating the file.
- `autonumber` : The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
2013-03-29 19:32:42 +08:00
- `playlist` : The name or the id of the playlist that contains the video.
2013-04-16 21:13:29 +08:00
- `playlist_index` : The index of the video in the playlist, a five-digit number.
2012-11-27 23:27:35 +08:00
2013-06-29 22:35:28 +08:00
The current default template is `%(title)s-%(id)s.%(ext)s` .
2012-11-27 23:27:35 +08:00
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:
$ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
youtube-dl test video ''_ä↭𝕐
$ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
youtube-dl_test_video_.mp4 # A simple file name
2013-04-28 18:02:30 +08:00
# VIDEO SELECTION
Videos can be filtered by their upload date using the options `--date` , `--datebefore` or `--dateafter` , they accept dates in two formats:
- Absolute dates: Dates in the format `YYYYMMDD` .
- Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
Examples:
$ youtube-dl --dateafter now-6months #will only download the videos uploaded in the last 6 months
$ youtube-dl --date 19700101 #will only download the videos uploaded in January 1, 1970
$ youtube-dl --dateafter 20000101 --datebefore 20100101 #will only download the videos uploaded between 2000 and 2010
2012-08-01 17:53:17 +08:00
# FAQ
2011-09-04 17:41:54 +08:00
### Can you please put the -b option back?
2013-07-02 13:39:54 +08:00
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.
2011-09-04 17:41:54 +08:00
2011-09-15 03:18:22 +08:00
### I get HTTP error 402 when trying to download a video. What's this?
2011-09-04 17:41:54 +08:00
2013-07-02 13:39:54 +08:00
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.
2011-09-04 17:41:54 +08:00
### I have downloaded a video but how can I play it?
Once the video is fully downloaded, use any video player, such as [vlc ](http://www.videolan.org ) or [mplayer ](http://www.mplayerhq.hu/ ).
### The links provided by youtube-dl -g are not working anymore
2012-03-15 21:56:08 +08:00
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.
2011-09-04 17:41:54 +08:00
2011-09-09 14:41:52 +08:00
### ERROR: no fmt_url_map or conn information found in video info
2011-09-14 03:51:06 +08:00
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` .
2011-09-09 14:41:52 +08:00
2012-09-28 05:30:17 +08:00
### ERROR: unable to download video ###
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` .
2012-09-29 01:55:18 +08:00
### SyntaxError: Non-ASCII character ###
2012-09-28 05:30:17 +08:00
The error
File "youtube-dl", line 2
SyntaxError: Non-ASCII character '\x93' ...
means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
2012-09-29 01:55:18 +08:00
### What is this binary file? Where has the code gone?
2012-11-27 06:40:51 +08:00
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` .
2012-09-29 01:55:18 +08:00
2012-09-29 21:35:07 +08:00
### The exe throws a *Runtime error from Visual C++*
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 ).
2012-08-01 17:53:17 +08:00
# COPYRIGHT
2011-09-14 05:54:30 +08:00
youtube-dl is released into the public domain by the copyright holders.
This README file was originally written by Daniel Bolton (< https: / / github . com / dbbolton > ) and is likewise released into the public domain.
2011-08-06 07:14:13 +08:00
2012-08-01 17:53:17 +08:00
# BUGS
2011-09-09 14:47:00 +08:00
2011-09-14 05:58:31 +08:00
Bugs and suggestions should be reported at: < https: / / github . com / rg3 / youtube-dl / issues >
2011-09-09 14:47:00 +08:00
Please include:
2013-01-01 02:09:37 +08:00
* Your exact command line, like `youtube-dl -t "http://www.youtube.com/watch?v=uHlDtZ6Oc3s&feature=channel_video_title"` . A common mistake is not to escape the `&` . Putting URLs in quotes should solve this problem.
* If possible re-run the command with `--verbose` , and include the full output, it is really helpful to us.
2011-09-09 14:47:00 +08:00
* The output of `youtube-dl --version`
* The output of `python --version`
* The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).
2012-11-30 02:45:07 +08:00
For discussions, join us in the irc channel #youtube -dl on freenode.
