npm 中文文档

Lux


Let there be Lux!

👾Lux is a fast and simple video downloader built with Go.

Installation
Prerequisites
Install via go install
Homebrew (macOS only)
Arch Linux
Void Linux
Scoop on Windows
Chocolatey on Windows
Cask on Windows/macOS/Linux

Getting Started
Download a video
Download anything else
Download playlist
Multiple inputs
Resume a download
Auto retry
Cookies
Proxy
Multi-Thread
Short link
bilibili

Use specified Referrer
Specify the output path and name
Debug Mode
Reuse extracted data
Options
Download:
Network:
Playlist:
Filesystem:
Subtitle:
Youku:
aria2:

Supported Sites
Known issues
优酷

Contributing
Authors
Similar projects
License

Installation


Prerequisites


The following dependencies are required and must be installed separately.

FFmpeg

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


Install via go install


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

  1. ``` shell
  2. $ go install github.com/iawia002/lux@latest
  3. ```

Homebrew (macOS only)


For macOS users, you can install lux via:

  1. ``` shell
  2. $ brew install lux
  3. ```

Arch Linux


For Arch Users AUR package is available.

Void Linux


For Void linux users, you can install lux via:

  1. ``` sh
  2. $ xbps-install -S lux

  4. ```

Scoop on Windows


  1. ``` shell
  2. $ scoop install lux
  3. ```

Chocolatey on Windows


  1. ``` sh
  2. $ choco install lux

  4. ```

Cask on Windows/macOS/Linux


  1. ``` shell
  2. $ cask install github.com/iawia002/lux
  3. ```

Getting Started


Usage:

  1. ``` sh
  2. lux [OPTIONS] URL [URL...]

  4. ```

Download a video


  1. ``` session
  2. $ lux "https://www.youtube.com/watch?v=dQw4w9WgXcQ"

  4. Site:      YouTube youtube.com
  5. Title:     Rick Astley - Never Gonna Give You Up (Video)
  6. Type:      video
  7. Stream:
  8.      [248]  -------------------
  9.      Quality:         1080p video/webm; codecs="vp9"
  10.      Size:            63.93 MiB (67038963 Bytes)
  11.      # download with: lux -f 248 ...

  13. 41.88 MiB / 63.93 MiB [=================>-------------]  65.51% 4.22 MiB/s 00m05s
  14. ```

The -i option displays all available quality of video without downloading.

  1. ``` session
  2. $ lux -i "https://www.youtube.com/watch?v=dQw4w9WgXcQ"

  4. Site:      YouTube youtube.com
  5. Title:     Rick Astley - Never Gonna Give You Up (Video)
  6. Type:      video
  7. Streams:   # All available quality
  8.      [248]  -------------------
  9.      Quality:         1080p video/webm; codecs="vp9"
  10.      Size:            49.29 MiB (51687554 Bytes)
  11.      # download with: lux -f 248 ...

  13.      [137]  -------------------
  14.      Quality:         1080p video/mp4; codecs="avc1.640028"
  15.      Size:            43.45 MiB (45564306 Bytes)
  16.      # download with: lux -f 137 ...

  18.      [398]  -------------------
  19.      Quality:         720p video/mp4; codecs="av01.0.05M.08"
  20.      Size:            37.12 MiB (38926432 Bytes)
  21.      # download with: lux -f 398 ...

  23.      [136]  -------------------
  24.      Quality:         720p video/mp4; codecs="avc1.4d401f"
  25.      Size:            31.34 MiB (32867324 Bytes)
  26.      # download with: lux -f 136 ...

  28.      [247]  -------------------
  29.      Quality:         720p video/webm; codecs="vp9"
  30.      Size:            31.03 MiB (32536181 Bytes)
  31.      # download with: lux -f 247 ...
  32. ```

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

Download anything else


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

  1. ``` session
  2. $ lux "https://img9.bcyimg.com/drawer/15294/post/1799t/1f5a87801a0711e898b12b640777720f.jpg"

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

  6. Site:      Universal
  7. Title:     1f5a87801a0711e898b12b640777720f
  8. Type:      image/jpeg
  9. Stream:
  10.      [default]  -------------------
  11.      Size:            1.00 MiB (1051042 Bytes)
  12.      # download with: lux -f default "URL"

  14. 1.00 MiB / 1.00 MiB [===================================] 100.00% 1.21 MiB/s 0s
  15. ```

