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.6.3)

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¶

Table of contents¶