Windows¶

choco install streamlink

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

scoop bucket add extras
scoop install streamlink

winget install streamlink

macOS¶

brew install streamlink

Linux and BSD¶

sudo apk add streamlink

sudo apt-get install streamlink

sudo pacman -S streamlink

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

sudo apt update
sudo apt install streamlink

# 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

sudo dnf install streamlink

pkg install multimedia/streamlink

cd /usr/ports/multimedia/streamlink
make config install clean

sudo emerge net-misc/streamlink

nix-env -iA nixos.streamlink

sudo zypper install streamlink

sudo eopkg install streamlink

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.

pip install -U streamlink

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

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

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.

# 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 ...

# *Either* install and run the latest Streamlink release from PyPI
uvx streamlink [streamlink-arguments...]

# *Or*, install and run the most up-to-date dev version on GitHub
uvx --from "git+https://github.com/streamlink/streamlink.git@master" streamlink [streamlink-arguments...]

# *Or*, from a pull request on GitHub
uvx --from "git+https://github.com/streamlink/streamlink.git@refs/pull/PULL-REQUEST-ID/head" streamlink [streamlink-arguments...]

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.

Windows binaries¶

Flavors

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¶

Architectures

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