Skip to content
Back to top
View this page
Edit this page

# Installation

Windows

macOS

Linux and BSD

PyPI package and source code

## Windows

Method | Installing
--- | ---
Installers | See the Windows binaries section below
Portable | See the Windows binaries section below
Preview builds | See the Windows binaries section below
Python pip | See the PyPI package and source code section below

Chocolatey

    choco install streamlink

Installing Chocolatey packages

MSYS2

    pacman -Ss streamlink
    pacman -S mingw-w64-x86_64-streamlink

Installing MSYS2 packages

Scoop

    scoop bucket add extras
    scoop install streamlink

Installing Scoop packages

Windows Package Manager

    winget install streamlink

Installing Winget packages

## macOS

Method | Installing
--- | ---
Python pip | See the PyPI package and source code section below

Homebrew

    brew install streamlink

Installing Homebrew packages

## Linux and BSD

Method / Distribution | Installing
--- | ---
AppImage | See the Linux AppImages section below
AppImage preview builds | See the Linux AppImages section below
Python pip | See the PyPI package and source code section below

Alpine Linux (edge)

    sudo apk add streamlink

ALT Linux (Sisyphus)

    sudo apt-get install streamlink

Arch Linux

    sudo pacman -S streamlink

Arch Linux (AUR, git)

    git clone https://aur.archlinux.org/streamlink-git.git
    cd streamlink-git
    makepkg -si

    # alternatively, get the PKGBUILD from the AUR mirror on GitHub
    git clone --single-branch --branch streamlink-git https://github.com/archlinux/aur.git streamlink-git

Installing AUR packages

Debian (sid, testing)

    sudo apt update
    sudo apt install streamlink

Debian (stable)

    # If you don't have Debian backports already (see link below):
    echo "deb http://deb.debian.org/debian trixie-backports main" | sudo tee "/etc/apt/sources.list.d/streamlink.list"

    sudo apt update
    sudo apt -t trixie-backports install streamlink

Installing Debian backported packages

Fedora

    sudo dnf install streamlink

Gentoo Linux

    sudo emerge net-misc/streamlink

NixOS

    nix-env -iA nixos.streamlink

NixOS channel

openSUSE

    sudo zypper install streamlink

Ubuntu | Not recommended. Ubuntu inherits the `streamlink` package from Debian, but doesn't maintain or update it. See Package availability.

Solus

    sudo eopkg install streamlink

Void

    sudo xbps-install streamlink

## Package availability

Packaging is not done by the Streamlink maintainers themselves except for the PyPI package, the Windows installers + portable builds, and the Linux AppImages.

If a packaged release of Streamlink is not available for your operating system / distro or your system's architecture, or if it's out of date or broken, then please contact the respective package maintainers or package-repository maintainers of your operating system / distro, as it's up to them to add, update, or fix those packages.

Users of glibc-based Linux distros can find up-to-date Streamlink releases via the available AppImages.

Please open an issue or pull request on GitHub if an available, maintained and up-to-date package is missing from the install docs.

## PyPI package and source code

If a package is not available on your platform, or if it's out of date, then Streamlink can be installed via pip, the Python package manager.

Warning

On Linux, when not using a virtual environment, it is recommended to install custom python packages like this only for the current user using the `--user` parameter, since system-wide packages can cause conflicts with the system's regular package manager. Never install Python packages via sudo in your system's global Python environment.

User-packages will be installed into `~/.local` instead of `/usr`, and entry-scripts for running the programs can be found in `~/.local/bin`, e.g. `~/.local/bin/streamlink`.

In order for the command line shell to be able to find these executables, the user's `PATH` environment variable needs to be extended. This can be done by adding `export PATH="${HOME}/.local/bin:${PATH}"` to `~/.profile` or `~/.bashrc`.

Version | Installing
--- | ---

Latest release

    pip install -U streamlink

Master branch

    pip install -U git+https://github.com/streamlink/streamlink.git

From a pull request

    pip install -U git+https://github.com/streamlink/streamlink.git@refs/pull/PULL-REQUEST-ID/head

Specific tag/branch/commit

    pip install -U git+https://github.com/USERNAME/streamlink.git@REVISION

## Virtual environment

A better way of installing Streamlink as a non-system Python package is using the venv or virtualenv Python modules, which both create a user-owned Python environment which is isolated from the system's main Python environment.

While venv is part of Python's standard library since `3.3`, virtualenv is the project which venv originated from, but it first needs to be installed, either via pip or from the system's package manager. It also implements more features, so depending on your needs, you may want to use virtualenv instead of venv.

### Install using `venv` and `pip`

    # Create a new environment
    python -m venv ~/myenv

    # Activate the environment
    # note: non-POSIX compliant shells like FISH or PowerShell have different activation script file names
    # note: on Windows, the `bin` subdirectory is called `Scripts`
    source ~/myenv/bin/activate

    # *Either* install the latest Streamlink release from PyPI in the virtual environment
    pip install --upgrade streamlink

    # *Or*, install the most up-to-date development version from master on GitHub
    pip install --upgrade git+https://github.com/streamlink/streamlink.git

    # Use Streamlink in the environment
    streamlink ...

    # Deactivate the environment
    deactivate

    # Use Streamlink without activating the environment
    ~/myenv/bin/streamlink ...

### Install using `pipx`

