]> jfr.im git - yt-dlp.git/blame - README.md
projects / yt-dlp.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[extractor/facebook] Fix metadata extraction (#6856)
[yt-dlp.git] / README.md
CommitLineData
ec2e44fc 1<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
b31fdeed 2<div align="center">
3
e980017a 4[![YT-DLP](https://raw.githubusercontent.com/yt-dlp/yt-dlp/master/.github/banner.svg)](#readme)
d9d045e2 5
2fa669f7 6[![Release version](https://img.shields.io/github/v/release/yt-dlp/yt-dlp?color=brightgreen&label=Download&style=for-the-badge)](#installation "Installation")
ae6a1b95 7[![PyPi](https://img.shields.io/badge/-PyPi-blue.svg?logo=pypi&labelColor=555555&style=for-the-badge)](https://pypi.org/project/yt-dlp "PyPi")
fc5fa964 8[![Donate](https://img.shields.io/badge/_-Donate-red.svg?logo=githubsponsors&labelColor=555555&style=for-the-badge)](Collaborators.md#collaborators "Donate")
ae6a1b95 9[![Matrix](https://img.shields.io/matrix/yt-dlp:matrix.org?color=brightgreen&labelColor=555555&label=&logo=element&style=for-the-badge)](https://matrix.to/#/#yt-dlp:matrix.org "Matrix")
10[![Discord](https://img.shields.io/discord/807245652072857610?color=blue&labelColor=555555&label=&logo=discord&style=for-the-badge)](https://discord.gg/H5MNcFW63r "Discord")
fc5fa964 11[![Supported Sites](https://img.shields.io/badge/-Supported_Sites-brightgreen.svg?style=for-the-badge)](supportedsites.md "Supported Sites")
ae6a1b95 12[![License: Unlicense](https://img.shields.io/badge/-Unlicense-blue.svg?style=for-the-badge)](LICENSE "License")
08e29b9f 13[![CI Status](https://img.shields.io/github/actions/workflow/status/yt-dlp/yt-dlp/core.yml?branch=master&label=Tests&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/actions "CI Status")
fc5fa964 14[![Commits](https://img.shields.io/github/commit-activity/m/yt-dlp/yt-dlp?label=commits&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/commits "Commit History")
46d09f87 15[![Last Commit](https://img.shields.io/github/last-commit/yt-dlp/yt-dlp/master?label=&style=for-the-badge&display_timestamp=committer)](https://github.com/yt-dlp/yt-dlp/commits "Commit History")
c76eb41b 16
b31fdeed 17</div>
ec2e44fc 18<!-- MANPAGE: END EXCLUDED SECTION -->
c76eb41b 19
b31fdeed 20yt-dlp is a [youtube-dl](https://github.com/ytdl-org/youtube-dl) fork based on the now inactive [youtube-dlc](https://github.com/blackjack4494/yt-dlc). The main focus of this project is adding new features and patches while also keeping up to date with the original project
5c0e5bc4 21
ec2e44fc 22<!-- MANPAGE: MOVE "USAGE AND OPTIONS" SECTION HERE -->
23
24<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
034b6215 25* [NEW FEATURES](#new-features)
53ed7066 26 * [Differences in default behavior](#differences-in-default-behavior)
c76eb41b 27* [INSTALLATION](#installation)
deae7c17 28 * [Detailed instructions](https://github.com/yt-dlp/yt-dlp/wiki/Installation)
17fa3ee2 29 * [Update](#update)
0e5927ee 30 * [Release Files](#release-files)
cf59cd4d 31 * [Dependencies](#dependencies)
17fa3ee2 32 * [Compile](#compile)
b31fdeed 33* [USAGE AND OPTIONS](#usage-and-options)
34 * [General Options](#general-options)
50865ca8 35 * [Network Options](#network-options)
b31fdeed 36 * [Geo-restriction](#geo-restriction)
50865ca8 37 * [Video Selection](#video-selection)
38 * [Download Options](#download-options)
39 * [Filesystem Options](#filesystem-options)
b31fdeed 40 * [Thumbnail Options](#thumbnail-options)
50865ca8 41 * [Internet Shortcut Options](#internet-shortcut-options)
0744a815 42 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
50865ca8 43 * [Workarounds](#workarounds)
44 * [Video Format Options](#video-format-options)
45 * [Subtitle Options](#subtitle-options)
46 * [Authentication Options](#authentication-options)
50865ca8 47 * [Post-processing Options](#post-processing-options)
7a340e0d 48 * [SponsorBlock Options](#sponsorblock-options)
50865ca8 49 * [Extractor Options](#extractor-options)
c76eb41b 50* [CONFIGURATION](#configuration)
304ad45a 51 * [Configuration file encoding](#configuration-file-encoding)
50865ca8 52 * [Authentication with .netrc file](#authentication-with-netrc-file)
878eac3e 53 * [Notes about environment variables](#notes-about-environment-variables)
c76eb41b 54* [OUTPUT TEMPLATE](#output-template)
50865ca8 55 * [Output template examples](#output-template-examples)
c76eb41b 56* [FORMAT SELECTION](#format-selection)
50865ca8 57 * [Filtering Formats](#filtering-formats)
58 * [Sorting Formats](#sorting-formats)
59 * [Format Selection examples](#format-selection-examples)
73cd218f 60* [MODIFYING METADATA](#modifying-metadata)
61 * [Modifying metadata examples](#modifying-metadata-examples)
5d3a0e79 62* [EXTRACTOR ARGUMENTS](#extractor-arguments)
f74980cb 63* [PLUGINS](#plugins)
8e40b9d1
M		 64 * [Installing Plugins](#installing-plugins)
65 * [Developing Plugins](#developing-plugins)
8c6f4daa 66* [EMBEDDING YT-DLP](#embedding-yt-dlp)
43cc91ad 67 * [Embedding examples](#embedding-examples)
e167860c 68* [DEPRECATED OPTIONS](#deprecated-options)
8c6f4daa 69* [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
70 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
71 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
17ffed18 72* [WIKI](https://github.com/yt-dlp/yt-dlp/wiki)
deae7c17 73 * [FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ)
ec2e44fc 74<!-- MANPAGE: END EXCLUDED SECTION -->
50865ca8 75
76
034b6215 77# NEW FEATURES
91f071af 78
45b2ee6f 79* Merged with **youtube-dl v2021.12.17+ [commit/2dd6c6e](https://github.com/ytdl-org/youtube-dl/commit/2dd6c6e)** ([exceptions](https://github.com/yt-dlp/yt-dlp/issues/21)) and **youtube-dlc v2020.11.11-3+ [commit/f9401f2](https://github.com/blackjack4494/yt-dlc/commit/f9401f2a91987068139c5f757b12fc711d4c0cee)**: You get all the features and patches of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) in addition to the latest [youtube-dl](https://github.com/ytdl-org/youtube-dl)
034b6215 80
304ad45a 81* **[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in YouTube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
034b6215 82
7581d246 83* **[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))
034b6215 84
8e174ba7 85* **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.
29b6000e 86
ae61d108 87* **YouTube improvements**:
88 * Supports Clips, Stories (`ytstories:<channel UCID>`), Search (including filters)**\***, YouTube Music Search, Channel-specific search, Search prefixes (`ytsearch:`, `ytsearchdate:`)**\***, Mixes, YouTube Music Albums/Channels ([except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723)), and Feeds (`:ytfav`, `:ytwatchlater`, `:ytsubs`, `:ythistory`, `:ytrec`, `:ytnotif`)
89 * Fix for [n-sig based throttling](https://github.com/ytdl-org/youtube-dl/issues/29326) **\***
90 * Supports some (but not all) age-gated content without cookies
91 * Download livestreams from the start using `--live-from-start` (*experimental*)
92 * `255kbps` audio is extracted (if available) from YouTube Music when premium cookies are given
86973308 93 * Channel URLs download all uploads of the channel, including shorts and live
f20f5fe5 94
304ad45a 95* **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using `--cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]`
245524e6 96
5ec1b6b7 97* **Download time range**: Videos can be downloaded partially based on either timestamps or chapters using `--download-sections`
98
597c1866 99* **Split video by chapters**: Videos can be split into multiple files based on chapters using `--split-chapters`
100
b31fdeed 101* **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
8d801631 102
b31fdeed 103* **Aria2c with HLS/DASH**: You can use `aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
f20f5fe5 104
e75bb0d6 105* **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)
86c1a8aa 106
56ba69e4 107* **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN etc.
fac98805 108
3de7c2ce 109* **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
034b6215 110
597c1866 111* **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`)
0bc0a322 112
d4ada357 113* **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [CONFIGURATION](#configuration) for details
0bc0a322 114
418964fa 115* **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`
fac98805 116
fe2ce85a 117* **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-filter` etc
0bc0a322 118
08d30158 119* **Improvements**: Regex and other operators in `--format`/`--match-filter`, 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
c69911e4 120
86c1a8aa 121* **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins](#plugins) for details
b31fdeed 122
77df20f1
SS		 123* **Self updater**: The releases can be updated using `yt-dlp -U`, and downgraded using `--update-to` if required
124
125* **Nightly builds**: [Automated nightly builds](#update-channels) can be used with `--update-to nightly`
aa837ddf 126
7a5c1cfe 127See [changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
a26c99ac 128
ae61d108 129Features marked with a **\*** have been back-ported to youtube-dl
130
53ed7066 131### Differences in default behavior
132
0930b11f 133Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
53ed7066 134
5b28cef7 135* yt-dlp supports only [Python 3.7+](## "Windows 7"), and *may* 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)
96565c7e 136* The options `--auto-number` (`-A`), `--title` (`-t`) and `--literal` (`-l`), no longer work. See [removed options](#Removed) for details
b69fd25c 137* `avconv` is not supported as an alternative to `ffmpeg`
d4ada357 138* yt-dlp stores config files in slightly different locations to youtube-dl. See [CONFIGURATION](#configuration) for a list of correct locations
96565c7e 139* 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`
e4f02757 140* 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
e75bb0d6 141* 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
28b0eb0f 142* 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
08d30158 143* `--no-abort-on-error` is enabled by default. Use `--abort-on-error` or `--compat-options abort-on-error` to abort on errors instead
28b0eb0f 144* 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
9222c381 145* `--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
9e907ebd 146* 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
28b0eb0f 147* `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
148* The output of `-F` is listed in a new format. Use `--compat-options list-formats` to revert this
b79f9e30 149* 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
86973308 150* 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
304ad45a 151* Unavailable videos are also listed for YouTube playlists. Use `--compat-options no-youtube-unavailable-videos` to remove this
1ff88b7a 152* 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.
18e674b4 153* 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
e858a9d6 154* Thumbnail embedding in `mp4` is done with mutagen if possible. Use `--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
e4f02757 155* Some private fields such as filenames are removed by default from the infojson. Use `--no-clean-infojson` or `--compat-options no-clean-infojson` to revert this
e75bb0d6 156* 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
168bbc4f 157* `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`
1e4fca9a 158* 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
ad68b16a 159* 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
53ed7066 160
161For ease of use, a few more compat options are available:
3d3bb168 162
8a82af35 163* `--compat-options all`: Use all compat options (Do NOT use)
28b0eb0f 164* `--compat-options youtube-dl`: Same as `--compat-options all,-multistreams`
165* `--compat-options youtube-dlc`: Same as `--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
2a06bb4e 166* `--compat-options 2021`: Same as `--compat-options 2022,no-certifi,filename-sanitization,no-youtube-prefer-utc-upload-date`
8c53322c 167* `--compat-options 2022`: Same as `--compat-options no-external-downloader-progress`. Use this to enable all future compat options
53ed7066 168
f20f5fe5 169
d19bb9c0 170# INSTALLATION
50865ca8 171
fc5fa964 172<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
173[![Windows](https://img.shields.io/badge/-Windows_x64-blue.svg?style=for-the-badge&logo=windows)](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)
17ffed18 174[![Unix](https://img.shields.io/badge/-Linux/BSD-red.svg?style=for-the-badge&logo=linux)](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)
24146491 175[![MacOS](https://img.shields.io/badge/-MacOS-lightblue.svg?style=for-the-badge&logo=apple)](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)
17ffed18 176[![PyPi](https://img.shields.io/badge/-PyPi-blue.svg?logo=pypi&labelColor=555555&style=for-the-badge)](https://pypi.org/project/yt-dlp)
fc5fa964 177[![Source Tarball](https://img.shields.io/badge/-Source_tar-green.svg?style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
178[![Other variants](https://img.shields.io/badge/-Other-grey.svg?style=for-the-badge)](#release-files)
3d3bb168 179[![All versions](https://img.shields.io/badge/-All_Versions-lightgrey.svg?style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/releases)
fc5fa964 180<!-- MANPAGE: END EXCLUDED SECTION -->
181
17ffed18 182You 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
0930b11f 183
b8773e63 184
a4211baf 185## UPDATE
4815bbfc 186You can use `yt-dlp -U` to update if you are using the [release binaries](#release-files)
17ffed18 187
188If 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
0930b11f 189
8e174ba7 190For other third-party package managers, see [the wiki](https://github.com/yt-dlp/yt-dlp/wiki/Installation#third-party-package-managers) or refer their documentation
0930b11f 191
77df20f1
SS		 192<a id="update-channels"/>
193
194There are currently two release channels for binaries, `stable` and `nightly`.
392389b7 195`stable` is the default channel, and many of its changes have been tested by users of the nightly channel.
196The `nightly` channel has releases built after each push to the master branch, and will have the most recent fixes and additions, but also have more risk of regressions. They are available in [their own repo](https://github.com/yt-dlp/yt-dlp-nightly-builds/releases).
77df20f1
SS		 197
198When using `--update`/`-U`, a release binary will only update to its current channel.
199This release channel can be changed by using the `--update-to` option. `--update-to` can also be used to upgrade or downgrade to specific tags from a channel.
200
201Example usage:
202* `yt-dlp --update-to nightly` change to `nightly` channel and update to its latest release
203* `yt-dlp --update-to stable@2023.02.17` upgrade/downgrade to release to `stable` channel tag `2023.02.17`
204* `yt-dlp --update-to 2023.01.06` upgrade/downgrade to tag `2023.01.06` if it exists on the current channel
cf59cd4d 205
ec2e44fc 206<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
a4211baf 207## RELEASE FILES
0e5927ee 208
733d8e8f 209#### Recommended
210
211File|Description
212:---|:---
962ffcf8 213[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**)
0930b11f 214[yt-dlp.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)|Windows (Win7 SP1+) standalone x64 binary (recommended for **Windows**)
f2df4071 215[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**)
733d8e8f 216
217#### Alternatives
218
0e5927ee
R		 219File|Description
220:---|:---
0930b11f 221[yt-dlp_x86.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe)|Windows (Vista SP2+) standalone x86 (32-bit) binary
8aa0e7cd 222[yt-dlp_min.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_min.exe)|Windows (Win7 SP1+) standalone x64 binary built with `py2exe`<br/> ([Not recommended](#standalone-py2exe-builds-windows))
f2df4071 223[yt-dlp_linux](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux)|Linux standalone x64 binary
224[yt-dlp_linux.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux.zip)|Unpackaged Linux executable (no auto-update)
17fc3dc4
M		 225[yt-dlp_linux_armv7l](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l)|Linux standalone armv7l (32-bit) binary
226[yt-dlp_linux_aarch64](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_aarch64)|Linux standalone aarch64 (64-bit) binary
0930b11f 227[yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged Windows executable (no auto-update)
228[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)
6d916fe7 229[yt-dlp_macos_legacy](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos_legacy)|MacOS (10.9+) standalone x64 executable
733d8e8f 230
231#### Misc
232
233File|Description
234:---|:---
17ffed18 235[yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)|Source tarball
0e5927ee 236[SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
12647e03 237[SHA2-512SUMS.sig](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS.sig)|GPG signature file for SHA512 sums
0e5927ee 238[SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
12647e03 239[SHA2-256SUMS.sig](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS.sig)|GPG signature file for SHA256 sums
0e5927ee 240
12647e03
SS		 241The 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)
242Example usage:
243```
244curl -L https://github.com/yt-dlp/yt-dlp/raw/master/public.key | gpg --import
245gpg --verify SHA2-256SUMS.sig SHA2-256SUMS
246gpg --verify SHA2-512SUMS.sig SHA2-512SUMS
247```
248<!-- MANPAGE: END EXCLUDED SECTION -->
17ffed18 249
4815bbfc 250**Note**: The manpages, shell completion files etc. are available inside the [source tarball](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
17ffed18 251
a4211baf 252## DEPENDENCIES
eff42759 253Python versions 3.7+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
b31fdeed 254
c9652aa4 255<!-- Python 3.5+ uses VC++14 and it is already embedded in the binary created
256<!x-- https://www.microsoft.com/en-us/download/details.aspx?id=26999 --x>
cf59cd4d 257On 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.
c9652aa4 258-->
fac98805 259
e75bb0d6 260While all the other dependencies are optional, `ffmpeg` and `ffprobe` are highly recommended
ec2e44fc 261
8aa0e7cd 262### Strongly recommended
263
b69fd25c 264* [**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)
8aa0e7cd 265
8e174ba7 266 There are bugs in ffmpeg that causes 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
267
268 **Important**: What you need is ffmpeg *binary*, **NOT** [the python package of the same name](https://pypi.org/project/ffmpeg)
8aa0e7cd 269
270### Networking
d5820461 271* [**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)
8aa0e7cd 272* [**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>
273* [**websockets**](https://github.com/aaugustin/websockets)\* - For downloading over websocket. Licensed under [BSD-3-Clause](https://github.com/aaugustin/websockets/blob/main/LICENSE)
274
275### Metadata
276
277* [**mutagen**](https://github.com/quodlibet/mutagen)\* - For `--embed-thumbnail` in certain formats. Licensed under [GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
278* [**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)
279* [**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 **Linux**. 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
280
281### Misc
282
283* [**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)
5d0aeac0 284* [**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)
8aa0e7cd 285* [**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)
cf59cd4d 286* Any external downloader that you want to use with `--downloader`
b31fdeed 287
deae7c17 288### Deprecated
8aa0e7cd 289
290* [**avconv** and **avprobe**](https://www.libav.org) - Now **deprecated** alternative to ffmpeg. License [depends on the build](https://libav.org/legal)
291* [**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)
998a3cae 292* [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading `rtmp` streams. ffmpeg can be used instead with `--downloader ffmpeg`. Licensed under [GPLv2+](http://rtmpdump.mplayerhq.hu)
293* [**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)
8aa0e7cd 294
cf59cd4d 295To use or redistribute the dependencies, you must agree to their respective licensing terms.
296
f2df4071 297The standalone release binaries are built with the Python interpreter and the packages marked with **\*** included.
d710cc6d 298
8aa0e7cd 299If 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
d710cc6d 300
5f326cf5 301
a4211baf 302## COMPILE
5f326cf5 303
8aa0e7cd 304### Standalone PyInstaller Builds
115add43 305To build the standalone executable, you must have Python and `pyinstaller` (plus any of yt-dlp's [optional dependencies](#dependencies) if needed). Once you have all the necessary dependencies installed, simply run `pyinst.py`. The executable will be built for the same architecture (x86/ARM, 32/64 bit) as the Python used.
e38df8f9 306
8aa0e7cd 307 python3 -m pip install -U pyinstaller -r requirements.txt
308 python3 devscripts/make_lazy_extractors.py
309 python3 pyinst.py
310
311On some systems, you may need to use `py` or `python` instead of `python3`.
312
73ac0e6b 313`pyinst.py` 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).
314
8e174ba7 315**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.
8aa0e7cd 316
317**Important**: Running `pyinstaller` directly **without** using `pyinst.py` is **not** officially supported. This may or may not work correctly.
7581d246 318
8aa0e7cd 319### Platform-independent Binary (UNIX)
deae7c17 320You will need the build tools `python` (3.7+), `zip`, `make` (GNU), `pandoc`\* and `pytest`\*.
b96a939b 321
8aa0e7cd 322After installing these, simply run `make`.
5f326cf5 323
a831c2ea 324You 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)
d19bb9c0 325
8aa0e7cd 326### Standalone Py2Exe Builds (Windows)
327
328While we provide the option to build with [py2exe](https://www.py2exe.org), it is recommended to build [using PyInstaller](#standalone-pyinstaller-builds) instead since the py2exe builds **cannot contain `pycryptodomex`/`certifi` and needs VC++14** on the target computer to run.
329
330If you wish to build it anyway, install Python and py2exe, and then simply run `setup.py py2exe`
331
332 py -m pip install -U py2exe -r requirements.txt
333 py devscripts/make_lazy_extractors.py
334 py setup.py py2exe
335
336### Related scripts
337
d400e261
SS		 338* **`devscripts/update-version.py`** - Update the version number based on current date.
339* **`devscripts/set-variant.py`** - Set the build variant of the executable.
340* **`devscripts/make_changelog.py`** - Create a markdown changelog using short commit messages and update `CONTRIBUTORS` file.
8aa0e7cd 341* **`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=1` if you wish to forcefully disable lazy extractor loading.
342
d400e261
SS		 343Note: See their `--help` for more info.
344
29cb20bd
SS		 345### Forking the project
346If 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.
59a7a13e 347
b31fdeed 348# USAGE AND OPTIONS
6bcd846b 349
ec2e44fc 350<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
7a5c1cfe 351 yt-dlp [OPTIONS] [--] URL [URL...]
b50e3bc6 352
c2b5f311 353`Ctrl+F` is your friend :D
ec2e44fc 354<!-- MANPAGE: END EXCLUDED SECTION -->
c2b5f311 355
ec2e44fc 356<!-- Auto generated -->
c76eb41b 357## General Options:
2dd5a2e3 358 -h, --help Print this help text and exit
359 --version Print program version and exit
70b23409 360 -U, --update Update this program to the latest version
361 --no-update Do not check for updates (default)
77df20f1
SS		 362 --update-to [CHANNEL]@[TAG] Upgrade/downgrade to a specific version.
363 CHANNEL and TAG defaults to "stable" and
4815bbfc 364 "latest" respectively if omitted; See
77df20f1
SS		 365 "UPDATE" for details. Supported channels:
366 stable, nightly
2dd5a2e3 367 -i, --ignore-errors Ignore download and postprocessing errors.
368 The download will be considered successful
369 even if the postprocessing fails
370 --no-abort-on-error Continue with next video on download errors;
371 e.g. to skip unavailable videos in a
372 playlist (default)
373 --abort-on-error Abort downloading of further videos if an
374 error occurs (Alias: --no-ignore-errors)
375 --dump-user-agent Display the current user-agent and exit
376 --list-extractors List all supported extractors and exit
377 --extractor-descriptions Output descriptions of all supported
378 extractors and exit
2516cafb 379 --use-extractors NAMES Extractor names to use separated by commas.
fe7866d0 380 You can also use regexes, "all", "default"
381 and "end" (end URL matching); e.g. --ies
382 "holodex.*,end,youtube". Prefix the name
383 with a "-" to exclude it, e.g. --ies
384 default,-generic. Use --list-extractors for
2516cafb 385 a list of extractor names. (Alias: --ies)
62b58c09 386 --default-search PREFIX Use this prefix for unqualified URLs. E.g.
2dd5a2e3 387 "gvsearch2:python" downloads two videos from
388 google videos for the search term "python".
389 Use the value "auto" to let yt-dlp guess
390 ("auto_warning" to emit a warning when
391 guessing). "error" just throws an error. The
392 default value "fixup_error" repairs broken
393 URLs, but emits an error if this is not
394 possible instead of searching
395 --ignore-config Don't load any more configuration files
396 except those given by --config-locations.
397 For backward compatibility, if this option
398 is found inside the system configuration
399 file, the user configuration is not loaded.
400 (Alias: --no-config)
401 --no-config-locations Do not load any custom configuration files
402 (default). When given inside a configuration
403 file, ignore all previous --config-locations
404 defined in the current file
405 --config-locations PATH Location of the main configuration file;
406 either the path to the config or its
6b9e832d 407 containing directory ("-" for stdin). Can be
408 used multiple times and inside other
409 configuration files
2dd5a2e3 410 --flat-playlist Do not extract the videos of a playlist,
411 only list them
412 --no-flat-playlist Extract the videos of a playlist
413 --live-from-start Download livestreams from the start.
414 Currently only supported for YouTube
415 (Experimental)
416 --no-live-from-start Download livestreams from the current time
417 (default)
418 --wait-for-video MIN[-MAX] Wait for scheduled streams to become
419 available. Pass the minimum number of
420 seconds (or range) to wait between retries
421 --no-wait-for-video Do not wait for scheduled streams (default)
422 --mark-watched Mark videos watched (even with --simulate)
423 --no-mark-watched Do not mark videos watched (default)
f2df4071 424 --no-colors Do not emit color codes in output (Alias:
425 --no-colours)
2dd5a2e3 426 --compat-options OPTS Options that can help keep compatibility
427 with youtube-dl or youtube-dlc
428 configurations by reverting some of the
429 changes made in yt-dlp. See "Differences in
430 default behavior" for details
431 --alias ALIASES OPTIONS Create aliases for an option string. Unless
432 an alias starts with a dash "-", it is
433 prefixed with "--". Arguments are parsed
434 according to the Python string formatting
62b58c09 435 mini-language. E.g. --alias get-audio,-X
2dd5a2e3 436 "-S=aext:{0},abr -x --audio-format {0}"
437 creates options "--get-audio" and "-X" that
438 takes an argument (ARG0) and expands to
439 "-S=aext:ARG0,abr -x --audio-format ARG0".
440 All defined aliases are listed in the --help
441 output. Alias options can trigger more
962ffcf8 442 aliases; so be careful to avoid defining
2dd5a2e3 443 recursive options. As a safety measure, each
444 alias may be triggered a maximum of 100
64fa820c 445 times. This option can be used multiple times
08c1d0d3 446
149f05c7 447## Network Options:
2dd5a2e3 448 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. To
62b58c09
L		 449 enable SOCKS proxy, specify a proper scheme,
450 e.g. socks5://user:pass@127.0.0.1:1080/.
451 Pass in an empty string (--proxy "") for
452 direct connection
2dd5a2e3 453 --socket-timeout SECONDS Time to wait before giving up, in seconds
454 --source-address IP Client-side IP address to bind to
455 -4, --force-ipv4 Make all connections via IPv4
456 -6, --force-ipv6 Make all connections via IPv6
8300774c
M		 457 --enable-file-urls Enable file:// URLs. This is disabled by
458 default for security reasons.
8c6c88c7 459
b31fdeed 460## Geo-restriction:
2dd5a2e3 461 --geo-verification-proxy URL Use this proxy to verify the IP address for
462 some geo-restricted sites. The default proxy
463 specified by --proxy (or none, if the option
464 is not present) is used for the actual
465 downloading
c1664464 466 --xff VALUE How to fake X-Forwarded-For HTTP header to
467 try bypassing geographic restriction. One of
468 "default" (Only when known to be useful),
469 "never", a two-letter ISO 3166-2 country
470 code, or an IP block in CIDR notation
149f05c7 471
cfcec693 472## Video Selection:
71df9b7f 473 -I, --playlist-items ITEM_SPEC Comma separated playlist_index of the items
7e88d7d7 474 to download. You can specify a range using
475 "[START]:[STOP][:STEP]". For backward
476 compatibility, START-STOP is also supported.
477 Use negative indices to count from the right
478 and negative STEP to download in reverse
62b58c09 479 order. E.g. "-I 1:3,7,-5::2" used on a
71df9b7f 480 playlist of size 15 will download the items
7e88d7d7 481 at index 1,2,3,7,11,13,15
71df9b7f 482 --min-filesize SIZE Abort download if filesize is smaller than
483 SIZE, e.g. 50k or 44.6M
484 --max-filesize SIZE Abort download if filesize is larger than
62b58c09 485 SIZE, e.g. 50k or 44.6M
2dd5a2e3 486 --date DATE Download only videos uploaded on this date.
487 The date can be "YYYYMMDD" or in the format
488 [now|today|yesterday][-N[day|week|month|year]].
29cb20bd
SS		 489 E.g. "--date today-2weeks" downloads only
490 videos uploaded on the same day two weeks ago
2dd5a2e3 491 --datebefore DATE Download only videos uploaded on or before
492 this date. The date formats accepted is the
493 same as --date
494 --dateafter DATE Download only videos uploaded on or after
495 this date. The date formats accepted is the
496 same as --date
497 --match-filters FILTER Generic video filter. Any "OUTPUT TEMPLATE"
498 field can be compared with a number or a
499 string using the operators defined in
d4ada357 500 "Filtering Formats". You can also simply
2dd5a2e3 501 specify a field to match if the field is
502 present, use "!field" to check if the field
503 is not present, and "&" to check multiple
504 conditions. Use a "\" to escape "&" or
505 quotes if needed. If used multiple times,
506 the filter matches if atleast one of the
62b58c09 507 conditions are met. E.g. --match-filter
2dd5a2e3 508 !is_live --match-filter "like_count>?100 &
509 description~='(?i)\bcats \& dogs\b'" matches
510 only videos that are not live OR those that
511 have a like count more than 100 (or the like
512 field is not available) and also has a
513 description that contains the phrase "cats &
514 dogs" (caseless). Use "--match-filter -" to
515 interactively ask whether to download each
516 video
fe2ce85a 517 --no-match-filter Do not use any --match-filter (default)
518 --break-match-filters FILTER Same as "--match-filters" but stops the
519 download process when a video is rejected
520 --no-break-match-filters Do not use any --break-match-filters (default)
2dd5a2e3 521 --no-playlist Download only the video, if the URL refers
522 to a video and a playlist
523 --yes-playlist Download the playlist, if the URL refers to
524 a video and a playlist
525 --age-limit YEARS Download only videos suitable for the given
526 age
527 --download-archive FILE Download only videos not listed in the
528 archive file. Record the IDs of all
529 downloaded videos in it
530 --no-download-archive Do not use archive file (default)
531 --max-downloads NUMBER Abort after downloading NUMBER files
532 --break-on-existing Stop the download process when encountering
533 a file that is in the archive
71df9b7f 534 --break-per-input Alters --max-downloads, --break-on-existing,
354d5fca 535 --break-match-filter, and autonumber to
536 reset per input URL
2dd5a2e3 537 --no-break-per-input --break-on-existing and similar options
538 terminates the entire download queue
539 --skip-playlist-after-errors N Number of allowed failures until the rest of
540 the playlist is skipped
6bcd846b 541
d5a62e4f 542## Download Options:
2dd5a2e3 543 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
544 video that should be downloaded concurrently
545 (default is 1)
62b58c09
L		 546 -r, --limit-rate RATE Maximum download rate in bytes per second,
547 e.g. 50K or 4.2M
2dd5a2e3 548 --throttled-rate RATE Minimum download rate in bytes per second
549 below which throttling is assumed and the
62b58c09 550 video data is re-extracted, e.g. 100K
2dd5a2e3 551 -R, --retries RETRIES Number of retries (default is 10), or
552 "infinite"
553 --file-access-retries RETRIES Number of times to retry on file access
554 error (default is 3), or "infinite"
555 --fragment-retries RETRIES Number of retries for a fragment (default is
556 10), or "infinite" (DASH, hlsnative and ISM)
be5c1ae8 557 --retry-sleep [TYPE:]EXPR Time to sleep between retries in seconds
558 (optionally) prefixed by the type of retry
559 (http (default), fragment, file_access,
560 extractor) to apply the sleep to. EXPR can
561 be a number, linear=START[:END[:STEP=1]] or
562 exp=START[:END[:BASE=2]]. This option can be
563 used multiple times to set the sleep for the
62b58c09 564 different retry types, e.g. --retry-sleep
2dd5a2e3 565 linear=1::2 --retry-sleep fragment:exp=1:20
566 --skip-unavailable-fragments Skip unavailable fragments for DASH,
567 hlsnative and ISM downloads (default)
8e174ba7 568 (Alias: --no-abort-on-unavailable-fragments)
569 --abort-on-unavailable-fragments
2dd5a2e3 570 Abort download if a fragment is unavailable
571 (Alias: --no-skip-unavailable-fragments)
572 --keep-fragments Keep downloaded fragments on disk after
573 downloading is finished
574 --no-keep-fragments Delete downloaded fragments after
575 downloading is finished (default)
62b58c09 576 --buffer-size SIZE Size of download buffer, e.g. 1024 or 16K
2dd5a2e3 577 (default is 1024)
578 --resize-buffer The buffer size is automatically resized
579 from an initial value of --buffer-size
580 (default)
581 --no-resize-buffer Do not automatically adjust the buffer size
582 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
62b58c09 583 downloading, e.g. 10485760 or 10M (default
2dd5a2e3 584 is disabled). May be useful for bypassing
585 bandwidth throttling imposed by a webserver
586 (experimental)
2dd5a2e3 587 --playlist-random Download playlist videos in random order
7e9a6125 588 --lazy-playlist Process entries in the playlist as they are
589 received. This disables n_entries,
590 --playlist-random and --playlist-reverse
591 --no-lazy-playlist Process videos in the playlist only after
592 the entire playlist is parsed (default)
2dd5a2e3 593 --xattr-set-filesize Set file xattribute ytdl.filesize with
594 expected file size
595 --hls-use-mpegts Use the mpegts container for HLS videos;
596 allowing some players to play the video
597 while downloading, and reducing the chance
598 of file corruption if download is
599 interrupted. This is enabled by default for
600 live streams
601 --no-hls-use-mpegts Do not use the mpegts container for HLS
602 videos. This is default when not downloading
603 live streams
5ec1b6b7 604 --download-sections REGEX Download only chapters whose title matches
605 the given regular expression. Time ranges
606 prefixed by a "*" can also be used in place
607 of chapters to download the specified range.
62b58c09
L		 608 Needs ffmpeg. This option can be used
609 multiple times to download multiple
610 sections, e.g. --download-sections
2fa669f7 611 "*10:15-inf" --download-sections "intro"
2dd5a2e3 612 --downloader [PROTO:]NAME Name or path of the external downloader to
613 use (optionally) prefixed by the protocols
614 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
615 use it for. Currently supports native,
616 aria2c, avconv, axel, curl, ffmpeg, httpie,
617 wget. You can use this option multiple times
618 to set different downloaders for different
62b58c09 619 protocols. E.g. --downloader aria2c
2dd5a2e3 620 --downloader "dash,m3u8:native" will use
621 aria2c for http/ftp downloads, and the
622 native downloader for dash/m3u8 downloads
623 (Alias: --external-downloader)
624 --downloader-args NAME:ARGS Give these arguments to the external
625 downloader. Specify the downloader name and
626 the arguments separated by a colon ":". For
627 ffmpeg, arguments can be passed to different
628 positions using the same syntax as
629 --postprocessor-args. You can use this
630 option multiple times to give different
631 arguments to different downloaders (Alias:
632 --external-downloader-args)
d5a62e4f 633
cfcec693 634## Filesystem Options:
2dd5a2e3 635 -a, --batch-file FILE File containing URLs to download ("-" for
636 stdin), one URL per line. Lines starting
637 with "#", ";" or "]" are considered as
638 comments and ignored
639 --no-batch-file Do not read URLs from batch file (default)
640 -P, --paths [TYPES:]PATH The paths where the files should be
641 downloaded. Specify the type of file and the
642 path separated by a colon ":". All the same
643 TYPES as --output are supported.
644 Additionally, you can also provide "home"
645 (default) and "temp" paths. All intermediary
646 files are first downloaded to the temp path
647 and then the final files are moved over to
648 the home path after download is finished.
649 This option is ignored if --output is an
650 absolute path
651 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
652 TEMPLATE" for details
653 --output-na-placeholder TEXT Placeholder for unavailable fields in
654 "OUTPUT TEMPLATE" (default: "NA")
655 --restrict-filenames Restrict filenames to only ASCII characters,
656 and avoid "&" and spaces in filenames
657 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
658 filenames (default)
659 --windows-filenames Force filenames to be Windows-compatible
660 --no-windows-filenames Make filenames Windows-compatible only if
661 using Windows (default)
662 --trim-filenames LENGTH Limit the filename length (excluding
663 extension) to the specified number of
664 characters
665 -w, --no-overwrites Do not overwrite any files
666 --force-overwrites Overwrite all video and metadata files. This
667 option includes --no-continue
668 --no-force-overwrites Do not overwrite the video, but overwrite
669 related files (default)
670 -c, --continue Resume partially downloaded files/fragments
671 (default)
672 --no-continue Do not resume partially downloaded
673 fragments. If the file is not fragmented,
674 restart download of the entire file
675 --part Use .part files instead of writing directly
676 into output file (default)
677 --no-part Do not use .part files - write directly into
678 output file
679 --mtime Use the Last-modified header to set the file
680 modification time (default)
681 --no-mtime Do not use the Last-modified header to set
682 the file modification time
64fa820c 683 --write-description Write video description to a .description file
2dd5a2e3 684 --no-write-description Do not write video description (default)
685 --write-info-json Write video metadata to a .info.json file
686 (this may contain personal information)
687 --no-write-info-json Do not write video metadata (default)
688 --write-playlist-metafiles Write playlist metadata in addition to the
689 video metadata when using --write-info-json,
690 --write-description etc. (default)
691 --no-write-playlist-metafiles Do not write playlist metadata when using
692 --write-info-json, --write-description etc.
693 --clean-info-json Remove some private fields such as filenames
694 from the infojson. Note that it could still
695 contain some personal information (default)
696 --no-clean-info-json Write all fields to the infojson
697 --write-comments Retrieve video comments to be placed in the
698 infojson. The comments are fetched even
699 without this option if the extraction is
700 known to be quick (Alias: --get-comments)
701 --no-write-comments Do not retrieve video comments unless the
702 extraction is known to be quick (Alias:
703 --no-get-comments)
704 --load-info-json FILE JSON file containing the video information
64fa820c 705 (created with the "--write-info-json" option)
2dd5a2e3 706 --cookies FILE Netscape formatted file to read cookies from
707 and dump cookie jar in
708 --no-cookies Do not read/dump cookies from/to file
709 (default)
825d3ce3 710 --cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]
711 The name of the browser to load cookies
712 from. Currently supported browsers are:
713 brave, chrome, chromium, edge, firefox,
714 opera, safari, vivaldi. Optionally, the
715 KEYRING used for decrypting Chromium cookies
716 on Linux, the name/path of the PROFILE to
717 load cookies from, and the CONTAINER name
718 (if Firefox) ("none" for no container) can
719 be given with their respective seperators.
720 By default, all containers of the most
721 recently accessed profile are used.
722 Currently supported keyrings are: basictext,
723 gnomekeyring, kwallet
2dd5a2e3 724 --no-cookies-from-browser Do not load cookies from browser (default)
17ffed18 725 --cache-dir DIR Location in the filesystem where yt-dlp can
726 store some downloaded information (such as
727 client ids and signatures) permanently. By
878eac3e 728 default ${XDG_CACHE_HOME}/yt-dlp
2dd5a2e3 729 --no-cache-dir Disable filesystem caching
730 --rm-cache-dir Delete all filesystem cache files
6bcd846b 731
b31fdeed 732## Thumbnail Options:
2dd5a2e3 733 --write-thumbnail Write thumbnail image to disk
64fa820c 734 --no-write-thumbnail Do not write thumbnail image to disk (default)
2dd5a2e3 735 --write-all-thumbnails Write all thumbnail image formats to disk
736 --list-thumbnails List available thumbnails of each video.
737 Simulate unless --no-simulate is used
2b1bd292 738
732044af 739## Internet Shortcut Options:
2dd5a2e3 740 --write-link Write an internet shortcut file, depending
741 on the current platform (.url, .webloc or
742 .desktop). The URL may be cached by the OS
743 --write-url-link Write a .url Windows internet shortcut. The
744 OS caches the URL based on the file path
745 --write-webloc-link Write a .webloc macOS internet shortcut
746 --write-desktop-link Write a .desktop Linux internet shortcut
732044af 747
0744a815 748## Verbosity and Simulation Options:
2dd5a2e3 749 -q, --quiet Activate quiet mode. If used with --verbose,
750 print the log to stderr
d669772c 751 --no-quiet Deactivate quiet mode. (Default)
2dd5a2e3 752 --no-warnings Ignore warnings
753 -s, --simulate Do not download the video and do not write
754 anything to disk
755 --no-simulate Download the video even if printing/listing
756 options are used
757 --ignore-no-formats-error Ignore "No video formats" error. Useful for
758 extracting metadata even if the videos are
759 not actually available for download
760 (experimental)
761 --no-ignore-no-formats-error Throw error when no downloadable video
762 formats are found (default)
763 --skip-download Do not download the video but write all
764 related files (Alias: --no-download)
765 -O, --print [WHEN:]TEMPLATE Field name or output template to print to
766 screen, optionally prefixed with when to
767 print it, separated by a ":". Supported
768 values of "WHEN" are the same as that of
119e40ef 769 --use-postprocessor (default: video).
2dd5a2e3 770 Implies --quiet. Implies --simulate unless
771 --no-simulate or later stages of WHEN are
772 used. This option can be used multiple times
bb66c247 773 --print-to-file [WHEN:]TEMPLATE FILE
2dd5a2e3 774 Append given template to the file. The
775 values of WHEN and TEMPLATE are same as that
776 of --print. FILE uses the same syntax as the
777 output template. This option can be used
778 multiple times
779 -j, --dump-json Quiet, but print JSON information for each
780 video. Simulate unless --no-simulate is
781 used. See "OUTPUT TEMPLATE" for a
782 description of available keys
783 -J, --dump-single-json Quiet, but print JSON information for each
784 url or infojson passed. Simulate unless
785 --no-simulate is used. If the URL refers to
786 a playlist, the whole playlist information
787 is dumped in a single line
788 --force-write-archive Force download archive entries to be written
789 as far as no errors occur, even if -s or
790 another simulation option is used (Alias:
791 --force-download-archive)
792 --newline Output progress bar as new lines
793 --no-progress Do not print progress bar
794 --progress Show progress bar, even if in quiet mode
795 --console-title Display progress in console titlebar
819e0531 796 --progress-template [TYPES:]TEMPLATE
2dd5a2e3 797 Template for progress outputs, optionally
798 prefixed with one of "download:" (default),
799 "download-title:" (the console title),
800 "postprocess:", or "postprocess-title:".
801 The video's fields are accessible under the
802 "info" key and the progress attributes are
62b58c09 803 accessible under "progress" key. E.g.
2dd5a2e3 804 --console-title --progress-template
805 "download-title:%(info.id)s-%(progress.eta)s"
806 -v, --verbose Print various debugging information
807 --dump-pages Print downloaded pages encoded using base64
808 to debug problems (very verbose)
809 --write-pages Write downloaded intermediary pages to files
810 in the current directory to debug problems
811 --print-traffic Display sent and read HTTP traffic
6bcd846b 812
36f35428 813## Workarounds:
2dd5a2e3 814 --encoding ENCODING Force the specified encoding (experimental)
815 --legacy-server-connect Explicitly allow HTTPS connection to servers
816 that do not support RFC 5746 secure
817 renegotiation
818 --no-check-certificates Suppress HTTPS certificate validation
819 --prefer-insecure Use an unencrypted connection to retrieve
820 information about the video (Currently
821 supported only for YouTube)
a5387729 822 --add-headers FIELD:VALUE Specify a custom HTTP header and its value,
2dd5a2e3 823 separated by a colon ":". You can use this
824 option multiple times
825 --bidi-workaround Work around terminals that lack
826 bidirectional text support. Requires bidiv
827 or fribidi executable in PATH
828 --sleep-requests SECONDS Number of seconds to sleep between requests
829 during data extraction
830 --sleep-interval SECONDS Number of seconds to sleep before each
831 download. This is the minimum time to sleep
832 when used along with --max-sleep-interval
833 (Alias: --min-sleep-interval)
834 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can only
835 be used along with --min-sleep-interval
836 --sleep-subtitles SECONDS Number of seconds to sleep before each
837 subtitle download
36f35428 838
cfcec693 839## Video Format Options:
2dd5a2e3 840 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
841 for more details
842 -S, --format-sort SORTORDER Sort the formats by the fields given, see
843 "Sorting Formats" for more details
844 --format-sort-force Force user specified sort order to have
845 precedence over all fields, see "Sorting
846 Formats" for more details (Alias: --S-force)
847 --no-format-sort-force Some fields have precedence over the user
848 specified sort order (default)
849 --video-multistreams Allow multiple video streams to be merged
850 into a single file
851 --no-video-multistreams Only one video stream is downloaded for each
852 output file (default)
853 --audio-multistreams Allow multiple audio streams to be merged
854 into a single file
855 --no-audio-multistreams Only one audio stream is downloaded for each
856 output file (default)
857 --prefer-free-formats Prefer video formats with free containers
858 over non-free ones of same quality. Use with
859 "-S ext" to strictly prefer free containers
860 irrespective of quality
861 --no-prefer-free-formats Don't give any special preference to free
862 containers (default)
863 --check-formats Make sure formats are selected only from
864 those that are actually downloadable
865 --check-all-formats Check all formats for whether they are
866 actually downloadable
867 --no-check-formats Do not check that the formats are actually
868 downloadable
869 -F, --list-formats List available formats of each video.
870 Simulate unless --no-simulate is used
fc61aff4 871 --merge-output-format FORMAT Containers that may be used when merging
62b58c09 872 formats, separated by "/", e.g. "mp4/mkv".
fc61aff4
LL		 873 Ignored if no merge is required. (currently
874 supported: avi, flv, mkv, mov, mp4, webm)
8ae7be3e
PH		 875
876## Subtitle Options:
2dd5a2e3 877 --write-subs Write subtitle file
878 --no-write-subs Do not write subtitle file (default)
879 --write-auto-subs Write automatically generated subtitle file
880 (Alias: --write-automatic-subs)
881 --no-write-auto-subs Do not write auto-generated subtitles
882 (default) (Alias: --no-write-automatic-subs)
883 --list-subs List available subtitles of each video.
884 Simulate unless --no-simulate is used
885 --sub-format FORMAT Subtitle format; accepts formats preference,
62b58c09 886 e.g. "srt" or "ass/srt/best"
2dd5a2e3 887 --sub-langs LANGS Languages of the subtitles to download (can
62b58c09
L		 888 be regex) or "all" separated by commas, e.g.
889 --sub-langs "en.*,ja". You can prefix the
2dd5a2e3 890 language code with a "-" to exclude it from
62b58c09
L		 891 the requested languages, e.g. --sub-langs
892 all,-live_chat. Use --list-subs for a list
2dd5a2e3 893 of available language tags
6bcd846b 894
cfcec693 895## Authentication Options:
2dd5a2e3 896 -u, --username USERNAME Login with this account ID
897 -p, --password PASSWORD Account password. If this option is left
898 out, yt-dlp will ask interactively
899 -2, --twofactor TWOFACTOR Two-factor authentication code
900 -n, --netrc Use .netrc authentication data
901 --netrc-location PATH Location of .netrc authentication data;
902 either the path or its containing directory.
903 Defaults to ~/.netrc
904 --video-password PASSWORD Video password (vimeo, youku)
905 --ap-mso MSO Adobe Pass multiple-system operator (TV
906 provider) identifier, use --ap-list-mso for
907 a list of available MSOs
908 --ap-username USERNAME Multiple-system operator account login
909 --ap-password PASSWORD Multiple-system operator account password.
910 If this option is left out, yt-dlp will ask
911 interactively
912 --ap-list-mso List all supported multiple-system operators
913 --client-certificate CERTFILE Path to client certificate file in PEM
914 format. May include the private key
915 --client-certificate-key KEYFILE
916 Path to private key file for client
917 certificate
bb58c9ed 918 --client-certificate-password PASSWORD
2dd5a2e3 919 Password for client certificate private key,
920 if encrypted. If not provided, and the key
921 is encrypted, yt-dlp will ask interactively
f5e008d1 922
c76eb41b 923## Post-Processing Options:
2dd5a2e3 924 -x, --extract-audio Convert video files to audio-only files
925 (requires ffmpeg and ffprobe)
35faefee 926 --audio-format FORMAT Format to convert the audio to when -x is
927 used. (currently supported: best (default),
8dc59305 928 aac, alac, flac, m4a, mp3, opus, vorbis,
e0ab9854 929 wav). You can specify multiple rules using
930 similar syntax as --remux-video
2dd5a2e3 931 --audio-quality QUALITY Specify ffmpeg audio quality to use when
932 converting the audio with -x. Insert a value
933 between 0 (best) and 10 (worst) for VBR or a
934 specific bitrate like 128K (default 5)
935 --remux-video FORMAT Remux the video into another container if
8dc59305 936 necessary (currently supported: avi, flv,
69f5fe45 937 gif, mkv, mov, mp4, webm, aac, aiff, alac,
938 flac, m4a, mka, mp3, ogg, opus, vorbis,
939 wav). If target container does not support
940 the video/audio codec, remuxing will fail.
941 You can specify multiple rules; e.g.
2dd5a2e3 942 "aac>m4a/mov>mp4/mkv" will remux aac to m4a,
35faefee 943 mov to mp4 and anything else to mkv
2dd5a2e3 944 --recode-video FORMAT Re-encode the video into another format if
945 necessary. The syntax and supported formats
946 are the same as --remux-video
947 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
948 Specify the postprocessor/executable name
949 and the arguments separated by a colon ":"
950 to give the argument to the specified
951 postprocessor/executable. Supported PP are:
952 Merger, ModifyChapters, SplitChapters,
953 ExtractAudio, VideoRemuxer, VideoConvertor,
954 Metadata, EmbedSubtitle, EmbedThumbnail,
955 SubtitlesConvertor, ThumbnailsConvertor,
956 FixupStretched, FixupM4a, FixupM3u8,
957 FixupTimestamp and FixupDuration. The
958 supported executables are: AtomicParsley,
959 FFmpeg and FFprobe. You can also specify
960 "PP+EXE:ARGS" to give the arguments to the
961 specified executable only when being used by
962 the specified postprocessor. Additionally,
963 for ffmpeg/ffprobe, "_i"/"_o" can be
964 appended to the prefix optionally followed
965 by a number to pass the argument before the
62b58c09 966 specified input/output file, e.g. --ppa
2dd5a2e3 967 "Merger+ffmpeg_i1:-v quiet". You can use
968 this option multiple times to give different
969 arguments to different postprocessors.
970 (Alias: --ppa)
971 -k, --keep-video Keep the intermediate video file on disk
972 after post-processing
973 --no-keep-video Delete the intermediate video file after
974 post-processing (default)
975 --post-overwrites Overwrite post-processed files (default)
976 --no-post-overwrites Do not overwrite post-processed files
977 --embed-subs Embed subtitles in the video (only for mp4,
978 webm and mkv videos)
979 --no-embed-subs Do not embed subtitles (default)
980 --embed-thumbnail Embed thumbnail in the video as cover art
981 --no-embed-thumbnail Do not embed thumbnail (default)
982 --embed-metadata Embed metadata to the video file. Also
983 embeds chapters/infojson if present unless
984 --no-embed-chapters/--no-embed-info-json are
985 used (Alias: --add-metadata)
986 --no-embed-metadata Do not add metadata to file (default)
987 (Alias: --no-add-metadata)
988 --embed-chapters Add chapter markers to the video file
989 (Alias: --add-chapters)
990 --no-embed-chapters Do not add chapter markers (default) (Alias:
991 --no-add-chapters)
992 --embed-info-json Embed the infojson as an attachment to
993 mkv/mka video files
994 --no-embed-info-json Do not embed the infojson as an attachment
995 to the video file
fe74d5b5 996 --parse-metadata [WHEN:]FROM:TO
997 Parse additional metadata like title/artist
2dd5a2e3 998 from other fields; see "MODIFYING METADATA"
fe74d5b5 999 for details. Supported values of "WHEN" are
1000 the same as that of --use-postprocessor
1001 (default: pre_process)
1002 --replace-in-metadata [WHEN:]FIELDS REGEX REPLACE
2dd5a2e3 1003 Replace text in a metadata field using the
1004 given regex. This option can be used
fe74d5b5 1005 multiple times. Supported values of "WHEN"
1006 are the same as that of --use-postprocessor
1007 (default: pre_process)
2dd5a2e3 1008 --xattrs Write metadata to the video file's xattrs
1009 (using dublin core and xdg standards)
1010 --concat-playlist POLICY Concatenate videos in a playlist. One of
1011 "never", "always", or "multi_video"
1012 (default; only when the videos form a single
1013 show). All the video files must have same
1014 codecs and number of streams to be
1015 concatable. The "pl_video:" prefix can be
1016 used with "--paths" and "--output" to set
1017 the output filename for the concatenated
1018 files. See "OUTPUT TEMPLATE" for details
1019 --fixup POLICY Automatically correct known faults of the
1020 file. One of never (do nothing), warn (only
1021 emit a warning), detect_or_warn (the
1022 default; fix file if we can, warn
1023 otherwise), force (try fixing even if file
1024 already exists)
1025 --ffmpeg-location PATH Location of the ffmpeg binary; either the
64fa820c 1026 path to the binary or its containing directory
2dd5a2e3 1027 --exec [WHEN:]CMD Execute a command, optionally prefixed with
119e40ef 1028 when to execute it, separated by a ":".
1029 Supported values of "WHEN" are the same as
1030 that of --use-postprocessor (default:
1031 after_move). Same syntax as the output
1032 template can be used to pass any field as
1033 arguments to the command. After download, an
1034 additional field "filepath" that contains
1035 the final path of the downloaded file is
1036 also available, and if no fields are passed,
8e174ba7 1037 %(filepath,_filename|)q is appended to the
1038 end of the command. This option can be used
1039 multiple times
2dd5a2e3 1040 --no-exec Remove any previously defined --exec
1041 --convert-subs FORMAT Convert the subtitles to another format
8dc59305 1042 (currently supported: ass, lrc, srt, vtt)
2dd5a2e3 1043 (Alias: --convert-subtitles)
1044 --convert-thumbnails FORMAT Convert the thumbnails to another format
00bbc5f1 1045 (currently supported: jpg, png, webp). You
1046 can specify multiple rules using similar
1047 syntax as --remux-video
2dd5a2e3 1048 --split-chapters Split video into multiple files based on
1049 internal chapters. The "chapter:" prefix can
1050 be used with "--paths" and "--output" to set
1051 the output filename for the split files. See
1052 "OUTPUT TEMPLATE" for details
64fa820c 1053 --no-split-chapters Do not split video based on chapters (default)
2dd5a2e3 1054 --remove-chapters REGEX Remove chapters whose title matches the
5ec1b6b7 1055 given regular expression. The syntax is the
1056 same as --download-sections. This option can
2dd5a2e3 1057 be used multiple times
1058 --no-remove-chapters Do not remove any chapters from the file
1059 (default)
5ec1b6b7 1060 --force-keyframes-at-cuts Force keyframes at cuts when
1061 downloading/splitting/removing sections.
1062 This is slow due to needing a re-encode, but
1063 the resulting video may have fewer artifacts
1064 around the cuts
2dd5a2e3 1065 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
1066 when cutting/splitting (default)
1067 --use-postprocessor NAME[:ARGS]
1068 The (case sensitive) name of plugin
1069 postprocessors to be enabled, and
1070 (optionally) arguments to be passed to it,
1071 separated by a colon ":". ARGS are a
1072 semicolon ";" delimited list of NAME=VALUE.
1073 The "when" argument determines when the
1074 postprocessor is invoked. It can be one of
1075 "pre_process" (after video extraction),
1076 "after_filter" (after video passes filter),
119e40ef 1077 "video" (after --format; before
1078 --print/--output), "before_dl" (before each
1079 video download), "post_process" (after each
1080 video download; default), "after_move"
1081 (after moving video file to it's final
1082 locations), "after_video" (after downloading
1083 and processing all formats of a video), or
1084 "playlist" (at end of playlist). This option
1085 can be used multiple times to add different
1086 postprocessors
7a340e0d
NA		 1087
1088## SponsorBlock Options:
1089Make chapter entries for, or remove various segments (sponsor,
1090 introductions, etc.) from downloaded YouTube videos using the
8a51f564 1091 [SponsorBlock API](https://sponsor.ajay.app)
1092
2dd5a2e3 1093 --sponsorblock-mark CATS SponsorBlock categories to create chapters
1094 for, separated by commas. Available
1095 categories are sponsor, intro, outro,
1096 selfpromo, preview, filler, interaction,
71df9b7f 1097 music_offtopic, poi_highlight, chapter, all
1098 and default (=all). You can prefix the
1099 category with a "-" to exclude it. See [1]
1100 for description of the categories. E.g.
2dd5a2e3 1101 --sponsorblock-mark all,-preview
1102 [1] https://wiki.sponsor.ajay.app/w/Segment_Categories
1103 --sponsorblock-remove CATS SponsorBlock categories to be removed from
1104 the video file, separated by commas. If a
1105 category is present in both mark and remove,
1106 remove takes precedence. The syntax and
1107 available categories are the same as for
1108 --sponsorblock-mark except that "default"
71df9b7f 1109 refers to "all,-filler" and poi_highlight,
63c547d7 1110 chapter are not available
7a340e0d 1111 --sponsorblock-chapter-title TEMPLATE
2dd5a2e3 1112 An output template for the title of the
1113 SponsorBlock chapters created by
1114 --sponsorblock-mark. The only available
1115 fields are start_time, end_time, category,
1116 categories, name, category_names. Defaults
1117 to "[SponsorBlock]: %(category_names)l"
1118 --no-sponsorblock Disable both --sponsorblock-mark and
1119 --sponsorblock-remove
1120 --sponsorblock-api URL SponsorBlock API location, defaults to
1121 https://sponsor.ajay.app
a9e7f546 1122
78895bd3 1123## Extractor Options:
2dd5a2e3 1124 --extractor-retries RETRIES Number of retries for known extractor errors
1125 (default is 3), or "infinite"
1126 --allow-dynamic-mpd Process dynamic DASH manifests (default)
1127 (Alias: --no-ignore-dynamic-mpd)
1128 --ignore-dynamic-mpd Do not process dynamic DASH manifests
1129 (Alias: --no-allow-dynamic-mpd)
1130 --hls-split-discontinuity Split HLS playlists to different formats at
1131 discontinuities such as ad breaks
1132 --no-hls-split-discontinuity Do not split HLS playlists to different
1133 formats at discontinuities such as ad breaks
1134 (default)
2fa669f7 1135 --extractor-args IE_KEY:ARGS Pass ARGS arguments to the IE_KEY extractor.
1136 See "EXTRACTOR ARGUMENTS" for details. You
1137 can use this option multiple times to give
2dd5a2e3 1138 arguments for different extractors
17cb02d0 1139
b7770046
U		 1140# CONFIGURATION
1141
7a5c1cfe 1142You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
e2e43aea 1143
878eac3e 11441. **Main Configuration**:
1145 * The file given by `--config-location`
11461. **Portable Configuration**: (Recommended for portable installations)
1147 * If using a binary, `yt-dlp.conf` in the same directory as the binary
1148 * If running from source-code, `yt-dlp.conf` in the parent directory of `yt_dlp`
11491. **Home Configuration**:
1150 * `yt-dlp.conf` in the home path given by `-P`
1151 * If `-P` is not given, the current directory is searched
e2e43aea 11521. **User Configuration**:
773c272d 1153 * `${XDG_CONFIG_HOME}/yt-dlp.conf`
878eac3e 1154 * `${XDG_CONFIG_HOME}/yt-dlp/config` (recommended on Linux/macOS)
8e40b9d1 1155 * `${XDG_CONFIG_HOME}/yt-dlp/config.txt`
773c272d 1156 * `${APPDATA}/yt-dlp.conf`
878eac3e 1157 * `${APPDATA}/yt-dlp/config` (recommended on Windows)
1158 * `${APPDATA}/yt-dlp/config.txt`
e2e43aea 1159 * `~/yt-dlp.conf`
1160 * `~/yt-dlp.conf.txt`
8e40b9d1
M		 1161 * `~/.yt-dlp/config`
1162 * `~/.yt-dlp/config.txt`
3d3bb168 1163
878eac3e 1164 See also: [Notes about environment variables](#notes-about-environment-variables)
11651. **System Configuration**:
1166 * `/etc/yt-dlp.conf`
8e40b9d1
M		 1167 * `/etc/yt-dlp/config`
1168 * `/etc/yt-dlp/config.txt`
b7770046 1169
62b58c09 1170E.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:
b7770046
U		 1171```
1172# Lines starting with # are comments
1173
1174# Always extract audio
1175-x
1176
1177# Do not copy the mtime
1178--no-mtime
1179
1180# Use this proxy
1181--proxy 127.0.0.1:3128
1182
298f597b 1183# Save all videos under YouTube directory in your home directory
1184-o ~/YouTube/%(title)s.%(ext)s
b7770046
U		 1185```
1186
8e174ba7 1187**Note**: Options in 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.
b7770046 1188
a4211baf 1189You 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.
b7770046 1190
304ad45a 1191### Configuration file encoding
a904a7f8 1192
304ad45a 1193The configuration files are decoded according to the UTF BOM if present, and in the encoding from system locale otherwise.
a904a7f8 1194
88f60feb 1195If 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.
a904a7f8 1196
b7770046
U		 1197### Authentication with `.netrc` file
1198
304ad45a 1199You 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:
b7770046 1200```
878eac3e 1201touch ${HOME}/.netrc
1202chmod a-rwx,u+rw ${HOME}/.netrc
b7770046
U		 1203```
1204After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1205```
0001fcb5 1206machine <extractor> login <username> password <password>
b7770046 1207```
62b58c09 1208E.g.
b7770046
U		 1209```
1210machine youtube login myaccount@gmail.com password my_youtube_password
1211machine twitch login my_twitch_account_name password my_twitch_password
1212```
7a5c1cfe 1213To activate authentication with the `.netrc` file you should pass `--netrc` to yt-dlp or place it in the [configuration file](#configuration).
b7770046 1214
878eac3e 1215The default location of the .netrc file is `~` (see below).
1216
1217### Notes about environment variables
1218* Environment variables are normally specified as `${VARIABLE}`/`$VARIABLE` on UNIX and `%VARIABLE%` on Windows; but is always shown as `${VARIABLE}` in this documentation
1219* yt-dlp also allow using UNIX-style variables on Windows for path-like options; e.g. `--output`, `--config-location`
1220* If unset, `${XDG_CONFIG_HOME}` defaults to `~/.config` and `${XDG_CACHE_HOME}` to `~/.cache`
1221* On Windows, `~` points to `${HOME}` if present; or, `${USERPROFILE}` or `${HOMEDRIVE}${HOMEPATH}` otherwise
1222* On Windows, `${USERPROFILE}` generally points to `C:\Users\<user name>` and `${APPDATA}` to `${USERPROFILE}\AppData\Roaming`
b7770046
U		 1223
1224# OUTPUT TEMPLATE
1225
0202b52a 1226The `-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.
b7770046 1227
ec2e44fc 1228<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
b7770046 1229**tl;dr:** [navigate me to examples](#output-template-examples).
ec2e44fc 1230<!-- MANPAGE: END EXCLUDED SECTION -->
b7770046 1231
e58c22a0 1232The 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).
a439a3a4 1233
62b58c09 1234It 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.
a439a3a4 1235
1236The field names themselves (the part inside the parenthesis) can also have some special formatting:
3d3bb168 1237
07a1250e 12381. **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:-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
ec2e44fc 1239
62b58c09 12401. **Addition**: Addition and subtraction of numeric fields can be done using `+` and `-` respectively. E.g. `%(playlist_index+10)03d`, `%(n_entries+1-playlist_index)d`
ec2e44fc 1241
62b58c09 12421. **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`
ec2e44fc 1243
62b58c09 12441. **Alternatives**: Alternate fields can be specified separated with a `,`. E.g. `%(release_date>%Y,upload_date>%Y|Unknown)s`
ec2e44fc 1245
ec9311c4 12461. **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`
e978789f 1247
17ffed18 12481. **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`
ec2e44fc 1249
9b9dad11 12501. **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)
ec2e44fc 1251
d5d1df8a 12521. **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
a439a3a4 1253
1254To summarize, the general syntax for a field is:
1255```
e978789f 1256%(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
a439a3a4 1257```
de6000d9 1258
62b58c09 1259Additionally, 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.
e29663c6 1260
4815bbfc 1261<a id="outtmpl-postprocess-note"/>
7aaf4cd2 1262
8e174ba7 1263**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.
7aaf4cd2 1264
e29663c6 1265The available fields are:
b7770046
U		 1266
1267 - `id` (string): Video identifier
1268 - `title` (string): Video title
455a15e2 1269 - `fulltitle` (string): Video title ignoring live timestamp and generic title
b7770046
U		 1270 - `ext` (string): Video filename extension
1271 - `alt_title` (string): A secondary title of the video
597c1866 1272 - `description` (string): The description of the video
b7770046
U		 1273 - `display_id` (string): An alternative identifier for the video
1274 - `uploader` (string): Full name of the video uploader
1275 - `license` (string): License name the video is licensed under
1276 - `creator` (string): The creator of the video
b7770046 1277 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
ae6a1b95 1278 - `upload_date` (string): Video upload date in UTC (YYYYMMDD)
e6f21b3d 1279 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
ae6a1b95 1280 - `release_date` (string): The date (YYYYMMDD) when the video was released in UTC
f0d785d3 1281 - `modified_timestamp` (numeric): UNIX timestamp of the moment the video was last modified
ae6a1b95 1282 - `modified_date` (string): The date (YYYYMMDD) when the video was last modified in UTC
b7770046
U		 1283 - `uploader_id` (string): Nickname or id of the video uploader
1284 - `channel` (string): Full name of the channel the video is uploaded on
1285 - `channel_id` (string): Id of the channel
6c73052c 1286 - `channel_follower_count` (numeric): Number of followers of the channel
b7770046
U		 1287 - `location` (string): Physical location where the video was filmed
1288 - `duration` (numeric): Length of the video in seconds
53c18592 1289 - `duration_string` (string): Length of the video (HH:mm:ss)
b7770046 1290 - `view_count` (numeric): How many users have watched the video on the platform
867c66ff 1291 - `concurrent_view_count` (numeric): How many users are currently watching the video on the platform.
b7770046
U		 1292 - `like_count` (numeric): Number of positive ratings of the video
1293 - `dislike_count` (numeric): Number of negative ratings of the video
1294 - `repost_count` (numeric): Number of reposts of the video
1295 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
277d6ff5 1296 - `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)
b7770046 1297 - `age_limit` (numeric): Age restriction for the video (years)
e325a21a 1298 - `live_status` (string): One of "not_live", "is_live", "is_upcoming", "was_live", "post_live" (was live, but VOD is not yet processed)
b7770046 1299 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
f76ede8e 1300 - `was_live` (boolean): Whether this video was originally a live stream
6cfda058 1301 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
940a67a3 1302 - `availability` (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
b7770046
U		 1303 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1304 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
b7770046
U		 1305 - `extractor` (string): Name of the extractor
1306 - `extractor_key` (string): Key name of the extractor
455a15e2 1307 - `epoch` (numeric): Unix epoch of when the information extraction was completed
b7770046 1308 - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
9c906919 1309 - `video_autonumber` (numeric): Number that will be increased with each video
e6f21b3d 1310 - `n_entries` (numeric): Total number of extracted items in the playlist
455a15e2 1311 - `playlist_id` (string): Identifier of the playlist that contains the video
1312 - `playlist_title` (string): Name of the playlist that contains the video
1313 - `playlist` (string): `playlist_id` or `playlist_title`
f0d785d3 1314 - `playlist_count` (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
e6f21b3d 1315 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1316 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
b7770046
U		 1317 - `playlist_uploader` (string): Full name of the playlist uploader
1318 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
bd99f6e6 1319 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
0bb322b9 1320 - `webpage_url_basename` (string): The basename of the webpage URL
1321 - `webpage_url_domain` (string): The domain of the webpage URL
bd99f6e6 1322 - `original_url` (string): The URL given by the user (or same as `webpage_url` for playlist entries)
d2c8aadf 1323
1324All the fields in [Filtering Formats](#filtering-formats) can also be used
b7770046
U		 1325
1326Available for the video that belongs to some logical chapter or section:
1327
1328 - `chapter` (string): Name or title of the chapter the video belongs to
1329 - `chapter_number` (numeric): Number of the chapter the video belongs to
1330 - `chapter_id` (string): Id of the chapter the video belongs to
1331
1332Available for the video that is an episode of some series or programme:
1333
1334 - `series` (string): Title of the series or programme the video episode belongs to
1335 - `season` (string): Title of the season the video episode belongs to
1336 - `season_number` (numeric): Number of the season the video episode belongs to
1337 - `season_id` (string): Id of the season the video episode belongs to
1338 - `episode` (string): Title of the video episode
1339 - `episode_number` (numeric): Number of the video episode within a season
1340 - `episode_id` (string): Id of the video episode
1341
1342Available for the media that is a track or a part of a music album:
1343
1344 - `track` (string): Title of the track
1345 - `track_number` (numeric): Number of the track within an album or a disc
1346 - `track_id` (string): Id of the track
1347 - `artist` (string): Artist(s) of the track
1348 - `genre` (string): Genre(s) of the track
1349 - `album` (string): Title of the album the track belongs to
1350 - `album_type` (string): Type of the album
1351 - `album_artist` (string): List of all artists appeared on the album
1352 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1353 - `release_year` (numeric): Year (YYYY) when the album was released
1354
5ec1b6b7 1355Available only when using `--download-sections` and for `chapter:` prefix when using `--split-chapters` for videos with internal chapters:
72755351 1356
1357 - `section_title` (string): Title of the chapter
1358 - `section_number` (numeric): Number of the chapter within the file
1359 - `section_start` (numeric): Start time of the chapter in seconds
1360 - `section_end` (numeric): End time of the chapter in seconds
1361
53c18592 1362Available only when used in `--print`:
1363
1364 - `urls` (string): The URLs of all requested formats, one in each line
7aaf4cd2 1365 - `filename` (string): Name of the video file. Note that the [actual filename may differ](#outtmpl-postprocess-note)
ed5835b4 1366 - `formats_table` (table): The video format table as printed by `--list-formats`
1367 - `thumbnails_table` (table): The thumbnail format table as printed by `--list-thumbnails`
1368 - `subtitles_table` (table): The subtitle format table as printed by `--list-subs`
1369 - `automatic_captions_table` (table): The automatic subtitle format table as printed by `--list-subs`
1370
7a340e0d
NA		 1371
1372Available only in `--sponsorblock-chapter-title`:
1373
1374 - `start_time` (numeric): Start time of the chapter in seconds
1375 - `end_time` (numeric): End time of the chapter in seconds
1338ae3b 1376 - `categories` (list): The [SponsorBlock categories](https://wiki.sponsor.ajay.app/w/Types#Category) the chapter belongs to
7a340e0d
NA		 1377 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1378 - `category_names` (list): Friendly names of the categories
1379 - `name` (string): Friendly name of the smallest category
1338ae3b 1380 - `type` (string): The [SponsorBlock action type](https://wiki.sponsor.ajay.app/w/Types#Action_Type) of the chapter
53c18592 1381
62b58c09 1382Each 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.
49a57e70 1383
8e174ba7 1384**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).
b7770046 1385
0930b11f 1386**Tip**: Look at the `-j` output to identify which fields are available for the particular URL
b7770046 1387
62b58c09 1388For 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`.
b7770046 1389
940a67a3 1390Output 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.
b7770046
U		 1391
1392To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
1393
91ebc640 1394The current default template is `%(title)s [%(id)s].%(ext)s`.
b7770046 1395
f304da8a 1396In 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.
b7770046 1397
b7770046
U		 1398#### Output template examples
1399
b7770046 1400```bash
d2c8aadf 1401$ yt-dlp --print filename -o "test video.%(ext)s" BaW_jenozKc
9222c381 1402test video.webm # Literal name with correct extension
1403
d2c8aadf 1404$ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc
9222c381 1405youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
b7770046 1406
d2c8aadf 1407$ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
9222c381 1408youtube-dl_test_video_.webm # Restricted file name
b7770046
U		 1409
1410# Download YouTube playlist videos in separate directory indexed by video order in a playlist
940a67a3 1411$ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
b7770046 1412
b050d210 1413# Download YouTube playlist videos in separate directories according to their uploaded year
940a67a3 1414$ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
e29663c6 1415
e978789f 1416# Prefix playlist index with " - " separator, but only if it is available
6a34813a 1417$ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
e978789f 1418
b7770046 1419# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
940a67a3 1420$ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
b7770046
U		 1421
1422# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
940a67a3 1423$ 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"
b7770046
U		 1424
1425# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
940a67a3 1426$ 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"
b7770046 1427
6a34813a 1428# Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
1429# and put all temporary files in "C:\MyVideos\tmp"
1430$ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs
1431
1432# Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
1433$ 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
1434
b7770046 1435# Stream the video being downloaded to stdout
7a5c1cfe 1436$ yt-dlp -o - BaW_jenozKc
b7770046
U		 1437```
1438
1439# FORMAT SELECTION
1440
7a5c1cfe
P		 1441By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1442This 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`.
b7770046 1443
c111cefa 1444**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.
1445
eff63539 1446The 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.
b7770046 1447
ec2e44fc 1448<!-- MANPAGE: BEGIN EXCLUDED SECTION -->
b7770046 1449**tl;dr:** [navigate me to examples](#format-selection-examples).
ec2e44fc 1450<!-- MANPAGE: END EXCLUDED SECTION -->
b7770046 1451
62b58c09 1452The 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.
b7770046
U		 1453
1454You 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.
1455
fa9f30b8 1456You can use `-f -` to interactively provide the format selector *for each video*
1457
b7770046
U		 1458You can also use special names to select particular edge case formats:
1459
59a7a13e 1460 - `all`: Select **all formats** separately
1461 - `mergeall`: Select and **merge all formats** (Must be used with `--audio-multistreams`, `--video-multistreams` or both)
30389593 1462 - `b*`, `best*`: Select the best quality format that **contains either** a video or an audio or both (ie; `vcodec!=none or acodec!=none`)
59a7a13e 1463 - `b`, `best`: Select the best quality format that **contains both** video and audio. Equivalent to `best*[vcodec!=none][acodec!=none]`
1464 - `bv`, `bestvideo`: Select the best quality **video-only** format. Equivalent to `best*[acodec=none]`
1465 - `bv*`, `bestvideo*`: Select the best quality format that **contains video**. It may also contain audio. Equivalent to `best*[vcodec!=none]`
1466 - `ba`, `bestaudio`: Select the best quality **audio-only** format. Equivalent to `best*[vcodec=none]`
ae6a1b95 1467 - `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))
59a7a13e 1468 - `w*`, `worst*`: Select the worst quality format that contains either a video or an audio
909d24dd 1469 - `w`, `worst`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]`
909d24dd 1470 - `wv`, `worstvideo`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]`
909d24dd 1471 - `wv*`, `worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]`
909d24dd 1472 - `wa`, `worstaudio`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]`
909d24dd 1473 - `wa*`, `worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]`
b7770046 1474
d4ada357 1475For 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.
eff63539 1476
1477You 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.
b7770046 1478
304ad45a 1479If 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.
b7770046
U		 1480
1481If 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`.
1482
62b58c09 1483You 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.
d806c9fd 1484
1485**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
1486
304ad45a 1487Unless `--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`.
eb8a4433 1488
1489## Filtering Formats
1490
b7770046
U		 1491You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
1492
1493The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
1494
1495 - `filesize`: The number of bytes, if known in advance
d2c8aadf 1496 - `filesize_approx`: An estimate for the number of bytes
b7770046
U		 1497 - `width`: Width of the video, if known
1498 - `height`: Height of the video, if known
105bfd90 1499 - `aspect_ratio`: Aspect ratio of the video, if known
b7770046
U		 1500 - `tbr`: Average bitrate of audio and video in KBit/s
1501 - `abr`: Average audio bitrate in KBit/s
1502 - `vbr`: Average video bitrate in KBit/s
1503 - `asr`: Audio sampling rate in Hertz
1504 - `fps`: Frame rate
d2c8aadf 1505 - `audio_channels`: The number of audio channels
1506 - `stretched_ratio`: `width:height` of the video's pixels, if not square
b7770046 1507
1ce9a3cb 1508Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains), `~=` (matches regex) and following string meta fields:
b7770046 1509
d2c8aadf 1510 - `url`: Video URL
b7770046
U		 1511 - `ext`: File extension
1512 - `acodec`: Name of the audio codec in use
1513 - `vcodec`: Name of the video codec in use
1514 - `container`: Name of the container format
1515 - `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`)
29f7c58a 1516 - `language`: Language code
d2c8aadf 1517 - `dynamic_range`: The dynamic range of the video
1518 - `format_id`: A short description of the format
1519 - `format`: A human-readable description of the format
1520 - `format_note`: Additional info about the format
1521 - `resolution`: Textual description of width and height
b7770046 1522
1ce9a3cb 1523Any 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 `._-`.
b7770046 1524
8e174ba7 1525**Note**: None of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.
b7770046 1526
62b58c09 1527Formats 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 "[height<=?720][tbr>500]"` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s. 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.
b7770046 1528
62b58c09 1529Format 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.
b7770046 1530
eb8a4433 1531## Sorting Formats
1532
2e7781a9 1533You can change the criteria for being considered the `best` by using `-S` (`--format-sort`). The general format for this is `--format-sort field1,field2...`.
1534
1535The available fields are:
eb8a4433 1536
304ad45a 1537 - `hasvid`: Gives priority to formats that have a video stream
1538 - `hasaud`: Gives priority to formats that have an audio stream
ed8d87f9 1539 - `ie_pref`: The format preference
1540 - `lang`: The language preference
1541 - `quality`: The quality of the format
1542 - `source`: The preference of the source
d80d98e7 1543 - `proto`: Protocol used for download (`https`/`ftps` > `http`/`ftp` > `m3u8_native`/`m3u8` > `http_dash_segments`> `websocket_frag` > `mms`/`rtsp` > `f4f`/`f4m`)
1544 - `vcodec`: Video Codec (`av01` > `vp9.2` > `vp9` > `h265` > `h264` > `vp8` > `h263` > `theora` > other)
a5387729 1545 - `acodec`: Audio Codec (`flac`/`alac` > `wav`/`aiff` > `opus` > `vorbis` > `aac` > `mp4a` > `mp3` > `ac4` > `eac3` > `ac3` > `dts` > other)
eb8a4433 1546 - `codec`: Equivalent to `vcodec,acodec`
29ca4082 1547 - `vext`: Video Extension (`mp4` > `mov` > `webm` > `flv` > other). If `--prefer-free-formats` is used, `webm` is preferred.
f2e9fa3e 1548 - `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`
63be1aab 1549 - `ext`: Equivalent to `vext,aext`
0930b11f 1550 - `filesize`: Exact filesize, if known in advance
63be1aab 1551 - `fs_approx`: Approximate filesize calculated from the manifests
1552 - `size`: Exact filesize if available, otherwise approximate filesize
eb8a4433 1553 - `height`: Height of video
1554 - `width`: Width of video
63be1aab 1555 - `res`: Video resolution, calculated as the smallest dimension.
1556 - `fps`: Framerate of video
49a57e70 1557 - `hdr`: The dynamic range of the video (`DV` > `HDR12` > `HDR10+` > `HDR10` > `HLG` > `SDR`)
b8ed0f15 1558 - `channels`: The number of audio channels
63be1aab 1559 - `tbr`: Total average bitrate in KBit/s
1560 - `vbr`: Average video bitrate in KBit/s
1561 - `abr`: Average audio bitrate in KBit/s
1562 - `br`: Equivalent to using `tbr,vbr,abr`
1563 - `asr`: Audio sample rate in Hz
d806c9fd 1564
1565**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.
eb8a4433 1566
62b58c09 1567All 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.
9ee4f0bb 1568
7e798d72 1569The fields `hasvid` and `ie_pref` are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using `--format-sort-force`. Apart from these, the default order used is: `lang,quality,res,fps,hdr:12,vcodec:vp9.2,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.
eb8a4433 1570
7e798d72 1571Note that the default has `vcodec:vp9.2`; i.e. `av1` is not preferred. Similarly, the default for hdr is `hdr:12`; i.e. dolby vision is not preferred. These choices are made since DV and AV1 formats are not yet fully compatible with most devices. This may be changed in the future as more devices become capable of smoothly playing back these formats.
eb8a4433 1572
e58c22a0 1573If 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`.
eb8a4433 1574
1575**Tip**: You can use the `-v -F` to see how the formats have been sorted (worst to best).
1576
eb8a4433 1577## Format Selection examples
b7770046 1578
b7770046 1579```bash
e58c22a0 1580# Download and merge the best video-only format and the best audio-only format,
909d24dd 1581# or download the best combined format if video-only format is not available
940a67a3 1582$ yt-dlp -f "bv+ba/b"
909d24dd 1583
1584# Download best format that contains video,
1585# and if it doesn't already have an audio stream, merge it with best audio-only format
940a67a3 1586$ yt-dlp -f "bv*+ba/b"
2af884ff 1587
1588# Same as above
7a5c1cfe 1589$ yt-dlp
909d24dd 1590
6fd35a11 1591# Download the best video-only format and the best audio-only format without merging them
1592# For this case, an output template should be used since
1593# by default, bestvideo and bestaudio will have the same file name.
940a67a3 1594$ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
909d24dd 1595
f8d4ad9a 1596# Download and merge the best format that has a video stream,
1597# and all audio-only formats into one file
940a67a3 1598$ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
f8d4ad9a 1599
1600# Download and merge the best format that has a video stream,
1601# and the best 2 audio-only formats into one file
940a67a3 1602$ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
909d24dd 1603
6fd35a11 1604
1605# The following examples show the old method (without -S) of format selection
f8d4ad9a 1606# and how to use -S to achieve a similar but (generally) better result
6fd35a11 1607
1608# Download the worst video available (old method)
940a67a3 1609$ yt-dlp -f "wv*+wa/w"
eb8a4433 1610
1611# Download the best video available but with the smallest resolution
940a67a3 1612$ yt-dlp -S "+res"
eb8a4433 1613
1614# Download the smallest video available
940a67a3 1615$ yt-dlp -S "+size,+br"
eb8a4433 1616
1617
909d24dd 1618
eb8a4433 1619# Download the best mp4 video available, or the best video if no mp4 available
940a67a3 1620$ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
eb8a4433 1621
1622# Download the best video with the best extension
29ca4082 1623# (For video, mp4 > mov > webm > flv. For audio, m4a > aac > mp3 ...)
940a67a3 1624$ yt-dlp -S "ext"
eb8a4433 1625
1626
909d24dd 1627
eb8a4433 1628# Download the best video available but no better than 480p,
1629# or the worst video if there is no video under 480p
940a67a3 1630$ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"
b7770046 1631
eb8a4433 1632# Download the best video available with the largest height but no better than 480p,
1633# or the best video with the smallest resolution if there is no video under 480p
940a67a3 1634$ yt-dlp -S "height:480"
b7770046 1635
eb8a4433 1636# Download the best video available with the largest resolution but no better than 480p,
1637# or the best video with the smallest resolution if there is no video under 480p
1638# Resolution is determined by using the smallest dimension.
1639# So this works correctly for vertical videos as well
940a67a3 1640$ yt-dlp -S "res:480"
b7770046 1641
b7770046 1642
909d24dd 1643
eb8a4433 1644# Download the best video (that also has audio) but no bigger than 50 MB,
1645# or the worst video (that also has audio) if there is no video under 50 MB
940a67a3 1646$ yt-dlp -f "b[filesize<50M] / w"
eb8a4433 1647
1648# Download largest video (that also has audio) but no bigger than 50 MB,
1649# or the smallest video (that also has audio) if there is no video under 50 MB
940a67a3 1650$ yt-dlp -f "b" -S "filesize:50M"
eb8a4433 1651
1652# Download best video (that also has audio) that is closest in size to 50 MB
940a67a3 1653$ yt-dlp -f "b" -S "filesize~50M"
eb8a4433 1654
1655
909d24dd 1656
eb8a4433 1657# Download best video available via direct link over HTTP/HTTPS protocol,
1658# or the best video available via any protocol if there is no such video
940a67a3 1659$ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
eb8a4433 1660
1661# Download best video available via the best protocol
1662# (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
940a67a3 1663$ yt-dlp -S "proto"
eb8a4433 1664
1665
909d24dd 1666
1ce9a3cb
LF		 1667# Download the best video with either h264 or h265 codec,
1668# or the best video if there is no such video
1669$ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"
eb8a4433 1670
1671# Download the best video with best codec no better than h264,
1672# or the best video with worst codec if there is no such video
940a67a3 1673$ yt-dlp -S "codec:h264"
eb8a4433 1674
1675# Download the best video with worst codec no worse than h264,
1676# or the best video with best codec if there is no such video
940a67a3 1677$ yt-dlp -S "+codec:h264"
eb8a4433 1678
1679
1680
1681# More complex examples
1682
e58c22a0 1683# Download the best video no better than 720p preferring framerate greater than 30,
1684# or the worst video (still preferring framerate greater than 30) if there is no such video
940a67a3 1685$ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"
eb8a4433 1686
1687# Download the video with the largest resolution no better than 720p,
f8d4ad9a 1688# or the video with the smallest resolution available if there is no such video,
e58c22a0 1689# preferring larger framerate for formats with the same resolution
940a67a3 1690$ yt-dlp -S "res:720,fps"
eb8a4433 1691
1692
909d24dd 1693
eb8a4433 1694# Download the video with smallest resolution no worse than 480p,
1695# or the video with the largest resolution available if there is no such video,
e58c22a0 1696# preferring better codec and then larger total bitrate for the same resolution
940a67a3 1697$ yt-dlp -S "+res:480,codec,br"
b7770046 1698```
eb8a4433 1699
73cd218f 1700# MODIFYING METADATA
1701
a4211baf 1702The metadata obtained by the extractors can be modified by using `--parse-metadata` and `--replace-in-metadata`
e9f4ccd1 1703
418964fa 1704`--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.
e9f4ccd1 1705
46d09f87 1706The 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.
73cd218f 1707
46d09f87 1708Note that these options preserve their relative order, allowing replacements to be made in parsed fields and viceversa. 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`.
73cd218f 1709
9c2b75b5 1710This option also has a few special uses:
3d3bb168 1711
62b58c09 1712* 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
3d3bb168 1713
62b58c09 1714* 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.
c31be5b0 1715
08d30158 1716**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.
1717
c31be5b0 1718For reference, these are the fields yt-dlp adds by default to the file metadata:
1719
08d30158 1720Metadata fields | From
1721:--------------------------|:------------------------------------------------
1722`title` | `track` or `title`
1723`date` | `upload_date`
1724`description`, `synopsis` | `description`
1725`purl`, `comment` | `webpage_url`
1726`track` | `track_number`
1727`artist` | `artist`, `creator`, `uploader` or `uploader_id`
1728`genre` | `genre`
1729`album` | `album`
1730`album_artist` | `album_artist`
1731`disc` | `disc_number`
1732`show` | `series`
1733`season_number` | `season_number`
1734`episode_id` | `episode` or `episode_id`
1735`episode_sort` | `episode_number`
1736`language` of each stream | the format's `language`
1737
c31be5b0 1738**Note**: The file format may not support some of these fields
1739
73cd218f 1740
1741## Modifying metadata examples
1742
73cd218f 1743```bash
1744# Interpret the title as "Artist - Title"
940a67a3 1745$ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
73cd218f 1746
1747# Regex example
940a67a3 1748$ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"
73cd218f 1749
1750# Set title as "Series name S01E05"
940a67a3 1751$ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
73cd218f 1752
a44ca5a4 1753# Prioritize uploader as the "artist" field in video metadata
2fa669f7 1754$ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --embed-metadata
a44ca5a4 1755
1756# Set "comment" field in video metadata using description instead of webpage_url,
1757# handling multiple lines correctly
2fa669f7 1758$ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --embed-metadata
73cd218f 1759
8aa0e7cd 1760# Do not set any "synopsis" in the video metadata
1761$ yt-dlp --parse-metadata ":(?P<meta_synopsis>)"
1762
0930b11f 1763# Remove "formats" field from the infojson by setting it to an empty string
940a67a3 1764$ yt-dlp --parse-metadata ":(?P<formats>)" -j
0930b11f 1765
e9f4ccd1 1766# Replace all spaces and "_" in title and uploader with a `-`
940a67a3 1767$ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
e9f4ccd1 1768
73cd218f 1769```
1770
5d3a0e79 1771# EXTRACTOR ARGUMENTS
1772
62b58c09 1773Some 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=android_embedded,web;include_live_dash" --extractor-args "funimation:version=uncut"`
5d3a0e79 1774
a5387729 1775Note: In CLI, `ARG` can use `-` instead of `_`; e.g. `youtube:player-client"` becomes `youtube:player_client"`
1776
5d3a0e79 1777The following extractors use this feature:
96565c7e 1778
1779#### youtube
8e174ba7 1780* `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
8aa0e7cd 1781* `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
304ad45a 1782* `player_client`: Clients to extract video data from. The main clients are `web`, `android` and `ios` with variants `_music`, `_embedded`, `_embedscreen`, `_creator` (e.g. `web_embedded`); and `mweb` and `tv_embedded` (agegate bypass) with no variants. By default, `android,web` is used, but `tv_embedded` and `creator` variants are added as required for age-gated videos. Similarly, the music variants are added for `music.youtube.com` urls. You can use `all` to use all the clients, and `default` for the default clients.
96565c7e 1783* `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
96565c7e 1784* `comment_sort`: `top` or `new` (default) - choose comment sorting mode (on YouTube's side)
a44ca5a4 1785* `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`
1786 * 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
86cb9221 1787* `include_duplicate_formats`: Extract formats with identical content but different URLs or protocol. This is useful if some of the formats are unavailable or throttled.
4d37720a 1788* `include_incomplete_formats`: Extract formats that cannot be downloaded completely (live dash and post-live m3u8)
1e4fca9a 1789* `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
2ae778b8 1790* `innertube_key`: Innertube API key to use for all API requests
96565c7e 1791
1792#### youtubetab (YouTube playlists, channels, feeds, etc.)
1793* `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)
5225df50 1794* `approximate_date`: Extract approximate `upload_date` and `timestamp` in flat-playlist. This may cause date-based filters to be slightly off
96565c7e 1795
3b021eac 1796#### generic
5cc0a8fd 1797* `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`. Does not apply to ffmpeg
1798* `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`
c2e0fc40 1799* `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
93e7c699 1800* `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`
3b021eac 1801
96565c7e 1802#### funimation
304ad45a 1803* `language`: Audio languages to extract, e.g. `funimation:language=english,japanese`
96565c7e 1804* `version`: The video version to extract - `uncut` or `simulcast`
1805
cb1553e9 1806#### crunchyrollbeta (Crunchyroll)
62b58c09 1807* `format`: Which stream type(s) to extract (default: `adaptive_hls`). Potentially useful values include `adaptive_hls`, `adaptive_dash`, `vo_adaptive_hls`, `vo_adaptive_dash`, `download_hls`, `download_dash`, `multitrack_adaptive_hls_v2`
dfea94f8 1808* `hardsub`: Preference order for which hardsub versions to extract, or `all` (default: `None` = no hardsubs), e.g. `crunchyrollbeta:hardsub=en-US,None`
706dfe44 1809
96565c7e 1810#### vikichannel
1811* `video_types`: Types of videos to download - one or more of `episodes`, `movies`, `clips`, `trailers`
73d829c1 1812
7bdcb4a4
LNO		 1813#### niconico
1814* `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.**
1815
aa4b0545 1816#### youtubewebarchive
1817* `check_all`: Try to check more at the cost of more requests. One or more of `thumbnails`, `captures`
1818
d43de682
M		 1819#### gamejolt
1820* `comment_sort`: `hot` (default), `you` (cookies needed), `top`, `new` - choose comment sorting mode (on GameJolt's side)
1821
26f2aa3d
AG		 1822#### hotstar
1823* `res`: resolution to ignore - one or more of `sd`, `hd`, `fhd`
1824* `vcodec`: vcodec to ignore - one or more of `h264`, `h265`, `dvh265`
1825* `dr`: dynamic range to ignore - one or more of `sdr`, `hdr10`, `dv`
1826
046cab39 1827#### tiktok
c4cbd3be 1828* `api_hostname`: Hostname to use for mobile API requests, e.g. `api-h2.tiktokv.com`
62b58c09
L		 1829* `app_version`: App version to call mobile APIs with - should be set along with `manifest_app_version`, e.g. `20.2.1`
1830* `manifest_app_version`: Numeric app version to call mobile APIs with, e.g. `221`
046cab39 1831
7eaf7f9a 1832#### rokfinchannel
62b58c09 1833* `tab`: Which tab to download - one of `new`, `top`, `videos`, `podcasts`, `streams`, `stacks`
7eaf7f9a 1834
7a26ce26 1835#### twitter
147e62fc 1836* `legacy_api`: Force usage of the legacy Twitter API instead of the GraphQL API for tweet extraction. Has no effect if login cookies are passed
7eaf7f9a 1837
8e174ba7 1838**Note**: These options may be changed/removed in the future without concern for backward compatibility
5d3a0e79 1839
ec2e44fc 1840<!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
1841
3acf6d38 1842
f74980cb 1843# PLUGINS
b7770046 1844
8e40b9d1 1845Note 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!**
3ae5e797 1846
8e40b9d1
M		 1847Plugins can be of `<type>`s `extractor` or `postprocessor`.
1848- Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it.
1849- Extractor plugins take priority over builtin extractors.
1850- Postprocessor plugins can be invoked using `--use-postprocessor NAME`.
3ae5e797 1851
3ae5e797 1852
8e40b9d1 1853Plugins are loaded from the namespace packages `yt_dlp_plugins.extractor` and `yt_dlp_plugins.postprocessor`.
3ae5e797 1854
8e40b9d1
M		 1855In other words, the file structure on the disk looks something like:
1856
1857 yt_dlp_plugins/
1858 extractor/
1859 myplugin.py
1860 postprocessor/
1861 myplugin.py
1862
1863yt-dlp looks for these `yt_dlp_plugins` namespace folders in many locations (see below) and loads in plugins from **all** of them.
b7770046 1864
deae7c17 1865See the [wiki for some known plugins](https://github.com/yt-dlp/yt-dlp/wiki/Plugins)
1866
8e40b9d1
M		 1867## Installing Plugins
1868
1869Plugins can be installed using various methods and locations.
1870
18711. **Configuration directories**:
1872 Plugin packages (containing a `yt_dlp_plugins` namespace folder) can be dropped into the following standard [configuration locations](#configuration):
1873 * **User Plugins**
1874 * `${XDG_CONFIG_HOME}/yt-dlp/plugins/<package name>/yt_dlp_plugins/` (recommended on Linux/macOS)
1875 * `${XDG_CONFIG_HOME}/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
1876 * `${APPDATA}/yt-dlp/plugins/<package name>/yt_dlp_plugins/` (recommended on Windows)
773c272d 1877 * `${APPDATA}/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
8e40b9d1
M		 1878 * `~/.yt-dlp/plugins/<package name>/yt_dlp_plugins/`
1879 * `~/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
1880 * **System Plugins**
1881 * `/etc/yt-dlp/plugins/<package name>/yt_dlp_plugins/`
1882 * `/etc/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
18832. **Executable location**: Plugin packages can similarly be installed in a `yt-dlp-plugins` directory under the executable location:
1884 * Binary: where `<root-dir>/yt-dlp.exe`, `<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
1885 * Source: where `<root-dir>/yt_dlp/__main__.py`, `<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/`
1886
18873. **pip and other locations in `PYTHONPATH`**
e756f45b 1888 * 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.
8e174ba7 1889 * Note: plugin files between plugin packages installed with pip must have unique filenames.
8e40b9d1
M		 1890 * Any path in `PYTHONPATH` is searched in for the `yt_dlp_plugins` namespace folder.
1891 * Note: This does not apply for Pyinstaller/py2exe builds.
1892
1893
8e174ba7 1894`.zip`, `.egg` and `.whl` archives containing a `yt_dlp_plugins` namespace folder in their root are also supported as plugin packages.
1895* e.g. `${XDG_CONFIG_HOME}/yt-dlp/plugins/mypluginpkg.zip` where `mypluginpkg.zip` contains `yt_dlp_plugins/<type>/myplugin.py`
8e40b9d1 1896
8e174ba7 1897Run yt-dlp with `--verbose` to check if the plugin has been loaded.
8e40b9d1
M		 1898
1899## Developing Plugins
1900
8e174ba7 1901See 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.
8e40b9d1 1902
8e174ba7 1903All public classes with a name ending in `IE`/`PP` are imported from each file for extractors and postprocessors repectively. 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`).
e756f45b 1904
773c272d 1905To 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.
8e40b9d1 1906
8e174ba7 1907If you are a plugin author, add [yt-dlp-plugins](https://github.com/topics/yt-dlp-plugins) as a topic to your repository for discoverability.
b7770046 1908
8e40b9d1 1909See the [Developer Instructions](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions) on how to write and test an extractor.
8c6f4daa 1910
1911# EMBEDDING YT-DLP
1912
1913yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1914
1915Your 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.
1916
1917From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1918
1919```python
59a7a13e 1920from yt_dlp import YoutubeDL
8c6f4daa 1921
3d3bb168 1922URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1923with YoutubeDL() as ydl:
1924 ydl.download(URLS)
8c6f4daa 1925```
1926
a5387729 1927Most 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#L184).
8c6f4daa 1928
43cc91ad 1929**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)
3d3bb168 1930
1931## Embedding examples
1932
43cc91ad 1933#### Extracting information
8c6f4daa 1934
1935```python
1936import json
8c6f4daa 1937import yt_dlp
8c6f4daa 1938
3d3bb168 1939URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'
1940
1941# ℹ️ See help(yt_dlp.YoutubeDL) for a list of available options and public functions
1942ydl_opts = {}
1943with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1944 info = ydl.extract_info(URL, download=False)
1945
1946 # ℹ️ ydl.sanitize_info makes the info json-serializable
1947 print(json.dumps(ydl.sanitize_info(info)))
1948```
43cc91ad 1949#### Download using an info-json
3d3bb168 1950
1951```python
1952import yt_dlp
1953
1954INFO_FILE = 'path/to/video.info.json'
1955
1956with yt_dlp.YoutubeDL() as ydl:
1957 error_code = ydl.download_with_info_file(INFO_FILE)
1958
1959print('Some videos failed to download' if error_code
1960 else 'All videos successfully downloaded')
1961```
1962
43cc91ad 1963#### Extract audio
3d3bb168 1964
1965```python
1966import yt_dlp
1967
1968URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1969
1970ydl_opts = {
0a41f331 1971 'format': 'm4a/bestaudio/best',
3d3bb168 1972 # ℹ️ See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
1973 'postprocessors': [{ # Extract audio using ffmpeg
1974 'key': 'FFmpegExtractAudio',
1975 'preferredcodec': 'm4a',
1976 }]
1977}
1978
1979with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1980 error_code = ydl.download(URLS)
1981```
0a41f331 1982
1983#### Filter videos
1984
1985```python
1986import yt_dlp
1987
1988URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1989
1990def longer_than_a_minute(info, *, incomplete):
1991 """Download only videos longer than a minute (or with unknown duration)"""
1992 duration = info.get('duration')
1993 if duration and duration < 60:
1994 return 'The video is too short'
1995
1996ydl_opts = {
1997 'match_filter': longer_than_a_minute,
1998}
1999
2000with yt_dlp.YoutubeDL(ydl_opts) as ydl:
2001 error_code = ydl.download(URLS)
2002```
2003
43cc91ad 2004#### Adding logger and progress hook
3d3bb168 2005
2006```python
2007import yt_dlp
2008
2009URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
8c6f4daa 2010
2011class MyLogger:
2012 def debug(self, msg):
e75bb0d6 2013 # For compatibility with youtube-dl, both debug and info are passed into debug
8c6f4daa 2014 # You can distinguish them by the prefix '[debug] '
2015 if msg.startswith('[debug] '):
2016 pass
2017 else:
2018 self.info(msg)
2019
2020 def info(self, msg):
2021 pass
2022
2023 def warning(self, msg):
2024 pass
2025
2026 def error(self, msg):
2027 print(msg)
2028
2029
3d3bb168 2030# ℹ️ See "progress_hooks" in help(yt_dlp.YoutubeDL)
2031def my_hook(d):
2032 if d['status'] == 'finished':
2033 print('Done downloading, now post-processing ...')
2034
2035
2036ydl_opts = {
2037 'logger': MyLogger(),
2038 'progress_hooks': [my_hook],
2039}
2040
2041with yt_dlp.YoutubeDL(ydl_opts) as ydl:
2042 ydl.download(URLS)
2043```
2044
43cc91ad 2045#### Add a custom PostProcessor
3d3bb168 2046
2047```python
2048import yt_dlp
2049
2050URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2051
2052# ℹ️ See help(yt_dlp.postprocessor.PostProcessor)
59a7a13e 2053class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
8c6f4daa 2054 def run(self, info):
2055 self.to_screen('Doing stuff')
2056 return [], info
2057
2058
3d3bb168 2059with yt_dlp.YoutubeDL() as ydl:
8aa0e7cd 2060 # ℹ️ "when" can take any value in yt_dlp.utils.POSTPROCESS_WHEN
2061 ydl.add_post_processor(MyCustomPP(), when='pre_process')
3d3bb168 2062 ydl.download(URLS)
2063```
8c6f4daa 2064
2065
43cc91ad 2066#### Use a custom format selector
3d3bb168 2067
2068```python
2069import yt_dlp
2070
2071URL = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2072
093a1710 2073def format_selector(ctx):
2074 """ Select the best video and the best audio that won't result in an mkv.
3d3bb168 2075 NOTE: This is just an example and does not handle all cases """
093a1710 2076
2077 # formats are already sorted worst to best
2078 formats = ctx.get('formats')[::-1]
2079
2080 # acodec='none' means there is no audio
2081 best_video = next(f for f in formats
2082 if f['vcodec'] != 'none' and f['acodec'] == 'none')
2083
2084 # find compatible audio extension
2085 audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
2086 # vcodec='none' means there is no video
2087 best_audio = next(f for f in formats if (
2088 f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
2089
3d3bb168 2090 # These are the minimum required fields for a merged format
093a1710 2091 yield {
093a1710 2092 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
2093 'ext': best_video['ext'],
2094 'requested_formats': [best_video, best_audio],
e75bb0d6 2095 # Must be + separated list of protocols
093a1710 2096 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
2097 }
2098
2099
8c6f4daa 2100ydl_opts = {
093a1710 2101 'format': format_selector,
8c6f4daa 2102}
2103
2104with yt_dlp.YoutubeDL(ydl_opts) as ydl:
3d3bb168 2105 ydl.download(URLS)
8c6f4daa 2106```
2107
ec2e44fc 2108<!-- MANPAGE: MOVE "NEW FEATURES" SECTION HERE -->
2109
e167860c 2110# DEPRECATED OPTIONS
2111
2112These are all the deprecated options and the current alternative to achieve the same effect
2113
8130779d 2114#### Almost redundant options
2115While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant
2116
2117 -j, --dump-json --print "%()j"
2118 -F, --list-formats --print formats_table
0bfc53d0 2119 --list-thumbnails --print thumbnails_table --print playlist:thumbnails_table
8130779d 2120 --list-subs --print automatic_captions_table --print subtitles_table
2121
6ccf351a 2122#### Redundant options
2123While these options are redundant, they are still expected to be used due to their ease of use
f4536226 2124
53c18592 2125 --get-description --print description
2126 --get-duration --print duration_string
2127 --get-filename --print filename
2128 --get-format --print format
2129 --get-id --print id
2130 --get-thumbnail --print thumbnail
2131 -e, --get-title --print title
2132 -g, --get-url --print urls
8f18aca8 2133 --match-title REGEX --match-filter "title ~= (?i)REGEX"
2134 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
2135 --min-views COUNT --match-filter "view_count >=? COUNT"
2136 --max-views COUNT --match-filter "view_count <=? COUNT"
fe2ce85a 2137 --break-on-reject Use --break-match-filter
8b7539d2 2138 --user-agent UA --add-header "User-Agent:UA"
2139 --referer URL --add-header "Referer:URL"
7e88d7d7 2140 --playlist-start NUMBER -I NUMBER:
2141 --playlist-end NUMBER -I :NUMBER
2142 --playlist-reverse -I ::-1
2143 --no-playlist-reverse Default
6ccf351a 2144
2145
2146#### Not recommended
2147While these options still work, their use is not recommended since there are other alternatives to achieve the same
2148
fe7866d0 2149 --force-generic-extractor --ies generic,default
1e43a6f7 2150 --exec-before-download CMD --exec "before_dl:CMD"
2151 --no-exec-before-download --no-exec
d9aa2332 2152 --all-formats -f all
c32b0aab 2153 --all-subs --sub-langs all --write-subs
b7b04c78 2154 --print-json -j --no-simulate
62b58c09 2155 --autonumber-size NUMBER Use string formatting, e.g. %(autonumber)03d
a439a3a4 2156 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
19b824f6 2157 --id -o "%(id)s.%(ext)s"
73cd218f 2158 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
52a8a1e1 2159 --hls-prefer-native --downloader "m3u8:native"
2160 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
53ed7066 2161 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
2162 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
5d3a0e79 2163 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
2164 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
2165 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
2166 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
c1664464 2167 --geo-bypass --xff "default"
2168 --no-geo-bypass --xff "never"
2169 --geo-bypass-country CODE --xff CODE
2170 --geo-bypass-ip-block IP_BLOCK --xff IP_BLOCK
6ccf351a 2171
2172
2173#### Developer options
2174These options are not intended to be used by the end-user
2175
34488702 2176 --test Download only part of video for testing extractors
f95b9dee 2177 --load-pages Load pages dumped by --write-pages
6ccf351a 2178 --youtube-print-sig-code For testing youtube signatures
88acdbc2 2179 --allow-unplayable-formats List unplayable formats also
2180 --no-allow-unplayable-formats Default
f4536226 2181
2182
2183#### Old aliases
2184These are aliases that are no longer documented for various reasons
2185
2186 --avconv-location --ffmpeg-location
3856407a 2187 --clean-infojson --clean-info-json
f4536226 2188 --cn-verification-proxy URL --geo-verification-proxy URL
2189 --dump-headers --print-traffic
2190 --dump-intermediate-pages --dump-pages
2191 --force-write-download-archive --force-write-archive
2192 --load-info --load-info-json
3856407a 2193 --no-clean-infojson --no-clean-info-json
f4536226 2194 --no-split-tracks --no-split-chapters
e167860c 2195 --no-write-srt --no-write-subs
e167860c 2196 --prefer-unsecure --prefer-insecure
2197 --rate-limit RATE --limit-rate RATE
f4536226 2198 --split-tracks --split-chapters
2199 --srt-lang LANGS --sub-langs LANGS
e167860c 2200 --trim-file-names LENGTH --trim-filenames LENGTH
f4536226 2201 --write-srt --write-subs
e167860c 2202 --yes-overwrites --force-overwrites
f4536226 2203
7a340e0d 2204#### Sponskrub Options
f304da8a 2205Support for [SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of the `--sponsorblock` options
7a340e0d
NA		 2206
2207 --sponskrub --sponsorblock-mark all
2208 --no-sponskrub --no-sponsorblock
2209 --sponskrub-cut --sponsorblock-remove all
2210 --no-sponskrub-cut --sponsorblock-remove -all
2211 --sponskrub-force Not applicable
2212 --no-sponskrub-force Not applicable
2213 --sponskrub-location Not applicable
2214 --sponskrub-args Not applicable
2215
f4536226 2216#### No longer supported
2217These options may no longer work as intended
2218
2219 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
2220 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
2221 -C, --call-home Not implemented
2222 --no-call-home Default
2223 --include-ads No longer supported
2224 --no-include-ads Default
0bb1bc1b 2225 --write-annotations No supported site has annotations now
2226 --no-write-annotations Default
1e8fe57e 2227 --compat-options seperate-video-versions No longer needed
486fb179 2228
2229#### Removed
2230These options were deprecated since 2014 and have now been entirely removed
2231
f4536226 2232 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
3d3bb168 2233 -t, -l, --title, --literal -o "%(title)s-%(id)s.%(ext)s"
f4536226 2234
8c6f4daa 2235# CONTRIBUTING
2236See [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)
e167860c 2237
17ffed18 2238# WIKI
2239See the [Wiki](https://github.com/yt-dlp/yt-dlp/wiki) for more information
fork of https://github.com/yt-dlp/yt-dlp/