Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Streamlink 8.1.0 documentation
Streamlink Streamlink

Streamlink

A command-line utility that extracts streams from various services and pipes them into a video player of choice.

8.1.0
Stable
Latest
  • Overview
  • Installation
  • Command-Line Interface
    • Command-line usage
    • Tutorial
    • Configuration file
    • Plugin sideloading
    • Streaming protocols
    • Proxy support
    • Metadata
    • Plugin specific usage
      • Twitch
  • Plugins
  • Players
  • Deprecations
  • Migrations
  • Developing
  • API Guide
    • Quickstart
    • Validation schemas
  • API Reference
    • Streamlink
    • Session
    • Plugin
    • Options
    • Cache
    • Validation schemas
    • Stream
    • Webbrowser
    • Exceptions
  • Changelog
  • Support
  • Streamlink Applications
  • Third Party Applications
Github Issues
Back to top
View this page
Edit this page

Streamlink¶

Overview¶

Streamlink is a command-line utility which pipes video streams from various services into a video player, such as VLC or mpv. The main purpose of Streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content. There is also a Python API available for developers who want access to the stream data.

This project was forked from Livestreamer, which is no longer maintained.

Latest release (8.1.0)

https://github.com/streamlink/streamlink/releases/latest

GitHub

https://github.com/streamlink/streamlink

Issue tracker

https://github.com/streamlink/streamlink/issues

Discussion forum

https://github.com/streamlink/streamlink/discussions

Gitter/Matrix channel

streamlink/streamlink:gitter.im

PyPI

https://pypi.org/project/streamlink/

Free software

Simplified BSD license

Features¶

Streamlink is built on top of a plugin system which allows support for new services to be added easily. Most of the popular streaming services are supported, such as Twitch, YouTube, and many more.

A list of all plugins currently included can be found on the plugins page.

Quickstart¶

The default behavior of Streamlink is to play back streams in the VLC player.

$ streamlink twitch.tv/CHANNEL best
[cli][info] Found matching plugin twitch for URL twitch.tv/CHANNEL
[cli][info] Available streams: audio_only, 160p (worst), 360p, 480p, 720p, 720p60, 1080p60 (best)
[cli][info] Opening stream: 1080p60 (hls)
[cli][info] Starting player: vlc

For more in-depth usage and install instructions, please refer to the User guide.

User guide¶

Streamlink is made up of two parts, a cli and a library API. See their respective sections for more information on how to use them.

Thank you¶

GitHub logo lockup-dark GitHub logo lockup-light

GitHub, for hosting the git repo, docs, release assets, and for providing CI tools

https://github.com/

JetBrains logo mono-black JetBrains logo mono-white

JetBrains, for sponsoring an open-source license for their IDEs

https://jetbrains.com/

Whatismybrowser, for the access to their user-agents API in our CI workflows

https://whatismybrowser.com/

