You are reading the documentation for the in-development version of Streamlink.
Configuration file#
Writing the command-line options every time is inconvenient, that's why Streamlink is capable of reading options from a configuration file instead.
Location#
Streamlink will look for config files in different locations depending on your platform:
Platform |
Location |
---|---|
Linux, BSD |
Deprecated:
|
macOS |
Deprecated:
|
Windows |
Deprecated:
|
You can also specify the location yourself using the --config
option.
Warning
Streamlink's Windows installers automatically create a config file if it doesn't exist yet, but on any other platform or installation method, you must create the file yourself.
Note
The XDG_CONFIG_HOME
environment variable is part of the XDG base directory specification (Arch Wiki).
The ${VARIABLENAME:-DEFAULTVALUE}
syntax is explained here.
Syntax#
The config file is a simple text file and should contain one command-line option (omitting the leading dashes) per line in the format:
option=value
or for an option without value:
option
Note
Any quotes used will be part of the value, so only use them when the value needs them, e.g. when specifying a player with a path which contains spaces.
Example#
# Player options
player=mpv --cache 2048
player-no-close
Note
Full player paths are supported via configuration file options such as
player="C:\mpv-x86_64\mpv"
Plugin specific configuration file#
You may want to use specific options for some plugins only. This can be accomplished by placing those settings inside a plugin specific config file. Options inside these config files will override the main config file when a URL matching the plugin is used.
Streamlink expects this config to be named like the main config but
with .<plugin name>
attached to the end.
Examples#
Platform |
Location |
---|---|
Linux, BSD |
Deprecated:
|
macOS |
Deprecated:
|
Windows |
Deprecated:
|
Have a look at the list of plugins, or
check the --plugins
option to see the name of each built-in plugin.