2021-12-16 18:23:04 -07:00
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
2021-04-10 18:22:55 -06:00
< div align = "center" >
2021-08-01 23:15:02 -06:00
[](#readme)
2021-01-12 09:17:22 -07:00
2022-09-21 14:07:44 -06:00
[](#installation "Installation")
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
[](https://pypi.org/project/yt-dlp "PyPI")
2022-01-19 15:57:07 -07:00
[](Collaborators.md#collaborators "Donate")
2022-03-23 19:30:22 -06:00
[](https://matrix.to/#/#yt-dlp:matrix.org "Matrix")
[](https://discord.gg/H5MNcFW63r "Discord")
2022-01-19 15:57:07 -07:00
[](supportedsites.md "Supported Sites")
2022-03-23 19:30:22 -06:00
[](LICENSE "License")
2023-01-02 07:09:03 -07:00
[](https://github.com/yt-dlp/yt-dlp/actions "CI Status")
2022-01-19 15:57:07 -07:00
[](https://github.com/yt-dlp/yt-dlp/commits "Commit History")
2023-07-06 07:48:35 -06:00
[](https://github.com/yt-dlp/yt-dlp/pulse/monthly "Last activity")
2021-01-06 23:41:05 -07:00
2021-04-10 18:22:55 -06:00
< / div >
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: END EXCLUDED SECTION -->
2021-01-06 23:41:05 -07:00
2024-03-19 11:14:04 -06:00
yt-dlp is a feature-rich command-line audio/video downloader with support for [thousands of sites ](supportedsites.md ). The project is a fork of [youtube-dl ](https://github.com/ytdl-org/youtube-dl ) based on the now inactive [youtube-dlc ](https://github.com/blackjack4494/yt-dlc ).
2017-10-20 13:11:11 -06:00
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: MOVE "USAGE AND OPTIONS" SECTION HERE -->
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
2021-01-06 23:41:05 -07:00
* [INSTALLATION ](#installation )
2022-09-09 16:16:54 -06:00
* [Detailed instructions ](https://github.com/yt-dlp/yt-dlp/wiki/Installation )
2021-10-21 04:48:46 -06:00
* [Release Files ](#release-files )
2024-03-10 13:18:47 -06:00
* [Update ](#update )
2021-06-07 12:46:22 -06:00
* [Dependencies ](#dependencies )
2021-01-14 08:38:27 -07:00
* [Compile ](#compile )
2021-04-10 18:22:55 -06:00
* [USAGE AND OPTIONS ](#usage-and-options )
* [General Options ](#general-options )
2021-01-04 10:50:13 -07:00
* [Network Options ](#network-options )
2021-04-10 18:22:55 -06:00
* [Geo-restriction ](#geo-restriction )
2021-01-04 10:50:13 -07:00
* [Video Selection ](#video-selection )
* [Download Options ](#download-options )
* [Filesystem Options ](#filesystem-options )
2021-04-10 18:22:55 -06:00
* [Thumbnail Options ](#thumbnail-options )
2021-01-04 10:50:13 -07:00
* [Internet Shortcut Options ](#internet-shortcut-options )
2021-02-24 12:46:57 -07:00
* [Verbosity and Simulation Options ](#verbosity-and-simulation-options )
2021-01-04 10:50:13 -07:00
* [Workarounds ](#workarounds )
* [Video Format Options ](#video-format-options )
* [Subtitle Options ](#subtitle-options )
* [Authentication Options ](#authentication-options )
* [Post-processing Options ](#post-processing-options )
2021-09-01 14:55:16 -06:00
* [SponsorBlock Options ](#sponsorblock-options )
2021-01-04 10:50:13 -07:00
* [Extractor Options ](#extractor-options )
2021-01-06 23:41:05 -07:00
* [CONFIGURATION ](#configuration )
2022-10-03 22:23:11 -06:00
* [Configuration file encoding ](#configuration-file-encoding )
2023-06-20 21:07:42 -06:00
* [Authentication with netrc ](#authentication-with-netrc )
2022-10-03 22:19:18 -06:00
* [Notes about environment variables ](#notes-about-environment-variables )
2021-01-06 23:41:05 -07:00
* [OUTPUT TEMPLATE ](#output-template )
2021-01-04 10:50:13 -07:00
* [Output template examples ](#output-template-examples )
2021-01-06 23:41:05 -07:00
* [FORMAT SELECTION ](#format-selection )
2021-01-04 10:50:13 -07:00
* [Filtering Formats ](#filtering-formats )
* [Sorting Formats ](#sorting-formats )
* [Format Selection examples ](#format-selection-examples )
2021-04-03 02:33:25 -06:00
* [MODIFYING METADATA ](#modifying-metadata )
* [Modifying metadata examples ](#modifying-metadata-examples )
2021-06-25 08:05:41 -06:00
* [EXTRACTOR ARGUMENTS ](#extractor-arguments )
2021-01-24 06:40:02 -07:00
* [PLUGINS ](#plugins )
2022-12-31 21:29:22 -07:00
* [Installing Plugins ](#installing-plugins )
* [Developing Plugins ](#developing-plugins )
2021-10-08 19:08:01 -06:00
* [EMBEDDING YT-DLP ](#embedding-yt-dlp )
2022-04-17 17:09:25 -06:00
* [Embedding examples ](#embedding-examples )
2024-03-10 13:18:47 -06:00
* [CHANGES FROM YOUTUBE-DL ](#changes-from-youtube-dl )
* [New features ](#new-features )
* [Differences in default behavior ](#differences-in-default-behavior )
* [Deprecated options ](#deprecated-options )
2021-10-08 19:08:01 -06:00
* [CONTRIBUTING ](CONTRIBUTING.md#contributing-to-yt-dlp )
* [Opening an Issue ](CONTRIBUTING.md#opening-an-issue )
* [Developer Instructions ](CONTRIBUTING.md#developer-instructions )
2022-09-07 06:05:45 -06:00
* [WIKI ](https://github.com/yt-dlp/yt-dlp/wiki )
2022-09-09 16:16:54 -06:00
* [FAQ ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ )
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: END EXCLUDED SECTION -->
2021-01-04 10:50:13 -07:00
2014-05-13 03:16:11 -06:00
# INSTALLATION
2021-01-04 10:50:13 -07:00
2022-01-19 15:57:07 -07:00
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)
2022-09-07 06:05:45 -06:00
[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)
2022-05-16 08:06:36 -06:00
[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
[](https://pypi.org/project/yt-dlp)
2022-01-19 15:57:07 -07:00
[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
[](#release-files)
2022-04-17 11:49:53 -06:00
[](https://github.com/yt-dlp/yt-dlp/releases)
2022-01-19 15:57:07 -07:00
<!-- MANPAGE: END EXCLUDED SECTION -->
2023-05-19 15:05:08 -06:00
You can install yt-dlp using [the binaries ](#release-files ), [pip ](https://pypi.org/project/yt-dlp ) or one using a third-party package manager. See [the wiki ](https://github.com/yt-dlp/yt-dlp/wiki/Installation ) for detailed instructions
2021-10-31 03:15:59 -06:00
2021-08-30 08:37:43 -06:00
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
2021-11-03 16:10:35 -06:00
## RELEASE FILES
2021-10-21 04:48:46 -06:00
2021-10-21 06:57:58 -06:00
#### Recommended
File|Description
:---|:---
2022-06-26 18:50:06 -06:00
[yt-dlp ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp )|Platform-independent [zipimport ](https://docs.python.org/3/library/zipimport.html ) binary. Needs Python (recommended for **Linux/BSD** )
2024-10-23 00:33:50 -06:00
[yt-dlp.exe ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe )|Windows (Win8+) standalone x64 binary (recommended for **Windows** )
2022-07-08 13:37:47 -06:00
[yt-dlp_macos ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos )|Universal MacOS (10.15+) standalone executable (recommended for **MacOS** )
2021-10-21 06:57:58 -06:00
#### Alternatives
2021-10-21 04:48:46 -06:00
File|Description
:---|:---
2024-10-23 00:33:50 -06:00
[yt-dlp_x86.exe ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe )|Windows (Win8+) standalone x86 (32-bit) binary
2022-07-08 13:37:47 -06:00
[yt-dlp_linux ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux )|Linux standalone x64 binary
2022-11-10 18:49:24 -07:00
[yt-dlp_linux_armv7l ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l )|Linux standalone armv7l (32-bit) binary
[yt-dlp_linux_aarch64 ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_aarch64 )|Linux standalone aarch64 (64-bit) binary
2021-10-31 03:15:59 -06:00
[yt-dlp_win.zip ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip )|Unpackaged Windows executable (no auto-update)
[yt-dlp_macos.zip ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos.zip )|Unpackaged MacOS (10.15+) executable (no auto-update)
2022-06-28 06:36:30 -06:00
[yt-dlp_macos_legacy ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos_legacy )|MacOS (10.9+) standalone x64 executable
2021-10-21 06:57:58 -06:00
#### Misc
File|Description
:---|:---
2022-09-07 06:05:45 -06:00
[yt-dlp.tar.gz ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz )|Source tarball
2021-10-21 04:48:46 -06:00
[SHA2-512SUMS ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS )|GNU-style SHA512 sums
2023-03-03 10:06:30 -07:00
[SHA2-512SUMS.sig ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS.sig )|GPG signature file for SHA512 sums
2021-10-21 04:48:46 -06:00
[SHA2-256SUMS ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS )|GNU-style SHA256 sums
2023-03-03 10:06:30 -07:00
[SHA2-256SUMS.sig ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS.sig )|GPG signature file for SHA256 sums
2021-10-21 04:48:46 -06:00
2023-03-03 10:06:30 -07:00
The public key that can be used to verify the GPG signatures is [available here ](https://github.com/yt-dlp/yt-dlp/blob/master/public.key )
Example usage:
```
curl -L https://github.com/yt-dlp/yt-dlp/raw/master/public.key | gpg --import
gpg --verify SHA2-256SUMS.sig SHA2-256SUMS
gpg --verify SHA2-512SUMS.sig SHA2-512SUMS
```
<!-- MANPAGE: END EXCLUDED SECTION -->
2022-09-07 06:05:45 -06:00
2023-06-20 21:51:20 -06:00
**Note**: The manpages, shell completion (autocomplete) files etc. are available inside the [source tarball ](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz )
2022-09-07 06:05:45 -06:00
2024-03-10 13:18:47 -06:00
## UPDATE
You can use `yt-dlp -U` to update if you are using the [release binaries ](#release-files )
If you [installed with pip ](https://github.com/yt-dlp/yt-dlp/wiki/Installation#with-pip ), simply re-run the same command that was used to install the program
2024-07-01 16:51:27 -06:00
For other third-party package managers, see [the wiki ](https://github.com/yt-dlp/yt-dlp/wiki/Installation#third-party-package-managers ) or refer to their documentation
2024-03-10 13:18:47 -06:00
< a id = "update-channels" > < / a >
There are currently three release channels for binaries: `stable` , `nightly` and `master` .
* `stable` is the default channel, and many of its changes have been tested by users of the `nightly` and `master` channels.
* The `nightly` channel has releases scheduled to build every day around midnight UTC, for a snapshot of the project's new patches and changes. This is the **recommended channel for regular users** of yt-dlp. The `nightly` releases are available from [yt-dlp/yt-dlp-nightly-builds ](https://github.com/yt-dlp/yt-dlp-nightly-builds/releases ) or as development releases of the `yt-dlp` PyPI package (which can be installed with pip's `--pre` flag).
* The `master` channel features releases that are built after each push to the master branch, and these will have the very latest fixes and additions, but may also be more prone to regressions. They are available from [yt-dlp/yt-dlp-master-builds ](https://github.com/yt-dlp/yt-dlp-master-builds/releases ).
When using `--update` /`-U`, a release binary will only update to its current channel.
`--update-to CHANNEL` can be used to switch to a different channel when a newer version is available. `--update-to [CHANNEL@]TAG` can also be used to upgrade or downgrade to specific tags from a channel.
You may also use `--update-to <repository>` (`< owner > /< repository > `) to update to a channel on a completely different repository. Be careful with what repository you are updating to though, there is no verification done for binaries from different repositories.
Example usage:
2024-04-08 13:18:04 -06:00
2024-03-10 13:18:47 -06:00
* `yt-dlp --update-to master` switch to the `master` channel and update to its latest release
* `yt-dlp --update-to stable@2023.07.06` upgrade/downgrade to release to `stable` channel tag `2023.07.06`
* `yt-dlp --update-to 2023.10.07` upgrade/downgrade to tag `2023.10.07` if it exists on the current channel
* `yt-dlp --update-to example/yt-dlp@2023.09.24` upgrade/downgrade to the release from the `example/yt-dlp` repository, tag `2023.09.24`
**Important**: Any user experiencing an issue with the `stable` release should install or update to the `nightly` release before submitting a bug report:
```
# To update to nightly from stable executable/binary:
yt-dlp --update-to nightly
# To install nightly with pip:
2024-05-26 15:37:49 -06:00
python3 -m pip install -U --pre "yt-dlp[default]"
2024-03-10 13:18:47 -06:00
```
2021-11-03 16:10:35 -06:00
## DEPENDENCIES
2024-10-23 00:33:50 -06:00
Python versions 3.9+ (CPython) and 3.10+ (PyPy) are supported. Other versions and implementations may or may not work correctly.
2021-04-10 18:22:55 -06:00
2021-10-09 15:53:47 -06:00
<!-- Python 3.5+ uses VC++14 and it is already embedded in the binary created
<!x-- https://www.microsoft.com/en-us/download/details.aspx?id=26999 --x>
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
On Windows, [Microsoft Visual C++ 2010 SP1 Redistributable Package (x86) ](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe ) is also necessary to run yt-dlp. You probably already have this, but if the executable throws an error due to missing `MSVCR100.dll` you need to install it manually.
2021-10-09 15:53:47 -06:00
-->
2021-05-08 15:25:05 -06:00
2021-12-19 08:18:06 -07:00
While all the other dependencies are optional, `ffmpeg` and `ffprobe` are highly recommended
2021-12-16 18:23:04 -07:00
2022-06-19 23:18:29 -06:00
### Strongly recommended
2024-07-01 16:51:27 -06:00
* [**ffmpeg** and **ffprobe** ](https://www.ffmpeg.org ) - Required for [merging separate video and audio files ](#format-selection ), as well as for various [post-processing ](#post-processing-options ) tasks. License [depends on the build ](https://www.ffmpeg.org/legal.html )
2022-06-19 23:18:29 -06:00
2024-01-05 10:13:46 -07:00
There are bugs in ffmpeg that cause various issues when used alongside yt-dlp. Since ffmpeg is such an important dependency, we provide [custom builds ](https://github.com/yt-dlp/FFmpeg-Builds#ffmpeg-static-auto-builds ) with patches for some of these issues at [yt-dlp/FFmpeg-Builds ](https://github.com/yt-dlp/FFmpeg-Builds ). See [the readme ](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied ) for details on the specific issues solved by these builds
2024-07-01 16:51:27 -06:00
2024-03-10 13:18:47 -06:00
**Important** : What you need is ffmpeg *binary* , **NOT** [the Python package of the same name ](https://pypi.org/project/ffmpeg )
2022-06-19 23:18:29 -06:00
### Networking
2022-03-22 17:26:55 -06:00
* [**certifi** ](https://github.com/certifi/python-certifi )\* - Provides Mozilla's root certificate bundle. Licensed under [MPLv2 ](https://github.com/certifi/python-certifi/blob/master/LICENSE )
2022-06-19 23:18:29 -06:00
* [**brotli** ](https://github.com/google/brotli )\* or [**brotlicffi** ](https://github.com/python-hyper/brotlicffi ) - [Brotli ](https://en.wikipedia.org/wiki/Brotli ) content encoding support. Both licensed under MIT < sup > [1](https://github.com/google/brotli/blob/master/LICENSE) [2 ](https://github.com/python-hyper/brotlicffi/blob/master/LICENSE ) </ sup >
* [**websockets** ](https://github.com/aaugustin/websockets )\* - For downloading over websocket. Licensed under [BSD-3-Clause ](https://github.com/aaugustin/websockets/blob/main/LICENSE )
2023-10-13 17:33:00 -06:00
* [**requests** ](https://github.com/psf/requests )\* - HTTP library. For HTTPS proxy and persistent connections support. Licensed under [Apache-2.0 ](https://github.com/psf/requests/blob/main/LICENSE )
2022-06-19 23:18:29 -06:00
2024-03-16 21:52:38 -06:00
#### Impersonation
2024-07-01 16:51:27 -06:00
The following provide support for impersonating browser requests. This may be required for some sites that employ TLS fingerprinting.
2024-03-16 21:52:38 -06:00
2024-09-27 16:46:22 -06:00
* [**curl_cffi** ](https://github.com/lexiforest/curl_cffi ) (recommended) - Python binding for [curl-impersonate ](https://github.com/lexiforest/curl-impersonate ). Provides impersonation targets for Chrome, Edge and Safari. Licensed under [MIT ](https://github.com/lexiforest/curl_cffi/blob/main/LICENSE )
2024-05-26 15:37:49 -06:00
* Can be installed with the `curl-cffi` group, e.g. `pip install "yt-dlp[default,curl-cffi]"`
2024-07-11 17:50:44 -06:00
* Currently included in `yt-dlp.exe` , `yt-dlp_linux` and `yt-dlp_macos` builds
2024-03-16 21:52:38 -06:00
2022-06-19 23:18:29 -06:00
### Metadata
* [**mutagen** ](https://github.com/quodlibet/mutagen )\* - For `--embed-thumbnail` in certain formats. Licensed under [GPLv2+ ](https://github.com/quodlibet/mutagen/blob/master/COPYING )
* [**AtomicParsley** ](https://github.com/wez/atomicparsley ) - For `--embed-thumbnail` in `mp4` /`m4a` files when `mutagen` /`ffmpeg` cannot. Licensed under [GPLv2+ ](https://github.com/wez/atomicparsley/blob/master/COPYING )
2023-10-09 12:30:36 -06:00
* [**xattr** ](https://github.com/xattr/xattr ), [**pyxattr** ](https://github.com/iustin/pyxattr ) or [**setfattr** ](http://savannah.nongnu.org/projects/attr ) - For writing xattr metadata (`--xattr`) on **Mac** and **BSD** . Licensed under [MIT ](https://github.com/xattr/xattr/blob/master/LICENSE.txt ), [LGPL2.1 ](https://github.com/iustin/pyxattr/blob/master/COPYING ) and [GPLv2+ ](http://git.savannah.nongnu.org/cgit/attr.git/tree/doc/COPYING ) respectively
2022-06-19 23:18:29 -06:00
### Misc
* [**pycryptodomex** ](https://github.com/Legrandin/pycryptodome )\* - For decrypting AES-128 HLS streams and various other data. Licensed under [BSD-2-Clause ](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst )
2022-03-30 05:35:06 -06:00
* [**phantomjs** ](https://github.com/ariya/phantomjs ) - Used in extractors where javascript needs to be run. Licensed under [BSD-3-Clause ](https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD )
2023-12-30 14:27:36 -07:00
* [**secretstorage** ](https://github.com/mitya57/secretstorage )\* - For `--cookies-from-browser` to access the **Gnome** keyring while decrypting cookies of **Chromium** -based browsers on **Linux** . Licensed under [BSD-3-Clause ](https://github.com/mitya57/secretstorage/blob/master/LICENSE )
2021-06-07 12:46:22 -06:00
* Any external downloader that you want to use with `--downloader`
2021-04-10 18:22:55 -06:00
2022-09-09 16:16:54 -06:00
### Deprecated
2022-06-19 23:18:29 -06:00
* [**avconv** and **avprobe** ](https://www.libav.org ) - Now **deprecated** alternative to ffmpeg. License [depends on the build ](https://libav.org/legal )
* [**sponskrub** ](https://github.com/faissaloo/SponSkrub ) - For using the now **deprecated** [sponskrub options ](#sponskrub-options ). Licensed under [GPLv3+ ](https://github.com/faissaloo/SponSkrub/blob/master/LICENCE.md )
2022-06-21 16:17:41 -06:00
* [**rtmpdump** ](http://rtmpdump.mplayerhq.hu ) - For downloading `rtmp` streams. ffmpeg can be used instead with `--downloader ffmpeg` . Licensed under [GPLv2+ ](http://rtmpdump.mplayerhq.hu )
* [**mplayer** ](http://mplayerhq.hu/design7/info.html ) or [**mpv** ](https://mpv.io ) - For downloading `rstp` /`mms` streams. ffmpeg can be used instead with `--downloader ffmpeg` . Licensed under [GPLv2+ ](https://github.com/mpv-player/mpv/blob/master/Copyright )
2022-06-19 23:18:29 -06:00
2021-06-07 12:46:22 -06:00
To use or redistribute the dependencies, you must agree to their respective licensing terms.
2022-07-08 13:37:47 -06:00
The standalone release binaries are built with the Python interpreter and the packages marked with ** \*** included.
2021-09-29 15:14:40 -06:00
2022-06-19 23:18:29 -06:00
If you do not have the necessary dependencies for a task you are attempting, yt-dlp will warn you. All the currently available dependencies are visible at the top of the `--verbose` output
2021-09-29 15:14:40 -06:00
2020-08-31 18:24:22 -06:00
2021-11-03 16:10:35 -06:00
## COMPILE
2020-08-31 18:24:22 -06:00
2022-06-19 23:18:29 -06:00
### Standalone PyInstaller Builds
2024-03-10 13:18:47 -06:00
To build the standalone executable, you must have Python and `pyinstaller` (plus any of yt-dlp's [optional dependencies ](#dependencies ) if needed). The executable will be built for the same CPU architecture as the Python used.
You can run the following commands:
2021-01-29 10:45:27 -07:00
2024-02-11 06:58:18 -07:00
```
2024-02-11 07:17:08 -07:00
python3 devscripts/install_deps.py --include pyinstaller
2024-02-11 06:58:18 -07:00
python3 devscripts/make_lazy_extractors.py
python3 -m bundle.pyinstaller
```
2022-06-19 23:18:29 -06:00
On some systems, you may need to use `py` or `python` instead of `python3` .
2024-03-10 13:18:47 -06:00
`python -m bundle.pyinstaller` accepts any arguments that can be passed to `pyinstaller` , such as `--onefile/-F` or `--onedir/-D` , which is further [documented here ](https://pyinstaller.org/en/stable/usage.html#what-to-generate ).
2022-10-18 11:55:52 -06:00
2023-01-02 07:09:28 -07:00
**Note**: Pyinstaller versions below 4.4 [do not support ](https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms ) Python installed from the Windows store without using a virtual environment.
2022-06-19 23:18:29 -06:00
2024-03-10 13:18:47 -06:00
**Important**: Running `pyinstaller` directly **instead of** using `python -m bundle.pyinstaller` is **not** officially supported. This may or may not work correctly.
2021-08-16 10:29:40 -06:00
2022-06-19 23:18:29 -06:00
### Platform-independent Binary (UNIX)
2024-10-23 00:33:50 -06:00
You will need the build tools `python` (3.9+), `zip` , `make` (GNU), `pandoc` \* and `pytest` \*.
2020-09-23 13:15:54 -06:00
2022-06-19 23:18:29 -06:00
After installing these, simply run `make` .
2020-08-31 18:24:22 -06:00
2022-08-18 17:28:54 -06:00
You can also run `make yt-dlp` instead to compile only the binary without updating any of the additional files. (The build tools marked with ** \*** are not needed for this)
2014-05-13 03:16:11 -06:00
2022-06-19 23:18:29 -06:00
### Related scripts
2024-02-11 07:17:08 -07:00
* **`devscripts/install_deps.py`** - Install dependencies for yt-dlp.
2024-07-01 16:51:27 -06:00
* **`devscripts/update-version.py`** - Update the version number based on the current date.
2023-03-03 10:01:41 -07:00
* **`devscripts/set-variant.py`** - Set the build variant of the executable.
* **`devscripts/make_changelog.py`** - Create a markdown changelog using short commit messages and update `CONTRIBUTORS` file.
2024-10-12 19:50:31 -06:00
* **`devscripts/make_lazy_extractors.py`** - Create lazy extractors. Running this before building the binaries (any variant) will improve their startup performance. Set the environment variable `YTDLP_NO_LAZY_EXTRACTORS` to something nonempty to forcefully disable lazy extractor loading.
2022-06-19 23:18:29 -06:00
2023-03-03 10:01:41 -07:00
Note: See their `--help` for more info.
2023-03-03 10:03:12 -07:00
### Forking the project
If you fork the project on GitHub, you can run your fork's [build workflow ](.github/workflows/build.yml ) to automatically build the selected version(s) as artifacts. Alternatively, you can run the [release workflow ](.github/workflows/release.yml ) or enable the [nightly workflow ](.github/workflows/release-nightly.yml ) to create full (pre-)releases.
2021-11-09 15:42:25 -07:00
2021-04-10 18:22:55 -06:00
# USAGE AND OPTIONS
2011-08-05 17:14:13 -06:00
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
2021-02-24 11:45:56 -07:00
yt-dlp [OPTIONS] [--] URL [URL...]
2014-12-16 08:33:23 -07:00
2021-01-04 10:02:43 -07:00
`Ctrl+F` is your friend :D
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: END EXCLUDED SECTION -->
2021-01-04 10:02:43 -07:00
2021-12-16 18:23:04 -07:00
<!-- Auto generated -->
2021-01-06 23:41:05 -07:00
## General Options:
2022-05-19 08:35:17 -06:00
-h, --help Print this help text and exit
--version Print program version and exit
2022-07-29 09:03:01 -06:00
-U, --update Update this program to the latest version
--no-update Do not check for updates (default)
2023-03-03 10:06:11 -07:00
--update-to [CHANNEL]@[TAG] Upgrade/downgrade to a specific version.
2023-05-20 13:21:32 -06:00
CHANNEL can be a repository as well. CHANNEL
and TAG default to "stable" and "latest"
respectively if omitted; See "UPDATE" for
2023-11-14 15:09:25 -07:00
details. Supported channels: stable,
nightly, master
2022-05-19 08:35:17 -06:00
-i, --ignore-errors Ignore download and postprocessing errors.
The download will be considered successful
even if the postprocessing fails
--no-abort-on-error Continue with next video on download errors;
e.g. to skip unavailable videos in a
playlist (default)
--abort-on-error Abort downloading of further videos if an
error occurs (Alias: --no-ignore-errors)
--dump-user-agent Display the current user-agent and exit
--list-extractors List all supported extractors and exit
--extractor-descriptions Output descriptions of all supported
extractors and exit
2022-08-23 20:50:52 -06:00
--use-extractors NAMES Extractor names to use separated by commas.
2022-08-23 18:12:16 -06:00
You can also use regexes, "all", "default"
and "end" (end URL matching); e.g. --ies
"holodex.*,end,youtube". Prefix the name
with a "-" to exclude it, e.g. --ies
default,-generic. Use --list-extractors for
2022-08-23 20:50:52 -06:00
a list of extractor names. (Alias: --ies)
2022-08-14 06:04:13 -06:00
--default-search PREFIX Use this prefix for unqualified URLs. E.g.
2022-05-19 08:35:17 -06:00
"gvsearch2:python" downloads two videos from
google videos for the search term "python".
Use the value "auto" to let yt-dlp guess
("auto_warning" to emit a warning when
guessing). "error" just throws an error. The
default value "fixup_error" repairs broken
URLs, but emits an error if this is not
possible instead of searching
--ignore-config Don't load any more configuration files
2024-03-10 13:18:47 -06:00
except those given to --config-locations.
2022-05-19 08:35:17 -06:00
For backward compatibility, if this option
is found inside the system configuration
file, the user configuration is not loaded.
(Alias: --no-config)
--no-config-locations Do not load any custom configuration files
(default). When given inside a configuration
file, ignore all previous --config-locations
defined in the current file
--config-locations PATH Location of the main configuration file;
either the path to the config or its
2022-05-24 06:00:28 -06:00
containing directory ("-" for stdin). Can be
used multiple times and inside other
configuration files
2024-10-20 11:10:26 -06:00
--plugin-dirs PATH Path to an additional directory to search
for plugins. This option can be used
multiple times to add multiple directories.
Note that this currently only works for
extractor plugins; postprocessor plugins can
only be loaded from the default plugin
directories
2024-11-17 16:25:05 -07:00
--flat-playlist Do not extract a playlist's URL result
entries; some entry metadata may be missing
and downloading may be bypassed
2023-05-19 15:05:08 -06:00
--no-flat-playlist Fully extract the videos of a playlist
(default)
2022-05-19 08:35:17 -06:00
--live-from-start Download livestreams from the start.
Currently only supported for YouTube
(Experimental)
--no-live-from-start Download livestreams from the current time
(default)
--wait-for-video MIN[-MAX] Wait for scheduled streams to become
available. Pass the minimum number of
seconds (or range) to wait between retries
--no-wait-for-video Do not wait for scheduled streams (default)
--mark-watched Mark videos watched (even with --simulate)
--no-mark-watched Do not mark videos watched (default)
2023-05-24 12:35:07 -06:00
--color [STREAM:]POLICY Whether to emit color codes in output,
optionally prefixed by the STREAM (stdout or
stderr) to apply the setting to. Can be one
of "always", "auto" (default), "never", or
"no_color" (use non color terminal
2024-07-16 16:08:42 -06:00
sequences). Use "auto-tty" or "no_color-tty"
to decide based on terminal support only.
Can be used multiple times
2022-05-19 08:35:17 -06:00
--compat-options OPTS Options that can help keep compatibility
with youtube-dl or youtube-dlc
configurations by reverting some of the
changes made in yt-dlp. See "Differences in
default behavior" for details
--alias ALIASES OPTIONS Create aliases for an option string. Unless
an alias starts with a dash "-", it is
prefixed with "--". Arguments are parsed
according to the Python string formatting
2022-08-14 06:04:13 -06:00
mini-language. E.g. --alias get-audio,-X
2022-05-19 08:35:17 -06:00
"-S=aext:{0},abr -x --audio-format {0}"
creates options "--get-audio" and "-X" that
takes an argument (ARG0) and expands to
"-S=aext:ARG0,abr -x --audio-format ARG0".
All defined aliases are listed in the --help
output. Alias options can trigger more
2022-06-26 18:50:06 -06:00
aliases; so be careful to avoid defining
2022-05-19 08:35:17 -06:00
recursive options. As a safety measure, each
alias may be triggered a maximum of 100
2022-05-25 06:23:46 -06:00
times. This option can be used multiple times
2011-09-14 14:55:09 -06:00
2015-01-10 12:06:13 -07:00
## Network Options:
2022-05-19 08:35:17 -06:00
--proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. To
2022-08-14 06:04:13 -06:00
enable SOCKS proxy, specify a proper scheme,
e.g. socks5://user:pass@127.0.0.1:1080/.
Pass in an empty string (--proxy "") for
direct connection
2022-05-19 08:35:17 -06:00
--socket-timeout SECONDS Time to wait before giving up, in seconds
--source-address IP Client-side IP address to bind to
2024-03-16 21:47:56 -06:00
--impersonate CLIENT[:OS] Client to impersonate for requests. E.g.
chrome, chrome-110, chrome:windows-10. Pass
--impersonate="" to impersonate any client.
2024-05-27 15:46:07 -06:00
Note that forcing impersonation for all
requests may have a detrimental impact on
download speed and stability
2024-03-16 21:47:56 -06:00
--list-impersonate-targets List available clients to impersonate.
2022-05-19 08:35:17 -06:00
-4, --force-ipv4 Make all connections via IPv4
-6, --force-ipv6 Make all connections via IPv6
2023-01-01 23:05:13 -07:00
--enable-file-urls Enable file:// URLs. This is disabled by
default for security reasons.
2017-02-21 09:48:24 -07:00
2021-04-10 18:22:55 -06:00
## Geo-restriction:
2022-05-19 08:35:17 -06:00
--geo-verification-proxy URL Use this proxy to verify the IP address for
some geo-restricted sites. The default proxy
specified by --proxy (or none, if the option
is not present) is used for the actual
downloading
2023-04-24 08:08:58 -06:00
--xff VALUE How to fake X-Forwarded-For HTTP header to
try bypassing geographic restriction. One of
2023-05-19 15:05:08 -06:00
"default" (only when known to be useful),
"never", an IP block in CIDR notation, or a
two-letter ISO 3166-2 country code
2015-01-10 12:06:13 -07:00
2012-08-01 03:53:17 -06:00
## Video Selection:
2022-11-29 23:04:51 -07:00
-I, --playlist-items ITEM_SPEC Comma separated playlist_index of the items
2022-06-16 22:48:21 -06:00
to download. You can specify a range using
"[START]:[STOP][:STEP]". For backward
compatibility, START-STOP is also supported.
Use negative indices to count from the right
and negative STEP to download in reverse
2022-08-14 06:04:13 -06:00
order. E.g. "-I 1:3,7,-5::2" used on a
2022-11-29 23:04:51 -07:00
playlist of size 15 will download the items
2022-06-16 22:48:21 -06:00
at index 1,2,3,7,11,13,15
2022-11-29 23:04:51 -07:00
--min-filesize SIZE Abort download if filesize is smaller than
SIZE, e.g. 50k or 44.6M
--max-filesize SIZE Abort download if filesize is larger than
2022-08-14 06:04:13 -06:00
SIZE, e.g. 50k or 44.6M
2022-05-19 08:35:17 -06:00
--date DATE Download only videos uploaded on this date.
The date can be "YYYYMMDD" or in the format
[now|today|yesterday][-N[day|week|month|year]].
2023-03-03 10:03:12 -07:00
E.g. "--date today-2weeks" downloads only
videos uploaded on the same day two weeks ago
2022-05-19 08:35:17 -06:00
--datebefore DATE Download only videos uploaded on or before
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
this date. The date formats accepted are the
2022-05-19 08:35:17 -06:00
same as --date
--dateafter DATE Download only videos uploaded on or after
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
this date. The date formats accepted are the
2022-05-19 08:35:17 -06:00
same as --date
--match-filters FILTER Generic video filter. Any "OUTPUT TEMPLATE"
field can be compared with a number or a
string using the operators defined in
2022-07-31 20:05:59 -06:00
"Filtering Formats". You can also simply
2022-05-19 08:35:17 -06:00
specify a field to match if the field is
present, use "!field" to check if the field
is not present, and "& " to check multiple
conditions. Use a "\" to escape "& " or
quotes if needed. If used multiple times,
2024-07-01 17:01:05 -06:00
the filter matches if at least one of the
2024-09-27 16:46:22 -06:00
conditions is met. E.g. --match-filters
!is_live --match-filters "like_count>?100 &
2022-05-19 08:35:17 -06:00
description~='(?i)\bcats \& dogs\b'" matches
only videos that are not live OR those that
have a like count more than 100 (or the like
field is not available) and also has a
description that contains the phrase "cats &
2024-09-27 16:46:22 -06:00
dogs" (caseless). Use "--match-filters -" to
2022-05-19 08:35:17 -06:00
interactively ask whether to download each
video
2024-09-27 16:46:22 -06:00
--no-match-filters Do not use any --match-filters (default)
2023-03-03 12:43:05 -07:00
--break-match-filters FILTER Same as "--match-filters" but stops the
download process when a video is rejected
--no-break-match-filters Do not use any --break-match-filters (default)
2022-05-19 08:35:17 -06:00
--no-playlist Download only the video, if the URL refers
to a video and a playlist
--yes-playlist Download the playlist, if the URL refers to
a video and a playlist
--age-limit YEARS Download only videos suitable for the given
age
--download-archive FILE Download only videos not listed in the
archive file. Record the IDs of all
downloaded videos in it
--no-download-archive Do not use archive file (default)
--max-downloads NUMBER Abort after downloading NUMBER files
--break-on-existing Stop the download process when encountering
2024-11-03 17:33:21 -07:00
a file that is in the archive supplied with
the --download-archive option
2024-04-03 16:51:41 -06:00
--no-break-on-existing Do not stop the download process when
encountering a file that is in the archive
(default)
2022-11-29 23:04:51 -07:00
--break-per-input Alters --max-downloads, --break-on-existing,
2024-09-27 16:46:22 -06:00
--break-match-filters, and autonumber to
2023-03-03 14:41:45 -07:00
reset per input URL
2022-05-19 08:35:17 -06:00
--no-break-per-input --break-on-existing and similar options
terminates the entire download queue
--skip-playlist-after-errors N Number of allowed failures until the rest of
the playlist is skipped
2011-08-05 17:14:13 -06:00
2013-07-02 01:14:09 -06:00
## Download Options:
2022-05-19 08:35:17 -06:00
-N, --concurrent-fragments N Number of fragments of a dash/hlsnative
video that should be downloaded concurrently
(default is 1)
2022-08-14 06:04:13 -06:00
-r, --limit-rate RATE Maximum download rate in bytes per second,
e.g. 50K or 4.2M
2022-05-19 08:35:17 -06:00
--throttled-rate RATE Minimum download rate in bytes per second
below which throttling is assumed and the
2022-08-14 06:04:13 -06:00
video data is re-extracted, e.g. 100K
2022-05-19 08:35:17 -06:00
-R, --retries RETRIES Number of retries (default is 10), or
"infinite"
--file-access-retries RETRIES Number of times to retry on file access
error (default is 3), or "infinite"
--fragment-retries RETRIES Number of retries for a fragment (default is
10), or "infinite" (DASH, hlsnative and ISM)
2022-08-01 14:13:18 -06:00
--retry-sleep [TYPE:]EXPR Time to sleep between retries in seconds
(optionally) prefixed by the type of retry
(http (default), fragment, file_access,
extractor) to apply the sleep to. EXPR can
be a number, linear=START[:END[:STEP=1]] or
exp=START[:END[:BASE=2]]. This option can be
used multiple times to set the sleep for the
2022-08-14 06:04:13 -06:00
different retry types, e.g. --retry-sleep
2022-05-19 08:35:17 -06:00
linear=1::2 --retry-sleep fragment:exp=1:20
--skip-unavailable-fragments Skip unavailable fragments for DASH,
hlsnative and ISM downloads (default)
2023-01-02 07:09:28 -07:00
(Alias: --no-abort-on-unavailable-fragments)
--abort-on-unavailable-fragments
2022-05-19 08:35:17 -06:00
Abort download if a fragment is unavailable
(Alias: --no-skip-unavailable-fragments)
--keep-fragments Keep downloaded fragments on disk after
downloading is finished
--no-keep-fragments Delete downloaded fragments after
downloading is finished (default)
2022-08-14 06:04:13 -06:00
--buffer-size SIZE Size of download buffer, e.g. 1024 or 16K
2022-05-19 08:35:17 -06:00
(default is 1024)
--resize-buffer The buffer size is automatically resized
from an initial value of --buffer-size
(default)
--no-resize-buffer Do not automatically adjust the buffer size
--http-chunk-size SIZE Size of a chunk for chunk-based HTTP
2022-08-14 06:04:13 -06:00
downloading, e.g. 10485760 or 10M (default
2022-05-19 08:35:17 -06:00
is disabled). May be useful for bypassing
bandwidth throttling imposed by a webserver
(experimental)
--playlist-random Download playlist videos in random order
2022-06-17 02:05:04 -06:00
--lazy-playlist Process entries in the playlist as they are
received. This disables n_entries,
--playlist-random and --playlist-reverse
--no-lazy-playlist Process videos in the playlist only after
the entire playlist is parsed (default)
2022-05-19 08:35:17 -06:00
--xattr-set-filesize Set file xattribute ytdl.filesize with
expected file size
--hls-use-mpegts Use the mpegts container for HLS videos;
allowing some players to play the video
while downloading, and reducing the chance
of file corruption if download is
interrupted. This is enabled by default for
live streams
--no-hls-use-mpegts Do not use the mpegts container for HLS
videos. This is default when not downloading
live streams
2023-06-21 17:24:39 -06:00
--download-sections REGEX Download only chapters that match the
regular expression. A "*" prefix denotes
time-range instead of chapter. Negative
timestamps are calculated from the end.
"*from-url" can be used to download between
the "start_time" and "end_time" extracted
from the URL. Needs ffmpeg. This option can
be used multiple times to download multiple
2022-08-14 06:04:13 -06:00
sections, e.g. --download-sections
2022-09-21 14:07:44 -06:00
"*10:15-inf" --download-sections "intro"
2022-05-19 08:35:17 -06:00
--downloader [PROTO:]NAME Name or path of the external downloader to
use (optionally) prefixed by the protocols
(http, ftp, m3u8, dash, rstp, rtmp, mms) to
use it for. Currently supports native,
aria2c, avconv, axel, curl, ffmpeg, httpie,
wget. You can use this option multiple times
to set different downloaders for different
2022-08-14 06:04:13 -06:00
protocols. E.g. --downloader aria2c
2022-05-19 08:35:17 -06:00
--downloader "dash,m3u8:native" will use
aria2c for http/ftp downloads, and the
native downloader for dash/m3u8 downloads
(Alias: --external-downloader)
--downloader-args NAME:ARGS Give these arguments to the external
downloader. Specify the downloader name and
the arguments separated by a colon ":". For
ffmpeg, arguments can be passed to different
positions using the same syntax as
--postprocessor-args. You can use this
option multiple times to give different
arguments to different downloaders (Alias:
--external-downloader-args)
2013-07-02 01:14:09 -06:00
2012-08-01 03:53:17 -06:00
## Filesystem Options:
2022-05-19 08:35:17 -06:00
-a, --batch-file FILE File containing URLs to download ("-" for
stdin), one URL per line. Lines starting
with "#", ";" or "]" are considered as
comments and ignored
--no-batch-file Do not read URLs from batch file (default)
-P, --paths [TYPES:]PATH The paths where the files should be
downloaded. Specify the type of file and the
path separated by a colon ":". All the same
TYPES as --output are supported.
Additionally, you can also provide "home"
(default) and "temp" paths. All intermediary
files are first downloaded to the temp path
and then the final files are moved over to
the home path after download is finished.
This option is ignored if --output is an
absolute path
-o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
TEMPLATE" for details
--output-na-placeholder TEXT Placeholder for unavailable fields in
2024-03-10 13:18:47 -06:00
--output (default: "NA")
2022-05-19 08:35:17 -06:00
--restrict-filenames Restrict filenames to only ASCII characters,
and avoid "& " and spaces in filenames
--no-restrict-filenames Allow Unicode characters, "& " and spaces in
filenames (default)
--windows-filenames Force filenames to be Windows-compatible
--no-windows-filenames Make filenames Windows-compatible only if
using Windows (default)
--trim-filenames LENGTH Limit the filename length (excluding
extension) to the specified number of
characters
-w, --no-overwrites Do not overwrite any files
--force-overwrites Overwrite all video and metadata files. This
option includes --no-continue
--no-force-overwrites Do not overwrite the video, but overwrite
related files (default)
-c, --continue Resume partially downloaded files/fragments
(default)
--no-continue Do not resume partially downloaded
fragments. If the file is not fragmented,
restart download of the entire file
--part Use .part files instead of writing directly
into output file (default)
--no-part Do not use .part files - write directly into
output file
--mtime Use the Last-modified header to set the file
modification time (default)
--no-mtime Do not use the Last-modified header to set
the file modification time
2022-05-25 06:23:46 -06:00
--write-description Write video description to a .description file
2022-05-19 08:35:17 -06:00
--no-write-description Do not write video description (default)
--write-info-json Write video metadata to a .info.json file
(this may contain personal information)
--no-write-info-json Do not write video metadata (default)
--write-playlist-metafiles Write playlist metadata in addition to the
video metadata when using --write-info-json,
--write-description etc. (default)
--no-write-playlist-metafiles Do not write playlist metadata when using
--write-info-json, --write-description etc.
2023-06-20 21:51:20 -06:00
--clean-info-json Remove some internal metadata such as
filenames from the infojson (default)
2022-05-19 08:35:17 -06:00
--no-clean-info-json Write all fields to the infojson
--write-comments Retrieve video comments to be placed in the
infojson. The comments are fetched even
without this option if the extraction is
known to be quick (Alias: --get-comments)
--no-write-comments Do not retrieve video comments unless the
extraction is known to be quick (Alias:
--no-get-comments)
--load-info-json FILE JSON file containing the video information
2022-05-25 06:23:46 -06:00
(created with the "--write-info-json" option)
2022-05-19 08:35:17 -06:00
--cookies FILE Netscape formatted file to read cookies from
and dump cookie jar in
--no-cookies Do not read/dump cookies from/to file
(default)
2022-09-01 03:52:59 -06:00
--cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]
The name of the browser to load cookies
from. Currently supported browsers are:
brave, chrome, chromium, edge, firefox,
2024-05-26 15:55:43 -06:00
opera, safari, vivaldi, whale. Optionally,
the KEYRING used for decrypting Chromium
cookies on Linux, the name/path of the
PROFILE to load cookies from, and the
CONTAINER name (if Firefox) ("none" for no
container) can be given with their
2024-07-01 17:01:05 -06:00
respective separators. By default, all
2024-05-26 15:55:43 -06:00
containers of the most recently accessed
profile are used. Currently supported
keyrings are: basictext, gnomekeyring,
kwallet, kwallet5, kwallet6
2022-05-19 08:35:17 -06:00
--no-cookies-from-browser Do not load cookies from browser (default)
2022-09-07 06:05:45 -06:00
--cache-dir DIR Location in the filesystem where yt-dlp can
store some downloaded information (such as
client ids and signatures) permanently. By
2022-10-03 22:19:18 -06:00
default ${XDG_CACHE_HOME}/yt-dlp
2022-05-19 08:35:17 -06:00
--no-cache-dir Disable filesystem caching
--rm-cache-dir Delete all filesystem cache files
2011-08-05 17:14:13 -06:00
2021-04-10 18:22:55 -06:00
## Thumbnail Options:
2022-05-19 08:35:17 -06:00
--write-thumbnail Write thumbnail image to disk
2022-05-25 06:23:46 -06:00
--no-write-thumbnail Do not write thumbnail image to disk (default)
2022-05-19 08:35:17 -06:00
--write-all-thumbnails Write all thumbnail image formats to disk
--list-thumbnails List available thumbnails of each video.
Simulate unless --no-simulate is used
2015-01-25 13:40:43 -07:00
2020-10-27 04:37:21 -06:00
## Internet Shortcut Options:
2022-05-19 08:35:17 -06:00
--write-link Write an internet shortcut file, depending
on the current platform (.url, .webloc or
.desktop). The URL may be cached by the OS
--write-url-link Write a .url Windows internet shortcut. The
OS caches the URL based on the file path
--write-webloc-link Write a .webloc macOS internet shortcut
--write-desktop-link Write a .desktop Linux internet shortcut
2020-10-27 04:37:21 -06:00
2021-02-24 12:46:57 -07:00
## Verbosity and Simulation Options:
2022-05-19 08:35:17 -06:00
-q, --quiet Activate quiet mode. If used with --verbose,
print the log to stderr
2023-04-24 07:22:09 -06:00
--no-quiet Deactivate quiet mode. (Default)
2022-05-19 08:35:17 -06:00
--no-warnings Ignore warnings
-s, --simulate Do not download the video and do not write
anything to disk
--no-simulate Download the video even if printing/listing
options are used
--ignore-no-formats-error Ignore "No video formats" error. Useful for
extracting metadata even if the videos are
not actually available for download
(experimental)
--no-ignore-no-formats-error Throw error when no downloadable video
formats are found (default)
--skip-download Do not download the video but write all
related files (Alias: --no-download)
-O, --print [WHEN:]TEMPLATE Field name or output template to print to
screen, optionally prefixed with when to
print it, separated by a ":". Supported
values of "WHEN" are the same as that of
2022-12-29 22:45:41 -07:00
--use-postprocessor (default: video).
2022-05-19 08:35:17 -06:00
Implies --quiet. Implies --simulate unless
--no-simulate or later stages of WHEN are
used. This option can be used multiple times
2022-01-23 14:34:19 -07:00
--print-to-file [WHEN:]TEMPLATE FILE
2022-05-19 08:35:17 -06:00
Append given template to the file. The
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
values of WHEN and TEMPLATE are the same as
that of --print. FILE uses the same syntax
as the output template. This option can be
used multiple times
2022-05-19 08:35:17 -06:00
-j, --dump-json Quiet, but print JSON information for each
video. Simulate unless --no-simulate is
used. See "OUTPUT TEMPLATE" for a
description of available keys
-J, --dump-single-json Quiet, but print JSON information for each
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
URL or infojson passed. Simulate unless
2022-05-19 08:35:17 -06:00
--no-simulate is used. If the URL refers to
a playlist, the whole playlist information
is dumped in a single line
--force-write-archive Force download archive entries to be written
as far as no errors occur, even if -s or
another simulation option is used (Alias:
--force-download-archive)
--newline Output progress bar as new lines
--no-progress Do not print progress bar
--progress Show progress bar, even if in quiet mode
--console-title Display progress in console titlebar
2021-10-08 13:11:59 -06:00
--progress-template [TYPES:]TEMPLATE
2022-05-19 08:35:17 -06:00
Template for progress outputs, optionally
prefixed with one of "download:" (default),
"download-title:" (the console title),
"postprocess:", or "postprocess-title:".
The video's fields are accessible under the
"info" key and the progress attributes are
2022-08-14 06:04:13 -06:00
accessible under "progress" key. E.g.
2022-05-19 08:35:17 -06:00
--console-title --progress-template
"download-title:%(info.id)s-%(progress.eta)s"
2024-04-08 14:47:38 -06:00
--progress-delta SECONDS Time between progress output (default: 0)
2022-05-19 08:35:17 -06:00
-v, --verbose Print various debugging information
--dump-pages Print downloaded pages encoded using base64
to debug problems (very verbose)
--write-pages Write downloaded intermediary pages to files
in the current directory to debug problems
--print-traffic Display sent and read HTTP traffic
2011-08-05 17:14:13 -06:00
2014-07-24 23:05:17 -06:00
## Workarounds:
2022-05-19 08:35:17 -06:00
--encoding ENCODING Force the specified encoding (experimental)
--legacy-server-connect Explicitly allow HTTPS connection to servers
that do not support RFC 5746 secure
renegotiation
--no-check-certificates Suppress HTTPS certificate validation
--prefer-insecure Use an unencrypted connection to retrieve
information about the video (Currently
supported only for YouTube)
2023-02-17 05:22:22 -07:00
--add-headers FIELD:VALUE Specify a custom HTTP header and its value,
2022-05-19 08:35:17 -06:00
separated by a colon ":". You can use this
option multiple times
--bidi-workaround Work around terminals that lack
bidirectional text support. Requires bidiv
or fribidi executable in PATH
--sleep-requests SECONDS Number of seconds to sleep between requests
during data extraction
--sleep-interval SECONDS Number of seconds to sleep before each
download. This is the minimum time to sleep
when used along with --max-sleep-interval
(Alias: --min-sleep-interval)
--max-sleep-interval SECONDS Maximum number of seconds to sleep. Can only
be used along with --min-sleep-interval
--sleep-subtitles SECONDS Number of seconds to sleep before each
subtitle download
2014-07-24 23:05:17 -06:00
2012-08-01 03:53:17 -06:00
## Video Format Options:
2022-05-19 08:35:17 -06:00
-f, --format FORMAT Video format code, see "FORMAT SELECTION"
for more details
-S, --format-sort SORTORDER Sort the formats by the fields given, see
"Sorting Formats" for more details
--format-sort-force Force user specified sort order to have
precedence over all fields, see "Sorting
Formats" for more details (Alias: --S-force)
--no-format-sort-force Some fields have precedence over the user
specified sort order (default)
--video-multistreams Allow multiple video streams to be merged
into a single file
--no-video-multistreams Only one video stream is downloaded for each
output file (default)
--audio-multistreams Allow multiple audio streams to be merged
into a single file
--no-audio-multistreams Only one audio stream is downloaded for each
output file (default)
--prefer-free-formats Prefer video formats with free containers
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
over non-free ones of the same quality. Use
with "-S ext" to strictly prefer free
containers irrespective of quality
2022-05-19 08:35:17 -06:00
--no-prefer-free-formats Don't give any special preference to free
containers (default)
--check-formats Make sure formats are selected only from
those that are actually downloadable
--check-all-formats Check all formats for whether they are
actually downloadable
--no-check-formats Do not check that the formats are actually
downloadable
-F, --list-formats List available formats of each video.
Simulate unless --no-simulate is used
2022-08-03 18:42:12 -06:00
--merge-output-format FORMAT Containers that may be used when merging
2022-08-14 06:04:13 -06:00
formats, separated by "/", e.g. "mp4/mkv".
2022-08-03 18:42:12 -06:00
Ignored if no merge is required. (currently
supported: avi, flv, mkv, mov, mp4, webm)
2013-08-23 15:09:53 -06:00
## Subtitle Options:
2022-05-19 08:35:17 -06:00
--write-subs Write subtitle file
--no-write-subs Do not write subtitle file (default)
--write-auto-subs Write automatically generated subtitle file
(Alias: --write-automatic-subs)
--no-write-auto-subs Do not write auto-generated subtitles
(default) (Alias: --no-write-automatic-subs)
--list-subs List available subtitles of each video.
Simulate unless --no-simulate is used
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
--sub-format FORMAT Subtitle format; accepts formats preference
separated by "/", e.g. "srt" or "ass/srt/best"
2022-05-19 08:35:17 -06:00
--sub-langs LANGS Languages of the subtitles to download (can
2022-08-14 06:04:13 -06:00
be regex) or "all" separated by commas, e.g.
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
--sub-langs "en.*,ja" (where "en.*" is a
regex pattern that matches "en" followed by
0 or more of any character). You can prefix
the language code with a "-" to exclude it
from the requested languages, e.g. --sub-
langs all,-live_chat. Use --list-subs for a
list of available language tags
2011-08-05 17:14:13 -06:00
2012-08-01 03:53:17 -06:00
## Authentication Options:
2022-05-19 08:35:17 -06:00
-u, --username USERNAME Login with this account ID
-p, --password PASSWORD Account password. If this option is left
out, yt-dlp will ask interactively
-2, --twofactor TWOFACTOR Two-factor authentication code
-n, --netrc Use .netrc authentication data
--netrc-location PATH Location of .netrc authentication data;
either the path or its containing directory.
Defaults to ~/.netrc
2023-06-20 21:07:42 -06:00
--netrc-cmd NETRC_CMD Command to execute to get the credentials
2023-06-20 22:02:40 -06:00
for an extractor.
2023-10-13 16:15:35 -06:00
--video-password PASSWORD Video-specific password
2022-05-19 08:35:17 -06:00
--ap-mso MSO Adobe Pass multiple-system operator (TV
provider) identifier, use --ap-list-mso for
a list of available MSOs
--ap-username USERNAME Multiple-system operator account login
--ap-password PASSWORD Multiple-system operator account password.
If this option is left out, yt-dlp will ask
interactively
--ap-list-mso List all supported multiple-system operators
--client-certificate CERTFILE Path to client certificate file in PEM
format. May include the private key
--client-certificate-key KEYFILE
Path to private key file for client
certificate
2022-05-02 01:59:45 -06:00
--client-certificate-password PASSWORD
2022-05-19 08:35:17 -06:00
Password for client certificate private key,
if encrypted. If not provided, and the key
is encrypted, yt-dlp will ask interactively
2016-09-15 10:46:11 -06:00
2021-01-06 23:41:05 -07:00
## Post-Processing Options:
2022-05-19 08:35:17 -06:00
-x, --extract-audio Convert video files to audio-only files
(requires ffmpeg and ffprobe)
2022-06-06 10:19:57 -06:00
--audio-format FORMAT Format to convert the audio to when -x is
used. (currently supported: best (default),
2022-07-30 14:45:22 -06:00
aac, alac, flac, m4a, mp3, opus, vorbis,
2022-06-06 09:48:44 -06:00
wav). You can specify multiple rules using
similar syntax as --remux-video
2022-05-19 08:35:17 -06:00
--audio-quality QUALITY Specify ffmpeg audio quality to use when
converting the audio with -x. Insert a value
between 0 (best) and 10 (worst) for VBR or a
specific bitrate like 128K (default 5)
--remux-video FORMAT Remux the video into another container if
2022-07-30 14:45:22 -06:00
necessary (currently supported: avi, flv,
2022-12-19 12:11:45 -07:00
gif, mkv, mov, mp4, webm, aac, aiff, alac,
flac, m4a, mka, mp3, ogg, opus, vorbis,
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
wav). If the target container does not
support the video/audio codec, remuxing will
fail. You can specify multiple rules; e.g.
2022-05-19 08:35:17 -06:00
"aac>m4a/mov>mp4/mkv" will remux aac to m4a,
2022-06-06 10:19:57 -06:00
mov to mp4 and anything else to mkv
2022-05-19 08:35:17 -06:00
--recode-video FORMAT Re-encode the video into another format if
necessary. The syntax and supported formats
are the same as --remux-video
--postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
Specify the postprocessor/executable name
and the arguments separated by a colon ":"
to give the argument to the specified
postprocessor/executable. Supported PP are:
Merger, ModifyChapters, SplitChapters,
ExtractAudio, VideoRemuxer, VideoConvertor,
Metadata, EmbedSubtitle, EmbedThumbnail,
SubtitlesConvertor, ThumbnailsConvertor,
FixupStretched, FixupM4a, FixupM3u8,
FixupTimestamp and FixupDuration. The
supported executables are: AtomicParsley,
FFmpeg and FFprobe. You can also specify
"PP+EXE:ARGS" to give the arguments to the
specified executable only when being used by
the specified postprocessor. Additionally,
for ffmpeg/ffprobe, "_i"/"_o" can be
appended to the prefix optionally followed
by a number to pass the argument before the
2022-08-14 06:04:13 -06:00
specified input/output file, e.g. --ppa
2022-05-19 08:35:17 -06:00
"Merger+ffmpeg_i1:-v quiet". You can use
this option multiple times to give different
arguments to different postprocessors.
(Alias: --ppa)
-k, --keep-video Keep the intermediate video file on disk
after post-processing
--no-keep-video Delete the intermediate video file after
post-processing (default)
--post-overwrites Overwrite post-processed files (default)
--no-post-overwrites Do not overwrite post-processed files
--embed-subs Embed subtitles in the video (only for mp4,
webm and mkv videos)
--no-embed-subs Do not embed subtitles (default)
--embed-thumbnail Embed thumbnail in the video as cover art
--no-embed-thumbnail Do not embed thumbnail (default)
--embed-metadata Embed metadata to the video file. Also
embeds chapters/infojson if present unless
--no-embed-chapters/--no-embed-info-json are
used (Alias: --add-metadata)
--no-embed-metadata Do not add metadata to file (default)
(Alias: --no-add-metadata)
--embed-chapters Add chapter markers to the video file
(Alias: --add-chapters)
--no-embed-chapters Do not add chapter markers (default) (Alias:
--no-add-chapters)
--embed-info-json Embed the infojson as an attachment to
mkv/mka video files
--no-embed-info-json Do not embed the infojson as an attachment
to the video file
2022-12-29 22:31:14 -07:00
--parse-metadata [WHEN:]FROM:TO
Parse additional metadata like title/artist
2022-05-19 08:35:17 -06:00
from other fields; see "MODIFYING METADATA"
2022-12-29 22:31:14 -07:00
for details. Supported values of "WHEN" are
the same as that of --use-postprocessor
(default: pre_process)
--replace-in-metadata [WHEN:]FIELDS REGEX REPLACE
2022-05-19 08:35:17 -06:00
Replace text in a metadata field using the
given regex. This option can be used
2022-12-29 22:31:14 -07:00
multiple times. Supported values of "WHEN"
are the same as that of --use-postprocessor
(default: pre_process)
2022-05-19 08:35:17 -06:00
--xattrs Write metadata to the video file's xattrs
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
(using Dublin Core and XDG standards)
2022-05-19 08:35:17 -06:00
--concat-playlist POLICY Concatenate videos in a playlist. One of
"never", "always", or "multi_video"
(default; only when the videos form a single
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
show). All the video files must have the
same codecs and number of streams to be
concatenable. The "pl_video:" prefix can be
2022-05-19 08:35:17 -06:00
used with "--paths" and "--output" to set
the output filename for the concatenated
files. See "OUTPUT TEMPLATE" for details
--fixup POLICY Automatically correct known faults of the
file. One of never (do nothing), warn (only
emit a warning), detect_or_warn (the
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
default; fix the file if we can, warn
otherwise), force (try fixing even if the
file already exists)
2022-05-19 08:35:17 -06:00
--ffmpeg-location PATH Location of the ffmpeg binary; either the
2022-05-25 06:23:46 -06:00
path to the binary or its containing directory
2022-05-19 08:35:17 -06:00
--exec [WHEN:]CMD Execute a command, optionally prefixed with
2022-12-29 22:45:41 -07:00
when to execute it, separated by a ":".
Supported values of "WHEN" are the same as
that of --use-postprocessor (default:
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
after_move). The same syntax as the output
2022-12-29 22:45:41 -07:00
template can be used to pass any field as
2023-06-20 21:51:20 -06:00
arguments to the command. If no fields are
passed, %(filepath,_filename|)q is appended
to the end of the command. This option can
be used multiple times
2022-05-19 08:35:17 -06:00
--no-exec Remove any previously defined --exec
--convert-subs FORMAT Convert the subtitles to another format
2024-09-27 14:52:41 -06:00
(currently supported: ass, lrc, srt, vtt).
Use "--convert-subs none" to disable
conversion (default) (Alias: --convert-
subtitles)
2022-05-19 08:35:17 -06:00
--convert-thumbnails FORMAT Convert the thumbnails to another format
2022-06-05 08:28:56 -06:00
(currently supported: jpg, png, webp). You
can specify multiple rules using similar
2024-09-27 14:52:41 -06:00
syntax as "--remux-video". Use "--convert-
thumbnails none" to disable conversion
(default)
2022-05-19 08:35:17 -06:00
--split-chapters Split video into multiple files based on
internal chapters. The "chapter:" prefix can
be used with "--paths" and "--output" to set
the output filename for the split files. See
"OUTPUT TEMPLATE" for details
2022-05-25 06:23:46 -06:00
--no-split-chapters Do not split video based on chapters (default)
2022-05-19 08:35:17 -06:00
--remove-chapters REGEX Remove chapters whose title matches the
2022-06-06 14:13:50 -06:00
given regular expression. The syntax is the
same as --download-sections. This option can
2022-05-19 08:35:17 -06:00
be used multiple times
--no-remove-chapters Do not remove any chapters from the file
(default)
2022-06-06 14:13:50 -06:00
--force-keyframes-at-cuts Force keyframes at cuts when
downloading/splitting/removing sections.
This is slow due to needing a re-encode, but
the resulting video may have fewer artifacts
around the cuts
2022-05-19 08:35:17 -06:00
--no-force-keyframes-at-cuts Do not force keyframes around the chapters
when cutting/splitting (default)
--use-postprocessor NAME[:ARGS]
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
The (case-sensitive) name of plugin
2022-05-19 08:35:17 -06:00
postprocessors to be enabled, and
(optionally) arguments to be passed to it,
separated by a colon ":". ARGS are a
semicolon ";" delimited list of NAME=VALUE.
The "when" argument determines when the
postprocessor is invoked. It can be one of
"pre_process" (after video extraction),
"after_filter" (after video passes filter),
2022-12-29 22:45:41 -07:00
"video" (after --format; before
--print/--output), "before_dl" (before each
video download), "post_process" (after each
video download; default), "after_move"
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
(after moving the video file to its final
location), "after_video" (after downloading
2022-12-29 22:45:41 -07:00
and processing all formats of a video), or
"playlist" (at end of playlist). This option
can be used multiple times to add different
postprocessors
2021-09-01 14:55:16 -06:00
## SponsorBlock Options:
Make chapter entries for, or remove various segments (sponsor,
introductions, etc.) from downloaded YouTube videos using the
2021-01-18 12:17:48 -07:00
[SponsorBlock API ](https://sponsor.ajay.app )
2022-05-19 08:35:17 -06:00
--sponsorblock-mark CATS SponsorBlock categories to create chapters
for, separated by commas. Available
categories are sponsor, intro, outro,
selfpromo, preview, filler, interaction,
2022-11-29 23:04:51 -07:00
music_offtopic, poi_highlight, chapter, all
and default (=all). You can prefix the
category with a "-" to exclude it. See [1]
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
for descriptions of the categories. E.g.
2022-05-19 08:35:17 -06:00
--sponsorblock-mark all,-preview
[1] https://wiki.sponsor.ajay.app/w/Segment_Categories
--sponsorblock-remove CATS SponsorBlock categories to be removed from
the video file, separated by commas. If a
category is present in both mark and remove,
remove takes precedence. The syntax and
available categories are the same as for
--sponsorblock-mark except that "default"
2022-11-29 23:04:51 -07:00
refers to "all,-filler" and poi_highlight,
2022-10-18 10:51:57 -06:00
chapter are not available
2021-09-01 14:55:16 -06:00
--sponsorblock-chapter-title TEMPLATE
2022-05-19 08:35:17 -06:00
An output template for the title of the
SponsorBlock chapters created by
--sponsorblock-mark. The only available
fields are start_time, end_time, category,
categories, name, category_names. Defaults
to "[SponsorBlock]: %(category_names)l"
--no-sponsorblock Disable both --sponsorblock-mark and
--sponsorblock-remove
--sponsorblock-api URL SponsorBlock API location, defaults to
https://sponsor.ajay.app
2020-11-14 17:28:41 -07:00
2020-09-16 05:00:41 -06:00
## Extractor Options:
2022-05-19 08:35:17 -06:00
--extractor-retries RETRIES Number of retries for known extractor errors
(default is 3), or "infinite"
--allow-dynamic-mpd Process dynamic DASH manifests (default)
(Alias: --no-ignore-dynamic-mpd)
--ignore-dynamic-mpd Do not process dynamic DASH manifests
(Alias: --no-allow-dynamic-mpd)
--hls-split-discontinuity Split HLS playlists to different formats at
discontinuities such as ad breaks
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
--no-hls-split-discontinuity Do not split HLS playlists into different
2022-05-19 08:35:17 -06:00
formats at discontinuities such as ad breaks
(default)
2022-09-21 14:07:44 -06:00
--extractor-args IE_KEY:ARGS Pass ARGS arguments to the IE_KEY extractor.
See "EXTRACTOR ARGUMENTS" for details. You
can use this option multiple times to give
2022-05-19 08:35:17 -06:00
arguments for different extractors
2020-09-16 05:55:35 -06:00
2020-10-06 21:34:22 -06:00
# CONFIGURATION
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
You can configure yt-dlp by placing any supported command line option in a configuration file. The configuration is loaded from the following locations:
2021-01-16 11:21:00 -07:00
2022-10-03 22:19:18 -06:00
1. **Main Configuration** :
2024-03-10 13:18:47 -06:00
* The file given to `--config-location`
2022-10-03 22:19:18 -06:00
1. **Portable Configuration** : (Recommended for portable installations)
* If using a binary, `yt-dlp.conf` in the same directory as the binary
* If running from source-code, `yt-dlp.conf` in the parent directory of `yt_dlp`
1. **Home Configuration** :
2024-03-10 13:18:47 -06:00
* `yt-dlp.conf` in the home path given to `-P`
2022-10-03 22:19:18 -06:00
* If `-P` is not given, the current directory is searched
2021-01-16 11:21:00 -07:00
1. **User Configuration** :
2023-01-06 12:01:00 -07:00
* `${XDG_CONFIG_HOME}/yt-dlp.conf`
2022-10-03 22:19:18 -06:00
* `${XDG_CONFIG_HOME}/yt-dlp/config` (recommended on Linux/macOS)
2022-12-31 21:29:22 -07:00
* `${XDG_CONFIG_HOME}/yt-dlp/config.txt`
2023-01-06 12:01:00 -07:00
* `${APPDATA}/yt-dlp.conf`
2022-10-03 22:19:18 -06:00
* `${APPDATA}/yt-dlp/config` (recommended on Windows)
* `${APPDATA}/yt-dlp/config.txt`
2021-01-16 11:21:00 -07:00
* `~/yt-dlp.conf`
* `~/yt-dlp.conf.txt`
2022-12-31 21:29:22 -07:00
* `~/.yt-dlp/config`
* `~/.yt-dlp/config.txt`
2022-04-17 11:49:53 -06:00
2022-10-03 22:19:18 -06:00
See also: [Notes about environment variables ](#notes-about-environment-variables )
1. **System Configuration** :
* `/etc/yt-dlp.conf`
2022-12-31 21:29:22 -07:00
* `/etc/yt-dlp/config`
* `/etc/yt-dlp/config.txt`
2020-10-06 21:34:22 -06:00
2024-07-01 16:51:27 -06:00
E.g. with the following configuration file, yt-dlp will always extract the audio, not copy the mtime, use a proxy and save all videos under `YouTube` directory in your home directory:
2020-10-06 21:34:22 -06:00
```
# Lines starting with # are comments
# Always extract audio
-x
# Do not copy the mtime
--no-mtime
# Use this proxy
--proxy 127.0.0.1:3128
2021-01-16 11:54:52 -07:00
# Save all videos under YouTube directory in your home directory
-o ~/YouTube/%(title)s.%(ext)s
2020-10-06 21:34:22 -06:00
```
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
**Note**: Options in a configuration file are just the same options aka switches used in regular command line calls; thus there **must be no whitespace** after `-` or `--` , e.g. `-o` or `--proxy` but not `- o` or `-- proxy` . They must also be quoted when necessary, as if it were a UNIX shell.
2020-10-06 21:34:22 -06:00
2021-11-03 16:10:35 -06:00
You can use `--ignore-config` if you want to disable all configuration files for a particular yt-dlp run. If `--ignore-config` is found inside any configuration file, no further configuration will be loaded. For example, having the option in the portable configuration file prevents loading of home, user, and system configurations. Additionally, (for backward compatibility) if `--ignore-config` is found inside the system configuration file, the user configuration is not loaded.
2020-10-06 21:34:22 -06:00
2022-10-03 22:23:11 -06:00
### Configuration file encoding
2022-07-15 05:52:14 -06:00
2022-10-03 22:23:11 -06:00
The configuration files are decoded according to the UTF BOM if present, and in the encoding from system locale otherwise.
2022-07-15 05:52:14 -06:00
2022-07-15 10:14:07 -06:00
If you want your file to be decoded differently, add `# coding: ENCODING` to the beginning of the file (e.g. `# coding: shift-jis` ). There must be no characters before that, even spaces or BOM.
2022-07-15 05:52:14 -06:00
2023-06-20 21:07:42 -06:00
### Authentication with netrc
2020-10-06 21:34:22 -06:00
2024-07-01 16:51:27 -06:00
You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password` ) in order not to pass credentials as command line arguments on every yt-dlp execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file ](https://stackoverflow.com/tags/.netrc/info ) on a per-extractor basis. For that, you will need to create a `.netrc` file in `--netrc-location` and restrict permissions to read/write by only you:
2020-10-06 21:34:22 -06:00
```
2022-10-03 22:19:18 -06:00
touch ${HOME}/.netrc
chmod a-rwx,u+rw ${HOME}/.netrc
2020-10-06 21:34:22 -06:00
```
2024-07-01 16:51:27 -06:00
After that, you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
2020-10-06 21:34:22 -06:00
```
2021-09-15 13:21:40 -06:00
machine < extractor > login < username > password < password >
2020-10-06 21:34:22 -06:00
```
2022-08-14 06:04:13 -06:00
E.g.
2020-10-06 21:34:22 -06:00
```
machine youtube login myaccount@gmail.com password my_youtube_password
machine twitch login my_twitch_account_name password my_twitch_password
```
2021-02-24 11:45:56 -07:00
To activate authentication with the `.netrc` file you should pass `--netrc` to yt-dlp or place it in the [configuration file ](#configuration ).
2020-10-06 21:34:22 -06:00
2022-10-03 22:19:18 -06:00
The default location of the .netrc file is `~` (see below).
2023-06-21 00:42:15 -06:00
As an alternative to using the `.netrc` file, which has the disadvantage of keeping your passwords in a plain text file, you can configure a custom shell command to provide the credentials for an extractor. This is done by providing the `--netrc-cmd` parameter, it shall output the credentials in the netrc format and return `0` on success, other values will be treated as an error. `{}` in the command will be replaced by the name of the extractor to make it possible to select the credentials for the right extractor.
2023-06-20 21:07:42 -06:00
E.g. To use an encrypted `.netrc` file stored as `.authinfo.gpg`
```
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
yt-dlp --netrc-cmd 'gpg --decrypt ~/.authinfo.gpg' 'https://www.youtube.com/watch?v=BaW_jenozKc'
2023-06-20 21:07:42 -06:00
```
2022-10-03 22:19:18 -06:00
### Notes about environment variables
* Environment variables are normally specified as `${VARIABLE}` /`$VARIABLE` on UNIX and `%VARIABLE%` on Windows; but is always shown as `${VARIABLE}` in this documentation
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
* yt-dlp also allows using UNIX-style variables on Windows for path-like options; e.g. `--output` , `--config-location`
2022-10-03 22:19:18 -06:00
* If unset, `${XDG_CONFIG_HOME}` defaults to `~/.config` and `${XDG_CACHE_HOME}` to `~/.cache`
* On Windows, `~` points to `${HOME}` if present; or, `${USERPROFILE}` or `${HOMEDRIVE}${HOMEPATH}` otherwise
* On Windows, `${USERPROFILE}` generally points to `C:\Users\<user name>` and `${APPDATA}` to `${USERPROFILE}\AppData\Roaming`
2020-10-06 21:34:22 -06:00
# OUTPUT TEMPLATE
2021-01-23 05:18:12 -07:00
The `-o` option is used to indicate a template for the output file names while `-P` option is used to specify the path each type of file should be saved to.
2020-10-06 21:34:22 -06:00
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
2020-10-06 21:34:22 -06:00
**tl;dr:** [navigate me to examples ](#output-template-examples ).
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: END EXCLUDED SECTION -->
2020-10-06 21:34:22 -06:00
2021-04-22 05:04:02 -06:00
The simplest usage of `-o` is not to set any template arguments when downloading a single file, like in `yt-dlp -o funny_video.flv "https://some/video"` (hard-coding file extension like this is _not_ recommended and could break some post-processing).
2021-04-15 06:31:16 -06:00
2022-08-14 06:04:13 -06:00
It may however also contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [Python string formatting operations ](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting ), e.g. `%(NAME)s` or `%(NAME)05d` . To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations.
2021-04-15 06:31:16 -06:00
The field names themselves (the part inside the parenthesis) can also have some special formatting:
2022-04-17 11:49:53 -06:00
2024-07-01 16:51:27 -06:00
1. **Object traversal** : The dictionaries and lists available in metadata can be traversed by using a dot `.` separator; e.g. `%(tags.0)s` , `%(subtitles.en.-1.ext)s` . You can do Python slicing with colon `:` ; E.g. `%(id.3:7)s` , `%(id.6:2:-1)s` , `%(formats.:.format_id)s` . Curly braces `{}` can be used to build dictionaries with only specific keys; e.g. `%(formats.:.{format_id,height})#j` . An empty field name `%()s` refers to the entire infodict; e.g. `%(.{id,title})s` . Note that all the fields that become available using this method are not listed below. Use `-j` to see such fields
2021-12-16 18:23:04 -07:00
2023-12-05 15:14:11 -07:00
1. **Arithmetic** : Simple arithmetic can be done on numeric fields using `+` , `-` and `*` . E.g. `%(playlist_index+10)03d` , `%(n_entries+1-playlist_index)d`
2021-12-16 18:23:04 -07:00
2022-08-14 06:04:13 -06:00
1. **Date/time Formatting** : Date/time fields can be formatted according to [strftime formatting ](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes ) by specifying it separated from the field name using a `>` . E.g. `%(duration>%H-%M-%S)s` , `%(upload_date>%Y-%m-%d)s` , `%(epoch-3600>%H-%M-%S)s`
2021-12-16 18:23:04 -07:00
2022-08-14 06:04:13 -06:00
1. **Alternatives** : Alternate fields can be specified separated with a `,` . E.g. `%(release_date>%Y,upload_date>%Y|Unknown)s`
2021-12-16 18:23:04 -07:00
2023-04-24 07:01:36 -06:00
1. **Replacement** : A replacement value can be specified using a `&` separator according to the [`str.format` mini-language ](https://docs.python.org/3/library/string.html#format-specification-mini-language ). If the field is *not* empty, this replacement value will be used instead of the actual field content. This is done after alternate fields are considered; thus the replacement is used if *any* of the alternative fields is *not* empty. E.g. `%(chapters&has chapters|no chapters)s` , `%(title&TITLE={:>20}|NO TITLE)s`
2021-12-17 13:35:48 -07:00
2022-09-07 06:05:45 -06:00
1. **Default** : A literal default value can be specified for when the field is empty using a `|` separator. This overrides `--output-na-placeholder` . E.g. `%(uploader|Unknown)s`
2021-12-16 18:23:04 -07:00
2022-10-14 00:18:45 -06:00
1. **More Conversions** : In addition to the normal format types `diouxXeEfFgGcrs` , yt-dlp additionally supports converting to `B` = **B**ytes, `j` = **j**son (flag `#` for pretty-printing, `+` for Unicode), `h` = HTML escaping, `l` = a comma separated **l**ist (flag `#` for `\n` newline-separated), `q` = a string **q**uoted for the terminal (flag `#` to split a list into different arguments), `D` = add **D**ecimal suffixes (e.g. 10M) (flag `#` to use 1024 as factor), and `S` = **S**anitize as filename (flag `#` for restricted)
2021-12-16 18:23:04 -07:00
2022-10-18 11:58:57 -06:00
1. **Unicode normalization** : The format type `U` can be used for NFC [Unicode normalization ](https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize ). The alternate form flag (`#`) changes the normalization to NFD and the conversion flag `+` can be used for NFKC/NFKD compatibility equivalence normalization. E.g. `%(title)+.100U` is NFKC
2021-04-15 06:31:16 -06:00
To summarize, the general syntax for a field is:
```
2021-12-17 13:35:48 -07:00
%(name[.keys][addition][>strf][,alternate][& replacement][|default])[flags][width][.precision][length]type
2021-04-15 06:31:16 -06:00
```
2021-02-03 06:36:09 -07:00
2024-07-01 16:51:27 -06:00
Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon `:` . The different file types supported are `subtitle` , `thumbnail` , `description` , `annotation` (deprecated), `infojson` , `link` , `pl_thumbnail` , `pl_description` , `pl_infojson` , `chapter` , `pl_video` . E.g. `-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"` will put the thumbnails in a folder with the same name as the video. If any of the templates is empty, that type of file will not be written. E.g. `--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
2021-02-02 14:15:00 -07:00
2024-03-10 13:18:47 -06:00
< a id = "outtmpl-postprocess-note" > < / a >
2022-11-10 20:13:08 -07:00
2023-01-02 07:09:28 -07:00
**Note**: Due to post-processing (i.e. merging etc.), the actual output filename might differ. Use `--print after_move:filepath` to get the name after all post-processing is complete.
2022-11-10 20:13:08 -07:00
2021-02-02 14:15:00 -07:00
The available fields are:
2020-10-06 21:34:22 -06:00
- `id` (string): Video identifier
- `title` (string): Video title
2022-02-03 08:02:10 -07:00
- `fulltitle` (string): Video title ignoring live timestamp and generic title
2020-10-06 21:34:22 -06:00
- `ext` (string): Video filename extension
- `alt_title` (string): A secondary title of the video
2021-03-14 18:00:18 -06:00
- `description` (string): The description of the video
2020-10-06 21:34:22 -06:00
- `display_id` (string): An alternative identifier for the video
- `uploader` (string): Full name of the video uploader
2024-03-08 15:36:41 -07:00
- `uploader_id` (string): Nickname or id of the video uploader
- `uploader_url` (string): URL to the video uploader's profile
2020-10-06 21:34:22 -06:00
- `license` (string): License name the video is licensed under
2024-02-20 00:19:24 -07:00
- `creators` (list): The creators of the video
- `creator` (string): The creators of the video; comma-separated
2020-10-06 21:34:22 -06:00
- `timestamp` (numeric): UNIX timestamp of the moment the video became available
2022-03-23 19:30:22 -06:00
- `upload_date` (string): Video upload date in UTC (YYYYMMDD)
2021-09-17 12:23:55 -06:00
- `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
2022-03-23 19:30:22 -06:00
- `release_date` (string): The date (YYYYMMDD) when the video was released in UTC
2023-11-25 19:12:05 -07:00
- `release_year` (numeric): Year (YYYY) when the video or album was released
2022-01-07 04:03:02 -07:00
- `modified_timestamp` (numeric): UNIX timestamp of the moment the video was last modified
2022-03-23 19:30:22 -06:00
- `modified_date` (string): The date (YYYYMMDD) when the video was last modified in UTC
2020-10-06 21:34:22 -06:00
- `channel` (string): Full name of the channel the video is uploaded on
- `channel_id` (string): Id of the channel
2024-03-08 15:36:41 -07:00
- `channel_url` (string): URL of the channel
2022-01-20 23:04:36 -07:00
- `channel_follower_count` (numeric): Number of followers of the channel
2023-06-08 01:50:05 -06:00
- `channel_is_verified` (boolean): Whether the channel is verified on the platform
2020-10-06 21:34:22 -06:00
- `location` (string): Physical location where the video was filmed
- `duration` (numeric): Length of the video in seconds
2021-05-14 01:44:38 -06:00
- `duration_string` (string): Length of the video (HH:mm:ss)
2020-10-06 21:34:22 -06:00
- `view_count` (numeric): How many users have watched the video on the platform
2022-10-07 01:00:40 -06:00
- `concurrent_view_count` (numeric): How many users are currently watching the video on the platform.
2020-10-06 21:34:22 -06:00
- `like_count` (numeric): Number of positive ratings of the video
- `dislike_count` (numeric): Number of negative ratings of the video
- `repost_count` (numeric): Number of reposts of the video
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
- `average_rating` (numeric): Average rating given by users, the scale used depends on the webpage
2021-02-28 07:56:08 -07:00
- `comment_count` (numeric): Number of comments on the video (For some extractors, comments are only downloaded at the end, and so this field cannot be used)
2020-10-06 21:34:22 -06:00
- `age_limit` (numeric): Age restriction for the video (years)
2022-07-31 14:12:04 -06:00
- `live_status` (string): One of "not_live", "is_live", "is_upcoming", "was_live", "post_live" (was live, but VOD is not yet processed)
2020-10-06 21:34:22 -06:00
- `is_live` (boolean): Whether this video is a live stream or a fixed-length video
2021-02-21 14:41:24 -07:00
- `was_live` (boolean): Whether this video was originally a live stream
2021-01-14 02:07:23 -07:00
- `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
2021-12-17 15:58:18 -07:00
- `availability` (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
2023-12-11 16:52:59 -07:00
- `media_type` (string): The type of media as classified by the site, e.g. "episode", "clip", "trailer"
2020-10-06 21:34:22 -06:00
- `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
- `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
- `extractor` (string): Name of the extractor
- `extractor_key` (string): Key name of the extractor
2022-02-03 08:02:10 -07:00
- `epoch` (numeric): Unix epoch of when the information extraction was completed
2023-07-06 07:48:35 -06:00
- `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start` , padded with leading zeros to 5 digits
2022-01-03 06:07:35 -07:00
- `video_autonumber` (numeric): Number that will be increased with each video
2021-09-17 12:23:55 -06:00
- `n_entries` (numeric): Total number of extracted items in the playlist
2022-02-03 08:02:10 -07:00
- `playlist_id` (string): Identifier of the playlist that contains the video
- `playlist_title` (string): Name of the playlist that contains the video
2024-07-01 16:51:27 -06:00
- `playlist` (string): `playlist_title` if available or else `playlist_id`
2022-01-07 04:03:02 -07:00
- `playlist_count` (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
2021-09-17 12:23:55 -06:00
- `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
- `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
2020-10-06 21:34:22 -06:00
- `playlist_uploader` (string): Full name of the playlist uploader
- `playlist_uploader_id` (string): Nickname or id of the playlist uploader
2024-07-01 10:48:11 -06:00
- `playlist_channel` (string): Display name of the channel that uploaded the playlist
- `playlist_channel_id` (string): Identifier of the channel that uploaded the playlist
2024-07-01 16:51:27 -06:00
- `webpage_url` (string): A URL to the video webpage which, if given to yt-dlp, should yield the same result again
2021-10-17 20:13:21 -06:00
- `webpage_url_basename` (string): The basename of the webpage URL
- `webpage_url_domain` (string): The domain of the webpage URL
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
- `original_url` (string): The URL given by the user (or the same as `webpage_url` for playlist entries)
2024-03-08 15:36:41 -07:00
- `categories` (list): List of categories the video belongs to
- `tags` (list): List of tags assigned to the video
- `cast` (list): List of cast members
2022-09-01 05:19:03 -06:00
All the fields in [Filtering Formats ](#filtering-formats ) can also be used
2020-10-06 21:34:22 -06:00
Available for the video that belongs to some logical chapter or section:
- `chapter` (string): Name or title of the chapter the video belongs to
- `chapter_number` (numeric): Number of the chapter the video belongs to
- `chapter_id` (string): Id of the chapter the video belongs to
2024-07-01 16:51:27 -06:00
Available for the video that is an episode of some series or program:
2020-10-06 21:34:22 -06:00
2024-07-01 16:51:27 -06:00
- `series` (string): Title of the series or program the video episode belongs to
- `series_id` (string): Id of the series or program the video episode belongs to
2020-10-06 21:34:22 -06:00
- `season` (string): Title of the season the video episode belongs to
- `season_number` (numeric): Number of the season the video episode belongs to
- `season_id` (string): Id of the season the video episode belongs to
- `episode` (string): Title of the video episode
- `episode_number` (numeric): Number of the video episode within a season
- `episode_id` (string): Id of the video episode
Available for the media that is a track or a part of a music album:
- `track` (string): Title of the track
- `track_number` (numeric): Number of the track within an album or a disc
- `track_id` (string): Id of the track
2024-02-20 00:19:24 -07:00
- `artists` (list): Artist(s) of the track
- `artist` (string): Artist(s) of the track; comma-separated
- `genres` (list): Genre(s) of the track
- `genre` (string): Genre(s) of the track; comma-separated
- `composers` (list): Composer(s) of the piece
- `composer` (string): Composer(s) of the piece; comma-separated
2020-10-06 21:34:22 -06:00
- `album` (string): Title of the album the track belongs to
- `album_type` (string): Type of the album
2024-02-20 00:19:24 -07:00
- `album_artists` (list): All artists appeared on the album
- `album_artist` (string): All artists appeared on the album; comma-separated
2020-10-06 21:34:22 -06:00
- `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
2022-06-06 14:13:50 -06:00
Available only when using `--download-sections` and for `chapter:` prefix when using `--split-chapters` for videos with internal chapters:
2021-03-14 17:02:13 -06:00
- `section_title` (string): Title of the chapter
- `section_number` (numeric): Number of the chapter within the file
- `section_start` (numeric): Start time of the chapter in seconds
- `section_end` (numeric): End time of the chapter in seconds
2021-05-14 01:44:38 -06:00
Available only when used in `--print` :
- `urls` (string): The URLs of all requested formats, one in each line
2022-11-10 20:13:08 -07:00
- `filename` (string): Name of the video file. Note that the [actual filename may differ ](#outtmpl-postprocess-note )
2022-01-10 11:27:59 -07:00
- `formats_table` (table): The video format table as printed by `--list-formats`
- `thumbnails_table` (table): The thumbnail format table as printed by `--list-thumbnails`
- `subtitles_table` (table): The subtitle format table as printed by `--list-subs`
- `automatic_captions_table` (table): The automatic subtitle format table as printed by `--list-subs`
2024-07-01 16:51:27 -06:00
2023-06-20 21:51:20 -06:00
Available only after the video is downloaded (`post_process`/`after_move`):
2024-07-01 16:51:27 -06:00
2023-06-20 21:51:20 -06:00
- `filepath` : Actual path of downloaded video file
2021-09-01 14:55:16 -06:00
Available only in `--sponsorblock-chapter-title` :
- `start_time` (numeric): Start time of the chapter in seconds
- `end_time` (numeric): End time of the chapter in seconds
2022-10-18 11:38:23 -06:00
- `categories` (list): The [SponsorBlock categories ](https://wiki.sponsor.ajay.app/w/Types#Category ) the chapter belongs to
2021-09-01 14:55:16 -06:00
- `category` (string): The smallest SponsorBlock category the chapter belongs to
- `category_names` (list): Friendly names of the categories
- `name` (string): Friendly name of the smallest category
2022-10-18 11:38:23 -06:00
- `type` (string): The [SponsorBlock action type ](https://wiki.sponsor.ajay.app/w/Types#Action_Type ) of the chapter
2021-05-14 01:44:38 -06:00
2022-08-14 06:04:13 -06:00
Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. E.g. for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `yt-dlp test video` and id `BaW_jenozKc` , this will result in a `yt-dlp test video-BaW_jenozKc.mp4` file created in the current directory.
2021-10-22 14:37:20 -06:00
2024-07-01 16:51:27 -06:00
**Note**: Some of the sequences are not guaranteed to be present, since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with `--output-na-placeholder` (`NA` by default).
2020-10-06 21:34:22 -06:00
2021-10-31 03:15:59 -06:00
**Tip**: Look at the `-j` output to identify which fields are available for the particular URL
2020-10-06 21:34:22 -06:00
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
For numeric sequences, you can use [numeric related formatting ](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting ); e.g. `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042` .
2020-10-06 21:34:22 -06:00
2021-12-17 15:58:18 -07:00
Output templates can also contain arbitrary hierarchical path, e.g. `-o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s"` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
2020-10-06 21:34:22 -06:00
To use percent literals in an output template use `%%` . To output to stdout use `-o -` .
Change defaults
* Enabled --ignore by default
* Disabled --video-multistreams and --audio-multistreams by default
* Changed default format selection to 'bv*+ba/b' when --audio-multistreams is disabled
* Changed default format sort order to 'res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id'
* Changed default output template to '%(title)s [%(id)s].%(ext)s'
* Enabled `--list-formats-as-table` by default
2021-01-04 09:40:47 -07:00
The current default template is `%(title)s [%(id)s].%(ext)s` .
2020-10-06 21:34:22 -06:00
2021-11-28 14:22:52 -07:00
In some cases, you don't want special characters such as 中, spaces, or & , such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title.
2020-10-06 21:34:22 -06:00
#### Output template examples
```bash
2022-09-01 05:19:03 -06:00
$ yt-dlp --print filename -o "test video.%(ext)s" BaW_jenozKc
2021-11-18 17:06:28 -07:00
test video.webm # Literal name with correct extension
2022-09-01 05:19:03 -06:00
$ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc
2021-11-18 17:06:28 -07:00
youtube-dl test video ''_ä↭𝕐
2020-10-06 21:34:22 -06:00
2022-09-01 05:19:03 -06:00
$ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
2021-11-18 17:06:28 -07:00
youtube-dl_test_video_.webm # Restricted file name
2020-10-06 21:34:22 -06:00
# Download YouTube playlist videos in separate directory indexed by video order in a playlist
2021-12-17 15:58:18 -07:00
$ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
2020-10-06 21:34:22 -06:00
2021-04-01 02:46:10 -06:00
# Download YouTube playlist videos in separate directories according to their uploaded year
2021-12-17 15:58:18 -07:00
$ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
2021-02-02 14:15:00 -07:00
2021-12-17 13:35:48 -07:00
# Prefix playlist index with " - " separator, but only if it is available
2023-06-20 21:51:20 -06:00
$ yt-dlp -o "%(playlist_index& {} - |)s%(title)s.%(ext)s" BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
2021-12-17 13:35:48 -07:00
2020-10-06 21:34:22 -06:00
# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
2021-12-17 15:58:18 -07:00
$ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
2020-10-06 21:34:22 -06:00
# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
2021-12-17 15:58:18 -07:00
$ yt-dlp -u user -p password -P "~/MyVideos" -o "%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s" "https://www.udemy.com/java-tutorial"
2020-10-06 21:34:22 -06:00
# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
2021-12-17 15:58:18 -07:00
$ yt-dlp -P "C:/MyVideos" -o "%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" "https://videomore.ru/kino_v_detalayah/5_sezon/367617"
2020-10-06 21:34:22 -06:00
2021-12-26 18:56:21 -07:00
# Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
# and put all temporary files in "C:\MyVideos\tmp"
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
$ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenozKc --write-subs
2021-12-26 18:56:21 -07:00
# Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
$ yt-dlp -P "C:/MyVideos" -o "%(uploader)s/%(title)s.%(ext)s" -o "subtitle:%(uploader)s/subs/%(title)s.%(ext)s" BaW_jenozKc --write-subs
2020-10-06 21:34:22 -06:00
# Stream the video being downloaded to stdout
2021-02-24 11:45:56 -07:00
$ yt-dlp -o - BaW_jenozKc
2020-10-06 21:34:22 -06:00
```
# FORMAT SELECTION
2021-02-24 11:45:56 -07:00
By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
This is generally equivalent to using `-f bestvideo*+bestaudio/best` . However, if multiple audiostreams is enabled (`--audio-multistreams`), the default format changes to `-f bestvideo+bestaudio/best` . Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to `stdout` (`-o -`), the default becomes `-f best/bestvideo+bestaudio` .
2020-10-06 21:34:22 -06:00
2021-10-12 05:20:04 -06:00
**Deprecation warning**: Latest versions of yt-dlp can stream multiple formats to the stdout simultaneously using ffmpeg. So, in future versions, the default for this will be set to `-f bv*+ba/b` similar to normal downloads. If you want to preserve the `-f b/bv+ba` setting, it is recommended to explicitly specify it in the configuration options.
2021-04-02 10:42:42 -06:00
The general syntax for format selection is `-f FORMAT` (or `--format FORMAT` ) where `FORMAT` is a *selector expression* , i.e. an expression that describes format or formats you would like to download.
2020-10-06 21:34:22 -06:00
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
2020-10-06 21:34:22 -06:00
**tl;dr:** [navigate me to examples ](#format-selection-examples ).
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: END EXCLUDED SECTION -->
2020-10-06 21:34:22 -06:00
2022-08-14 06:04:13 -06:00
The simplest case is requesting a specific format; e.g. with `-f 22` you can download the format with format code equal to 22. You can get the list of available format codes for particular video using `--list-formats` or `-F` . Note that these format codes are extractor specific.
2020-10-06 21:34:22 -06:00
You can also use a file extension (currently `3gp` , `aac` , `flv` , `m4a` , `mp3` , `mp4` , `ogg` , `wav` , `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
2021-12-21 04:32:13 -07:00
You can use `-f -` to interactively provide the format selector *for each video*
2020-10-06 21:34:22 -06:00
You can also use special names to select particular edge case formats:
2021-11-09 15:42:25 -07:00
- `all` : Select **all formats** separately
- `mergeall` : Select and **merge all formats** (Must be used with `--audio-multistreams` , `--video-multistreams` or both)
2024-07-01 16:51:27 -06:00
- `b*` , `best*` : Select the best quality format that **contains either** a video or an audio or both (i.e.; `vcodec!=none or acodec!=none` )
2021-11-09 15:42:25 -07:00
- `b` , `best` : Select the best quality format that **contains both** video and audio. Equivalent to `best*[vcodec!=none][acodec!=none]`
- `bv` , `bestvideo` : Select the best quality **video-only** format. Equivalent to `best*[acodec=none]`
- `bv*` , `bestvideo*` : Select the best quality format that **contains video** . It may also contain audio. Equivalent to `best*[vcodec!=none]`
- `ba` , `bestaudio` : Select the best quality **audio-only** format. Equivalent to `best*[vcodec=none]`
2022-03-23 19:30:22 -06:00
- `ba*` , `bestaudio*` : Select the best quality format that **contains audio** . It may also contain video. Equivalent to `best*[acodec!=none]` ([Do not use!](https://github.com/yt-dlp/yt-dlp/issues/979#issuecomment-919629354))
2021-11-09 15:42:25 -07:00
- `w*` , `worst*` : Select the worst quality format that contains either a video or an audio
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
- `w` , `worst` : Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]`
- `wv` , `worstvideo` : Select the worst quality video-only format. Equivalent to `worst*[acodec=none]`
- `wv*` , `worstvideo*` : Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]`
- `wa` , `worstaudio` : Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]`
- `wa*` , `worstaudio*` : Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]`
2020-10-06 21:34:22 -06:00
2024-07-01 16:51:27 -06:00
For example, to download the worst quality video-only format you can use `-f worstvideo` . It is, however, recommended not to use `worst` and related options. When your format selector is `worst` , the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-S +size` or more rigorously, `-S +size,+br,+res,+fps` instead of `-f worst` . See [Sorting Formats ](#sorting-formats ) for more details.
2021-04-02 10:42:42 -06:00
You can select the n'th best format of a type by using `best<type>.<n>` . For example, `best.2` will select the 2nd best combined format. Similarly, `bv*.3` will select the 3rd best format that contains a video stream.
2020-10-06 21:34:22 -06:00
2022-10-03 22:23:11 -06:00
If you want to download multiple videos, and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred; e.g. `-f 22/17/18` will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
2020-10-06 21:34:22 -06:00
If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio` .
2022-08-14 06:04:13 -06:00
You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...` (requires ffmpeg installed); e.g. `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg.
2021-09-21 18:20:11 -06:00
**Deprecation warning**: Since the *below* described behavior is complex and counter-intuitive, this will be removed and multistreams will be enabled by default in the future. A new operator will be instead added to limit formats to single audio/video
2022-10-03 22:23:11 -06:00
Unless `--video-multistreams` is used, all formats with a video stream except the first one are ignored. Similarly, unless `--audio-multistreams` is used, all formats with an audio stream except the first one are ignored. E.g. `-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams` will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But `-f bestvideo+best+bestaudio --no-video-multistreams` will download and merge only `bestvideo` and `bestaudio` . `best` is ignored since another format containing a video stream (`bestvideo`) has already been selected. The order of the formats is therefore important. `-f best+bestaudio --no-audio-multistreams` will download only `best` while `-f bestaudio+best --no-audio-multistreams` will ignore `best` and download only `bestaudio` .
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
## Filtering Formats
2023-07-06 07:48:35 -06:00
You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"` since filters without a selector are interpreted as `best` ).
2020-10-06 21:34:22 -06:00
The following numeric meta fields can be used with comparisons `<` , `<=` , `>` , `>=` , `=` (equals), `!=` (not equals):
- `filesize` : The number of bytes, if known in advance
2022-09-01 05:19:03 -06:00
- `filesize_approx` : An estimate for the number of bytes
2020-10-06 21:34:22 -06:00
- `width` : Width of the video, if known
- `height` : Height of the video, if known
2022-11-15 18:22:57 -07:00
- `aspect_ratio` : Aspect ratio of the video, if known
2024-03-31 17:17:24 -06:00
- `tbr` : Average bitrate of audio and video in [kbps ](## "1000 bits/sec" )
- `abr` : Average audio bitrate in [kbps ](## "1000 bits/sec" )
- `vbr` : Average video bitrate in [kbps ](## "1000 bits/sec" )
2020-10-06 21:34:22 -06:00
- `asr` : Audio sampling rate in Hertz
- `fps` : Frame rate
2022-09-01 05:19:03 -06:00
- `audio_channels` : The number of audio channels
- `stretched_ratio` : `width:height` of the video's pixels, if not square
2020-10-06 21:34:22 -06:00
2022-02-11 14:35:34 -07:00
Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains), `~=` (matches regex) and following string meta fields:
2020-10-06 21:34:22 -06:00
2022-09-01 05:19:03 -06:00
- `url` : Video URL
2020-10-06 21:34:22 -06:00
- `ext` : File extension
- `acodec` : Name of the audio codec in use
- `vcodec` : Name of the video codec in use
- `container` : Name of the container format
- `protocol` : The protocol that will be used for the actual download, lower-case (`http`, `https` , `rtsp` , `rtmp` , `rtmpe` , `mms` , `f4m` , `ism` , `http_dash_segments` , `m3u8` , or `m3u8_native` )
2021-01-01 05:26:37 -07:00
- `language` : Language code
2022-09-01 05:19:03 -06:00
- `dynamic_range` : The dynamic range of the video
- `format_id` : A short description of the format
- `format` : A human-readable description of the format
- `format_note` : Additional info about the format
- `resolution` : Textual description of width and height
2020-10-06 21:34:22 -06:00
2022-02-11 14:35:34 -07:00
Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain). The comparand of a string comparison needs to be quoted with either double or single quotes if it contains spaces or special characters other than `._-` .
2020-10-06 21:34:22 -06:00
2024-07-01 16:51:27 -06:00
**Note**: None of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by the particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.
2020-10-06 21:34:22 -06:00
2024-03-31 17:17:24 -06:00
Formats for which the value is not known are excluded unless you put a question mark (`?`) after the operator. You can combine format filters, so `-f "bv[height<=?720][tbr>500]"` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 kbps. You can also use the filters with `all` to download all formats that satisfy the filter, e.g. `-f "all[vcodec=none]"` selects all audio-only formats.
2020-10-06 21:34:22 -06:00
2022-08-14 06:04:13 -06:00
Format selectors can also be grouped using parentheses; e.g. `-f "(mp4,webm)[height<480]"` will download the best pre-merged mp4 and webm formats with a height lower than 480.
2020-10-06 21:34:22 -06:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
## Sorting Formats
2021-08-27 14:50:18 -06:00
You can change the criteria for being considered the `best` by using `-S` (`--format-sort`). The general format for this is `--format-sort field1,field2...` .
The available fields are:
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
2022-10-03 22:23:11 -06:00
- `hasvid` : Gives priority to formats that have a video stream
- `hasaud` : Gives priority to formats that have an audio stream
2022-01-11 20:30:21 -07:00
- `ie_pref` : The format preference
- `lang` : The language preference
- `quality` : The quality of the format
- `source` : The preference of the source
2021-12-24 15:38:15 -07:00
- `proto` : Protocol used for download (`https`/`ftps` > `http` /`ftp` > `m3u8_native` /`m3u8` > `http_dash_segments` > `websocket_frag` > `mms` /`rtsp` > `f4f` /`f4m`)
- `vcodec` : Video Codec (`av01` > `vp9.2` > `vp9` > `h265` > `h264` > `vp8` > `h263` > `theora` > other)
2023-02-17 05:22:22 -07:00
- `acodec` : Audio Codec (`flac`/`alac` > `wav` /`aiff` > `opus` > `vorbis` > `aac` > `mp4a` > `mp3` > `ac4` > `eac3` > `ac3` > `dts` > other)
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
- `codec` : Equivalent to `vcodec,acodec`
2022-11-17 23:01:15 -07:00
- `vext` : Video Extension (`mp4` > `mov` > `webm` > `flv` > other). If `--prefer-free-formats` is used, `webm` is preferred.
2022-08-31 11:19:14 -06:00
- `aext` : Audio Extension (`m4a` > `aac` > `mp3` > `ogg` > `opus` > `webm` > other). If `--prefer-free-formats` is used, the order changes to `ogg` > `opus` > `webm` > `mp3` > `m4a` > `aac`
2021-01-21 05:50:09 -07:00
- `ext` : Equivalent to `vext,aext`
2021-10-31 03:15:59 -06:00
- `filesize` : Exact filesize, if known in advance
2023-07-21 21:38:12 -06:00
- `fs_approx` : Approximate filesize
2021-01-21 05:50:09 -07:00
- `size` : Exact filesize if available, otherwise approximate filesize
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
- `height` : Height of video
- `width` : Width of video
2021-01-21 05:50:09 -07:00
- `res` : Video resolution, calculated as the smallest dimension.
- `fps` : Framerate of video
2021-10-22 14:37:20 -06:00
- `hdr` : The dynamic range of the video (`DV` > `HDR12` > `HDR10+` > `HDR10` > `HLG` > `SDR` )
2022-08-07 14:05:36 -06:00
- `channels` : The number of audio channels
2024-03-31 17:17:24 -06:00
- `tbr` : Total average bitrate in [kbps ](## "1000 bits/sec" )
- `vbr` : Average video bitrate in [kbps ](## "1000 bits/sec" )
- `abr` : Average audio bitrate in [kbps ](## "1000 bits/sec" )
- `br` : Average bitrate in [kbps ](## "1000 bits/sec" ), `tbr` /`vbr`/`abr`
2021-01-21 05:50:09 -07:00
- `asr` : Audio sample rate in Hz
2024-07-01 16:51:27 -06:00
2021-09-21 18:20:11 -06:00
**Deprecation warning**: Many of these fields have (currently undocumented) aliases, that may be removed in a future version. It is recommended to use only the documented field names.
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
2022-08-14 06:04:13 -06:00
All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a `+` . E.g. `+res` prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a `:` . E.g. `res:720` prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For `codec` and `ext` , you can provide two preferred values, the first for video and the second for audio. E.g. `+codec:avc:m4a` (equivalent to `+vcodec:avc,+acodec:m4a` ) sets the video codec preference to `h264` > `h265` > `vp9` > `vp9.2` > `av01` > `vp8` > `h263` > `theora` and audio codec preference to `mp4a` > `aac` > `vorbis` > `opus` > `mp3` > `ac3` > `dts` . You can also make the sorting prefer the nearest values to the provided by using `~` as the delimiter. E.g. `filesize~1G` prefers the format with filesize closest to 1 GiB.
2021-09-01 17:09:47 -06:00
2024-11-03 12:39:10 -07:00
The fields `hasvid` and `ie_pref` are always given highest priority in sorting, irrespective of the user-defined order. This behavior can be changed by using `--format-sort-force` . Apart from these, the default order used is: `lang,quality,res,fps,hdr:12,vcodec,channels,acodec,size,br,asr,proto,ext,hasaud,source,id` . The extractors may override this default order, but they cannot override the user-provided order.
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
2024-11-03 12:39:10 -07:00
Note that the default for hdr is `hdr:12` ; i.e. Dolby Vision is not preferred. This choice was made since DV formats are not yet fully compatible with most devices. This may be changed in the future.
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
2021-04-22 05:04:02 -06:00
If your format selector is `worst` , the last item is selected after sorting. This means it will select the format that is worst in all respects. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-f best -S +size,+br,+res,+fps` .
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
**Tip**: You can use the `-v -F` to see how the formats have been sorted (worst to best).
## Format Selection examples
2020-10-06 21:34:22 -06:00
```bash
2021-04-22 05:04:02 -06:00
# Download and merge the best video-only format and the best audio-only format,
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
# or download the best combined format if video-only format is not available
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv+ba/b"
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
# Download best format that contains video,
# and if it doesn't already have an audio stream, merge it with best audio-only format
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv*+ba/b"
2021-01-04 12:43:45 -07:00
# Same as above
2021-02-24 11:45:56 -07:00
$ yt-dlp
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
2021-01-09 05:27:36 -07:00
# Download the best video-only format and the best audio-only format without merging them
# For this case, an output template should be used since
# by default, bestvideo and bestaudio will have the same file name.
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
2021-04-10 08:40:30 -06:00
# Download and merge the best format that has a video stream,
# and all audio-only formats into one file
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
2021-04-10 08:40:30 -06:00
# Download and merge the best format that has a video stream,
# and the best 2 audio-only formats into one file
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
2021-01-09 05:27:36 -07:00
# The following examples show the old method (without -S) of format selection
2021-04-10 08:40:30 -06:00
# and how to use -S to achieve a similar but (generally) better result
2021-01-09 05:27:36 -07:00
# Download the worst video available (old method)
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "wv*+wa/w"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video available but with the smallest resolution
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "+res"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the smallest video available
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "+size,+br"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best mp4 video available, or the best video if no mp4 available
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video with the best extension
2022-11-17 23:01:15 -07:00
# (For video, mp4 > mov > webm > flv. For audio, m4a > aac > mp3 ...)
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "ext"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video available but no better than 480p,
# or the worst video if there is no video under 480p
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "bv*[height< =480]+ba/b[height< =480] / wv*+ba/w"
2020-10-06 21:34:22 -06:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video available with the largest height but no better than 480p,
# or the best video with the smallest resolution if there is no video under 480p
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "height:480"
2020-10-06 21:34:22 -06:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video available with the largest resolution but no better than 480p,
# or the best video with the smallest resolution if there is no video under 480p
# Resolution is determined by using the smallest dimension.
# So this works correctly for vertical videos as well
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "res:480"
2020-10-06 21:34:22 -06:00
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video (that also has audio) but no bigger than 50 MB,
# or the worst video (that also has audio) if there is no video under 50 MB
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "b[filesize< 50M ] / w "
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
# Download the largest video (that also has audio) but no bigger than 50 MB,
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# or the smallest video (that also has audio) if there is no video under 50 MB
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "b" -S "filesize:50M"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
# Download the best video (that also has audio) that is closest in size to 50 MB
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "b" -S "filesize~50M"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download best video available via direct link over HTTP/HTTPS protocol,
# or the best video available via any protocol if there is no such video
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download best video available via the best protocol
# (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "proto"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
2022-02-11 14:35:34 -07:00
# Download the best video with either h264 or h265 codec,
# or the best video if there is no such video
$ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video with best codec no better than h264,
# or the best video with worst codec if there is no such video
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "codec:h264"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the best video with worst codec no worse than h264,
# or the best video with best codec if there is no such video
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "+codec:h264"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# More complex examples
2021-04-22 05:04:02 -06:00
# Download the best video no better than 720p preferring framerate greater than 30,
# or the worst video (still preferring framerate greater than 30) if there is no such video
2021-12-17 15:58:18 -07:00
$ yt-dlp -f "((bv*[fps>30]/bv*)[height< =720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height< =720]/(w[fps>30]/w)"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the video with the largest resolution no better than 720p,
2021-04-10 08:40:30 -06:00
# or the video with the smallest resolution available if there is no such video,
2021-04-22 05:04:02 -06:00
# preferring larger framerate for formats with the same resolution
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "res:720,fps"
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 08:35:36 -07:00
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
# Download the video with smallest resolution no worse than 480p,
# or the video with the largest resolution available if there is no such video,
2021-04-22 05:04:02 -06:00
# preferring better codec and then larger total bitrate for the same resolution
2021-12-17 15:58:18 -07:00
$ yt-dlp -S "+res:480,codec,br"
2020-10-06 21:34:22 -06:00
```
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 09:50:09 -06:00
2021-04-03 02:33:25 -06:00
# MODIFYING METADATA
2021-11-03 16:10:35 -06:00
The metadata obtained by the extractors can be modified by using `--parse-metadata` and `--replace-in-metadata`
2021-08-09 13:52:55 -06:00
2024-03-10 13:18:47 -06:00
`--replace-in-metadata FIELDS REGEX REPLACE` is used to replace text in any metadata field using [Python regular expression ](https://docs.python.org/3/library/re.html#regular-expression-syntax ). [Backreferences ](https://docs.python.org/3/library/re.html?highlight=backreferences#re.sub ) can be used in the replace string for advanced use.
2021-08-09 13:52:55 -06:00
2024-03-10 13:18:47 -06:00
The general syntax of `--parse-metadata FROM:TO` is to give the name of a field or an [output template ](#output-template ) to extract data from, and the format to interpret it as, separated by a colon `:` . Either a [Python regular expression ](https://docs.python.org/3/library/re.html#regular-expression-syntax ) with named capture groups, a single field name, or a similar syntax to the [output template ](#output-template ) (only `%(field)s` formatting is supported) can be used for `TO` . The option can be used multiple times to parse and modify various fields.
2021-04-03 02:33:25 -06:00
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
Note that these options preserve their relative order, allowing replacements to be made in parsed fields and vice versa. Also, any field thus created can be used in the [output template ](#output-template ) and will also affect the media file's metadata added when using `--embed-metadata` .
2021-04-03 02:33:25 -06:00
2021-05-18 12:20:29 -06:00
This option also has a few special uses:
2022-04-17 11:49:53 -06:00
2023-05-19 15:05:08 -06:00
* You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field `additional_urls` to the URL that you want to download. E.g. `--parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)"` will download the first vimeo video found in the description
2022-04-17 11:49:53 -06:00
2022-08-14 06:04:13 -06:00
* You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a `meta_` prefix. For example, any value you set to `meta_description` field will be added to the `description` field in the file - you can use this to set a different "description" and "synopsis". To modify the metadata of individual streams, use the `meta<n>_` prefix (e.g. `meta1_language` ). Any value set to the `meta_` field will overwrite all default values.
2021-08-02 14:03:51 -06:00
2022-03-04 07:08:55 -07:00
**Note**: Metadata modification happens before format selection, post-extraction and other post-processing operations. Some fields may be added or changed during these steps, overriding your changes.
2021-08-02 14:03:51 -06:00
For reference, these are the fields yt-dlp adds by default to the file metadata:
2022-03-04 07:08:55 -07:00
Metadata fields | From
:--------------------------|:------------------------------------------------
`title` | `track` or `title`
`date` | `upload_date`
`description` , `synopsis` | `description`
`purl` , `comment` | `webpage_url`
`track` | `track_number`
2024-02-20 00:19:24 -07:00
`artist` | `artist` , `artists` , `creator` , `creators` , `uploader` or `uploader_id`
`composer` | `composer` or `composers`
`genre` | `genre` or `genres`
2022-03-04 07:08:55 -07:00
`album` | `album`
2024-02-20 00:19:24 -07:00
`album_artist` | `album_artist` or `album_artists`
2022-03-04 07:08:55 -07:00
`disc` | `disc_number`
`show` | `series`
`season_number` | `season_number`
`episode_id` | `episode` or `episode_id`
`episode_sort` | `episode_number`
`language` of each stream | the format's `language`
2021-08-02 14:03:51 -06:00
**Note**: The file format may not support some of these fields
2021-04-03 02:33:25 -06:00
## Modifying metadata examples
```bash
# Interpret the title as "Artist - Title"
2021-12-17 15:58:18 -07:00
$ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
2021-04-03 02:33:25 -06:00
# Regex example
2021-12-17 15:58:18 -07:00
$ yt-dlp --parse-metadata "description:Artist - (?P< artist > .+)"
2021-04-03 02:33:25 -06:00
# Set title as "Series name S01E05"
2021-12-17 15:58:18 -07:00
$ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
2021-04-03 02:33:25 -06:00
2022-03-26 20:20:43 -06:00
# Prioritize uploader as the "artist" field in video metadata
2022-09-21 14:07:44 -06:00
$ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --embed-metadata
2022-03-26 20:20:43 -06:00
# Set "comment" field in video metadata using description instead of webpage_url,
# handling multiple lines correctly
2022-09-21 14:07:44 -06:00
$ yt-dlp --parse-metadata "description:(?s)(?P< meta_comment > .+)" --embed-metadata
2021-04-03 02:33:25 -06:00
2022-06-19 23:18:29 -06:00
# Do not set any "synopsis" in the video metadata
$ yt-dlp --parse-metadata ":(?P< meta_synopsis > )"
2021-10-31 03:15:59 -06:00
# Remove "formats" field from the infojson by setting it to an empty string
2023-06-21 02:24:24 -06:00
$ yt-dlp --parse-metadata "video::(?P< formats > )" --write-info-json
2021-10-31 03:15:59 -06:00
2021-08-09 13:52:55 -06:00
# Replace all spaces and "_" in title and uploader with a `-`
2021-12-17 15:58:18 -07:00
$ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
2021-08-09 13:52:55 -06:00
2021-04-03 02:33:25 -06:00
```
2021-06-25 08:05:41 -06:00
# EXTRACTOR ARGUMENTS
2024-07-30 15:27:06 -06:00
Some extractors accept additional arguments which can be passed using `--extractor-args KEY:ARGS` . `ARGS` is a `;` (semicolon) separated string of `ARG=VAL1,VAL2` . E.g. `--extractor-args "youtube:player-client=mediaconnect,web;formats=incomplete" --extractor-args "funimation:version=uncut"`
2021-06-25 08:05:41 -06:00
2023-02-17 05:22:22 -07:00
Note: In CLI, `ARG` can use `-` instead of `_` ; e.g. `youtube:player-client"` becomes `youtube:player_client"`
2021-06-25 08:05:41 -06:00
The following extractors use this feature:
2021-10-23 08:29:52 -06:00
#### youtube
2023-01-02 07:09:28 -07:00
* `lang` : Prefer translated metadata (`title`, `description` etc) of this language code (case-sensitive). By default, the video primary language metadata is preferred, with a fallback to `en` translated. See [youtube.py ](https://github.com/yt-dlp/yt-dlp/blob/c26f9b991a0681fd3ea548d535919cec1fbbd430/yt_dlp/extractor/youtube.py#L381-L390 ) for list of supported content language codes
2022-06-19 23:18:29 -06:00
* `skip` : One or more of `hls` , `dash` or `translated_subs` to skip extraction of the m3u8 manifests, dash manifests and [auto-translated subtitles ](https://github.com/yt-dlp/yt-dlp/issues/4090#issuecomment-1158102032 ) respectively
2024-11-16 16:31:04 -07:00
* `player_client` : Clients to extract video data from. The main clients are `web` , `ios` and `android` , with variants `_music` and `_creator` (e.g. `ios_creator` ); and `mweb` , `mediaconnect` , `android_vr` , `web_safari` , `web_embedded` , `tv` and `tv_embedded` with no variants. By default, `ios,mweb` is used, and `web_creator` is added as needed for age-gated videos when account age verification is required. Similarly, the `_music` variants are added for `music.youtube.com` URLs. Some clients, such as `web` and `android` , require a `po_token` for their formats to be downloadable. Some clients, such as the `_creator` variants, will only work with authentication. You can use `all` to use all the clients, and `default` for the default clients. You can prefix a client with `-` to exclude it, e.g. `youtube:player_client=all,-web`
2021-10-23 08:29:52 -06:00
* `player_skip` : Skip some network requests that are generally needed for robust extraction. One or more of `configs` (skip client configs), `webpage` (skip initial webpage), `js` (skip js player). While these options can help reduce the number of requests needed or avoid some rate-limiting, they could cause some issues. See [#860 ](https://github.com/yt-dlp/yt-dlp/pull/860 ) for more details
2023-07-29 00:20:42 -06:00
* `player_params` : YouTube player parameters to use for player requests. Will overwrite any default ones set by yt-dlp.
2021-10-23 08:29:52 -06:00
* `comment_sort` : `top` or `new` (default) - choose comment sorting mode (on YouTube's side)
2022-03-26 20:20:43 -06:00
* `max_comments` : Limit the amount of comments to gather. Comma-separated list of integers representing `max-comments,max-parents,max-replies,max-replies-per-thread` . Default is `all,all,all,all`
* E.g. `all,all,1000,10` will get a maximum of 1000 replies total, with up to 10 replies per thread. `1000,all,100` will get a maximum of 1000 comments, with a maximum of 100 replies total
2023-07-06 07:48:35 -06:00
* `formats` : Change the types of formats to return. `dashy` (convert HTTP to DASH), `duplicate` (identical content but different URLs or protocol; includes `dashy` ), `incomplete` (cannot be downloaded completely - live dash and post-live m3u8)
2022-08-14 15:45:05 -06:00
* `innertube_host` : Innertube API host to use for all API requests; e.g. `studio.youtube.com` , `youtubei.googleapis.com` . Note that cookies exported from one subdomain will not work on others
2024-07-30 15:27:06 -06:00
* `innertube_key` : Innertube API key to use for all API requests. By default, no API key is used
2023-10-03 00:42:30 -06:00
* `raise_incomplete_data` : `Incomplete Data Received` raises an error instead of reporting a warning
2024-09-13 04:51:58 -06:00
* `data_sync_id` : Overrides the account Data Sync ID used in Innertube API requests. This may be needed if you are using an account with `youtube:player_skip=webpage,configs` or `youtubetab:skip=webpage`
* `visitor_data` : Overrides the Visitor Data used in Innertube API requests. This should be used with `player_skip=webpage,configs` and without cookies. Note: this may have adverse effects if used improperly. If a session from a browser is wanted, you should pass cookies instead (which contain the Visitor ID)
* `po_token` : Proof of Origin (PO) Token(s) to use for requesting video playback. Comma seperated list of PO Tokens in the format `CLIENT+PO_TOKEN` , e.g. `youtube:po_token=web+XXX,android+YYY`
2021-10-23 08:29:52 -06:00
#### youtubetab (YouTube playlists, channels, feeds, etc.)
* `skip` : One or more of `webpage` (skip initial webpage download), `authcheck` (allow the download of playlists requiring authentication when no initial webpage is downloaded. This may cause unwanted behavior, see [#1122 ](https://github.com/yt-dlp/yt-dlp/pull/1122 ) for more details)
2022-10-12 16:53:39 -06:00
* `approximate_date` : Extract approximate `upload_date` and `timestamp` in flat-playlist. This may cause date-based filters to be slightly off
2021-10-23 08:29:52 -06:00
2022-11-20 17:51:45 -07:00
#### generic
2024-06-15 17:18:42 -06:00
* `fragment_query` : Passthrough any query in mpd/m3u8 manifest URLs to their fragments if no value is provided, or else apply the query string given as `fragment_query=VALUE` . Note that if the stream has an HLS AES-128 key, then the query parameters will be passed to the key URI as well, unless the `key_query` extractor-arg is passed, or unless an external key URI is provided via the `hls_key` extractor-arg. Does not apply to ffmpeg
2023-03-23 10:28:23 -06:00
* `variant_query` : Passthrough the master m3u8 URL query to its variant playlist URLs if no value is provided, or else apply the query string given as `variant_query=VALUE`
2024-06-15 17:18:42 -06:00
* `key_query` : Passthrough the master m3u8 URL query to its HLS AES-128 decryption key URI if no value is provided, or else apply the query string given as `key_query=VALUE` . Note that this will have no effect if the key URI is provided via the `hls_key` extractor-arg. Does not apply to ffmpeg
2023-03-21 17:12:17 -06:00
* `hls_key` : An HLS AES-128 key URI *or* key (as hex), and optionally the IV (as hex), in the form of `(URI|KEY)[,IV]` ; e.g. `generic:hls_key=ABCDEF1234567980,0xFEDCBA0987654321` . Passing any of these values will force usage of the native HLS downloader and override the corresponding values found in the m3u8 playlist
2023-04-13 13:36:06 -06:00
* `is_live` : Bypass live HLS detection and manually set `live_status` - a value of `false` will set `not_live` , any other value (or no value) will set `is_live`
2024-10-24 17:11:48 -06:00
* `impersonate` : Target(s) to try and impersonate with the initial webpage request; e.g. `generic:impersonate=safari,chrome-110` . Use `generic:impersonate` to impersonate any available target, and use `generic:impersonate=false` to disable impersonation (default)
2022-11-20 17:51:45 -07:00
2021-10-23 08:29:52 -06:00
#### funimation
2022-10-03 22:23:11 -06:00
* `language` : Audio languages to extract, e.g. `funimation:language=english,japanese`
2021-10-23 08:29:52 -06:00
* `version` : The video version to extract - `uncut` or `simulcast`
2022-11-06 11:48:55 -07:00
#### crunchyrollbeta (Crunchyroll)
2024-04-06 04:53:20 -06:00
* `hardsub` : One or more hardsub versions to extract (in order of preference), or `all` (default: `None` = no hardsubs will be extracted), e.g. `crunchyrollbeta:hardsub=en-US,de-DE`
2022-01-28 17:33:51 -07:00
2021-10-23 08:29:52 -06:00
#### vikichannel
* `video_types` : Types of videos to download - one or more of `episodes` , `movies` , `clips` , `trailers`
2021-07-09 14:38:09 -06:00
2022-03-17 06:22:14 -06:00
#### niconico
* `segment_duration` : Segment duration in milliseconds for HLS-DMC formats. Use it at your own risk since this feature **may result in your account termination.**
2021-12-09 16:43:15 -07:00
#### youtubewebarchive
* `check_all` : Try to check more at the cost of more requests. One or more of `thumbnails` , `captures`
2021-12-24 15:28:57 -07:00
#### gamejolt
* `comment_sort` : `hot` (default), `you` (cookies needed), `top` , `new` - choose comment sorting mode (on GameJolt's side)
2021-12-31 14:02:23 -07:00
#### hotstar
* `res` : resolution to ignore - one or more of `sd` , `hd` , `fhd`
* `vcodec` : vcodec to ignore - one or more of `h264` , `h265` , `dvh265`
* `dr` : dynamic range to ignore - one or more of `sdr` , `hdr10` , `dv`
2023-09-23 16:36:34 -06:00
#### niconicochannelplus
* `max_comments` : Maximum number of comments to extract - default is `120`
2022-02-01 01:26:23 -07:00
#### tiktok
2024-03-29 17:20:14 -06:00
* `api_hostname` : Hostname to use for mobile API calls, e.g. `api22-normal-c-alisg.tiktokv.com`
* `app_name` : Default app name to use with mobile API calls, e.g. `trill`
* `app_version` : Default app version to use with mobile API calls - should be set along with `manifest_app_version` , e.g. `34.1.2`
* `manifest_app_version` : Default numeric app version to use with mobile API calls, e.g. `2023401020`
2024-05-16 16:27:09 -06:00
* `aid` : Default app ID to use with mobile API calls, e.g. `1180`
* `app_info` : Enable mobile API extraction with one or more app info strings in the format of `<iid>/[app_name]/[app_version]/[manifest_app_version]/[aid]` , where `iid` is the unique app install ID. `iid` is the only required value; all other values and their `/` separators can be omitted, e.g. `tiktok:app_info=1234567890123456789` or `tiktok:app_info=123,456/trill///1180,789//34.0.1/340001`
2024-05-20 17:09:28 -06:00
* `device_id` : Enable mobile API extraction with a genuine device ID to be used with mobile API calls. Default is a random 19-digit string
2022-02-01 01:26:23 -07:00
2022-03-02 08:46:25 -07:00
#### rokfinchannel
2022-08-14 06:04:13 -06:00
* `tab` : Which tab to download - one of `new` , `top` , `videos` , `podcasts` , `streams` , `stacks`
2022-03-02 08:46:25 -07:00
2023-07-05 14:30:23 -06:00
#### twitter
2023-09-09 09:14:49 -06:00
* `api` : Select one of `graphql` (default), `legacy` or `syndication` as the API for tweet extraction. Has no effect if logged in
2023-07-05 14:30:23 -06:00
2023-06-30 12:27:07 -06:00
#### stacommu, wrestleuniverse
2023-05-08 17:45:31 -06:00
* `device_id` : UUID value assigned by the website and used to enforce device limits for paid livestream content. Can be found in browser local storage
2023-06-21 02:24:24 -06:00
#### twitch
* `client_id` : Client ID value to be sent with GraphQL requests, e.g. `twitch:client_id=kimne78kx3ncx6brgo4mv6wki5h1ko`
2023-06-02 07:39:24 -06:00
2023-06-19 07:25:27 -06:00
#### nhkradirulive (NHK らじる★らじる LIVE)
* `area` : Which regional variation to extract. Valid areas are: `sapporo` , `sendai` , `tokyo` , `nagoya` , `osaka` , `hiroshima` , `matsuyama` , `fukuoka` . Defaults to `tokyo`
2023-09-23 17:47:14 -06:00
#### nflplusreplay
* `type` : Type(s) of game replays to extract. Valid types are: `full_game` , `full_game_spanish` , `condensed_game` and `all_22` . You can use `all` to extract all available replay types, which is the default
2024-05-25 17:03:05 -06:00
#### jiocinema
* `refresh_token` : The `refreshToken` UUID from browser local storage can be passed to extend the life of your login session when logging in with `token` as username and the `accessToken` from browser local storage as password
2024-01-19 08:48:45 -07:00
#### jiosaavn
* `bitrate` : Audio bitrates to request. One or more of `16` , `32` , `64` , `128` , `320` . Default is `128,320`
2024-04-13 10:40:53 -06:00
#### afreecatvlive
* `cdn` : One or more CDN IDs to use with the API call for stream URLs, e.g. `gcp_cdn` , `gs_cdn_pc_app` , `gs_cdn_mobile_web` , `gs_cdn_pc_web`
2024-05-22 16:20:29 -06:00
#### soundcloud
2024-07-01 16:51:27 -06:00
* `formats` : Formats to request from the API. Requested values should be in the format of `{protocol}_{extension}` (omitting the bitrate), e.g. `hls_opus,http_aac` . The `*` character functions as a wildcard, e.g. `*_mp3` , and can be passed by itself to request all formats. Known protocols include `http` , `hls` and `hls-aes` ; known extensions include `aac` , `opus` and `mp3` . Original `download` formats are always extracted. Default is `http_aac,hls_aac,http_opus,hls_opus,http_mp3,hls_mp3`
2024-05-22 16:20:29 -06:00
2024-07-01 04:43:52 -06:00
#### orfon (orf:on)
* `prefer_segments_playlist` : Prefer a playlist of program segments instead of a single complete video when available. If individual segments are desired, use `--concat-playlist never --extractor-args "orfon:prefer_segments_playlist"`
2024-07-01 14:22:49 -06:00
#### bilibili
* `prefer_multi_flv` : Prefer extracting flv formats over mp4 for older videos that still provide legacy formats
2024-11-17 14:16:22 -07:00
#### sonylivseries
* `sort_order` : Episode sort order for series extraction - one of `asc` (ascending, oldest first) or `desc` (descending, newest first). Default is `asc`
2023-01-02 07:09:28 -07:00
**Note**: These options may be changed/removed in the future without concern for backward compatibility
2021-06-25 08:05:41 -06:00
2021-12-16 18:23:04 -07:00
<!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
2021-07-06 15:21:29 -06:00
2021-01-24 06:40:02 -07:00
# PLUGINS
2020-10-06 21:34:22 -06:00
2022-12-31 21:29:22 -07:00
Note that **all** plugins are imported even if not invoked, and that **there are no checks** performed on plugin code. **Use plugins at your own risk and only if you trust the code!**
2021-09-29 14:53:33 -06:00
2024-07-01 16:51:27 -06:00
Plugins can be of `<type>` s `extractor` or `postprocessor` .
- Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it.
- Extractor plugins take priority over built-in extractors.
2022-12-31 21:29:22 -07:00
- Postprocessor plugins can be invoked using `--use-postprocessor NAME` .
2021-09-29 14:53:33 -06:00
2022-12-31 21:29:22 -07:00
Plugins are loaded from the namespace packages `yt_dlp_plugins.extractor` and `yt_dlp_plugins.postprocessor` .
2021-09-29 14:53:33 -06:00
2022-12-31 21:29:22 -07:00
In other words, the file structure on the disk looks something like:
2024-07-01 16:51:27 -06:00
2022-12-31 21:29:22 -07:00
yt_dlp_plugins/
extractor/
myplugin.py
postprocessor/
myplugin.py
yt-dlp looks for these `yt_dlp_plugins` namespace folders in many locations (see below) and loads in plugins from **all** of them.
2024-10-12 19:50:31 -06:00
Set the environment variable `YTDLP_NO_PLUGINS` to something nonempty to disable loading plugins entirely.
2020-10-06 21:34:22 -06:00
2022-09-09 16:16:54 -06:00
See the [wiki for some known plugins ](https://github.com/yt-dlp/yt-dlp/wiki/Plugins )
2022-12-31 21:29:22 -07:00
## Installing Plugins
Plugins can be installed using various methods and locations.
1. **Configuration directories** :
Plugin packages (containing a `yt_dlp_plugins` namespace folder) can be dropped into the following standard [configuration locations ](#configuration ):
* **User Plugins**
* `${XDG_CONFIG_HOME}/yt-dlp/plugins/<package name>/yt_dlp_plugins/` (recommended on Linux/macOS)
* `${XDG_CONFIG_HOME}/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
* `${APPDATA}/yt-dlp/plugins/<package name>/yt_dlp_plugins/` (recommended on Windows)
2023-01-06 12:01:00 -07:00
* `${APPDATA}/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
2022-12-31 21:29:22 -07:00
* `~/.yt-dlp/plugins/<package name>/yt_dlp_plugins/`
* `~/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
* **System Plugins**
* `/etc/yt-dlp/plugins/<package name>/yt_dlp_plugins/`
* `/etc/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
2023-05-19 15:05:08 -06:00
2. **Executable location** : Plugin packages can similarly be installed in a `yt-dlp-plugins` directory under the executable location (recommended for portable installations):
2022-12-31 21:29:22 -07:00
* Binary: where `<root-dir>/yt-dlp.exe` , `<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
* Source: where `<root-dir>/yt_dlp/__main__.py` , `<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
3. **pip and other locations in `PYTHONPATH`**
2023-01-01 21:55:11 -07:00
* Plugin packages can be installed and managed using `pip` . See [yt-dlp-sample-plugins ](https://github.com/yt-dlp/yt-dlp-sample-plugins ) for an example.
2023-01-02 07:09:28 -07:00
* Note: plugin files between plugin packages installed with pip must have unique filenames.
2022-12-31 21:29:22 -07:00
* Any path in `PYTHONPATH` is searched in for the `yt_dlp_plugins` namespace folder.
2024-10-21 22:20:20 -06:00
* Note: This does not apply for Pyinstaller builds.
2022-12-31 21:29:22 -07:00
2023-01-02 07:09:28 -07:00
`.zip` , `.egg` and `.whl` archives containing a `yt_dlp_plugins` namespace folder in their root are also supported as plugin packages.
2024-04-08 13:18:04 -06:00
2023-01-02 07:09:28 -07:00
* e.g. `${XDG_CONFIG_HOME}/yt-dlp/plugins/mypluginpkg.zip` where `mypluginpkg.zip` contains `yt_dlp_plugins/<type>/myplugin.py`
2022-12-31 21:29:22 -07:00
2023-01-02 07:09:28 -07:00
Run yt-dlp with `--verbose` to check if the plugin has been loaded.
2022-12-31 21:29:22 -07:00
## Developing Plugins
2023-01-02 07:09:28 -07:00
See the [yt-dlp-sample-plugins ](https://github.com/yt-dlp/yt-dlp-sample-plugins ) repo for a template plugin package and the [Plugin Development ](https://github.com/yt-dlp/yt-dlp/wiki/Plugin-Development ) section of the wiki for a plugin development guide.
2022-12-31 21:29:22 -07:00
2024-07-01 16:51:27 -06:00
All public classes with a name ending in `IE` /`PP` are imported from each file for extractors and postprocessors respectively. This respects underscore prefix (e.g. `_MyBasePluginIE` is private) and `__all__` . Modules can similarly be excluded by prefixing the module name with an underscore (e.g. `_myplugin.py` ).
2023-01-01 21:55:11 -07:00
2023-01-06 12:01:00 -07:00
To replace an existing extractor with a subclass of one, set the `plugin_name` class keyword argument (e.g. `class MyPluginIE(ABuiltInIE, plugin_name='myplugin')` will replace `ABuiltInIE` with `MyPluginIE` ). Since the extractor replaces the parent, you should exclude the subclass extractor from being imported separately by making it private using one of the methods described above.
2022-12-31 21:29:22 -07:00
2023-01-02 07:09:28 -07:00
If you are a plugin author, add [yt-dlp-plugins ](https://github.com/topics/yt-dlp-plugins ) as a topic to your repository for discoverability.
2020-10-06 21:34:22 -06:00
2022-12-31 21:29:22 -07:00
See the [Developer Instructions ](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions ) on how to write and test an extractor.
2021-10-08 19:08:01 -06:00
# EMBEDDING YT-DLP
yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
2024-07-01 16:51:27 -06:00
Your program should avoid parsing the normal stdout since they may change in future versions. Instead, they should use options such as `-J` , `--print` , `--progress-template` , `--exec` etc to create console output that you can reliably reproduce and parse.
2021-10-08 19:08:01 -06:00
From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
```python
2021-11-09 15:42:25 -07:00
from yt_dlp import YoutubeDL
2021-10-08 19:08:01 -06:00
2022-04-17 11:49:53 -06:00
URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
with YoutubeDL() as ydl:
ydl.download(URLS)
2021-10-08 19:08:01 -06:00
```
2023-07-06 07:48:35 -06:00
Most likely, you'll want to use various options. For a list of options available, have a look at [`yt_dlp/YoutubeDL.py` ](yt_dlp/YoutubeDL.py#L183 ) or `help(yt_dlp.YoutubeDL)` in a Python shell. If you are already familiar with the CLI, you can use [`devscripts/cli_to_api.py` ](https://github.com/yt-dlp/yt-dlp/blob/master/devscripts/cli_to_api.py ) to translate any CLI switches to `YoutubeDL` params.
2021-10-08 19:08:01 -06:00
2022-04-17 17:09:25 -06:00
**Tip**: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of `YoutubeDL.extract_info` to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through `YoutubeDL.sanitize_info` as shown in the [example below ](#extracting-information )
2022-04-17 11:49:53 -06:00
## Embedding examples
2022-04-17 17:09:25 -06:00
#### Extracting information
2021-10-08 19:08:01 -06:00
```python
import json
import yt_dlp
2022-04-17 11:49:53 -06:00
URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'
# ℹ ️
ydl_opts = {}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
info = ydl.extract_info(URL, download=False)
# ℹ ️
print(json.dumps(ydl.sanitize_info(info)))
```
2022-04-17 17:09:25 -06:00
#### Download using an info-json
2022-04-17 11:49:53 -06:00
```python
import yt_dlp
INFO_FILE = 'path/to/video.info.json'
with yt_dlp.YoutubeDL() as ydl:
error_code = ydl.download_with_info_file(INFO_FILE)
print('Some videos failed to download' if error_code
else 'All videos successfully downloaded')
```
2022-04-17 17:09:25 -06:00
#### Extract audio
2022-04-17 11:49:53 -06:00
```python
import yt_dlp
URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
ydl_opts = {
2022-04-28 19:19:57 -06:00
'format': 'm4a/bestaudio/best',
2022-04-17 11:49:53 -06:00
# ℹ ️
'postprocessors': [{ # Extract audio using ffmpeg
'key': 'FFmpegExtractAudio',
'preferredcodec': 'm4a',
}]
}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
error_code = ydl.download(URLS)
```
2022-04-28 19:19:57 -06:00
#### Filter videos
```python
import yt_dlp
URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
def longer_than_a_minute(info, *, incomplete):
"""Download only videos longer than a minute (or with unknown duration)"""
duration = info.get('duration')
if duration and duration < 60:
return 'The video is too short'
ydl_opts = {
'match_filter': longer_than_a_minute,
}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
error_code = ydl.download(URLS)
```
2022-04-17 17:09:25 -06:00
#### Adding logger and progress hook
2022-04-17 11:49:53 -06:00
```python
import yt_dlp
URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2021-10-08 19:08:01 -06:00
class MyLogger:
def debug(self, msg):
2021-12-19 08:18:06 -07:00
# For compatibility with youtube-dl, both debug and info are passed into debug
2021-10-08 19:08:01 -06:00
# You can distinguish them by the prefix '[debug] '
if msg.startswith('[debug] '):
pass
else:
self.info(msg)
def info(self, msg):
pass
def warning(self, msg):
pass
def error(self, msg):
print(msg)
2022-04-17 11:49:53 -06:00
# ℹ ️
def my_hook(d):
if d['status'] == 'finished':
print('Done downloading, now post-processing ...')
ydl_opts = {
'logger': MyLogger(),
'progress_hooks': [my_hook],
}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
ydl.download(URLS)
```
2022-04-17 17:09:25 -06:00
#### Add a custom PostProcessor
2022-04-17 11:49:53 -06:00
```python
import yt_dlp
URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
# ℹ ️
2021-11-09 15:42:25 -07:00
class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
2021-10-08 19:08:01 -06:00
def run(self, info):
self.to_screen('Doing stuff')
return [], info
2022-04-17 11:49:53 -06:00
with yt_dlp.YoutubeDL() as ydl:
2022-06-19 23:18:29 -06:00
# ℹ ️
ydl.add_post_processor(MyCustomPP(), when='pre_process')
2022-04-17 11:49:53 -06:00
ydl.download(URLS)
```
2021-10-08 19:08:01 -06:00
2022-04-17 17:09:25 -06:00
#### Use a custom format selector
2022-04-17 11:49:53 -06:00
```python
import yt_dlp
2023-05-19 15:05:08 -06:00
URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2022-04-17 11:49:53 -06:00
2021-11-10 09:11:41 -07:00
def format_selector(ctx):
""" Select the best video and the best audio that won't result in an mkv.
2022-04-17 11:49:53 -06:00
NOTE: This is just an example and does not handle all cases """
2021-11-10 09:11:41 -07:00
# formats are already sorted worst to best
formats = ctx.get('formats')[::-1]
# acodec='none' means there is no audio
best_video = next(f for f in formats
if f['vcodec'] != 'none' and f['acodec'] == 'none')
# find compatible audio extension
audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
# vcodec='none' means there is no video
best_audio = next(f for f in formats if (
f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
2022-04-17 11:49:53 -06:00
# These are the minimum required fields for a merged format
2021-11-10 09:11:41 -07:00
yield {
'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
'ext': best_video['ext'],
'requested_formats': [best_video, best_audio],
2021-12-19 08:18:06 -07:00
# Must be + separated list of protocols
2021-11-10 09:11:41 -07:00
'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
}
2021-10-08 19:08:01 -06:00
ydl_opts = {
2021-11-10 09:11:41 -07:00
'format': format_selector,
2021-10-08 19:08:01 -06:00
}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
2022-04-17 11:49:53 -06:00
ydl.download(URLS)
2021-10-08 19:08:01 -06:00
```
2021-12-16 18:23:04 -07:00
2024-03-10 13:18:47 -06:00
# CHANGES FROM YOUTUBE-DL
### New features
2024-05-26 15:09:53 -06:00
* Forked from [**yt-dlc@f9401f2** ](https://github.com/blackjack4494/yt-dlc/commit/f9401f2a91987068139c5f757b12fc711d4c0cee ) and merged with [**youtube-dl@a08f2b7** ](https://github.com/ytdl-org/youtube-dl/commit/a08f2b7e4567cdc50c0614ee0a4ffdff49b8b6e6 ) ([exceptions](https://github.com/yt-dlp/yt-dlp/issues/21))
2024-03-10 13:18:47 -06:00
* **[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in YouTube videos by utilizing the [SponsorBlock ](https://sponsor.ajay.app ) API
* **[Format Sorting](#sorting-formats)**: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using `-S` . This allows for much easier format selection than what is possible by simply using `--format` ([examples](#format-selection-examples))
* **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from [animelover1984/youtube-dl ](https://github.com/animelover1984/youtube-dl ) including `--write-comments` , `BiliBiliSearch` , `BilibiliChannel` , Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that NicoNico livestreams are not available. See [#31 ](https://github.com/yt-dlp/yt-dlp/pull/31 ) for details.
* **YouTube improvements**:
* Supports Clips, Stories (`ytstories:< channel UCID > `), Search (including filters)**\***, YouTube Music Search, Channel-specific search, Search prefixes (`ytsearch:`, `ytsearchdate:` )**\***, Mixes, and Feeds (`:ytfav`, `:ytwatchlater` , `:ytsubs` , `:ythistory` , `:ytrec` , `:ytnotif` )
* Fix for [n-sig based throttling ](https://github.com/ytdl-org/youtube-dl/issues/29326 ) ** \***
* Download livestreams from the start using `--live-from-start` (*experimental*)
* Channel URLs download all uploads of the channel, including shorts and live
2024-10-23 15:27:26 -06:00
* Support for [logging in with OAuth ](https://github.com/yt-dlp/yt-dlp/wiki/Extractors#logging-in-with-oauth )
2024-03-10 13:18:47 -06:00
* **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using `--cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]`
* **Download time range**: Videos can be downloaded partially based on either timestamps or chapters using `--download-sections`
* **Split video by chapters**: Videos can be split into multiple files based on chapters using `--split-chapters`
* **Multi-threaded fragment downloads**: Download multiple fragments of m3u8/mpd videos in parallel. Use `--concurrent-fragments` (`-N`) option to set the number of threads used
* **Aria2c with HLS/DASH**: You can use `aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
* **New and fixed extractors**: Many new extractors have been added and a lot of existing ones have been fixed. See the [changelog ](Changelog.md ) or the [list of supported sites ](supportedsites.md )
* **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN etc.
* **Subtitle extraction from manifests**: Subtitles can be extracted from streaming media manifests. See [commit/be6202f ](https://github.com/yt-dlp/yt-dlp/commit/be6202f12b97858b9d716e608394b51065d0419f ) for details
* **Multiple paths and output templates**: You can give different [output templates ](#output-template ) and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to using `--paths` (`-P`)
* **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [CONFIGURATION ](#configuration ) for details
* **Output template improvements**: Output templates can now have date-time formatting, numeric offsets, object traversal etc. See [output template ](#output-template ) for details. Even more advanced operations can also be done with the help of `--parse-metadata` and `--replace-in-metadata`
2024-09-27 16:46:22 -06:00
* **Other new options**: Many new options have been added such as `--alias` , `--print` , `--concat-playlist` , `--wait-for-video` , `--retry-sleep` , `--sleep-requests` , `--convert-thumbnails` , `--force-download-archive` , `--force-overwrites` , `--break-match-filters` etc
2024-03-10 13:18:47 -06:00
2024-09-27 16:46:22 -06:00
* **Improvements**: Regex and other operators in `--format` /`--match-filters`, multiple `--postprocessor-args` and `--downloader-args` , faster archive checking, more [format selection options ](#format-selection ), merge multi-video/audio, multiple `--config-locations` , `--exec` at different stages, etc
2024-03-10 13:18:47 -06:00
* **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins ](#plugins ) for details
* **Self updater**: The releases can be updated using `yt-dlp -U` , and downgraded using `--update-to` if required
* **Automated builds**: [Nightly/master builds ](#update-channels ) can be used with `--update-to nightly` and `--update-to master`
See [changelog ](Changelog.md ) or [commits ](https://github.com/yt-dlp/yt-dlp/commits ) for the full list of changes
Features marked with a ** \*** have been back-ported to youtube-dl
### Differences in default behavior
Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
2024-10-23 00:33:50 -06:00
* yt-dlp supports only [Python 3.9+ ](## "Windows 8" ), and will remove support for more versions as they [become EOL ](https://devguide.python.org/versions/#python-release-cycle ); while [youtube-dl still supports Python 2.6+ and 3.2+ ](https://github.com/ytdl-org/youtube-dl/issues/30568#issue-1118238743 )
2024-03-10 13:18:47 -06:00
* The options `--auto-number` (`-A`), `--title` (`-t`) and `--literal` (`-l`), no longer work. See [removed options ](#Removed ) for details
* `avconv` is not supported as an alternative to `ffmpeg`
* yt-dlp stores config files in slightly different locations to youtube-dl. See [CONFIGURATION ](#configuration ) for a list of correct locations
* The default [output template ](#output-template ) is `%(title)s [%(id)s].%(ext)s` . There is no real reason for this change. This was changed before yt-dlp was ever made public and now there are no plans to change it back to `%(title)s-%(id)s.%(ext)s` . Instead, you may use `--compat-options filename`
2024-11-03 12:39:10 -07:00
* The default [format sorting ](#sorting-formats ) is different from youtube-dl and prefers higher resolution and better codecs rather than higher bitrates. You can use the `--format-sort` option to change this to any order you prefer, or use `--compat-options format-sort` to use youtube-dl's sorting order. Older versions of yt-dlp preferred VP9 due to its broader compatibility; you can use `--compat-options prefer-vp9-sort` to revert to that format sorting preference. These two compat options cannot be used together
2024-03-10 13:18:47 -06:00
* The default format selector is `bv*+ba/b` . This means that if a combined video + audio format that is better than the best video-only format is found, the former will be preferred. Use `-f bv+ba/b` or `--compat-options format-spec` to revert this
* Unlike youtube-dlc, yt-dlp does not allow merging multiple audio/video streams into one file by default (since this conflicts with the use of `-f bv*+ba` ). If needed, this feature must be enabled using `--audio-multistreams` and `--video-multistreams` . You can also use `--compat-options multistreams` to enable both
* `--no-abort-on-error` is enabled by default. Use `--abort-on-error` or `--compat-options abort-on-error` to abort on errors instead
* When writing metadata files such as thumbnails, description or infojson, the same information (if available) is also written for playlists. Use `--no-write-playlist-metafiles` or `--compat-options no-playlist-metafiles` to not write these files
* `--add-metadata` attaches the `infojson` to `mkv` files in addition to writing the metadata when used with `--write-info-json` . Use `--no-embed-info-json` or `--compat-options no-attach-info-json` to revert this
* Some metadata are embedded into different fields when using `--add-metadata` as compared to youtube-dl. Most notably, `comment` field contains the `webpage_url` and `synopsis` contains the `description` . You can [use `--parse-metadata` ](#modifying-metadata ) to modify this to your liking or use `--compat-options embed-metadata` to revert this
* `playlist_index` behaves differently when used with options like `--playlist-reverse` and `--playlist-items` . See [#302 ](https://github.com/yt-dlp/yt-dlp/issues/302 ) for details. You can use `--compat-options playlist-index` if you want to keep the earlier behavior
* The output of `-F` is listed in a new format. Use `--compat-options list-formats` to revert this
* Live chats (if available) are considered as subtitles. Use `--sub-langs all,-live_chat` to download all subtitles except live chat. You can also use `--compat-options no-live-chat` to prevent any live chat/danmaku from downloading
* YouTube channel URLs download all uploads of the channel. To download only the videos in a specific tab, pass the tab's URL. If the channel does not show the requested tab, an error will be raised. Also, `/live` URLs raise an error if there are no live videos instead of silently downloading the entire channel. You may use `--compat-options no-youtube-channel-redirect` to revert all these redirections
* Unavailable videos are also listed for YouTube playlists. Use `--compat-options no-youtube-unavailable-videos` to remove this
* The upload dates extracted from YouTube are in UTC [when available ](https://github.com/yt-dlp/yt-dlp/blob/89e4d86171c7b7c997c77d4714542e0383bf0db0/yt_dlp/extractor/youtube.py#L3898-L3900 ). Use `--compat-options no-youtube-prefer-utc-upload-date` to prefer the non-UTC upload date.
* If `ffmpeg` is used as the downloader, the downloading and merging of formats happen in a single step when possible. Use `--compat-options no-direct-merge` to revert this
* Thumbnail embedding in `mp4` is done with mutagen if possible. Use `--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
* Some internal metadata such as filenames are removed by default from the infojson. Use `--no-clean-infojson` or `--compat-options no-clean-infojson` to revert this
* When `--embed-subs` and `--write-subs` are used together, the subtitles are written to disk and also embedded in the media file. You can use just `--embed-subs` to embed the subs and automatically delete the separate file. See [#630 (comment) ](https://github.com/yt-dlp/yt-dlp/issues/630#issuecomment-893659460 ) for more info. `--compat-options no-keep-subs` can be used to revert this
* `certifi` will be used for SSL root certificates, if installed. If you want to use system certificates (e.g. self-signed), use `--compat-options no-certifi`
* yt-dlp's sanitization of invalid characters in filenames is different/smarter than in youtube-dl. You can use `--compat-options filename-sanitization` to revert to youtube-dl's behavior
* ~~yt-dlp tries to parse the external downloader outputs into the standard progress output if possible (Currently implemented: [aria2c ](https://github.com/yt-dlp/yt-dlp/issues/5931 )). You can use `--compat-options no-external-downloader-progress` to get the downloader output as-is~~
2024-09-27 16:46:22 -06:00
* yt-dlp versions between 2021.09.01 and 2023.01.02 applies `--match-filters` to nested playlists. This was an unintentional side-effect of [8f18ac ](https://github.com/yt-dlp/yt-dlp/commit/8f18aca8717bb0dd49054555af8d386e5eda3a88 ) and is fixed in [d7b460 ](https://github.com/yt-dlp/yt-dlp/commit/d7b460d0e5fc710950582baed2e3fc616ed98a80 ). Use `--compat-options playlist-match-filter` to revert this
2024-03-10 13:18:47 -06:00
* yt-dlp versions between 2021.11.10 and 2023.06.21 estimated `filesize_approx` values for fragmented/manifest formats. This was added for convenience in [f2fe69 ](https://github.com/yt-dlp/yt-dlp/commit/f2fe69c7b0d208bdb1f6292b4ae92bc1e1a7444a ), but was reverted in [0dff8e ](https://github.com/yt-dlp/yt-dlp/commit/0dff8e4d1e6e9fb938f4256ea9af7d81f42fd54f ) due to the potentially extreme inaccuracy of the estimated values. Use `--compat-options manifest-filesize-approx` to keep extracting the estimated values
* yt-dlp uses modern http client backends such as `requests` . Use `--compat-options prefer-legacy-http-handler` to prefer the legacy http handler (`urllib`) to be used for standard http requests.
2024-03-10 10:58:37 -06:00
* The sub-modules `swfinterp` , `casefold` are removed.
2024-07-08 17:51:43 -06:00
* Passing `--simulate` (or calling `extract_info` with `download=False` ) no longer alters the default format selection. See [#9843 ](https://github.com/yt-dlp/yt-dlp/issues/9843 ) for details.
2024-03-10 13:18:47 -06:00
For ease of use, a few more compat options are available:
2024-07-02 17:03:08 -06:00
* `--compat-options all` : Use all compat options (**Do NOT use this!**)
2024-11-03 12:39:10 -07:00
* `--compat-options youtube-dl` : Same as `--compat-options all,-multistreams,-playlist-match-filter,-manifest-filesize-approx,-allow-unsafe-ext,-prefer-vp9-sort`
* `--compat-options youtube-dlc` : Same as `--compat-options all,-no-live-chat,-no-youtube-channel-redirect,-playlist-match-filter,-manifest-filesize-approx,-allow-unsafe-ext,-prefer-vp9-sort`
2024-03-10 13:18:47 -06:00
* `--compat-options 2021` : Same as `--compat-options 2022,no-certifi,filename-sanitization,no-youtube-prefer-utc-upload-date`
* `--compat-options 2022` : Same as `--compat-options 2023,playlist-match-filter,no-external-downloader-progress,prefer-legacy-http-handler,manifest-filesize-approx`
2024-11-03 12:39:10 -07:00
* `--compat-options 2023` : Same as `--compat-options prefer-vp9-sort` . Use this to enable all future compat options
2024-03-10 13:18:47 -06:00
2024-07-01 16:52:50 -06:00
The following compat options restore vulnerable behavior from before security patches:
* `--compat-options allow-unsafe-ext` : Allow files with any extension (including unsafe ones) to be downloaded ([GHSA-79w7-vh3h-8g4j](< https: // github . com / yt-dlp / yt-dlp / security / advisories / GHSA-79w7-vh3h-8g4j > ))
> :warning: Only use if a valid file download is rejected because its extension is detected as uncommon
>
> **This option can enable remote code execution! Consider [opening an issue](<https://github.com/yt-dlp/yt-dlp/issues/new/choose>) instead!**
2024-03-10 13:18:47 -06:00
### Deprecated options
2021-03-18 09:34:09 -06:00
These are all the deprecated options and the current alternative to achieve the same effect
2022-01-10 11:41:12 -07:00
#### Almost redundant options
While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant
-j, --dump-json --print "%()j"
-F, --list-formats --print formats_table
2022-01-21 00:21:06 -07:00
--list-thumbnails --print thumbnails_table --print playlist:thumbnails_table
2022-01-10 11:41:12 -07:00
--list-subs --print automatic_captions_table --print subtitles_table
2021-08-01 22:48:33 -06:00
#### Redundant options
While these options are redundant, they are still expected to be used due to their ease of use
2021-04-21 16:17:31 -06:00
2021-05-14 01:44:38 -06:00
--get-description --print description
--get-duration --print duration_string
--get-filename --print filename
--get-format --print format
--get-id --print id
--get-thumbnail --print thumbnail
-e, --get-title --print title
-g, --get-url --print urls
2024-09-27 16:46:22 -06:00
--match-title REGEX --match-filters "title ~= (?i)REGEX"
--reject-title REGEX --match-filters "title !~= (?i)REGEX"
--min-views COUNT --match-filters "view_count >=? COUNT"
--max-views COUNT --match-filters "view_count < =? COUNT"
--break-on-reject Use --break-match-filters
[cleanup] Misc (#11216)
- Add Python 3.13 to CI, finalize 3.13 support
- Remove Python 3.8 from CI in preparation for removing 3.8 support
- Document that PyPy3.8 and PyPy3.9 are no longer supported
- Usual documentation fixes and code cleanup
Closes #8248, Closes #11146, Closes #11149, Closes #11211
Authored by: Grub4K, grqz, DTrombett, KarboniteKream, bashonly, mikkovedru, seproDev
Co-authored-by: N/Ame <173015200+grqz@users.noreply.github.com>
Co-authored-by: DTrombett <d@trombett.org>
Co-authored-by: =?UTF-8?q?Klemen=20Ko=C5=A1ir?= <klemen.kosir@kream.io>
Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>
Co-authored-by: Mikko Vedru <mikko.vedru@gmail.com>
Co-authored-by: sepro <sepro@sepr0.com>
2024-10-21 22:50:35 -06:00
--user-agent UA --add-headers "User-Agent:UA"
--referer URL --add-headers "Referer:URL"
2022-06-16 22:48:21 -06:00
--playlist-start NUMBER -I NUMBER:
--playlist-end NUMBER -I :NUMBER
--playlist-reverse -I ::-1
--no-playlist-reverse Default
2023-05-24 12:35:07 -06:00
--no-colors --color no_color
2021-08-01 22:48:33 -06:00
#### Not recommended
While these options still work, their use is not recommended since there are other alternatives to achieve the same
2022-08-23 18:12:16 -06:00
--force-generic-extractor --ies generic,default
2022-01-03 04:13:54 -07:00
--exec-before-download CMD --exec "before_dl:CMD"
--no-exec-before-download --no-exec
2021-04-10 09:22:54 -06:00
--all-formats -f all
2021-04-19 15:17:09 -06:00
--all-subs --sub-langs all --write-subs
2021-08-06 18:01:51 -06:00
--print-json -j --no-simulate
2022-08-14 06:04:13 -06:00
--autonumber-size NUMBER Use string formatting, e.g. %(autonumber)03d
2021-04-15 06:31:16 -06:00
--autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
2021-10-21 17:04:22 -06:00
--id -o "%(id)s.%(ext)s"
2021-04-03 02:33:25 -06:00
--metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
2021-04-10 09:08:33 -06:00
--hls-prefer-native --downloader "m3u8:native"
--hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
2021-05-11 02:00:48 -06:00
--list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
--list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
2021-06-25 08:05:41 -06:00
--youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
--youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
--youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
--youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
2023-04-24 08:08:58 -06:00
--geo-bypass --xff "default"
--no-geo-bypass --xff "never"
--geo-bypass-country CODE --xff CODE
--geo-bypass-ip-block IP_BLOCK --xff IP_BLOCK
2021-08-01 22:48:33 -06:00
#### Developer options
These options are not intended to be used by the end-user
2021-08-07 02:49:17 -06:00
--test Download only part of video for testing extractors
2022-05-31 14:33:22 -06:00
--load-pages Load pages dumped by --write-pages
2021-08-01 22:48:33 -06:00
--youtube-print-sig-code For testing youtube signatures
2021-08-22 14:08:38 -06:00
--allow-unplayable-formats List unplayable formats also
--no-allow-unplayable-formats Default
2021-04-21 16:17:31 -06:00
#### Old aliases
These are aliases that are no longer documented for various reasons
--avconv-location --ffmpeg-location
2022-02-10 08:43:28 -07:00
--clean-infojson --clean-info-json
2021-04-21 16:17:31 -06:00
--cn-verification-proxy URL --geo-verification-proxy URL
--dump-headers --print-traffic
--dump-intermediate-pages --dump-pages
--force-write-download-archive --force-write-archive
--load-info --load-info-json
2022-02-10 08:43:28 -07:00
--no-clean-infojson --no-clean-info-json
2021-04-21 16:17:31 -06:00
--no-split-tracks --no-split-chapters
2021-03-18 09:34:09 -06:00
--no-write-srt --no-write-subs
--prefer-unsecure --prefer-insecure
--rate-limit RATE --limit-rate RATE
2021-04-21 16:17:31 -06:00
--split-tracks --split-chapters
--srt-lang LANGS --sub-langs LANGS
2021-03-18 09:34:09 -06:00
--trim-file-names LENGTH --trim-filenames LENGTH
2021-04-21 16:17:31 -06:00
--write-srt --write-subs
2021-03-18 09:34:09 -06:00
--yes-overwrites --force-overwrites
2021-04-21 16:17:31 -06:00
2021-09-01 14:55:16 -06:00
#### Sponskrub Options
2021-11-28 14:22:52 -07:00
Support for [SponSkrub ](https://github.com/faissaloo/SponSkrub ) has been deprecated in favor of the `--sponsorblock` options
2021-09-01 14:55:16 -06:00
--sponskrub --sponsorblock-mark all
--no-sponskrub --no-sponsorblock
--sponskrub-cut --sponsorblock-remove all
--no-sponskrub-cut --sponsorblock-remove -all
--sponskrub-force Not applicable
--no-sponskrub-force Not applicable
--sponskrub-location Not applicable
--sponskrub-args Not applicable
2021-04-21 16:17:31 -06:00
#### No longer supported
These options may no longer work as intended
--prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
--prefer-ffmpeg Default (Alias: --no-prefer-avconv)
-C, --call-home Not implemented
--no-call-home Default
--include-ads No longer supported
--no-include-ads Default
2021-08-23 21:52:40 -06:00
--write-annotations No supported site has annotations now
--no-write-annotations Default
2022-07-13 03:33:05 -06:00
--compat-options seperate-video-versions No longer needed
2024-05-26 15:13:12 -06:00
--compat-options no-youtube-prefer-utc-upload-date No longer supported
2021-05-08 09:21:43 -06:00
#### Removed
These options were deprecated since 2014 and have now been entirely removed
2021-04-21 16:17:31 -06:00
-A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
2022-04-17 11:49:53 -06:00
-t, -l, --title, --literal -o "%(title)s-%(id)s.%(ext)s"
2021-04-21 16:17:31 -06:00
2024-03-10 13:18:47 -06:00
2021-10-08 19:08:01 -06:00
# CONTRIBUTING
See [CONTRIBUTING.md ](CONTRIBUTING.md#contributing-to-yt-dlp ) for instructions on [Opening an Issue ](CONTRIBUTING.md#opening-an-issue ) and [Contributing code to the project ](CONTRIBUTING.md#developer-instructions )
2021-03-18 09:34:09 -06:00
2022-09-07 06:05:45 -06:00
# WIKI
See the [Wiki ](https://github.com/yt-dlp/yt-dlp/wiki ) for more information