Table of contents¶

  • Overview
  • Installation
    • Windows
    • macOS
    • Linux and BSD
    • Package availability
    • PyPI package and source code
    • Virtual environment
    • Source distribution
    • Windows binaries
    • Linux AppImages
  • Command-Line Interface
    • Command-line usage
    • Tutorial
    • Configuration file
    • Plugin sideloading
    • Streaming protocols
    • Proxy support
    • Metadata
    • Plugin specific usage
    • Command-line usage
  • Plugins
    • abematv
    • adultswim
    • albavision
    • aloula
    • app17
    • ard_live
    • ard_mediathek
    • artetv
    • atpchallenger
    • atresplayer
    • bbciplayer
    • bfmtv
    • bigo
    • bilibili
    • blasttv
    • blazetv
    • bloomberg
    • brightcove
    • btv
    • cbsnews
    • cdnbg
    • ceskatelevize
    • chzzk
    • cinergroup
    • clubbingtv
    • cmmedia
    • cnbce
    • cnews
    • dailymotion
    • delfi
    • deutschewelle
    • dlive
    • dogan
    • dogus
    • douyin
    • drdk
    • earthcam
    • euronews
    • filmon
    • goltelevision
    • goodgame
    • googledrive
    • gulli
    • hiplayer
    • htv
    • huajiao
    • huya
    • invintus
    • kick
    • kugou
    • livestream
    • lnk
    • lrt
    • ltv_lsm_lv
    • mangomolo
    • mdstrm
    • mediaklikk
    • mediavitrina
    • mixcloud
    • mjunoon
    • mrtmk
    • n13tv
    • nasaplus
    • nicolive
    • nimotv
    • nos
    • nowtvtr
    • nrk
    • okru
    • olympicchannel
    • oneplusone
    • onetv
    • openrectv
    • pandalive
    • piaulizaportal
    • picarto
    • piczel
    • pixiv
    • pluto
    • pluzz
    • radiko
    • raiplay
    • reuters
    • rtpa
    • rtpplay
    • rtve
    • rtvs
    • ruv
    • sbscokr
    • showroom
    • soop
    • sportal
    • sportschau
    • ssh101
    • stadium
    • steam
    • streann
    • stv
    • svtplay
    • swisstxt
    • telefe
    • telemadrid
    • tf1
    • tiktok
    • trovo
    • turkuvaz
    • tv360
    • tv3cat
    • tv5monde
    • tv8
    • tv999
    • tvibo
    • tviplayer
    • tvp
    • tvtoya
    • twitcasting
    • twitch
    • ustreamtv
    • ustvnow
    • vidio
    • vimeo
    • vinhlongtv
    • vk
    • vkvideolive
    • welt
    • wwenetwork
    • youtube
    • yupptv
    • zattoo
    • zdf_mediathek
    • zeenews
  • Players
    • Transport modes
    • Player compatibility
    • Flatpak players
    • Known issues and workarounds
  • Deprecations
    • streamlink 8.1.0
    • streamlink 8.0.0
    • streamlink 7.0.0
    • streamlink 6.11.0
    • streamlink 6.8.0
    • streamlink 6.7.0
    • streamlink 6.6.0
    • streamlink 5.4.0
    • streamlink 5.3.0
    • streamlink 5.2.0
    • streamlink 5.0.0
    • streamlink 4.2.0
    • streamlink 3.0.0
    • streamlink 2.4.0
    • streamlink 2.3.0
    • streamlink 2.2.0
  • Migrations
    • streamlink 8.0.0
    • streamlink 7.0.0
    • streamlink 6.0.0
    • streamlink 5.0.0
    • streamlink 4.0.0
    • streamlink 3.0.0
  • Developing
    • Setup
    • Validating changes
    • Code style
    • Plugins
  • API Guide
    • Quickstart
    • Validation schemas
  • API Reference
    • Streamlink
    • Session
    • Plugin
    • Options
    • Cache
    • Validation schemas
    • Stream
    • Webbrowser
    • Exceptions
  • Changelog
    • streamlink 8.1.0 (2025-12-14)
    • streamlink 8.0.0 (2025-11-11)
    • streamlink 7.6.0 (2025-09-08)
    • streamlink 7.5.0 (2025-07-08)
    • streamlink 7.4.0 (2025-06-08)
    • streamlink 7.3.0 (2025-04-26)
    • streamlink 7.2.0 (2025-04-04)
    • streamlink 7.1.3 (2025-02-14)
    • streamlink 7.1.2 (2025-01-08)
    • streamlink 7.1.1 (2024-12-28)
    • streamlink 7.1.0 (2024-12-28)
    • streamlink 7.0.0 (2024-11-04)
    • streamlink 6.11.0 (2024-10-01)
    • streamlink 6.10.0 (2024-09-06)
    • streamlink 6.9.0 (2024-08-12)
    • streamlink 6.8.3 (2024-07-11)
    • streamlink 6.8.2 (2024-07-04)
    • streamlink 6.8.1 (2024-06-18)
    • streamlink 6.8.0 (2024-06-17)
    • streamlink 6.7.4 (2024-05-12)
    • streamlink 6.7.3 (2024-04-14)
    • streamlink 6.7.2 (2024-03-23)
    • streamlink 6.7.1 (2024-03-19)
    • streamlink 6.7.0 (2024-03-09)
    • streamlink 6.6.2 (2024-02-20)
    • streamlink 6.6.1 (2024-02-17)
    • streamlink 6.6.0 (2024-02-16)
    • streamlink 6.5.1 (2024-01-16)
    • streamlink 6.5.0 (2023-12-16)
    • streamlink 6.4.2 (2023-11-28)
    • streamlink 6.4.1 (2023-11-22)