/annie

👾 Fast, simple and clean video downloader

Primary LanguageGoMIT LicenseMIT

Annie

Codecov Build Status Go Report Card GitHub release homebrew

👾 Annie is a fast, simple and clean video downloader built with Go.

Installation

Prerequisites

The following dependencies are required and must be installed separately.

Note: FFmpeg does not affect the download, only affects the final file merge.

Install via go get

To install Annie, use go get, or download the binary file from Releases page.

$ go get github.com/iawia002/annie

Homebrew (macOS only)

For macOS users, you can install annie via:

$ brew install annie

Arch Linux

For Arch Users AUR package is available.

Void Linux

For Void linux users, you can install annie via:

$ xbps-install -S annie

Getting Started

Download a video

$ annie https://youtu.be/Gnbch2osEeo

 Site:      YouTube youtube.com
 Title:     Multifandom Mashup 2017
 Type:      video
 Stream:
     [default]  -------------------
     Quality:         hd720
     Size:            57.97 MiB (60785404 Bytes)
     # download with: annie -f default "URL"

 11.93 MiB / 57.97 MiB [======>-------------------------]  20.57% 19.03 MiB/s 2s

Note: wrap the URL in quotation marks if it contains special characters. (thanks @tonyxyl for pointing this out)

$ annie 'https://...'

The -i option displays all available quality and formats of video in the supplied link without downloading.

$ annie -i https://youtu.be/Gnbch2osEeo

 Site:      YouTube youtube.com
 Title:     Multifandom Mashup 2017
 Type:      video
 Streams:   # All available quality
     [43]  -------------------
     Quality:         medium
     Size:            31.95 MiB (33505824 Bytes)
     # download with: annie -f 43 "URL"

     [18]  -------------------
     Quality:         medium
     Size:            24.81 MiB (26011062 Bytes)
     # download with: annie -f 18 "URL"

     [36]  -------------------
     Quality:         small
     Size:            8.67 MiB (9088579 Bytes)
     # download with: annie -f 36 "URL"

     [17]  -------------------
     Quality:         small
     Size:            3.10 MiB (3248257 Bytes)
     # download with: annie -f 17 "URL"

     [default]  -------------------
     Quality:         hd720
     Size:            57.97 MiB (60785404 Bytes)
     # download with: annie -f default "URL"

Use annie -f format "URL" to download a specific format listed in the output of -i option.

Download anything else

If Annie is provided the URL of a specific resource, then it will be downloaded directly:

$ annie https://img9.bcyimg.com/drawer/15294/post/1799t/1f5a87801a0711e898b12b640777720f.jpg

annie doesn't support this URL right now, but it will try to download it directly

 Site:      Universal
 Title:     1f5a87801a0711e898b12b640777720f
 Type:      image/jpeg
 Stream:
     [default]  -------------------
     Size:            1.00 MiB (1051042 Bytes)
     # download with: annie -f default "URL"

 1.00 MiB / 1.00 MiB [===================================] 100.00% 1.21 MiB/s 0s

Download playlist

The -p option downloads an entire playlist instead of a single video.

$ annie -i -p https://www.bilibili.com/bangumi/play/ep198061

 Site:      哔哩哔哩 bilibili.com
 Title:     Doctor X 第四季：第一集
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            845.66 MiB (886738354 Bytes)
     # download with: annie -f default "URL"


 Site:      哔哩哔哩 bilibili.com
 Title:     Doctor X 第四季：第二集
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            930.71 MiB (975919195 Bytes)
     # download with: annie -f default "URL"

......

You can use the -start, -end or -items option to specify the download range of the list:

-start
    	Playlist video to start at (default 1)
-end
    	Playlist video to end at (default is last)
-items
    	Playlist video items to download. Separated by commas like: 1,5,6

Multiple inputs

You can also download multiple URLs at once:

