Go to file

bastimeyer e7821a2428 release: 4.0.1		2022-05-01 19:37:57 +02:00
.github	ci: fix github deploy config	2022-05-01 15:16:24 +02:00
docs	docs: fix incorrect min setuptools version	2022-04-24 08:39:43 +02:00
examples	typo of "steams" to "streams" in opencv-face.py	2022-02-13 11:28:28 -08:00
script	installer: drop Windows installer build config	2022-04-03 22:09:35 +02:00
src	plugins.nicolive: fix timeshift-offset option	2022-04-25 20:02:49 +02:00
tests	tests.plugins: make description metadata mandatory	2022-04-24 08:40:07 +02: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	setup: include shell completions in sdist	2021-11-15 18:53:58 +01:00
AUTHORS	AUTHORS: removed unused script and removed outdated list (#2889 )	2020-04-12 21:13:15 +02:00
CHANGELOG.md	release: 4.0.1	2022-05-01 19:37:57 +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	chore: move coverage config to pyproject.toml	2022-04-22 10:45:08 -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	chore: move coverage config to pyproject.toml	2022-04-22 10:45:08 -07:00
setup.cfg	chore: clean up flake8 config	2022-04-22 10:45:08 -07: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]