2016-09-17 22:49:16 +02:00
# Streamlink
2016-10-08 06:25:01 +02:00
[](https://travis-ci.org/streamlink/streamlink)
2016-10-08 06:31:04 +02:00
[](http://codecov.io/github/streamlink/streamlink?branch=master)
2016-10-08 06:25:01 +02:00
2016-09-17 22:49:16 +02:00
Streamlink is a CLI utility that pipes flash videos from online streaming services to a variety of video players such as VLC, or alternatively, a browser.
The main purpose of streamlink is to convert CPU-heavy flash plugins to a less CPU-intensive format.
Streamlink is a fork of the [livestreamer ](https://github.com/chrippa/livestreamer ) project.
2016-09-23 22:41:57 +02:00
# Installation
2016-12-08 00:56:44 +01:00
Streamlink can be installed by using Python or through the the installers below.
2016-09-23 22:41:57 +02:00
2016-12-08 00:56:44 +01:00
**Installation via Python pip:**
2016-09-23 22:41:57 +02:00
```
sudo pip install streamlink
```
2016-12-07 03:31:21 +01:00
Note: For Windows, omit "sudo"
2016-09-23 22:41:57 +02:00
2016-12-08 00:56:44 +01:00
**Manual installation via Python:**
2016-09-23 22:41:57 +02:00
```
git clone https://github.com/streamlink/streamlink
sudo python setup.py install
```
2016-12-08 00:56:44 +01:00
**Installers for Windows/Mac/Linux:**
2016-12-07 03:31:21 +01:00
2016-12-08 00:56:44 +01:00
- [Mac OSX ](https://streamlink.github.io/install.html#other-platforms )
2016-12-07 03:31:21 +01:00
2016-12-08 00:56:44 +01:00
- [Windows ](https://streamlink.github.io/install.html#windows-binaries )
2016-12-07 03:31:21 +01:00
2016-12-08 00:56:44 +01:00
- [Linux and BSD ](https://streamlink.github.io/install.html#linux-and-bsd-packages )
2016-09-23 22:41:57 +02:00
2016-09-17 22:49:16 +02:00
# Features
Streamlink is built via a plugin system which allows new services to be easily added.
Major streaming services such as:
- [Dailymotion ](http://dailymotion.com/live )
- [Livestream ](https://livestream.com )
- [Twitch ](http://twitch.tv )
- [UStream ](http://ustream.tv )
- [YouTube Live ](http://youtube.com )
Are supported.
2016-09-28 17:09:49 +02:00
A full list of plugins can be found on the [plugin page ](https://streamlink.github.io/plugin_matrix.html ).
2016-09-17 22:49:16 +02:00
# Quickstart
2016-09-23 22:41:57 +02:00
After installation simply use:
```
streamlink twitch.tv/lirik source
```
And Streamlink will automatically open a default video player and begin streaming!
For full details on how to use Streamlink visit our documentation at [streamlink.github.io ](https://streamlink.github.io )
2016-09-17 22:49:16 +02:00
# Contributing
Feel free to open a bug or contribute to code!
No need to go through a large CONTRIBUTING.md doc. The only requirement being that we get at least one ACK from a maintainer. Fork / clone us and open a PR!
