2023-02-05 18:15:57 +01:00
< h1 align = "center" > < a href = "https://streamlink.github.io/" > Streamlink< br > < img height = "150" alt = "Streamlink" src = "https://raw.githubusercontent.com/streamlink/streamlink/master/icon.svg" > < / a > < / h1 >
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
< p align = "center" >
< a href = "https://streamlink.github.io/install.html" > < img alt = "Supported Python versions" src = "https://img.shields.io/pypi/pyversions/streamlink.svg?style=flat-square&maxAge=86400" > < / a >
< a href = "https://streamlink.github.io/changelog.html" > < img alt = "Latest release" src = "https://img.shields.io/github/release/streamlink/streamlink.svg?style=flat-square&maxAge=86400" > < / a >
< a href = "https://github.com/streamlink/streamlink" > < img alt = "License" src = "https://img.shields.io/github/license/streamlink/streamlink.svg?style=flat-square&maxAge=86400" > < / a >
< a href = "https://github.com/streamlink/streamlink/issues" > < img alt = "Open issues" src = "https://img.shields.io/github/issues/streamlink/streamlink.svg?style=flat-square&maxAge=86400" > < / a >
2023-11-18 14:28:18 +01:00
< a href = "https://github.com/streamlink/streamlink/actions?query=event%3Apush" > < img alt = "Build status" src = "https://img.shields.io/github/actions/workflow/status/streamlink/streamlink/test.yml?branch=master&event=push&style=flat-square&maxAge=86400" > < / a >
2023-02-05 18:15:57 +01:00
< a href = "https://codecov.io/github/streamlink/streamlink?branch=master" > < img alt = "Overall code coverage" src = "https://img.shields.io/codecov/c/github/streamlink/streamlink.svg?branch=master&style=flat-square&maxAge=86400" > < / a >
< / p >
2016-10-08 06:25:01 +02:00
2023-02-05 18:15:57 +01:00
< p align = "center" >
A Python library and command-line interface which pipes streams from various services into a video player.< br >
Avoid resource-heavy and unoptimized websites, and still enjoy streamed content.
< / p >
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
< p align = "center" >
Streamlink was forked in 2016 from the abandoned < em > Livestreamer< / em > project.
< / p >
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
# 📦 Installation
2017-04-04 18:45:07 +02:00
2023-02-05 18:15:57 +01:00
Please take a look at the documentation for different ways of installing Streamlink:
2016-12-07 03:31:21 +01:00
2017-07-27 18:43:51 +02:00
- [Windows][streamlink-installation-windows]
2019-10-03 11:16:31 +02:00
- [macOS][streamlink-installation-macos]
- [Linux and BSD][streamlink-installation-linux-and-bsd]
2020-12-19 20:49:00 +01:00
- [PyPI package and source code][streamlink-installation-pypi-source]
2016-09-23 22:41:57 +02:00
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
# 👍 Features
Streamlink is built on top of a plugin system which allows support for new services to be added easily.
Most of the popular streaming services are supported, such as:
2016-09-17 22:49:16 +02:00
2017-07-27 18:43:51 +02:00
- [Twitch ](https://www.twitch.tv )
2018-06-19 23:07:30 +02:00
- [YouTube ](https://www.youtube.com )
2020-04-10 23:20:23 +02:00
- [Livestream ](https://livestream.com )
- [Dailymotion ](https://www.dailymotion.com )
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
... and many more. A list of all plugins currently included can be found on the [plugins page][streamlink-plugins].
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
# 💡 Quickstart
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
After installing, simply run:
2017-07-27 18:43:51 +02:00
2023-02-05 18:15:57 +01:00
```sh
streamlink "STREAMURL" best
2016-09-23 22:41:57 +02:00
```
2023-02-05 18:15:57 +01:00
The default behavior of Streamlink is to play back streams in the [VLC player][player-vlc], but a lot of other options and output methods are available, such as writing the stream to the filesystem, reading stream metadata, etc.
For more in-depth usage, please refer to the [CLI documentation][streamlink-documentation-cli].
2020-04-10 23:20:23 +02:00
2023-02-05 18:15:57 +01:00
An [API guide][streamlink-documentation-apiguide] and [API reference][streamlink-documentation-apiref] is available for Python implementors of Streamlink.
2016-09-23 22:41:57 +02:00
2016-09-17 22:49:16 +02:00
2023-02-05 18:15:57 +01:00
# 🙏 Contributing
2016-09-17 22:49:16 +02:00
2017-07-27 18:43:51 +02:00
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][contributing] first. Thanks!
2017-07-18 20:27:37 +02:00
2023-02-05 18:15:57 +01:00
# ❤️ Support
2017-07-18 20:27:37 +02:00
2023-02-05 18:15:57 +01:00
If you think that Streamlink is useful and if you want to keep the project alive, then please consider supporting its maintainers by sending a small and optionally recurring tip via the [available options][support].
Your support is very much appreciated, thank you!
2017-07-18 20:27:37 +02:00
2019-10-03 11:16:31 +02:00
[streamlink-installation-windows]: https://streamlink.github.io/install.html#windows
[streamlink-installation-macos]: https://streamlink.github.io/install.html#macos
[streamlink-installation-linux-and-bsd]: https://streamlink.github.io/install.html#linux-and-bsd
2020-12-19 20:49:00 +01:00
[streamlink-installation-pypi-source]: https://streamlink.github.io/install.html#pypi-package-and-source-code
2023-02-05 18:15:57 +01:00
[streamlink-documentation-cli]: https://streamlink.github.io/cli.html
[streamlink-documentation-apiguide]: https://streamlink.github.io/api_guide.html
[streamlink-documentation-apiref]: https://streamlink.github.io/api.html
[streamlink-plugins]: https://streamlink.github.io/plugins.html
[player-vlc]: https://www.videolan.org/vlc/
2017-07-27 18:43:51 +02:00
[contributing]: https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md
2023-02-05 18:15:57 +01:00
[support]: https://streamlink.github.io/latest/donate.html