You are reading the documentation for the in-development version of Streamlink.

Overview

Streamlink is a command-line utility which pipes video streams from various services into a video player, such as VLC. 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 an API available for developers who want access to the stream data.

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

Latest release (1.5.0)
https://github.com/streamlink/streamlink/releases/latest
GitHub
https://github.com/streamlink/streamlink
Issue tracker
https://github.com/streamlink/streamlink/issues
PyPI
https://pypi.org/project/streamlink/
Free software
Simplified BSD license

Features

Streamlink is built upon a plugin system which allows support for new services to be easily added. Most of the big streaming services are supported, such as:

... and many more. A full list of 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/day9tv best
[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
[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 Command-Line Interface and a library API. See their respective sections for more information on how to use them.