README.md
1# You-Get
2
3[](https://github.com/soimort/you-get/actions)
4[](https://pypi.python.org/pypi/you-get/)
5[](https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
6
7**NOTICE: Read [this](https://github.com/soimort/you-get/blob/develop/CONTRIBUTING.md) if you are looking for the conventional "Issues" tab.**
8
9---
10
11[You-Get](https://you-get.org/) is a tiny command-line utility to download media contents (videos, audios, images) from the Web, in case there is no other handy way to do it.
12
13Here's how you use `you-get` to download a video from [YouTube](https://www.youtube.com/watch?v=jNQXAC9IVRw):
14
15```console
16$ you-get 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
17site: YouTube
18title: Me at the zoo
19stream:
20 - itag: 43
21 container: webm
22 quality: medium
23 size: 0.5 MiB (564215 bytes)
24 # download-with: you-get --itag=43 [URL]
25
26Downloading Me at the zoo.webm ...
27 100% ( 0.5/ 0.5MB) ├██████████████████████████████████┤[1/1] 6 MB/s
28
29Saving Me at the zoo.en.srt ... Done.
30```
31
32And here's why you might want to use it:
33
34* You enjoyed something on the Internet, and just want to download them for your own pleasure.
35* You watch your favorite videos online from your computer, but you are prohibited from saving them. You feel that you have no control over your own computer. (And it's not how an open Web is supposed to work.)
36* You want to get rid of any closed-source technology or proprietary JavaScript code, and disallow things like Flash running on your computer.
37* You are an adherent of hacker culture and free software.
38
39What `you-get` can do for you:
40
41* Download videos / audios from popular websites such as YouTube, Youku, Niconico, and a bunch more. (See the [full list of supported sites](#supported-sites))
42* Stream an online video in your media player. No web browser, no more ads.
43* Download images (of interest) by scraping a web page.
44* Download arbitrary non-HTML contents, i.e., binary files.
45
46Interested? [Install it](#installation) now and [get started by examples](#getting-started).
47
48Are you a Python programmer? Then check out [the source](https://github.com/soimort/you-get) and fork it!
49
50
51
52## Installation
53
54### Prerequisites
55
56The following dependencies are necessary:
57
58* **[Python](https://www.python.org/downloads/)** 3.2 or above
59* **[FFmpeg](https://www.ffmpeg.org/)** 1.0 or above
60* (Optional) [RTMPDump](https://rtmpdump.mplayerhq.hu/)
61
62### Option 1: Install via pip
63
64The official release of `you-get` is distributed on [PyPI](https://pypi.python.org/pypi/you-get), and can be installed easily from a PyPI mirror via the [pip](https://en.wikipedia.org/wiki/Pip_\(package_manager\)) package manager. Note that you must use the Python 3 version of `pip`:
65
66 $ pip3 install you-get
67
68### Option 2: Install via [Antigen](https://github.com/zsh-users/antigen) (for Zsh users)
69
70Add the following line to your `.zshrc`:
71
72 antigen bundle soimort/you-get
73
74### Option 3: Download from GitHub
75
76You may either download the [stable](https://github.com/soimort/you-get/archive/master.zip) (identical with the latest release on PyPI) or the [develop](https://github.com/soimort/you-get/archive/develop.zip) (more hotfixes, unstable features) branch of `you-get`. Unzip it, and put the directory containing the `you-get` script into your `PATH`.
77
78Alternatively, run
79
80```
81$ [sudo] python3 setup.py install
82```
83
84Or
85
86```
87$ python3 setup.py install --user
88```
89
90to install `you-get` to a permanent path.
91
92### Option 4: Git clone
93
94This is the recommended way for all developers, even if you don't often code in Python.
95
96```
97$ git clone git://github.com/soimort/you-get.git
98```
99
100Then put the cloned directory into your `PATH`, or run `./setup.py install` to install `you-get` to a permanent path.
101
102### Option 5: Homebrew (Mac only)
103
104You can install `you-get` easily via:
105
106```
107$ brew install you-get
108```
109
110### Option 6: pkg (FreeBSD only)
111
112You can install `you-get` easily via:
113
114```
115# pkg install you-get
116```
117
118### Shell completion
119
120Completion definitions for Bash, Fish and Zsh can be found in [`contrib/completion`](https://github.com/soimort/you-get/tree/develop/contrib/completion). Please consult your shell's manual for how to take advantage of them.
121
122## Upgrading
123
124Based on which option you chose to install `you-get`, you may upgrade it via:
125
126```
127$ pip3 install --upgrade you-get
128```
129
130or download the latest release via:
131
132```
133$ you-get https://github.com/soimort/you-get/archive/master.zip
134```
135
136In order to get the latest ```develop``` branch without messing up the PIP, you can try:
137
138```
139$ pip3 install --upgrade git+https://github.com/soimort/you-get@develop
140```
141
142## Getting Started
143
144### Download a video
145
146When you get a video of interest, you might want to use the `--info`/`-i` option to see all available quality and formats:
147
148```
149$ you-get -i 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
150site: YouTube
151title: Me at the zoo
152streams: # Available quality and codecs
153 [ DASH ] ____________________________________
154 - itag: 242
155 container: webm
156 quality: 320x240
157 size: 0.6 MiB (618358 bytes)
158 # download-with: you-get --itag=242 [URL]
159
160 - itag: 395
161 container: mp4
162 quality: 320x240
163 size: 0.5 MiB (550743 bytes)
164 # download-with: you-get --itag=395 [URL]
165
166 - itag: 133
167 container: mp4
168 quality: 320x240
169 size: 0.5 MiB (498558 bytes)
170 # download-with: you-get --itag=133 [URL]
171
172 - itag: 278
173 container: webm
174 quality: 192x144
175 size: 0.4 MiB (392857 bytes)
176 # download-with: you-get --itag=278 [URL]
177
178 - itag: 160
179 container: mp4
180 quality: 192x144
181 size: 0.4 MiB (370882 bytes)
182 # download-with: you-get --itag=160 [URL]
183
184 - itag: 394
185 container: mp4
186 quality: 192x144
187 size: 0.4 MiB (367261 bytes)
188 # download-with: you-get --itag=394 [URL]
189
190 [ DEFAULT ] _________________________________
191 - itag: 43
192 container: webm
193 quality: medium
194 size: 0.5 MiB (568748 bytes)
195 # download-with: you-get --itag=43 [URL]
196
197 - itag: 18
198 container: mp4
199 quality: small
200 # download-with: you-get --itag=18 [URL]
201
202 - itag: 36
203 container: 3gp
204 quality: small
205 # download-with: you-get --itag=36 [URL]
206
207 - itag: 17
208 container: 3gp
209 quality: small
210 # download-with: you-get --itag=17 [URL]
211```
212
213By default, the one on the top is the one you will get. If that looks cool to you, download it:
214
215```
216$ you-get 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
217site: YouTube
218title: Me at the zoo
219stream:
220 - itag: 242
221 container: webm
222 quality: 320x240
223 size: 0.6 MiB (618358 bytes)
224 # download-with: you-get --itag=242 [URL]
225
226Downloading Me at the zoo.webm ...
227 100% ( 0.6/ 0.6MB) ├██████████████████████████████████████████████████████████████████████████████┤[2/2] 2 MB/s
228Merging video parts... Merged into Me at the zoo.webm
229
230Saving Me at the zoo.en.srt ... Done.
231```
232
233(If a YouTube video has any closed captions, they will be downloaded together with the video file, in SubRip subtitle format.)
234
235Or, if you prefer another format (mp4), just use whatever the option `you-get` shows to you:
236
237```
238$ you-get --itag=18 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
239```
240
241**Note:**
242
243* At this point, format selection has not been generally implemented for most of our supported sites; in that case, the default format to download is the one with the highest quality.
244* `ffmpeg` is a required dependency, for downloading and joining videos streamed in multiple parts (e.g. on some sites like Youku), and for YouTube videos of 1080p or high resolution.
245* If you don't want `you-get` to join video parts after downloading them, use the `--no-merge`/`-n` option.
246
247### Download anything else
248
249If you already have the URL of the exact resource you want, you can download it directly with:
250
251```
252$ you-get https://stallman.org/rms.jpg
253Site: stallman.org
254Title: rms
255Type: JPEG Image (image/jpeg)
256Size: 0.06 MiB (66482 Bytes)
257
258Downloading rms.jpg ...
259100.0% ( 0.1/0.1 MB) ├████████████████████████████████████████┤[1/1] 127 kB/s
260```
261
262Otherwise, `you-get` will scrape the web page and try to figure out if there's anything interesting to you:
263
264```
265$ you-get http://kopasas.tumblr.com/post/69361932517
266Site: Tumblr.com
267Title: kopasas
268Type: Unknown type (None)
269Size: 0.51 MiB (536583 Bytes)
270
271Site: Tumblr.com
272Title: tumblr_mxhg13jx4n1sftq6do1_1280
273Type: Portable Network Graphics (image/png)
274Size: 0.51 MiB (536583 Bytes)
275
276Downloading tumblr_mxhg13jx4n1sftq6do1_1280.png ...
277100.0% ( 0.5/0.5 MB) ├████████████████████████████████████████┤[1/1] 22 MB/s
278```
279
280**Note:**
281
282* This feature is an experimental one and far from perfect. It works best on scraping large-sized images from popular websites like Tumblr and Blogger, but there is really no universal pattern that can apply to any site on the Internet.
283
284### Search on Google Videos and download
285
286You can pass literally anything to `you-get`. If it isn't a valid URL, `you-get` will do a Google search and download the most relevant video for you. (It might not be exactly the thing you wish to see, but still very likely.)
287
288```
289$ you-get "Richard Stallman eats"
290```
291
292### Pause and resume a download
293
294You may use <kbd>Ctrl</kbd>+<kbd>C</kbd> to interrupt a download.
295
296A temporary `.download` file is kept in the output directory. Next time you run `you-get` with the same arguments, the download progress will resume from the last session. In case the file is completely downloaded (the temporary `.download` extension is gone), `you-get` will just skip the download.
297
298To enforce re-downloading, use the `--force`/`-f` option. (**Warning:** doing so will overwrite any existing file or temporary file with the same name!)
299
300### Set the path and name of downloaded file
301
302Use the `--output-dir`/`-o` option to set the path, and `--output-filename`/`-O` to set the name of the downloaded file:
303
304```
305$ you-get -o ~/Videos -O zoo.webm 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
306```
307
308**Tips:**
309
310* These options are helpful if you encounter problems with the default video titles, which may contain special characters that do not play well with your current shell / operating system / filesystem.
311* These options are also helpful if you write a script to batch download files and put them into designated folders with designated names.
312
313### Proxy settings
314
315You may specify an HTTP proxy for `you-get` to use, via the `--http-proxy`/`-x` option:
316
317```
318$ you-get -x 127.0.0.1:8087 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
319```
320
321However, the system proxy setting (i.e. the environment variable `http_proxy`) is applied by default. To disable any proxy, use the `--no-proxy` option.
322
323**Tips:**
324
325* If you need to use proxies a lot (in case your network is blocking certain sites), you might want to use `you-get` with [proxychains](https://github.com/rofl0r/proxychains-ng) and set `alias you-get="proxychains -q you-get"` (in Bash).
326* For some websites (e.g. Youku), if you need access to some videos that are only available in mainland China, there is an option of using a specific proxy to extract video information from the site: `--extractor-proxy`/`-y`.
327
328### Watch a video
329
330Use the `--player`/`-p` option to feed the video into your media player of choice, e.g. `mpv` or `vlc`, instead of downloading it:
331
332```
333$ you-get -p vlc 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
334```
335
336Or, if you prefer to watch the video in a browser, just without ads or comment section:
337
338```
339$ you-get -p chromium 'https://www.youtube.com/watch?v=jNQXAC9IVRw'
340```
341
342**Tips:**
343
344* It is possible to use the `-p` option to start another download manager, e.g., `you-get -p uget-gtk 'https://www.youtube.com/watch?v=jNQXAC9IVRw'`, though they may not play together very well.
345
346### Load cookies
347
348Not all videos are publicly available to anyone. If you need to log in your account to access something (e.g., a private video), it would be unavoidable to feed the browser cookies to `you-get` via the `--cookies`/`-c` option.
349
350**Note:**
351
352* As of now, we are supporting two formats of browser cookies: Mozilla `cookies.sqlite` and Netscape `cookies.txt`.
353
354### Reuse extracted data
355
356Use `--url`/`-u` to get a list of downloadable resource URLs extracted from the page. Use `--json` to get an abstract of extracted data in the JSON format.
357
358**Warning:**
359
360* For the time being, this feature has **NOT** been stabilized and the JSON schema may have breaking changes in the future.
361
362## Supported Sites
363
364| Site | URL | Videos? | Images? | Audios? |
365| :--: | :-- | :-----: | :-----: | :-----: |
366| **YouTube** | <https://www.youtube.com/> |✓| | |
367| **Twitter** | <https://twitter.com/> |✓|✓| |
368| VK | <http://vk.com/> |✓|✓| |
369| Vine | <https://vine.co/> |✓| | |
370| Vimeo | <https://vimeo.com/> |✓| | |
371| Veoh | <http://www.veoh.com/> |✓| | |
372| **Tumblr** | <https://www.tumblr.com/> |✓|✓|✓|
373| TED | <http://www.ted.com/> |✓| | |
374| SoundCloud | <https://soundcloud.com/> | | |✓|
375| SHOWROOM | <https://www.showroom-live.com/> |✓| | |
376| Pinterest | <https://www.pinterest.com/> | |✓| |
377| MTV81 | <http://www.mtv81.com/> |✓| | |
378| Mixcloud | <https://www.mixcloud.com/> | | |✓|
379| Metacafe | <http://www.metacafe.com/> |✓| | |
380| Magisto | <http://www.magisto.com/> |✓| | |
381| Khan Academy | <https://www.khanacademy.org/> |✓| | |
382| Internet Archive | <https://archive.org/> |✓| | |
383| **Instagram** | <https://instagram.com/> |✓|✓| |
384| InfoQ | <http://www.infoq.com/presentations/> |✓| | |
385| Imgur | <http://imgur.com/> | |✓| |
386| Heavy Music Archive | <http://www.heavy-music.ru/> | | |✓|
387| Freesound | <http://www.freesound.org/> | | |✓|
388| Flickr | <https://www.flickr.com/> |✓|✓| |
389| FC2 Video | <http://video.fc2.com/> |✓| | |
390| Facebook | <https://www.facebook.com/> |✓| | |
391| eHow | <http://www.ehow.com/> |✓| | |
392| Dailymotion | <http://www.dailymotion.com/> |✓| | |
393| Coub | <http://coub.com/> |✓| | |
394| CBS | <http://www.cbs.com/> |✓| | |
395| Bandcamp | <http://bandcamp.com/> | | |✓|
396| AliveThai | <http://alive.in.th/> |✓| | |
397| interest.me | <http://ch.interest.me/tvn> |✓| | |
398| **755<br/>ナナゴーゴー** | <http://7gogo.jp/> |✓|✓| |
399| **niconico<br/>ニコニコ動画** | <http://www.nicovideo.jp/> |✓| | |
400| **163<br/>网易视频<br/>网易云音乐** | <http://v.163.com/><br/><http://music.163.com/> |✓| |✓|
401| 56网 | <http://www.56.com/> |✓| | |
402| **AcFun** | <http://www.acfun.cn/> |✓| | |
403| **Baidu<br/>百度贴吧** | <http://tieba.baidu.com/> |✓|✓| |
404| 爆米花网 | <http://www.baomihua.com/> |✓| | |
405| **bilibili<br/>哔哩哔哩** | <http://www.bilibili.com/> |✓|✓|✓|
406| 豆瓣 | <http://www.douban.com/> |✓| |✓|
407| 斗鱼 | <http://www.douyutv.com/> |✓| | |
408| 凤凰视频 | <http://v.ifeng.com/> |✓| | |
409| 风行网 | <http://www.fun.tv/> |✓| | |
410| iQIYI<br/>爱奇艺 | <http://www.iqiyi.com/> |✓| | |
411| 激动网 | <http://www.joy.cn/> |✓| | |
412| 酷6网 | <http://www.ku6.com/> |✓| | |
413| 酷狗音乐 | <http://www.kugou.com/> | | |✓|
414| 酷我音乐 | <http://www.kuwo.cn/> | | |✓|
415| 乐视网 | <http://www.le.com/> |✓| | |
416| 荔枝FM | <http://www.lizhi.fm/> | | |✓|
417| 懒人听书 | <http://www.lrts.me/> | | |✓|
418| 秒拍 | <http://www.miaopai.com/> |✓| | |
419| MioMio弹幕网 | <http://www.miomio.tv/> |✓| | |
420| MissEvan<br/>猫耳FM | <http://www.missevan.com/> | | |✓|
421| 痞客邦 | <https://www.pixnet.net/> |✓| | |
422| PPTV聚力 | <http://www.pptv.com/> |✓| | |
423| 齐鲁网 | <http://v.iqilu.com/> |✓| | |
424| QQ<br/>腾讯视频 | <http://v.qq.com/> |✓| | |
425| 企鹅直播 | <http://live.qq.com/> |✓| | |
426| Sina<br/>新浪视频<br/>微博秒拍视频 | <http://video.sina.com.cn/><br/><http://video.weibo.com/> |✓| | |
427| Sohu<br/>搜狐视频 | <http://tv.sohu.com/> |✓| | |
428| **Tudou<br/>土豆** | <http://www.tudou.com/> |✓| | |
429| 阳光卫视 | <http://www.isuntv.com/> |✓| | |
430| **Youku<br/>优酷** | <http://www.youku.com/> |✓| | |
431| 战旗TV | <http://www.zhanqi.tv/lives> |✓| | |
432| 央视网 | <http://www.cntv.cn/> |✓| | |
433| Naver<br/>네이버 | <http://tvcast.naver.com/> |✓| | |
434| 芒果TV | <http://www.mgtv.com/> |✓| | |
435| 火猫TV | <http://www.huomao.com/> |✓| | |
436| 阳光宽频网 | <http://www.365yg.com/> |✓| | |
437| 西瓜视频 | <https://www.ixigua.com/> |✓| | |
438| 新片场 | <https://www.xinpianchang.com/> |✓| | |
439| 快手 | <https://www.kuaishou.com/> |✓|✓| |
440| 抖音 | <https://www.douyin.com/> |✓| | |
441| TikTok | <https://www.tiktok.com/> |✓| | |
442| 中国体育(TV) | <http://v.zhibo.tv/> </br><http://video.zhibo.tv/> |✓| | |
443| 知乎 | <https://www.zhihu.com/> |✓| | |
444
445For all other sites not on the list, the universal extractor will take care of finding and downloading interesting resources from the page.
446
447### Known bugs
448
449If something is broken and `you-get` can't get you things you want, don't panic. (Yes, this happens all the time!)
450
451Check if it's already a known problem on <https://github.com/soimort/you-get/wiki/Known-Bugs>. If not, follow the guidelines on [how to report an issue](https://github.com/soimort/you-get/blob/develop/CONTRIBUTING.md).
452
453## Getting Involved
454
455You can reach us on the Gitter channel [#soimort/you-get](https://gitter.im/soimort/you-get) (here's how you [set up your IRC client](http://irc.gitter.im) for Gitter). If you have a quick question regarding `you-get`, ask it there.
456
457If you are seeking to report an issue or contribute, please make sure to read [the guidelines](https://github.com/soimort/you-get/blob/develop/CONTRIBUTING.md) first.
458
459## Legal Issues
460
461This software is distributed under the [MIT license](https://raw.github.com/soimort/you-get/master/LICENSE.txt).
462
463In particular, please be aware that
464
465> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
466IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
467FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
468AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
469LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
470OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
471SOFTWARE.
472
473Translated to human words:
474
475*In case your use of the software forms the basis of copyright infringement, or you use the software for any other illegal purposes, the authors cannot take any responsibility for you.*
476
477We only ship the code here, and how you are going to use it is left to your own discretion.
478
479## Authors
480
481Made by [@soimort](https://github.com/soimort), who is in turn powered by :coffee:, :beer: and :ramen:.
482
483You can find the [list of all contributors](https://github.com/soimort/you-get/graphs/contributors) here.
484
1You-Get
2=======
3
4|PyPI version| |Build Status| |Gitter|
5
6`You-Get <https://you-get.org/>`__ is a tiny command-line utility to
7download media contents (videos, audios, images) from the Web, in case
8there is no other handy way to do it.
9
10Here's how you use ``you-get`` to download a video from `this web
11page <http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society>`__:
12
13.. code:: console
14
15 $ you-get http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society
16 Site: fsf.org
17 Title: TEDxGE2014_Stallman05_LQ
18 Type: WebM video (video/webm)
19 Size: 27.12 MiB (28435804 Bytes)
20
21 Downloading TEDxGE2014_Stallman05_LQ.webm ...
22 100.0% ( 27.1/27.1 MB) ├████████████████████████████████████████┤[1/1] 12 MB/s
23
24And here's why you might want to use it:
25
26- You enjoyed something on the Internet, and just want to download them
27 for your own pleasure.
28- You watch your favorite videos online from your computer, but you are
29 prohibited from saving them. You feel that you have no control over
30 your own computer. (And it's not how an open Web is supposed to
31 work.)
32- You want to get rid of any closed-source technology or proprietary
33 JavaScript code, and disallow things like Flash running on your
34 computer.
35- You are an adherent of hacker culture and free software.
36
37What ``you-get`` can do for you:
38
39- Download videos / audios from popular websites such as YouTube,
40 Youku, Niconico, and a bunch more. (See the `full list of supported
41 sites <#supported-sites>`__)
42- Stream an online video in your media player. No web browser, no more
43 ads.
44- Download images (of interest) by scraping a web page.
45- Download arbitrary non-HTML contents, i.e., binary files.
46
47Interested? `Install it <#installation>`__ now and `get started by
48examples <#getting-started>`__.
49
50Are you a Python programmer? Then check out `the
51source <https://github.com/soimort/you-get>`__ and fork it!
52
53.. |PyPI version| image:: https://badge.fury.io/py/you-get.png
54 :target: http://badge.fury.io/py/you-get
55.. |Build Status| image:: https://api.travis-ci.org/soimort/you-get.png
56 :target: https://travis-ci.org/soimort/you-get
57.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
58 :target: https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
59
){kind=link}
){kind=link}
){kind=link}
){kind=link}
