Go to file

bastimeyer 6dd920f590 docs: add generic pull request template		2020-10-12 16:37:13 -07:00
.github	docs: add generic pull request template	2020-10-12 16:37:13 -07:00
docs	docs: add developing menu with basic setup steps	2020-10-12 16:37:13 -07:00
examples	example: added an opencv face detection example	2018-05-24 16:54:51 +02:00
script	docs: fix working tree check in deploy script	2020-10-10 12:10:42 -07:00
src	plugins.twitch: remove stream weights and clean up	2020-10-10 12:10:14 -07:00
tests	plugins.twitch: refactor _get_hls_streams	2020-10-10 12:10:14 -07:00
win32	installer: delete locally included binary files	2020-04-19 20:12:40 +02:00
.codecov.yml	ci: add python 3.9 test runners	2020-10-07 02:01:30 +02:00
.coveragerc	Improve coverage reports on codecov (#3200 )	2020-09-24 18:19:06 -07:00
.editorconfig	tools: add .editorconfig	2020-02-25 05:35:16 +01:00
.gitattributes	build: use versioneer to set the build number (#1413 )	2018-05-13 22:18:52 -07: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 1.6.0	2020-09-22 23:03:52 +02:00
CONTRIBUTING.md	docs: update plugin guidelines	2020-10-11 23:08:48 -07:00
KNOWN_ISSUES.md	Improve contribution guidelines (#772 )	2017-04-14 18:46:55 -07:00
LICENSE	2020	2020-01-16 18:32:24 +01:00
MANIFEST.in	sdist: include tests resources (#1785 )	2018-06-13 00:44:12 +01:00
NOTICE	docs: remove unimportant note / file	2020-04-26 13:21:29 -07:00
README.md	Updating README	2020-04-10 23:20:23 +02:00
dev-requirements.txt	ci.github: fix codecov uploads	2020-04-04 00:49:14 -07:00
docs-requirements.txt	docs: use recommonmark as an extension	2020-09-26 00:16:07 +02: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
setup.cfg	flake8: E501	2020-02-23 09:53:55 +01:00
setup.py	docs/tests: remove python 3.4, use 3.8 and nightly for travis-ci	2019-12-14 11:18:29 +01: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]