Go to file

bastimeyer 334e18e412 tools: add mypy config - Add mypy and available typing stubs to dev-requirements - Add mypy config - Add py.typed to streamlink + streamlink_cli packages (PEP 561): This is required, so that mypy can import types from streamlink when installed in editable mode. Don't publish this file for now. Once various streamlink APIs are properly typed, typing stub files can be added instead.		2022-05-24 14:07:47 -07:00
.github	ci: use GITHUB_TOKEN for deploying to GitHub	2022-05-07 12:20:56 +02:00
docs	docs: enable intersphinx again	2022-05-23 15:20:50 -07:00
examples	typo of "steams" to "streams" in opencv-face.py	2022-02-13 11:28:28 -08:00
script	script: rename github release script	2022-05-07 12:20:56 +02:00
src	tools: add mypy config	2022-05-24 14:07:47 -07:00
tests	chore: fix import typing issues	2022-05-24 14:07:47 -07:00
.codecov.yml	chore: drop support for Python 3.6	2022-04-10 07:35:19 +02: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	tools: add mypy config	2022-05-24 14:07:47 -07:00
AUTHORS	AUTHORS: removed unused script and removed outdated list (#2889 )	2020-04-12 21:13:15 +02:00
CHANGELOG.md	changelog: remove git shortlogs	2022-05-07 12:20:56 +02: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	2022	2021-12-31 17:21:59 -08:00
MANIFEST.in	build: add pyproject.toml, switch to versioningit	2022-04-10 07:55:31 +02:00
README.md	docs: README.md update link to plugins list	2022-04-04 20:19:51 +02:00
dev-requirements.txt	tools: add mypy config	2022-05-24 14:07:47 -07:00
docs-requirements.txt	ci: fix netlify PR preview builds	2022-04-17 22:14:33 -07: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: fix netlify PR preview builds	2022-04-17 22:14:33 -07:00
pyproject.toml	tools: add mypy config	2022-05-24 14:07:47 -07:00
setup.cfg	script: rewrite github release script	2022-05-07 12:20:56 +02:00
setup.py	build: move imports in setup.py	2022-04-10 17:16:27 -07:00
signing.key.gpg	build: include correct signing key: 0xE3DB9E282E390FA0	2020-04-24 12:01:28 +02: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]