The pipx project combines the functionality of both `venv` and `pip`. It may be necessary to install it first, either with a system package manager, or using `pip`, as detailed in the documentation.

    # *Either* install the latest Streamlink release from PyPI in a virtual environment
    pipx install streamlink

    # *Or*, install the most up-to-date development version from master on GitHub
    pipx install git+https://github.com/streamlink/streamlink.git

    # Use Streamlink
    streamlink ...

## Source distribution

In addition to the pre-built wheels uploaded to PyPI, Streamlink's source distribution tarballs get uploaded to both PyPI and GitHub releases. These tarballs are meant for packagers and are signed using the following PGP key:

44448A298D5C3618

Please be aware that PyPI has dropped support for uploading new release file signatures in May 2023, so those can only be found on GitHub releases now.

See the Dependencies section down below for the required build- and runtime-requirements.

Warning

Please avoid building Streamlink from tarballs generated by GitHub from (tagged) git commits, as they are lacking the built-in release version string. The `versioningit` build-requirement also won't be able to find the correct version, as the content is not part of a git repository.

Instead, build from Streamlink's signed source-distribution tarballs which are uploaded to PyPI and GitHub releases, or from the cloned git repository.

### Dependencies

To install Streamlink from source, you will need these dependencies.

Since 4.0.0, Streamlink defines a build system according to PEP-517 / PEP-518.

Type | Name | Notes
--- | --- | ---
python | Python | At least version 3.10
build | setuptools | At least version 65.6.0 Used as build backend
build | wheel | Used by the build frontend for creating Python wheels
build | versioningit | At least version 2.0.0 Used for generating the version string from git when building, or when running in an editable install. Not needed when building wheels and installing from the source distribution.
runtime | certifi | Used for loading the CA bundle extracted from the Mozilla Included CA Certificate List
runtime | exceptiongroup | Only required on `python_version<"3.11"` Used for `ExceptionGroup` handling on older Python versions
runtime | isodate | Used for parsing ISO8601 strings
runtime | lxml | Used for processing HTML and XML data
runtime | pycountry | Used for localization settings, provides country and language data
runtime | pycryptodome | Used for decrypting encrypted streams
runtime | PySocks | Used for SOCKS Proxies
runtime | requests | Used for making any kind of HTTP/HTTPS request
runtime | trio | Used for async concurrency and I/O in some parts of Streamlink
runtime | trio-websocket | Used for WebSocket connections on top of the async trio framework
runtime | typing-extensions | Only required on `python_version<"3.11"` Used for PEP 681 on older Python versions
runtime | urllib3 | Used internally by requests, defined as direct dependency
runtime | websocket-client | Used for making websocket connections

optional

FFmpeg

Required for muxing multiple video/audio/subtitle streams into a single output stream.

- DASH streams with video and audio content always have to get remuxed.

- HLS streams optionally need to get remuxed depending on the stream selection.

optional | brotli `decompress` extras marker | Used for decompressing HTTP responses
optional | zstandard `decompress` extras marker | Used for decompressing HTTP responses

## Windows binaries

Windows stable releases

GitHub releases page

The most recent Streamlink release

Windows stable releases

Windows preview builds

GitHub actions build artifacts

Account required

Windows preview builds

Flavors

Installer

- Windows 10+

- Adds itself to the system's `PATH` env var

- Automatically creates a config file

- Sets `--ffmpeg-ffmpeg` in config file

Portable archive

- Windows 10+

- No config file created automatically

- `--ffmpeg-ffmpeg` must be set manually

- No pre-compiled Python bytecode

Contents

Python
embedded build

Embedded Python build

Streamlink
and dependencies

Streamlink and its runtime dependencies

FFmpeg
for muxing streams

FFmpeg, required for muxing streams

## Linux AppImages

AppImage stable releases

GitHub releases page

The most recent Streamlink release

AppImage stable releases

AppImage preview builds

GitHub actions build artifacts

Account required

AppImage preview builds

Architectures

x86_64

aarch64

Contents

Python
from the pypa/manylinux docker images

Python from the pypa/manulinux docker images

Streamlink
and dependencies

Streamlink and its runtime dependencies

FFmpeg
for muxing streams
(optional)

FFmpeg, required for muxing streams

How-To

1. Verify that the system is running on at least glibc 2.28 (Aug 2018) (see ld.so --version)

2. Download the AppImage file matching the system's CPU architecture (see uname --machine)

3. Set the executable flag via a file browser or chmod +x filename from a command-line shell

       # AppImage file names include the release version,
       # the Python version, platform name and CPU architecture
       chmod +x streamlink-7.0.0-1-cp312-cp312-manylinux_2_28_x86_64.AppImage

4. Run the AppImage with any command-line parameters supported by Streamlink

       ./streamlink-7.0.0-1-cp312-cp312-manylinux_2_28_x86_64.AppImage --loglevel=debug

### What are AppImages?

AppImages are portable applications which are independent of the Linux distribution in use and its package management. Just set the executable flag on the AppImage file and run it.

The only requirement is having FUSE installed for being able to mount the contents of the AppImage's SquashFS, which is done automatically. Also, only glibc-based systems are currently supported.

Note: Check out AppImageLauncher, which automates the setup and system integration of AppImages. AppImageLauncher may also be available via your distro's package management.

Additional information, like for example how to inspect the AppImage contents or how to extract the contents if FUSE is not available on your system, can be found in the AppImage documentation.