Download playlist


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

  1. ``` session
  2. $ lux -i -p "https://www.bilibili.com/bangumi/play/ep198061"

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

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

  22. ......
  23. ```

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

  1. ``` sh
  2. -start
  3.      Playlist video to start at (default 1)
  4. -end
  5.      Playlist video to end at
  6. -items
  7.      Playlist video items to download. Separated by commas like: 1,5,6,8-10

  9. ```

For bilibili playlists only:

  1. ``` sh
  2. -eto
  3.   File name of each bilibili episode doesn't include the playlist title

  5. ```

Multiple inputs


You can also download multiple URLs at once:

  1. ``` session
  2. $ lux -i "https://www.bilibili.com/video/av21877586" "https://www.bilibili.com/video/av21990740"

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

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

These URLs will be downloaded one by one.

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

  1. ``` session
  2. $ lux -F ~/Desktop/u.txt

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

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

  14. ......
  15. ```

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

  1. ``` sh
  2. -start
  3.      File line to start at (default 1)
  4. -end
  5.      File line to end at
  6. -items
  7.      File lines to download. Separated by commas like: 1,5,6,8-10

  9. ```

Resume a download


Ctrl+Cinterrupts a download.

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

Auto retry


lux will auto retry when the download failed, you can specify the retry times by -retry option (default is 100).

Cookies


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

Cookies can be the following format or Netscape Cookie format:

  1. ``` session
  2. name=value; name2=value2; ...
  3. ```

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

As a string:

  1. ``` session
  2. $ lux -c "name=value; name2=value2" "https://www.bilibili.com/video/av20203945"
  3. ```

As a text file:

  1. ``` session
  2. $ lux -c cookies.txt "https://www.bilibili.com/video/av20203945"
  3. ```

Proxy


You can set the HTTP/SOCKS5 proxy using environment variables:

  1. ``` session
  2. $ HTTP_PROXY="http://127.0.0.1:1087/" lux -i "https://www.youtube.com/watch?v=Gnbch2osEeo"
  3. ```

  1. ``` session
  2. $ HTTP_PROXY="socks5://127.0.0.1:1080/" lux -i "https://www.youtube.com/watch?v=Gnbch2osEeo"
  3. ```

Multi-Thread


Use --multi-thread or -m multiple threads to download single video.

Use --thread or -n option to set the number of download threads(default is 10).

Note: If the video has multi fragment, the number of actual download threads will increase.


For example:

If -n is set to 10, and the video has 2 fragments, then 20 threads will actually be used.
If the video has 20 fragments, only 10 fragments are downloaded in the same time, the actual threads count is 100.

Special Tips:Use too many threads in mgtvdownload 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:

  1. ``` session
  2. $ lux -i ep198381 av21877586

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

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

Use specified Referrer


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

  1. ``` session
  2. $ lux -r "https://www.bilibili.com/video/av20383055/" "http://cn-scnc1-dx.acgvideo.com/"
  3. ```

Specify the output path and name


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

  1. ``` session
  2. $ lux -o ../ -O "hello" "https://example.com"
  3. ```

Debug Mode