$ annie -i https://www.bilibili.com/video/av21877586 https://www.bilibili.com/video/av21990740

 Site:      哔哩哔哩 bilibili.com
 Title:     【莓机会了】甜到虐哭的13集单集MAD「我现在什么都不想干,更不想看14集」
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            51.88 MiB (54403767 Bytes)
     # download with: annie -f default "URL"


 Site:      哔哩哔哩 bilibili.com
 Title:     【莓救了】甜到虐哭！！！国家队单集MAD-当熟悉的bgm响起，眼泪从脸颊滑下
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            77.63 MiB (81404093 Bytes)
     # download with: annie -f default "URL"

These URLs will be downloaded one by one.

You can also use the -F option to read URLs from file:

$ annie -F ~/Desktop/u.txt

 Site:      微博 weibo.com
 Title:     在Google，我们设计什么？ via@阑夕
 Type:      video
 Stream:
     [default]  -------------------
     Size:            19.19 MiB (20118196 Bytes)
     # download with: annie -f default "URL"

 19.19 MiB / 19.19 MiB [=================================] 100.00% 9.69 MiB/s 1s

......

Resume a download

Ctrl+C interrupts a download.

A temporary .download file is kept in the output directory. If annie is ran with the same arguments, then the download progress will resume from the last session.

Cookies

Cookies can be provided to annie with the -c option if they are required for accessing the video.

Note: cookies must match the following format:

name=value; name2=value2; ...

Cookies can be a string or a text file, supply cookies in one of the two following ways.

As a string:

$ annie -c "name=value; name2=value2" https://www.bilibili.com/video/av20203945

As a text file:

$ annie -c cookies.txt https://www.bilibili.com/video/av20203945

Proxy

HTTP proxy

An HTTP proxy can be specified with the -x option:

$ annie -x http://127.0.0.1:7777 -i https://www.youtube.com/watch?v=Gnbch2osEeo

SOCKS5 proxy

A SOCKS5 proxy can be specified with the -s option:

$ annie -s 127.0.0.1:1080 -i https://www.youtube.com/watch?v=Gnbch2osEeo

Multi-Thread

Use -n option to set the number of download threads(default is 10, only works for multiple-parts video).

Special Tips: Use too many threads in mgtv download will cause HTTP 403 error, we recommend setting the number of threads to 1.

Short link

bilibili

You can just use av or ep number to download bilibili's video:

$ annie -i ep198381 av21877586

 Site:      哔哩哔哩 bilibili.com
 Title:     狐妖小红娘：第79话 南国公主的吃货本色
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            485.23 MiB (508798478 Bytes)
     # download with: annie -f default "URL"


 Site:      哔哩哔哩 bilibili.com
 Title:     【莓机会了】甜到虐哭的13集单集MAD「我现在什么都不想干,更不想看14集」
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            51.88 MiB (54403767 Bytes)
     # download with: annie -f default "URL"

Use specified Referrer

A Referrer can be used for the request with the -r option:

$ annie -r https://www.bilibili.com/video/av20383055/ http://cn-scnc1-dx.acgvideo.com/...

...

Specify the output path and name

The -o option sets the path, and -O option sets the name of the downloaded file:

$ annie -o ../ -O "hello" https://...

Debug Mode

The -d option outputs network request messages:

$ annie -i -d http://www.bilibili.com/video/av20088587

URL:         http://www.bilibili.com/video/av20088587
Method:      GET
Headers:     http.Header{
    "Referer":         {"http://www.bilibili.com/video/av20088587"},
    "Accept":          {"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"},
    "Accept-Charset":  {"UTF-8,*;q=0.5"},
    "Accept-Encoding": {"gzip,deflate,sdch"},
    "Accept-Language": {"en-US,en;q=0.8"},
    "User-Agent":      {"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.146 Safari/537.36"},
}
Status Code: 200

