]> jfr.im git - yt-dlp.git/blame - README.md
Merge remote-tracking branch 'origin/master'
[yt-dlp.git] / README.md
CommitLineData
d94adc26 1% YOUTUBE-DL(1)
6bcd846b 2
cfcec693
FV
3# NAME
4youtube-dl
6bcd846b 5
cfcec693
FV
6# SYNOPSIS
7**youtube-dl** [OPTIONS] URL [URL...]
8
9# DESCRIPTION
6bcd846b
DB
10**youtube-dl** is a small command-line program to download videos from
11YouTube.com and a few more sites. It requires the Python interpreter, version
280d6789
PH
122.6, 2.7, or 3.3+, and it is not platform specific. It should work on
13your Unix box, on Windows or on Mac OS X. It is released to the public domain,
6bcd846b
DB
14which means you can modify it, redistribute it or use it however you like.
15
cfcec693 16# OPTIONS
b625bc2c
PH
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
20 -i, --ignore-errors continue on download errors
21 -r, --rate-limit LIMIT maximum download rate (e.g. 50k or 44.6m)
22 -R, --retries RETRIES number of retries (default is 10)
23 --buffer-size SIZE size of download buffer (e.g. 1024 or 16k)
24 (default is 1024)
25 --no-resize-buffer do not automatically adjust the buffer size. By
26 default, the buffer size is automatically resized
27 from an initial value of SIZE.
28 --dump-user-agent display the current browser identification
29 --user-agent UA specify a custom user agent
3820df01
JMF
30 --referer REF specify a custom referer, use if the video access
31 is restricted to one domain
b625bc2c
PH
32 --list-extractors List all supported extractors and the URLs they
33 would handle
dbc50fdf 34 --proxy URL Use the specified HTTP/HTTPS proxy
08c1d0d3 35
cfcec693 36## Video Selection:
b625bc2c
PH
37 --playlist-start NUMBER playlist video to start at (default is 1)
38 --playlist-end NUMBER playlist video to end at (default is last)
39 --match-title REGEX download only matching titles (regex or caseless
40 sub-string)
41 --reject-title REGEX skip download for matching titles (regex or
42 caseless sub-string)
43 --max-downloads NUMBER Abort after downloading NUMBER files
44 --min-filesize SIZE Do not download any videos smaller than SIZE
45 (e.g. 50k or 44.6m)
46 --max-filesize SIZE Do not download any videos larger than SIZE (e.g.
47 50k or 44.6m)
fc63faf0
PH
48 --date DATE download only videos uploaded in this date
49 --datebefore DATE download only videos uploaded before this date
50 --dateafter DATE download only videos uploaded after this date
6bcd846b 51
cfcec693 52## Filesystem Options:
6ce533a2
PH
53 -t, --title use title in file name (default)
54 --id use only video ID in file name
b625bc2c
PH
55 -l, --literal [deprecated] alias of --title
56 -A, --auto-number number downloaded files starting from 00000
57 -o, --output TEMPLATE output filename template. Use %(title)s to get
58 the title, %(uploader)s for the uploader name,
59 %(uploader_id)s for the uploader nickname if
60 different, %(autonumber)s to get an automatically
61 incremented number, %(ext)s for the filename
62 extension, %(upload_date)s for the upload date
63 (YYYYMMDD), %(extractor)s for the provider
64 (youtube, metacafe, etc), %(id)s for the video id
8cb94542
PH
65 , %(playlist)s for the playlist the video is in,
66 %(playlist_index)s for the position in the
67 playlist and %% for a literal percent. Use - to
68 output to stdout. Can also be used to download to
69 a different directory, for example with -o '/my/d
70 ownloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
b625bc2c
PH
71 --autonumber-size NUMBER Specifies the number of digits in %(autonumber)s
72 when it is present in output filename template or
73 --autonumber option is given
74 --restrict-filenames Restrict filenames to only ASCII characters, and
75 avoid "&" and spaces in filenames
76 -a, --batch-file FILE file containing URLs to download ('-' for stdin)
77 -w, --no-overwrites do not overwrite files
78 -c, --continue resume partially downloaded files
79 --no-continue do not resume partially downloaded files (restart
80 from beginning)
81 --cookies FILE file to read cookies from and dump cookie jar in
82 --no-part do not use .part files
83 --no-mtime do not use the Last-modified header to set the
84 file modification time
85 --write-description write video description to a .description file
86 --write-info-json write video metadata to a .info.json file
6bcd846b 87
cfcec693 88## Verbosity / Simulation Options:
b625bc2c
PH
89 -q, --quiet activates quiet mode
90 -s, --simulate do not download the video and do not write
91 anything to disk
92 --skip-download do not download the video
93 -g, --get-url simulate, quiet but print URL
94 -e, --get-title simulate, quiet but print title
95 --get-thumbnail simulate, quiet but print thumbnail URL
96 --get-description simulate, quiet but print video description
97 --get-filename simulate, quiet but print output filename
98 --get-format simulate, quiet but print output format
99 --newline output progress bar as new lines
100 --no-progress do not print progress bar
101 --console-title display progress in console titlebar
102 -v, --verbose print various debugging information
103 --dump-intermediate-pages print downloaded pages to debug problems(very
104 verbose)
6bcd846b 105
cfcec693 106## Video Format Options:
f4b659f7
JMF
107 -f, --format FORMAT video format code, specifiy the order of
108 preference using slashes: "-f 22/17/18"
b625bc2c
PH
109 --all-formats download all available video formats
110 --prefer-free-formats prefer free video formats unless a specific one
111 is requested
112 --max-quality FORMAT highest quality format to download
113 -F, --list-formats list all available formats (currently youtube
114 only)
115 --write-sub write subtitle file (currently youtube only)
116 --only-sub downloads only the subtitles (no video)
117 --all-subs downloads all the available subtitles of the
118 video (currently youtube only)
119 --list-subs lists all available subtitles for the video
120 (currently youtube only)
121 --sub-format LANG subtitle format [srt/sbv] (default=srt)
122 (currently youtube only)
123 --sub-lang LANG language of the subtitles to download (optional)
124 use IETF language tags like 'en'
6bcd846b 125
cfcec693 126## Authentication Options:
b625bc2c
PH
127 -u, --username USERNAME account username
128 -p, --password PASSWORD account password
129 -n, --netrc use .netrc authentication data
6bcd846b 130
cfcec693 131## Post-processing Options:
b625bc2c
PH
132 -x, --extract-audio convert video files to audio-only files (requires
133 ffmpeg or avconv and ffprobe or avprobe)
134 --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a", "opus", or
135 "wav"; best by default
136 --audio-quality QUALITY ffmpeg/avconv audio quality specification, insert
137 a value between 0 (better) and 9 (worse) for VBR
138 or a specific bitrate like 128K (default 5)
139 --recode-video FORMAT Encode the video to another format if necessary
140 (currently supported: mp4|flv|ogg|webm)
141 -k, --keep-video keeps the video file on disk after the post-
142 processing; the video is erased by default
143 --no-post-overwrites do not overwrite post-processed files; the post-
144 processed files are overwritten by default
6bcd846b 145
df4bad32
PH
146# CONFIGURATION
147
280d6789 148You 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`.
df4bad32 149
02531431
PH
150# OUTPUT TEMPLATE
151
152The `-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:
153
154 - `id`: The sequence will be replaced by the video identifier.
155 - `url`: The sequence will be replaced by the video URL.
156 - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
157 - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
158 - `title`: The sequence will be replaced by the video title.
877f4c45
PH
159 - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
160 - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
161 - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
7eab8dc7 162 - `playlist`: The name or the id of the playlist that contains the video.
d281274b 163 - `playlist_index`: The index of the video in the playlist, a five-digit number.
02531431
PH
164
165The current default template is `%(id)s.%(ext)s`, but that will be switchted to `%(title)s-%(id)s.%(ext)s` (which can be requested with `-t` at the moment).
166
167In 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:
168
169 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
170 youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
171 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
172 youtube-dl_test_video_.mp4 # A simple file name
173
e31852ab
JMF
174# VIDEO SELECTION
175
176Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
177
178 - Absolute dates: Dates in the format `YYYYMMDD`.
179 - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
180
181Examples:
182
183 $ youtube-dl --dateafter now-6months #will only download the videos uploaded in the last 6 months
184 $ youtube-dl --date 19700101 #will only download the videos uploaded in January 1, 1970
185 $ youtube-dl --dateafter 20000101 --datebefore 20100101 #will only download the videos uploaded between 2000 and 2010
186
cfcec693 187# FAQ
447b1d71
PH
188
189### Can you please put the -b option back?
190
191Most 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.
192
f2a3a352 193### I get HTTP error 402 when trying to download a video. What's this?
447b1d71 194
8236e851 195Apparently 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
PH
196
197### I have downloaded a video but how can I play it?
198
199Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
200
201### The links provided by youtube-dl -g are not working anymore
202
a0432a1e 203The 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.
447b1d71 204
454d6691
PH
205### ERROR: no fmt_url_map or conn information found in video info
206
5a2ba45e 207youtube 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`.
454d6691 208
6c5b442a
PH
209### ERROR: unable to download video ###
210
211youtube 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`.
212
5cdfaeb3 213### SyntaxError: Non-ASCII character ###
6c5b442a
PH
214
215The error
216
217 File "youtube-dl", line 2
218 SyntaxError: Non-ASCII character '\x93' ...
219
220means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
221
5cdfaeb3
FV
222### What is this binary file? Where has the code gone?
223
71f36332 224Since 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 225
ce367443
FV
226### The exe throws a *Runtime error from Visual C++*
227
228To 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).
229
cfcec693 230# COPYRIGHT
803abae2
PH
231
232youtube-dl is released into the public domain by the copyright holders.
233
234This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
6bcd846b 235
cfcec693 236# BUGS
e133e121 237
8236e851 238Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
e133e121
PH
239
240Please include:
241
95fedbf8
FV
242* 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.
243* If possible re-run the command with `--verbose`, and include the full output, it is really helpful to us.
e133e121
PH
244* The output of `youtube-dl --version`
245* The output of `python --version`
246* The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).
4b235346
PH
247
248For discussions, join us in the irc channel #youtube-dl on freenode.