The -d option outputs network request messages:

  1. ``` session
  2. $ lux -i -d "http://www.bilibili.com/video/av20088587"

  4. URL:         http://www.bilibili.com/video/av20088587
  5. Method:      GET
  6. Headers:     http.Header{
  7.     "Referer":         {"http://www.bilibili.com/video/av20088587"},
  8.     "Accept":          {"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"},
  9.     "Accept-Charset":  {"UTF-8,*;q=0.5"},
  10.     "Accept-Encoding": {"gzip,deflate,sdch"},
  11.     "Accept-Language": {"en-US,en;q=0.8"},
  12.     "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"},
  13. }
  14. Status Code: 200

  16. URL:         https://interface.bilibili.com/v2/playurl?appkey=84956560bc028eb7&cid=32782944&otype=json&qn=116&quality=116&type=&sign=fb2e3f261fec398652f96d358517e535
  17. Method:      GET
  18. Headers:     http.Header{
  19.     "Accept-Charset":  {"UTF-8,*;q=0.5"},
  20.     "Accept-Encoding": {"gzip,deflate,sdch"},
  21.     "Accept-Language": {"en-US,en;q=0.8"},
  22.     "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"},
  23.     "Referer":         {"https://interface.bilibili.com/v2/playurl?appkey=84956560bc028eb7&cid=32782944&otype=json&qn=116&quality=116&type=&sign=fb2e3f261fec398652f96d358517e535"},
  24.     "Accept":          {"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"},
  25. }
  26. Status Code: 200

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

Reuse extracted data


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

  1. ``` session
  2. $ lux -j "https://www.bilibili.com/video/av20203945"

  4. {
  5.     "site": "哔哩哔哩 bilibili.com",
  6.     "title": "【2018拜年祭单品】相遇day by day",
  7.     "type": "video",
  8.     "streams": {
  9.         "15": {
  10.             "urls": [
  11.                 {
  12.                     "url": "...",
  13.                     "size": 18355205,
  14.                     "ext": "flv"
  15.                 }
  16.             ],
  17.             "quality": "流畅 360P",
  18.             "size": 18355205
  19.         },
  20.         "32": {
  21.             "urls": [
  22.                 {
  23.                     "url": "...",
  24.                     "size": 40058632,
  25.                     "ext": "flv"
  26.                 }
  27.             ],
  28.             "quality": "清晰 480P",
  29.             "size": 40058632
  30.         },
  31.         "64": {
  32.             "urls": [
  33.                 {
  34.                     "url": "...",
  35.                     "size": 82691087,
  36.                     "ext": "flv"
  37.                 }
  38.             ],
  39.             "quality": "高清 720P",
  40.             "size": 82691087
  41.         },
  42.         "80": {
  43.             "urls": [
  44.                 {
  45.                     "url": "...",
  46.                     "size": 121735559,
  47.                     "ext": "flv"
  48.                 }
  49.             ],
  50.             "quality": "高清 1080P",
  51.             "size": 121735559
  52.         }
  53.     }
  54. }
  55. ```

Options


  1. ``` sh
  2.   -i Information only
  3.   -F string
  4.      URLs file path
  5.   -d Debug mode
  6.   -j Print extracted data
  7.   -s Minimum outputs
  8.   -v Show version

  10. ```

Download:


  1. ``` sh
  2.   -f string
  3.      Select specific stream to download
  4.   -p Download playlist
  5.   -n int
  6.      The number of download thread (only works for multiple-parts video) (default 10)
  7.   -c string
  8.      Cookie
  9.   -r string
  10.      Use specified Referrer
  11.   -cs int
  12.      HTTP chunk size for downloading (in MB) (default 1)

  14. ```

Network:


  1. ``` sh
  2.   -retry int
  3.      How many times to retry when the download failed (default 10)

  5. ```

Playlist:


  1. ``` sh
  2.   -start int
  3.      Playlist video to start at (default 1)
  4.   -end int
  5.      Playlist video to end at
  6.   -items string
  7.      Playlist video items to download. Separated by commas like: 1,5,6,8-10

  9. ```

Filesystem:


  1. ``` sh
  2.   -o string
  3.      Specify the output path
  4.   -O string
  5.      Specify the output file name

  7. ```

Subtitle:


  1. ``` sh
  2.   -C Download captions

  4. ```

Youku:


  1. ``` sh
  2.   -ccode string
  3.      Youku ccode (default "0502")
  4.   -ckey string
  5.      Youku ckey (default "7B19C0AB12633B22E7FE81271162026020570708D6CC189E4924503C49D243A0DE6CD84A766832C2C99898FC5ED31F3709BB3CDD82C96492E721BDD381735026")
  6.   -password string
  7.      Youku password

  9. ```

aria2:


Note: If you use aria2 to download, you need to merge the multi-part videos yourself.


  1. ``` sh
  2.   -aria2
  3.      Use Aria2 RPC to download
  4.   -aria2addr string
  5.      Aria2 Address (default "localhost:6800")
  6.   -aria2method string
  7.      Aria2 Method (default "http")
  8.   -aria2token string
  9.      Aria2 RPC Token

  11. ```

Supported Sites


Site URL 🎬 Videos 🌁 Images 🔊 Audio 📚 Playlist 🍪 VIP adaptation Build Status
:--- :--- :--- :--- :--- :--- :--- :--- :--- :--- :--- :--- :---
抖音 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://m.toutiao.com, https://v.ixigua.com, https://www.ixigua.com ✓
爱奇艺 https://www.iqiyi.com ✓
新片场 https://www.xi