URL:         https://interface.bilibili.com/v2/playurl?appkey=84956560bc028eb7&cid=32782944&otype=json&qn=116&quality=116&type=&sign=fb2e3f261fec398652f96d358517e535
Method:      GET
Headers:     http.Header{
    "Accept-Charset":  {"UTF-8,*;q=0.5"},
    "Accept-Encoding": {"gzip,deflate,sdch"},
    "Accept-Language": {"en-US,en;q=0.8"},
    "User-Agent":      {"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.146 Safari/537.36"},
    "Referer":         {"https://interface.bilibili.com/v2/playurl?appkey=84956560bc028eb7&cid=32782944&otype=json&qn=116&quality=116&type=&sign=fb2e3f261fec398652f96d358517e535"},
    "Accept":          {"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"},
}
Status Code: 200

 Site:      哔哩哔哩 bilibili.com
 Title:     燃油动力的遥控奥迪R8跑赛道
 Type:      video
 Streams:   # All available quality
     [default]  -------------------
     Quality:         高清 1080P
     Size:            64.38 MiB (67504795 Bytes)
     # download with: annie -f default "URL"

Reuse extracted data

The -j option will print the extracted data in JSON format.

$ annie -j https://www.bilibili.com/video/av20203945
{
    "Site": "哔哩哔哩 bilibili.com",
    "Title": "【2018拜年祭单品】相遇day by day",
    "Type": "video",
    "Formats": {
        "default": {
            "URLs": [
                {
                    "URL": "http://cn-jszj-dx-v-11.acgvideo.com/vg1/upgcxcode/60/93/32989360/32989360-1-80.flv?expires=1522325400\u0026platform=pc\u0026ssig=5x0f9tkmvOrQBavICgRElA\u0026oi=3063167823\u0026nfa=wjcs6MVDpr+CJX9KAl+nbw==\u0026dynamic=1\u0026hfa=2022678329\u0026hfb=Yjk5ZmZjM2M1YzY4ZjAwYTMzMTIzYmIyNWY4ODJkNWI=\u0026trid=c2de1496db7646e8917f6a556668b5a9",
                    "Size": 121735559,
                    "Ext": "flv"
                }
            ],
            "Quality": "高清 1080P",
            "Size": 121735559
        }
    }
}

All available arguments

$ annie -h

Usage of ./annie:
  -C	Download captions
  -F string
    	URLs file
  -O string
    	Specify the output file name
  -c string
    	Cookie
  -d	Debug mode
  -end int
    	Playlist video to end at
  -f string
    	Select specific format to download
  -i	Information only
  -items string
    	Playlist video items to download. Separated by commas like: 1,5,6
  -j	Print extracted data
  -n int
    	The number of download thread (default 10)
  -o string
    	Specify the output path
  -p	Download playlist
  -r string
    	Use specified Referrer
  -s string
    	SOCKS5 proxy
  -start int
    	Playlist video to start at (default 1)
  -v	Show version
  -x string
    	HTTP proxy

Supported Sites

Site URL 🎬 Videos 🌁 Images 📚 Playlist 🍪 VIP adaptation
抖音 https://www.douyin.com ✓
哔哩哔哩 https://www.bilibili.com ✓ ✓ ✓
半次元 https://bcy.net ✓
pixivision https://www.pixivision.net ✓
优酷 https://www.youku.com ✓ ✓
YouTube https://www.youtube.com ✓ ✓
爱奇艺 https://www.iqiyi.com ✓
芒果TV https://www.mgtv.com ✓
Tumblr https://www.tumblr.com ✓ ✓
Vimeo https://vimeo.com ✓
Facebook https://facebook.com ✓
斗鱼视频 https://v.douyu.com ✓
秒拍 https://www.miaopai.com ✓
微博 https://weibo.com ✓
Instagram https://www.instagram.com ✓ ✓
Twitter https://twitter.com ✓
腾讯视频 https://v.qq.com ✓

Known issues

Contributing

Annie is an open source project and built on the top of open-source projects. If you are interested, then you are welcome to contribute. Let's make Annie better, together. 💪

Check out the Contributing Guide to get started.

Special thanks to @Yasujizr who designed the amazing logo!

Authors

Code with ❤️ by iawia002 and lovely contributors

Similar projects

License

MIT

Copyright (c) 2018-present, iawia002