Go to file

bastimeyer 1b517c7771 chore: replace issue templates with forms		2021-07-10 15:36:36 -07:00
.github	chore: replace issue templates with forms	2021-07-10 15:36:36 -07:00
docs	plugins.Streamingvideoprovider: removed	2021-07-04 19:29:10 +02:00
examples	docs: remove outdated gst-player example	2020-12-27 11:58:31 +01:00
script	cli: rename config file on Windows to "config"	2021-06-06 11:50:33 -07:00
src	plugins.openrectv: update HLS URLs (#3850 )	2021-07-07 12:17:46 +02:00
tests	plugins.youtube: find videoId on channel pages	2021-07-05 18:24:49 +02:00
win32	cli: rename config file on Windows to "config"	2021-06-06 11:50:33 -07:00
.codecov.yml	ci.codecov: disable GH status check annotations	2021-02-19 17:54:26 -08:00
.coveragerc	Improve coverage reports on codecov (#3200 )	2020-09-24 18:19:06 -07:00
.editorconfig	ci: add netlify docs preview deploy config	2020-12-28 11:11:45 -08:00
.gitattributes	tools: force LF line endings via .gitattributes	2020-12-25 11:49:38 -08:00
.gitignore	build: build and sign sdist in travis using an RSA sign-only key (#1701 )	2018-05-28 16:33:41 -07:00
AUTHORS	AUTHORS: removed unused script and removed outdated list (#2889 )	2020-04-12 21:13:15 +02:00
CHANGELOG.md	release: 2.2.0	2021-06-18 18:38:57 -07:00
CODE_OF_CONDUCT.md	docs: add minimalist code of conduct	2020-12-26 17:10:04 +01:00
CONTRIBUTING.md	chore: replace issue templates with forms	2021-07-10 15:36:36 -07:00
KNOWN_ISSUES.md	Improve contribution guidelines (#772 )	2017-04-14 18:46:55 -07:00
LICENSE	2021	2021-01-01 12:11:57 -08:00
MANIFEST.in	build: include removed plugins file in sdist	2021-03-24 00:53:08 +01:00
NOTICE	docs: remove unimportant note / file	2020-04-26 13:21:29 -07:00
README.md	docs: fix link in readme	2020-12-19 13:27:10 -08:00
dev-requirements.txt	flake8: add import-order linting config	2020-10-27 17:17:49 +01:00
docs-requirements.txt	docs: bump furo docs req to 2020.12.28.beta23	2020-12-30 11:41:13 +01:00
icon.svg	Add icon, modify installer, update docs (#2165 )	2018-12-31 04:37:51 +01:00
id_rsa_docs.gpg	update docs deployment key	2020-04-02 22:11:56 +02:00
netlify.toml	ci.netlify: build docs when CHANGELOG.md changes	2021-03-14 12:13:05 -07:00
setup.cfg	flake8: add import-order linting config	2020-10-27 17:17:49 +01:00
setup.py	build: include .removed file in build	2021-04-01 06:12:39 +02:00
signing.key.gpg	build: include correct signing key: 0xE3DB9E282E390FA0	2020-04-24 12:01:28 +02:00
versioneer.py	versioneer: always use 7 characters	2018-10-16 19:15:03 +00:00

README.md

Streamlink

Streamlink is a CLI 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.

Streamlink is a fork of the Livestreamer project.

Please note that by using this application you're bypassing ads run by sites such as Twitch.tv. Please consider donating or paying for subscription services when they are available for the content you consume and enjoy.

Installation

Please refer to our documentation for different ways to install Streamlink:

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 plugin page.

Quickstart

After installing, simply use:

streamlink STREAMURL best

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

For more in-depth usage and install instructions, please refer to the detailed documentation.

Contributing

All contributions are welcome. Feel free to open a new thread on the issue tracker or submit a new pull request. Please read CONTRIBUTING.md first. Thanks!

Backers

Thank you to all our backers! [Become a backer]