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