]> jfr.im git - yt-dlp.git/blob - README.md
18cf3f8fe1bef6836bf4488ae257cfe9ce9584c4
[yt-dlp.git] / README.md
1 <div align="center">
2
3 [![YT-DLP](https://raw.githubusercontent.com/yt-dlp/yt-dlp/master/.github/banner.svg)](#readme)
4
5 [![Release version](https://img.shields.io/github/v/release/yt-dlp/yt-dlp?color=blue&label=&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/releases/latest)
6 [![CI Status](https://img.shields.io/github/workflow/status/yt-dlp/yt-dlp/Core%20Tests/master?label=&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/actions)
7 [![License: Unlicense](https://img.shields.io/badge/-Unlicense-blue.svg?style=for-the-badge)](LICENSE)
8 [![Donate](https://img.shields.io/badge/_-Donate-red.svg?logo=githubsponsors&labelColor=555555&style=for-the-badge)](Collaborators.md#collaborators)
9 [![Supported Sites](https://img.shields.io/badge/-Supported_Sites-brightgreen.svg?style=for-the-badge)](supportedsites.md)
10 [![Discord](https://img.shields.io/discord/807245652072857610?color=blue&label=​&logo=discord&style=for-the-badge)](https://discord.gg/H5MNcFW63r)
11 [![Doc Status](https://readthedocs.org/projects/yt-dlp/badge/?version=latest&style=for-the-badge)](https://yt-dlp.readthedocs.io)
12 [![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)
13 [![Last Commit](https://img.shields.io/github/last-commit/yt-dlp/yt-dlp/master?label=&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/commits)
14 [![Downloads](https://img.shields.io/github/downloads/yt-dlp/yt-dlp/total?style=for-the-badge&color=blue)](https://github.com/yt-dlp/yt-dlp/releases/latest)
15 [![PyPi Downloads](https://img.shields.io/pypi/dm/yt-dlp?label=PyPi&style=for-the-badge)](https://pypi.org/project/yt-dlp)
16
17 </div>
18
19 yt-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
20
21 * [NEW FEATURES](#new-features)
22 * [Differences in default behavior](#differences-in-default-behavior)
23 * [INSTALLATION](#installation)
24 * [Update](#update)
25 * [Release Files](#release-files)
26 * [Dependencies](#dependencies)
27 * [Compile](#compile)
28 * [USAGE AND OPTIONS](#usage-and-options)
29 * [General Options](#general-options)
30 * [Network Options](#network-options)
31 * [Geo-restriction](#geo-restriction)
32 * [Video Selection](#video-selection)
33 * [Download Options](#download-options)
34 * [Filesystem Options](#filesystem-options)
35 * [Thumbnail Options](#thumbnail-options)
36 * [Internet Shortcut Options](#internet-shortcut-options)
37 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
38 * [Workarounds](#workarounds)
39 * [Video Format Options](#video-format-options)
40 * [Subtitle Options](#subtitle-options)
41 * [Authentication Options](#authentication-options)
42 * [Post-processing Options](#post-processing-options)
43 * [SponsorBlock Options](#sponsorblock-options)
44 * [Extractor Options](#extractor-options)
45 * [CONFIGURATION](#configuration)
46 * [Authentication with .netrc file](#authentication-with-netrc-file)
47 * [OUTPUT TEMPLATE](#output-template)
48 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
49 * [Output template examples](#output-template-examples)
50 * [FORMAT SELECTION](#format-selection)
51 * [Filtering Formats](#filtering-formats)
52 * [Sorting Formats](#sorting-formats)
53 * [Format Selection examples](#format-selection-examples)
54 * [MODIFYING METADATA](#modifying-metadata)
55 * [Modifying metadata examples](#modifying-metadata-examples)
56 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
57 * [PLUGINS](#plugins)
58 * [EMBEDDING YT-DLP](#embedding-yt-dlp)
59 * [DEPRECATED OPTIONS](#deprecated-options)
60 * [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
61 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
62 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
63 * [MORE](#more)
64
65
66 # NEW FEATURES
67 The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are:
68
69 * **[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
70
71 * **[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))
72
73 * **Merged with youtube-dl [commit/379f52a](https://github.com/ytdl-org/youtube-dl/commit/379f52a4954013767219d25099cce9e0f9401961)**: (v2021.06.06) You get all the latest features and patches of [youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of [youtube-dlc](https://github.com/blackjack4494/yt-dlc)
74
75 * **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 the NicoNico improvements are not available. See [#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details.
76
77 * **Youtube improvements**:
78 * All Feeds (`:ytfav`, `:ytwatchlater`, `:ytsubs`, `:ythistory`, `:ytrec`) and private playlists supports downloading multiple pages of content
79 * Search (`ytsearch:`, `ytsearchdate:`), search URLs and in-channel search works
80 * Mixes supports downloading multiple pages of content
81 * Some (but not all) age-gated content can be downloaded without cookies
82 * Fix for [n-sig based throttling](https://github.com/ytdl-org/youtube-dl/issues/29326)
83 * Redirect channel's home URL automatically to `/video` to preserve the old behaviour
84 * `255kbps` audio is extracted (if available) from youtube music when premium cookies are given
85 * Youtube music Albums, channels etc can be downloaded ([except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723))
86
87 * **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using `--cookies-from-browser BROWSER[:PROFILE]`
88
89 * **Split video by chapters**: Videos can be split into multiple files based on chapters using `--split-chapters`
90
91 * **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
92
93 * **Aria2c with HLS/DASH**: You can use `aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
94
95 * **New extractors**: 17live, 3speak, amazonstore, animelab, audius, bandcampmusic, bannedvideo, biliintl, bitwave.tv, blackboardcollaborate, cam4, cgtn, chingari, ciscowebex, damtomo, discoveryplus.in, douyin, epicon, euscreen, fancode, filmmodu, gab, gedi, gettr, gopro, gotostage, gronkh, koo, manototv, mediaite, mediaklikk, mediasetshow, mediathek, microsoftstream, mildom, mirrativ, mlsscoccer, mtv.it, musescore, mxplayershow, n1, nebula, nfhsnetwork, novaplay, nzherald, olympics replay, on24, openrec, parlview-AU, peloton, planetmarathi, pluto.tv, polsatgo, polskieradio, pornflip, projectveritas, radiko, radiokapital, radlive, raiplayradio, rcs, rctiplus, saitosan, sciencechannel, shemaroome, skynews-AU, skynews-story, sovietscloset, startv, streamanity, telemundo, theta, theta, tokentube, tv2huseries, ukcolumn, utreon, veo, vidiolive, vidiopremier, voicy, vupload, whowatch, wim.tv, wppilot, youtube webarchive, zee5, zen.yandex
96
97 * **New playlist extractors**: bilibili categories, eroprofile albums, hotstar series, hungama albums, newgrounds user, niconico search/users, paramountplus series, patreon user, peertube playlist/channels, roosterteeth series, sonyliv series, tiktok user, trovo channels, voot series
98
99 * **Fixed/improved extractors**: 7plus, 9now, afreecatv, akamai, aljazeera, amcnetworks, animalplanet, archive.org, arte, atv, bbc, bilibili, bitchute, bravotv, camtube, cbc, cda, ceskatelevize, chingari, comedycentral, coub, crackle, crunchyroll, curiositystream, diynetwork, dw, eroprofile, facebook, francetv, funimation, globo, hearthisatie, hidive, hotstar, hungama, imdb, ina, instagram, iprima, itv, iwara, kakao, la7, linkedinlearning, linuxacadamy, mediaset, mediasite, motherless, mxplayer, nbcolympics, ndr, newgrounds, niconico, nitter, nova, nrk, nuvid, oreilly, paramountplus, parliamentlive, patreon, pbs, peertube, plutotv, polskieradio, pornhub, reddit, redtube, rmcdecouverte, roosterteeth, rtp, rumble, saml verizon login, skyit, sonyliv, soundcloud, southparkde, spankbang, spreaker, streamable, tagesschau, tbs, tennistv, tenplay, tiktok, tubi, tv2, tv2hu, tv5mondeplus, tvp, twitcasting, vh1, viafree, videa, vidio, vidme, viewlift, viki, vimeo, viu, vk, vlive, vrt, wakanim, xhamster, yahoo
100
101 * **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN
102
103 * **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
104
105 * **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`)
106
107 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
108
109 * **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`
110
111 * **Other new options**: `--print`, `--sleep-requests`, `--convert-thumbnails`, `--write-link`, `--force-download-archive`, `--force-overwrites`, `--break-on-reject` etc
112
113 * **Improvements**: Regex and other operators in `--match-filter`, multiple `--postprocessor-args` and `--downloader-args`, faster archive checking, more [format selection options](#format-selection) etc
114
115 * **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins](#plugins) for details
116
117 * **Self-updater**: The releases can be updated using `yt-dlp -U`
118
119
120 See [changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
121
122
123 **PS**: Some of these changes are already in youtube-dlc, but are still unreleased. See [this](Changelog.md#unreleased-changes-in-blackjack4494yt-dlc) for details
124
125 If you are coming from [youtube-dl](https://github.com/ytdl-org/youtube-dl), the amount of changes are very large. Compare [options](#options) and [supported sites](supportedsites.md) with youtube-dl's to get an idea of the massive number of features/patches [youtube-dlc](https://github.com/blackjack4494/yt-dlc) has accumulated.
126
127 ### Differences in default behavior
128
129 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
130
131 * The options `--auto-number` (`-A`), `--title` (`-t`) and `--literal` (`-l`), no longer work. See [removed options](#Removed) for details
132 * `avconv` is not supported as as an alternative to `ffmpeg`
133 * 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`
134 * 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
135 * 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 prefered. Use `-f bv+ba/b` or `--compat-options format-spec` to revert this
136 * 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
137 * `--ignore-errors` is enabled by default. Use `--abort-on-error` or `--compat-options abort-on-error` to abort on errors instead
138 * 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
139 * `--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
140 * 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`](https://github.com/yt-dlp/yt-dlp#modifying-metadata) to modify this to your liking or use `--compat-options embed-metadata` to revert this
141 * `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
142 * The output of `-F` is listed in a new format. Use `--compat-options list-formats` to revert this
143 * All *experiences* of a funimation episode are considered as a single video. This behavior breaks existing archives. Use `--compat-options seperate-video-versions` to extract information from only the default player
144 * Youtube live chat (if available) is considered as a subtitle. Use `--sub-langs all,-live_chat` to download all subtitles except live chat. You can also use `--compat-options no-live-chat` to prevent live chat from downloading
145 * Youtube channel URLs are automatically redirected to `/video`. Append a `/featured` to the URL to download only the videos in the home page. If the channel does not have a videos tab, we try to download the equivalent `UU` playlist instead. 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
146 * Unavailable videos are also listed for youtube playlists. Use `--compat-options no-youtube-unavailable-videos` to remove this
147 * 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
148 * Thumbnail embedding in `mp4` is done with mutagen if possible. Use `--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
149 * 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
150 * 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 seperate 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
151
152 For ease of use, a few more compat options are available:
153 * `--compat-options all`: Use all compat options
154 * `--compat-options youtube-dl`: Same as `--compat-options all,-multistreams`
155 * `--compat-options youtube-dlc`: Same as `--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
156
157
158 # INSTALLATION
159
160 You can install yt-dlp using one of the following methods:
161
162 ### Using the release binary
163
164 You can simply download the [correct binary file](#release-files) for your OS: **[[Windows](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)] [[UNIX-like](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)]**
165
166 In UNIX-like OSes (MacOS, Linux, BSD), you can also install the same in one of the following ways:
167
168 ```
169 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
170 sudo chmod a+rx /usr/local/bin/yt-dlp
171 ```
172
173 ```
174 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
175 sudo chmod a+rx /usr/local/bin/yt-dlp
176 ```
177
178 ```
179 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
180 sudo chmod a+rx /usr/local/bin/yt-dlp
181 ```
182
183 PS: The manpages, shell completion files etc. are available in [yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
184
185 ### With [PIP](https://pypi.org/project/pip)
186
187 You can install the [PyPI package](https://pypi.org/project/yt-dlp) with:
188 ```
189 python3 -m pip install -U yt-dlp
190 ```
191
192 You can install without any of the optional dependencies using:
193 ```
194 python3 -m pip install --no-deps -U yt-dlp
195 ```
196
197 If you want to be on the cutting edge, you can also install the master branch with:
198 ```
199 python3 -m pip install --force-reinstall https://github.com/yt-dlp/yt-dlp/archive/master.zip
200 ```
201
202 Note that on some systems, you may need to use `py` or `python` instead of `python3`
203
204 ### With [Homebrew](https://brew.sh)
205
206 macOS or Linux users that are using Homebrew can also install it by:
207
208 ```
209 brew install yt-dlp/taps/yt-dlp
210 ```
211
212 ## UPDATE
213 You can use `yt-dlp -U` to update if you are [using the provided release](#using-the-release-binary)
214
215 If you [installed with pip](#with-pip), simply re-run the same command that was used to install the program
216
217 If you [installed using Homebrew](#with-homebrew), run `brew upgrade yt-dlp/taps/yt-dlp`
218
219 ## RELEASE FILES
220
221 #### Recommended
222
223 File|Description
224 :---|:---
225 [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform-independant binary. Needs Python (recommended for **UNIX-like systems**)
226 [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**)
227
228 #### Alternatives
229
230 File|Description
231 :---|:---
232 [yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|MacOS (10.15+) standalone executable
233 [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
234 [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/> Does not contain `pycryptodomex`, needs VC++14
235 [yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged Windows executable (no auto-update)
236 [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)
237
238 #### Misc
239
240 File|Description
241 :---|:---
242 [yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)|Source tarball. Also contains manpages, completions, etc
243 [SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
244 [SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
245
246 ## DEPENDENCIES
247 Python versions 3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
248
249 <!-- Python 3.5+ uses VC++14 and it is already embedded in the binary created
250 <!x-- https://www.microsoft.com/en-us/download/details.aspx?id=26999 --x>
251 On windows, [Microsoft Visual C++ 2010 SP1 Redistributable Package (x86)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe) is also necessary to run yt-dlp. You probably already have this, but if the executable throws an error due to missing `MSVCR100.dll` you need to install it manually.
252 -->
253
254 While all the other dependancies are optional, `ffmpeg` and `ffprobe` are highly recommended
255 * [**ffmpeg** and **ffprobe**](https://www.ffmpeg.org) - Required for [merging seperate video and audio files](#format-selection) as well as for various [post-processing](#post-processing-options) tasks. Licence [depends on the build](https://www.ffmpeg.org/legal.html)
256 * [**mutagen**](https://github.com/quodlibet/mutagen) - For embedding thumbnail in certain formats. Licensed under [GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
257 * [**pycryptodomex**](https://github.com/Legrandin/pycryptodome) - For decrypting AES-128 HLS streams and various other data. Licensed under [BSD2](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
258 * [**websockets**](https://github.com/aaugustin/websockets) - For downloading over websocket. Licensed under [BSD3](https://github.com/aaugustin/websockets/blob/main/LICENSE)
259 * [**keyring**](https://github.com/jaraco/keyring) - For decrypting cookies of chromium-based browsers on Linux. Licensed under [MIT](https://github.com/jaraco/keyring/blob/main/LICENSE)
260 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For embedding thumbnail in mp4/m4a if mutagen is not present. Licensed under [GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
261 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading `rtmp` streams. ffmpeg will be used as a fallback. Licensed under [GPLv2+](http://rtmpdump.mplayerhq.hu)
262 * [**mplayer**](http://mplayerhq.hu/design7/info.html) or [**mpv**](https://mpv.io) - For downloading `rstp` streams. ffmpeg will be used as a fallback. Licensed under [GPLv2+](https://github.com/mpv-player/mpv/blob/master/Copyright)
263 * [**phantomjs**](https://github.com/ariya/phantomjs) - Used in extractors where javascript needs to be run. Licensed under [BSD3](https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD)
264 * [**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)
265 * Any external downloader that you want to use with `--downloader`
266
267 To use or redistribute the dependencies, you must agree to their respective licensing terms.
268
269 The Windows and MacOS standalone release binaries are already built with the python interpreter, mutagen, pycryptodomex and websockets included.
270
271 **Note**: There are some regressions in newer ffmpeg versions that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependancy, we provide [custom builds](https://github.com/yt-dlp/FFmpeg-Builds/wiki/Latest#latest-autobuilds) with patches for 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 specifc issues solved by these builds
272
273
274 ## COMPILE
275
276 **For Windows**:
277 To build the Windows executable, you must have pyinstaller (and optionally mutagen, pycryptodomex, websockets). Once you have all the necessary dependencies installed, (optionally) build lazy extractors using `devscripts/make_lazy_extractors.py`, and then just run `pyinst.py`. The executable will be built for the same architecture (32/64 bit) as the python used to build it.
278
279 py -m pip install -U pyinstaller -r requirements.txt
280 py devscripts/make_lazy_extractors.py
281 py pyinst.py
282
283 Note that pyinstaller [does not support](https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms) Python installed from the Windows store without using a virtual environment
284
285 **For Unix**:
286 You will need the required build tools: `python`, `make` (GNU), `pandoc`, `zip`, `pytest`
287 Then simply run `make`. You can also run `make yt-dlp` instead to compile only the binary without updating any of the additional files
288
289 **Note**: In either platform, `devscripts/update-version.py` can be used to automatically update the version number
290
291 You can also fork the project on github and run your fork's [build workflow](.github/workflows/build.yml) to automatically build a release
292
293 # USAGE AND OPTIONS
294
295 yt-dlp [OPTIONS] [--] URL [URL...]
296
297 `Ctrl+F` is your friend :D
298 <!-- Auto generated -->
299
300 ## General Options:
301 -h, --help Print this help text and exit
302 --version Print program version and exit
303 -U, --update Update this program to latest version. Make
304 sure that you have sufficient permissions
305 (run with sudo if needed)
306 -i, --ignore-errors Ignore download and postprocessing errors.
307 The download will be considered successful
308 even if the postprocessing fails
309 --no-abort-on-error Continue with next video on download
310 errors; e.g. to skip unavailable videos in
311 a playlist (default)
312 --abort-on-error Abort downloading of further videos if an
313 error occurs (Alias: --no-ignore-errors)
314 --dump-user-agent Display the current user-agent and exit
315 --list-extractors List all supported extractors and exit
316 --extractor-descriptions Output descriptions of all supported
317 extractors and exit
318 --force-generic-extractor Force extraction to use the generic
319 extractor
320 --default-search PREFIX Use this prefix for unqualified URLs. For
321 example "gvsearch2:" downloads two videos
322 from google videos for the search term
323 "large apple". Use the value "auto" to let
324 yt-dlp guess ("auto_warning" to emit a
325 warning when guessing). "error" just throws
326 an error. The default value "fixup_error"
327 repairs broken URLs, but emits an error if
328 this is not possible instead of searching
329 --ignore-config, --no-config Disable loading any configuration files
330 except the one provided by --config-location.
331 When given inside a configuration
332 file, no further configuration files are
333 loaded. Additionally, (for backward
334 compatibility) if this option is found
335 inside the system configuration file, the
336 user configuration is not loaded
337 --config-location PATH Location of the main configuration file;
338 either the path to the config or its
339 containing directory
340 --flat-playlist Do not extract the videos of a playlist,
341 only list them
342 --no-flat-playlist Extract the videos of a playlist
343 --mark-watched Mark videos watched (even with --simulate).
344 Currently only supported for YouTube
345 --no-mark-watched Do not mark videos watched (default)
346 --no-colors Do not emit color codes in output
347 --compat-options OPTS Options that can help keep compatibility
348 with youtube-dl or youtube-dlc
349 configurations by reverting some of the
350 changes made in yt-dlp. See "Differences in
351 default behavior" for details
352
353 ## Network Options:
354 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
355 To enable SOCKS proxy, specify a proper
356 scheme. For example
357 socks5://127.0.0.1:1080/. Pass in an empty
358 string (--proxy "") for direct connection
359 --socket-timeout SECONDS Time to wait before giving up, in seconds
360 --source-address IP Client-side IP address to bind to
361 -4, --force-ipv4 Make all connections via IPv4
362 -6, --force-ipv6 Make all connections via IPv6
363
364 ## Geo-restriction:
365 --geo-verification-proxy URL Use this proxy to verify the IP address for
366 some geo-restricted sites. The default
367 proxy specified by --proxy (or none, if the
368 option is not present) is used for the
369 actual downloading
370 --geo-bypass Bypass geographic restriction via faking
371 X-Forwarded-For HTTP header
372 --no-geo-bypass Do not bypass geographic restriction via
373 faking X-Forwarded-For HTTP header
374 --geo-bypass-country CODE Force bypass geographic restriction with
375 explicitly provided two-letter ISO 3166-2
376 country code
377 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
378 explicitly provided IP block in CIDR
379 notation
380
381 ## Video Selection:
382 --playlist-start NUMBER Playlist video to start at (default is 1)
383 --playlist-end NUMBER Playlist video to end at (default is last)
384 --playlist-items ITEM_SPEC Playlist video items to download. Specify
385 indices of the videos in the playlist
386 separated by commas like: "--playlist-items
387 1,2,5,8" if you want to download videos
388 indexed 1, 2, 5, 8 in the playlist. You can
389 specify range: "--playlist-items
390 1-3,7,10-13", it will download the videos
391 at index 1, 2, 3, 7, 10, 11, 12 and 13
392 --max-downloads NUMBER Abort after downloading NUMBER files
393 --min-filesize SIZE Do not download any videos smaller than
394 SIZE (e.g. 50k or 44.6m)
395 --max-filesize SIZE Do not download any videos larger than SIZE
396 (e.g. 50k or 44.6m)
397 --date DATE Download only videos uploaded on this date.
398 The date can be "YYYYMMDD" or in the format
399 "(now|today)[+-][0-9](day|week|month|year)(s)?"
400 --datebefore DATE Download only videos uploaded on or before
401 this date. The date formats accepted is the
402 same as --date
403 --dateafter DATE Download only videos uploaded on or after
404 this date. The date formats accepted is the
405 same as --date
406 --match-filter FILTER Generic video filter. Any field (see
407 "OUTPUT TEMPLATE") can be compared with a
408 number or a string using the operators
409 defined in "Filtering formats". You can
410 also simply specify a field to match if the
411 field is present and "!field" to check if
412 the field is not present. In addition,
413 Python style regular expression matching
414 can be done using "~=", and multiple
415 filters can be checked with "&". Use a "\"
416 to escape "&" or quotes if needed. Eg:
417 --match-filter "!is_live & like_count>?100
418 & description~='(?i)\bcats \& dogs\b'"
419 matches only videos that are not live, has
420 a like count more than 100 (or the like
421 field is not available), and also has a
422 description that contains the phrase "cats
423 & dogs" (ignoring case)
424 --no-match-filter Do not use generic video filter (default)
425 --no-playlist Download only the video, if the URL refers
426 to a video and a playlist
427 --yes-playlist Download the playlist, if the URL refers to
428 a video and a playlist
429 --age-limit YEARS Download only videos suitable for the given
430 age
431 --download-archive FILE Download only videos not listed in the
432 archive file. Record the IDs of all
433 downloaded videos in it
434 --break-on-existing Stop the download process when encountering
435 a file that is in the archive
436 --break-on-reject Stop the download process when encountering
437 a file that has been filtered out
438 --skip-playlist-after-errors N Number of allowed failures until the rest
439 of the playlist is skipped
440 --no-download-archive Do not use archive file (default)
441
442 ## Download Options:
443 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
444 video that should be download concurrently
445 (default is 1)
446 -r, --limit-rate RATE Maximum download rate in bytes per second
447 (e.g. 50K or 4.2M)
448 --throttled-rate RATE Minimum download rate in bytes per second
449 below which throttling is assumed and the
450 video data is re-extracted (e.g. 100K)
451 -R, --retries RETRIES Number of retries (default is 10), or
452 "infinite"
453 --fragment-retries RETRIES Number of retries for a fragment (default
454 is 10), or "infinite" (DASH, hlsnative and
455 ISM)
456 --skip-unavailable-fragments Skip unavailable fragments for DASH,
457 hlsnative and ISM (default)
458 (Alias: --no-abort-on-unavailable-fragment)
459 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
460 (Alias: --no-skip-unavailable-fragments)
461 --keep-fragments Keep downloaded fragments on disk after
462 downloading is finished
463 --no-keep-fragments Delete downloaded fragments after
464 downloading is finished (default)
465 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
466 (default is 1024)
467 --resize-buffer The buffer size is automatically resized
468 from an initial value of --buffer-size
469 (default)
470 --no-resize-buffer Do not automatically adjust the buffer size
471 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
472 downloading (e.g. 10485760 or 10M) (default
473 is disabled). May be useful for bypassing
474 bandwidth throttling imposed by a webserver
475 (experimental)
476 --playlist-reverse Download playlist videos in reverse order
477 --no-playlist-reverse Download playlist videos in default order
478 (default)
479 --playlist-random Download playlist videos in random order
480 --xattr-set-filesize Set file xattribute ytdl.filesize with
481 expected file size
482 --hls-use-mpegts Use the mpegts container for HLS videos;
483 allowing some players to play the video
484 while downloading, and reducing the chance
485 of file corruption if download is
486 interrupted. This is enabled by default for
487 live streams
488 --no-hls-use-mpegts Do not use the mpegts container for HLS
489 videos. This is default when not
490 downloading live streams
491 --downloader [PROTO:]NAME Name or path of the external downloader to
492 use (optionally) prefixed by the protocols
493 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
494 use it for. Currently supports native,
495 aria2c, avconv, axel, curl, ffmpeg, httpie,
496 wget (Recommended: aria2c). You can use
497 this option multiple times to set different
498 downloaders for different protocols. For
499 example, --downloader aria2c --downloader
500 "dash,m3u8:native" will use aria2c for
501 http/ftp downloads, and the native
502 downloader for dash/m3u8 downloads
503 (Alias: --external-downloader)
504 --downloader-args NAME:ARGS Give these arguments to the external
505 downloader. Specify the downloader name and
506 the arguments separated by a colon ":". For
507 ffmpeg, arguments can be passed to
508 different positions using the same syntax
509 as --postprocessor-args. You can use this
510 option multiple times to give different
511 arguments to different downloaders
512 (Alias: --external-downloader-args)
513
514 ## Filesystem Options:
515 -a, --batch-file FILE File containing URLs to download ('-' for
516 stdin), one URL per line. Lines starting
517 with '#', ';' or ']' are considered as
518 comments and ignored
519 --no-batch-file Do not read URLs from batch file (default)
520 -P, --paths [TYPES:]PATH The paths where the files should be
521 downloaded. Specify the type of file and
522 the path separated by a colon ":". All the
523 same types as --output are supported.
524 Additionally, you can also provide "home"
525 (default) and "temp" paths. All
526 intermediary files are first downloaded to
527 the temp path and then the final files are
528 moved over to the home path after download
529 is finished. This option is ignored if
530 --output is an absolute path
531 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
532 TEMPLATE" for details
533 --output-na-placeholder TEXT Placeholder value for unavailable meta
534 fields in output filename template
535 (default: "NA")
536 --restrict-filenames Restrict filenames to only ASCII
537 characters, and avoid "&" and spaces in
538 filenames
539 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
540 filenames (default)
541 --windows-filenames Force filenames to be Windows-compatible
542 --no-windows-filenames Make filenames Windows-compatible only if
543 using Windows (default)
544 --trim-filenames LENGTH Limit the filename length (excluding
545 extension) to the specified number of
546 characters
547 -w, --no-overwrites Do not overwrite any files
548 --force-overwrites Overwrite all video and metadata files.
549 This option includes --no-continue
550 --no-force-overwrites Do not overwrite the video, but overwrite
551 related files (default)
552 -c, --continue Resume partially downloaded files/fragments
553 (default)
554 --no-continue Do not resume partially downloaded
555 fragments. If the file is not fragmented,
556 restart download of the entire file
557 --part Use .part files instead of writing directly
558 into output file (default)
559 --no-part Do not use .part files - write directly
560 into output file
561 --mtime Use the Last-modified header to set the
562 file modification time (default)
563 --no-mtime Do not use the Last-modified header to set
564 the file modification time
565 --write-description Write video description to a .description
566 file
567 --no-write-description Do not write video description (default)
568 --write-info-json Write video metadata to a .info.json file
569 (this may contain personal information)
570 --no-write-info-json Do not write video metadata (default)
571 --write-playlist-metafiles Write playlist metadata in addition to the
572 video metadata when using --write-info-json,
573 --write-description etc. (default)
574 --no-write-playlist-metafiles Do not write playlist metadata when using
575 --write-info-json, --write-description etc.
576 --clean-infojson Remove some private fields such as
577 filenames from the infojson. Note that it
578 could still contain some personal
579 information (default)
580 --no-clean-infojson Write all fields to the infojson
581 --write-comments Retrieve video comments to be placed in the
582 infojson. The comments are fetched even
583 without this option if the extraction is
584 known to be quick (Alias: --get-comments)
585 --no-write-comments Do not retrieve video comments unless the
586 extraction is known to be quick
587 (Alias: --no-get-comments)
588 --load-info-json FILE JSON file containing the video information
589 (created with the "--write-info-json"
590 option)
591 --cookies FILE File to read cookies from and dump cookie
592 jar in
593 --no-cookies Do not read/dump cookies from/to file
594 (default)
595 --cookies-from-browser BROWSER[:PROFILE]
596 Load cookies from a user profile of the
597 given web browser. Currently supported
598 browsers are: brave, chrome, chromium,
599 edge, firefox, opera, safari, vivaldi. You
600 can specify the user profile name or
601 directory using "BROWSER:PROFILE_NAME" or
602 "BROWSER:PROFILE_PATH". If no profile is
603 given, the most recently accessed one is
604 used
605 --no-cookies-from-browser Do not load cookies from browser (default)
606 --cache-dir DIR Location in the filesystem where youtube-dl
607 can store some downloaded information (such
608 as client ids and signatures) permanently.
609 By default $XDG_CACHE_HOME/yt-dlp or
610 ~/.cache/yt-dlp
611 --no-cache-dir Disable filesystem caching
612 --rm-cache-dir Delete all filesystem cache files
613
614 ## Thumbnail Options:
615 --write-thumbnail Write thumbnail image to disk
616 --no-write-thumbnail Do not write thumbnail image to disk
617 (default)
618 --write-all-thumbnails Write all thumbnail image formats to disk
619 --list-thumbnails List available thumbnails of each video.
620 Simulate unless --no-simulate is used
621
622 ## Internet Shortcut Options:
623 --write-link Write an internet shortcut file, depending
624 on the current platform (.url, .webloc or
625 .desktop). The URL may be cached by the OS
626 --write-url-link Write a .url Windows internet shortcut. The
627 OS caches the URL based on the file path
628 --write-webloc-link Write a .webloc macOS internet shortcut
629 --write-desktop-link Write a .desktop Linux internet shortcut
630
631 ## Verbosity and Simulation Options:
632 -q, --quiet Activate quiet mode. If used with
633 --verbose, print the log to stderr
634 --no-warnings Ignore warnings
635 -s, --simulate Do not download the video and do not write
636 anything to disk
637 --no-simulate Download the video even if printing/listing
638 options are used
639 --ignore-no-formats-error Ignore "No video formats" error. Useful for
640 extracting metadata even if the videos are
641 not actually available for download
642 (experimental)
643 --no-ignore-no-formats-error Throw error when no downloadable video
644 formats are found (default)
645 --skip-download Do not download the video but write all
646 related files (Alias: --no-download)
647 -O, --print TEMPLATE Quiet, but print the given fields for each
648 video. Simulate unless --no-simulate is
649 used. Either a field name or same syntax as
650 the output template can be used
651 -j, --dump-json Quiet, but print JSON information for each
652 video. Simulate unless --no-simulate is
653 used. See "OUTPUT TEMPLATE" for a
654 description of available keys
655 -J, --dump-single-json Quiet, but print JSON information for each
656 url or infojson passed. Simulate unless
657 --no-simulate is used. If the URL refers to
658 a playlist, the whole playlist information
659 is dumped in a single line
660 --force-write-archive Force download archive entries to be
661 written as far as no errors occur, even if
662 -s or another simulation option is used
663 (Alias: --force-download-archive)
664 --newline Output progress bar as new lines
665 --no-progress Do not print progress bar
666 --progress Show progress bar, even if in quiet mode
667 --console-title Display progress in console titlebar
668 --progress-template [TYPES:]TEMPLATE
669 Template for progress outputs, optionally
670 prefixed with one of "download:" (default),
671 "download-title:" (the console title),
672 "postprocess:", or "postprocess-title:".
673 The video's fields are accessible under the
674 "info" key and the progress attributes are
675 accessible under "progress" key. E.g.:
676 --console-title --progress-template
677 "download-title:%(info.id)s-%(progress.eta)s"
678 -v, --verbose Print various debugging information
679 --dump-pages Print downloaded pages encoded using base64
680 to debug problems (very verbose)
681 --write-pages Write downloaded intermediary pages to
682 files in the current directory to debug
683 problems
684 --print-traffic Display sent and read HTTP traffic
685
686 ## Workarounds:
687 --encoding ENCODING Force the specified encoding (experimental)
688 --no-check-certificates Suppress HTTPS certificate validation
689 --prefer-insecure Use an unencrypted connection to retrieve
690 information about the video (Currently
691 supported only for YouTube)
692 --user-agent UA Specify a custom user agent
693 --referer URL Specify a custom referer, use if the video
694 access is restricted to one domain
695 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
696 separated by a colon ":". You can use this
697 option multiple times
698 --bidi-workaround Work around terminals that lack
699 bidirectional text support. Requires bidiv
700 or fribidi executable in PATH
701 --sleep-requests SECONDS Number of seconds to sleep between requests
702 during data extraction
703 --sleep-interval SECONDS Number of seconds to sleep before each
704 download. This is the minimum time to sleep
705 when used along with --max-sleep-interval
706 (Alias: --min-sleep-interval)
707 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
708 only be used along with --min-sleep-interval
709 --sleep-subtitles SECONDS Number of seconds to sleep before each
710 subtitle download
711
712 ## Video Format Options:
713 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
714 for more details
715 -S, --format-sort SORTORDER Sort the formats by the fields given, see
716 "Sorting Formats" for more details
717 --S-force, --format-sort-force Force user specified sort order to have
718 precedence over all fields, see "Sorting
719 Formats" for more details
720 --no-format-sort-force Some fields have precedence over the user
721 specified sort order (default), see
722 "Sorting Formats" for more details
723 --video-multistreams Allow multiple video streams to be merged
724 into a single file
725 --no-video-multistreams Only one video stream is downloaded for
726 each output file (default)
727 --audio-multistreams Allow multiple audio streams to be merged
728 into a single file
729 --no-audio-multistreams Only one audio stream is downloaded for
730 each output file (default)
731 --prefer-free-formats Prefer video formats with free containers
732 over non-free ones of same quality. Use
733 with "-S ext" to strictly prefer free
734 containers irrespective of quality
735 --no-prefer-free-formats Don't give any special preference to free
736 containers (default)
737 --check-formats Check that the selected formats are
738 actually downloadable
739 --check-all-formats Check all formats for whether they are
740 actually downloadable
741 --no-check-formats Do not check that the formats are actually
742 downloadable
743 -F, --list-formats List available formats of each video.
744 Simulate unless --no-simulate is used
745 --merge-output-format FORMAT If a merge is required (e.g.
746 bestvideo+bestaudio), output to given
747 container format. One of mkv, mp4, ogg,
748 webm, flv. Ignored if no merge is required
749
750 ## Subtitle Options:
751 --write-subs Write subtitle file
752 --no-write-subs Do not write subtitle file (default)
753 --write-auto-subs Write automatically generated subtitle file
754 (Alias: --write-automatic-subs)
755 --no-write-auto-subs Do not write auto-generated subtitles
756 (default) (Alias: --no-write-automatic-subs)
757 --list-subs List available subtitles of each video.
758 Simulate unless --no-simulate is used
759 --sub-format FORMAT Subtitle format, accepts formats
760 preference, for example: "srt" or
761 "ass/srt/best"
762 --sub-langs LANGS Languages of the subtitles to download (can
763 be regex) or "all" separated by commas.
764 (Eg: --sub-langs "en.*,ja") You can prefix
765 the language code with a "-" to exempt it
766 from the requested languages. (Eg: --sub-
767 langs all,-live_chat) Use --list-subs for a
768 list of available language tags
769
770 ## Authentication Options:
771 -u, --username USERNAME Login with this account ID
772 -p, --password PASSWORD Account password. If this option is left
773 out, yt-dlp will ask interactively
774 -2, --twofactor TWOFACTOR Two-factor authentication code
775 -n, --netrc Use .netrc authentication data
776 --netrc-location PATH Location of .netrc authentication data;
777 either the path or its containing
778 directory. Defaults to ~/.netrc
779 --video-password PASSWORD Video password (vimeo, youku)
780 --ap-mso MSO Adobe Pass multiple-system operator (TV
781 provider) identifier, use --ap-list-mso for
782 a list of available MSOs
783 --ap-username USERNAME Multiple-system operator account login
784 --ap-password PASSWORD Multiple-system operator account password.
785 If this option is left out, yt-dlp will ask
786 interactively
787 --ap-list-mso List all supported multiple-system
788 operators
789
790 ## Post-Processing Options:
791 -x, --extract-audio Convert video files to audio-only files
792 (requires ffmpeg and ffprobe)
793 --audio-format FORMAT Specify audio format to convert the audio
794 to when -x is used. Currently supported
795 formats are: best (default) or one of
796 best|aac|flac|mp3|m4a|opus|vorbis|wav|alac
797 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
798 value between 0 (best) and 10 (worst) for
799 VBR or a specific bitrate like 128K
800 (default 5)
801 --remux-video FORMAT Remux the video into another container if
802 necessary (currently supported: mp4|mkv|flv
803 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
804 target container does not support the
805 video/audio codec, remuxing will fail. You
806 can specify multiple rules; Eg.
807 "aac>m4a/mov>mp4/mkv" will remux aac to
808 m4a, mov to mp4 and anything else to mkv.
809 --recode-video FORMAT Re-encode the video into another format if
810 re-encoding is necessary. The syntax and
811 supported formats are the same as --remux-video
812 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
813 Specify the postprocessor/executable name
814 and the arguments separated by a colon ":"
815 to give the argument to the specified
816 postprocessor/executable. Supported PP are:
817 Merger, ModifyChapters, SplitChapters,
818 ExtractAudio, VideoRemuxer, VideoConvertor,
819 Metadata, EmbedSubtitle, EmbedThumbnail,
820 SubtitlesConvertor, ThumbnailsConvertor,
821 FixupStretched, FixupM4a, FixupM3u8,
822 FixupTimestamp and FixupDuration. The
823 supported executables are: AtomicParsley,
824 FFmpeg and FFprobe. You can also specify
825 "PP+EXE:ARGS" to give the arguments to the
826 specified executable only when being used
827 by the specified postprocessor.
828 Additionally, for ffmpeg/ffprobe, "_i"/"_o"
829 can be appended to the prefix optionally
830 followed by a number to pass the argument
831 before the specified input/output file. Eg:
832 --ppa "Merger+ffmpeg_i1:-v quiet". You can
833 use this option multiple times to give
834 different arguments to different
835 postprocessors. (Alias: --ppa)
836 -k, --keep-video Keep the intermediate video file on disk
837 after post-processing
838 --no-keep-video Delete the intermediate video file after
839 post-processing (default)
840 --post-overwrites Overwrite post-processed files (default)
841 --no-post-overwrites Do not overwrite post-processed files
842 --embed-subs Embed subtitles in the video (only for mp4,
843 webm and mkv videos)
844 --no-embed-subs Do not embed subtitles (default)
845 --embed-thumbnail Embed thumbnail in the video as cover art
846 --no-embed-thumbnail Do not embed thumbnail (default)
847 --embed-metadata Embed metadata to the video file. Also
848 embeds chapters/infojson if present unless
849 --no-embed-chapters/--no-embed-info-json
850 are used (Alias: --add-metadata)
851 --no-embed-metadata Do not add metadata to file (default)
852 (Alias: --no-add-metadata)
853 --embed-chapters Add chapter markers to the video file
854 (Alias: --add-chapters)
855 --no-embed-chapters Do not add chapter markers (default)
856 (Alias: --no-add-chapters)
857 --embed-info-json Embed the infojson as an attachment to
858 mkv/mka video files
859 --no-embed-info-json Do not embed the infojson as an attachment
860 to the video file
861 --parse-metadata FROM:TO Parse additional metadata like title/artist
862 from other fields; see "MODIFYING METADATA"
863 for details
864 --replace-in-metadata FIELDS REGEX REPLACE
865 Replace text in a metadata field using the
866 given regex. This option can be used
867 multiple times
868 --xattrs Write metadata to the video file's xattrs
869 (using dublin core and xdg standards)
870 --fixup POLICY Automatically correct known faults of the
871 file. One of never (do nothing), warn (only
872 emit a warning), detect_or_warn (the
873 default; fix file if we can, warn
874 otherwise), force (try fixing even if file
875 already exists
876 --ffmpeg-location PATH Location of the ffmpeg binary; either the
877 path to the binary or its containing
878 directory
879 --exec CMD Execute a command on the file after
880 downloading and post-processing. Same
881 syntax as the output template can be used
882 to pass any field as arguments to the
883 command. An additional field "filepath"
884 that contains the final path of the
885 downloaded file is also available. If no
886 fields are passed, %(filepath)q is appended
887 to the end of the command. This option can
888 be used multiple times
889 --no-exec Remove any previously defined --exec
890 --exec-before-download CMD Execute a command before the actual
891 download. The syntax is the same as --exec
892 but "filepath" is not available. This
893 option can be used multiple times
894 --no-exec-before-download Remove any previously defined
895 --exec-before-download
896 --convert-subs FORMAT Convert the subtitles to another format
897 (currently supported: srt|vtt|ass|lrc)
898 (Alias: --convert-subtitles)
899 --convert-thumbnails FORMAT Convert the thumbnails to another format
900 (currently supported: jpg|png)
901 --split-chapters Split video into multiple files based on
902 internal chapters. The "chapter:" prefix
903 can be used with "--paths" and "--output"
904 to set the output filename for the split
905 files. See "OUTPUT TEMPLATE" for details
906 --no-split-chapters Do not split video based on chapters
907 (default)
908 --remove-chapters REGEX Remove chapters whose title matches the
909 given regular expression. Time ranges
910 prefixed by a "*" can also be used in place
911 of chapters to remove the specified range.
912 Eg: --remove-chapters "*10:15-15:00"
913 --remove-chapters "intro". This option can
914 be used multiple times
915 --no-remove-chapters Do not remove any chapters from the file
916 (default)
917 --force-keyframes-at-cuts Force keyframes around the chapters before
918 removing/splitting them. Requires a
919 reencode and thus is very slow, but the
920 resulting video may have fewer artifacts
921 around the cuts
922 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
923 when cutting/splitting (default)
924 --use-postprocessor NAME[:ARGS] The (case sensitive) name of plugin
925 postprocessors to be enabled, and
926 (optionally) arguments to be passed to it,
927 seperated by a colon ":". ARGS are a
928 semicolon ";" delimited list of NAME=VALUE.
929 The "when" argument determines when the
930 postprocessor is invoked. It can be one of
931 "pre_process" (after extraction),
932 "before_dl" (before video download),
933 "post_process" (after video download;
934 default) or "after_move" (after moving file
935 to their final locations). This option can
936 be used multiple times to add different
937 postprocessors
938
939 ## SponsorBlock Options:
940 Make chapter entries for, or remove various segments (sponsor,
941 introductions, etc.) from downloaded YouTube videos using the
942 [SponsorBlock API](https://sponsor.ajay.app)
943
944 --sponsorblock-mark CATS SponsorBlock categories to create chapters
945 for, separated by commas. Available
946 categories are all, sponsor, intro, outro,
947 selfpromo, interaction, preview,
948 music_offtopic. You can prefix the category
949 with a "-" to exempt it. See
950 https://wiki.sponsor.ajay.app/index.php/Segment_Categories
951 for description of the categories. Eg:
952 --sponsorblock-query all,-preview
953 --sponsorblock-remove CATS SponsorBlock categories to be removed from
954 the video file, separated by commas. If a
955 category is present in both mark and
956 remove, remove takes precedence. The syntax
957 and available categories are the same as
958 for --sponsorblock-mark
959 --sponsorblock-chapter-title TEMPLATE
960 The title template for SponsorBlock
961 chapters created by --sponsorblock-mark.
962 The same syntax as the output template is
963 used, but the only available fields are
964 start_time, end_time, category, categories,
965 name, category_names. Defaults to
966 "[SponsorBlock]: %(category_names)l"
967 --no-sponsorblock Disable both --sponsorblock-mark and
968 --sponsorblock-remove
969 --sponsorblock-api URL SponsorBlock API location, defaults to
970 https://sponsor.ajay.app
971
972 ## Extractor Options:
973 --extractor-retries RETRIES Number of retries for known extractor
974 errors (default is 3), or "infinite"
975 --allow-dynamic-mpd Process dynamic DASH manifests (default)
976 (Alias: --no-ignore-dynamic-mpd)
977 --ignore-dynamic-mpd Do not process dynamic DASH manifests
978 (Alias: --no-allow-dynamic-mpd)
979 --hls-split-discontinuity Split HLS playlists to different formats at
980 discontinuities such as ad breaks
981 --no-hls-split-discontinuity Do not split HLS playlists to different
982 formats at discontinuities such as ad
983 breaks (default)
984 --extractor-args KEY:ARGS Pass these arguments to the extractor. See
985 "EXTRACTOR ARGUMENTS" for details. You can
986 use this option multiple times to give
987 arguments for different extractors
988
989 # CONFIGURATION
990
991 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
992
993 1. **Main Configuration**: The file given by `--config-location`
994 1. **Portable Configuration**: `yt-dlp.conf` in the same directory as the bundled binary. If you are running from source-code (`<root dir>/yt_dlp/__main__.py`), the root directory is used instead.
995 1. **Home Configuration**: `yt-dlp.conf` in the home path given by `-P "home:<path>"`, or in the current directory if no such path is given
996 1. **User Configuration**:
997 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
998 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
999 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
1000 * `%APPDATA%/yt-dlp/config.txt`
1001 * `~/yt-dlp.conf`
1002 * `~/yt-dlp.conf.txt`
1003
1004 `%XDG_CONFIG_HOME%` defaults to `~/.config` if undefined. On windows, `%APPDATA%` generally points to (`C:\Users\<user name>\AppData\Roaming`) and `~` points to `%HOME%` if present, `%USERPROFILE%` (generally `C:\Users\<user name>`), or `%HOMEDRIVE%%HOMEPATH%`
1005 1. **System Configuration**: `/etc/yt-dlp.conf`
1006
1007 For example, 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:
1008 ```
1009 # Lines starting with # are comments
1010
1011 # Always extract audio
1012 -x
1013
1014 # Do not copy the mtime
1015 --no-mtime
1016
1017 # Use this proxy
1018 --proxy 127.0.0.1:3128
1019
1020 # Save all videos under YouTube directory in your home directory
1021 -o ~/YouTube/%(title)s.%(ext)s
1022 ```
1023
1024 Note that 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`.
1025
1026 You can use `--ignore-config` if you want to disable all configuration files for a particular yt-dlp run. If `--ignore-config` is found inside any configuration file, no further configuration will be loaded. For example, having the option in the portable configuration file prevents loading of home, user, and system configurations. Additionally, (for backward compatibility) if `--ignore-config` is found inside the system configuration file, the user configuration is not loaded.
1027
1028 ### Authentication with `.netrc` file
1029
1030 You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every yt-dlp execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](https://stackoverflow.com/tags/.netrc/info) on a per extractor basis. For that you will need to create a `.netrc` file in `--netrc-location` and restrict permissions to read/write by only you:
1031 ```
1032 touch $HOME/.netrc
1033 chmod a-rwx,u+rw $HOME/.netrc
1034 ```
1035 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1036 ```
1037 machine <extractor> login <username> password <password>
1038 ```
1039 For example:
1040 ```
1041 machine youtube login myaccount@gmail.com password my_youtube_password
1042 machine twitch login my_twitch_account_name password my_twitch_password
1043 ```
1044 To activate authentication with the `.netrc` file you should pass `--netrc` to yt-dlp or place it in the [configuration file](#configuration).
1045
1046 The default location of the .netrc file is `$HOME` (`~`) in UNIX. On Windows, it is `%HOME%` if present, `%USERPROFILE%` (generally `C:\Users\<user name>`) or `%HOMEDRIVE%%HOMEPATH%`
1047
1048 # OUTPUT TEMPLATE
1049
1050 The `-o` option is used to indicate a template for the output file names while `-P` option is used to specify the path each type of file should be saved to.
1051
1052 **tl;dr:** [navigate me to examples](#output-template-examples).
1053
1054 The simplest usage of `-o` is not to set any template arguments when downloading a single file, like in `yt-dlp -o funny_video.flv "https://some/video"` (hard-coding file extension like this is _not_ recommended and could break some post-processing).
1055
1056 It may however also contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [Python string formatting operations](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting). For example, `%(NAME)s` or `%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations.
1057
1058 The field names themselves (the part inside the parenthesis) can also have some special formatting:
1059 1. **Object traversal**: The dictionaries and lists available in metadata can be traversed by using a `.` (dot) separator. You can also do python slicing using `:`. Eg: `%(tags.0)s`, `%(subtitles.en.-1.ext)s`, `%(id.3:7:-1)s`, `%(formats.:.format_id)s`. `%()s` refers to the entire infodict. Note that all the fields that become available using this method are not listed below. Use `-j` to see such fields
1060 1. **Addition**: Addition and subtraction of numeric fields can be done using `+` and `-` respectively. Eg: `%(playlist_index+10)03d`, `%(n_entries+1-playlist_index)d`
1061 1. **Date/time Formatting**: Date/time fields can be formatted according to [strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it separated from the field name using a `>`. Eg: `%(duration>%H-%M-%S)s`, `%(upload_date>%Y-%m-%d)s`, `%(epoch-3600>%H-%M-%S)s`
1062 1. **Alternatives**: Alternate fields can be specified seperated with a `,`. Eg: `%(release_date>%Y,upload_date>%Y|Unknown)s`
1063 1. **Default**: A literal default value can be specified for when the field is empty using a `|` seperator. This overrides `--output-na-template`. Eg: `%(uploader|Unknown)s`
1064 1. **More Conversions**: In addition to the normal format types `diouxXeEfFgGcrs`, `B`, `j`, `l`, `q` can be used for converting to **B**ytes, **j**son (flag `#` for pretty-printing), a comma seperated **l**ist (flag `#` for `\n` newline-seperated) and a string **q**uoted for the terminal (flag `#` to split a list into different arguments), respectively
1065 1. **Unicode normalization**: The format type `U` can be used for NFC [unicode normalization](https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize). The alternate form flag (`#`) changes the normalization to NFD and the conversion flag `+` can be used for NFKC/NFKD compatibility equivalence normalization. Eg: `%(title)+.100U` is NFKC
1066
1067 To summarize, the general syntax for a field is:
1068 ```
1069 %(name[.keys][addition][>strf][,alternate][|default])[flags][width][.precision][length]type
1070 ```
1071
1072 Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon `:`. The different file types supported are `subtitle`, `thumbnail`, `description`, `annotation` (deprecated), `infojson`, `link`, `pl_thumbnail`, `pl_description`, `pl_infojson`, `chapter`. For example, `-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 (except default) is empty, that type of file will not be written. Eg: `--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
1073
1074 The available fields are:
1075
1076 - `id` (string): Video identifier
1077 - `title` (string): Video title
1078 - `url` (string): Video URL
1079 - `ext` (string): Video filename extension
1080 - `alt_title` (string): A secondary title of the video
1081 - `description` (string): The description of the video
1082 - `display_id` (string): An alternative identifier for the video
1083 - `uploader` (string): Full name of the video uploader
1084 - `license` (string): License name the video is licensed under
1085 - `creator` (string): The creator of the video
1086 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
1087 - `upload_date` (string): Video upload date (YYYYMMDD)
1088 - `release_date` (string): The date (YYYYMMDD) when the video was released
1089 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
1090 - `uploader_id` (string): Nickname or id of the video uploader
1091 - `channel` (string): Full name of the channel the video is uploaded on
1092 - `channel_id` (string): Id of the channel
1093 - `location` (string): Physical location where the video was filmed
1094 - `duration` (numeric): Length of the video in seconds
1095 - `duration_string` (string): Length of the video (HH:mm:ss)
1096 - `view_count` (numeric): How many users have watched the video on the platform
1097 - `like_count` (numeric): Number of positive ratings of the video
1098 - `dislike_count` (numeric): Number of negative ratings of the video
1099 - `repost_count` (numeric): Number of reposts of the video
1100 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
1101 - `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)
1102 - `age_limit` (numeric): Age restriction for the video (years)
1103 - `live_status` (string): One of 'is_live', 'was_live', 'is_upcoming', 'not_live'
1104 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
1105 - `was_live` (boolean): Whether this video was originally a live stream
1106 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
1107 - `availability` (string): Whether the video is 'private', 'premium_only', 'subscriber_only', 'needs_auth', 'unlisted' or 'public'
1108 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1109 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
1110 - `format` (string): A human-readable description of the format
1111 - `format_id` (string): Format code specified by `--format`
1112 - `format_note` (string): Additional info about the format
1113 - `width` (numeric): Width of the video
1114 - `height` (numeric): Height of the video
1115 - `resolution` (string): Textual description of width and height
1116 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
1117 - `abr` (numeric): Average audio bitrate in KBit/s
1118 - `acodec` (string): Name of the audio codec in use
1119 - `asr` (numeric): Audio sampling rate in Hertz
1120 - `vbr` (numeric): Average video bitrate in KBit/s
1121 - `fps` (numeric): Frame rate
1122 - `dynamic_range` (string): The dynamic range of the video
1123 - `vcodec` (string): Name of the video codec in use
1124 - `container` (string): Name of the container format
1125 - `filesize` (numeric): The number of bytes, if known in advance
1126 - `filesize_approx` (numeric): An estimate for the number of bytes
1127 - `protocol` (string): The protocol that will be used for the actual download
1128 - `extractor` (string): Name of the extractor
1129 - `extractor_key` (string): Key name of the extractor
1130 - `epoch` (numeric): Unix epoch when creating the file
1131 - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
1132 - `n_entries` (numeric): Total number of extracted items in the playlist
1133 - `playlist` (string): Name or id of the playlist that contains the video
1134 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1135 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
1136 - `playlist_id` (string): Playlist identifier
1137 - `playlist_title` (string): Playlist title
1138 - `playlist_uploader` (string): Full name of the playlist uploader
1139 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
1140 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
1141 - `original_url` (string): The URL given by the user (or same as `webpage_url` for playlist entries)
1142
1143 Available for the video that belongs to some logical chapter or section:
1144
1145 - `chapter` (string): Name or title of the chapter the video belongs to
1146 - `chapter_number` (numeric): Number of the chapter the video belongs to
1147 - `chapter_id` (string): Id of the chapter the video belongs to
1148
1149 Available for the video that is an episode of some series or programme:
1150
1151 - `series` (string): Title of the series or programme the video episode belongs to
1152 - `season` (string): Title of the season the video episode belongs to
1153 - `season_number` (numeric): Number of the season the video episode belongs to
1154 - `season_id` (string): Id of the season the video episode belongs to
1155 - `episode` (string): Title of the video episode
1156 - `episode_number` (numeric): Number of the video episode within a season
1157 - `episode_id` (string): Id of the video episode
1158
1159 Available for the media that is a track or a part of a music album:
1160
1161 - `track` (string): Title of the track
1162 - `track_number` (numeric): Number of the track within an album or a disc
1163 - `track_id` (string): Id of the track
1164 - `artist` (string): Artist(s) of the track
1165 - `genre` (string): Genre(s) of the track
1166 - `album` (string): Title of the album the track belongs to
1167 - `album_type` (string): Type of the album
1168 - `album_artist` (string): List of all artists appeared on the album
1169 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1170 - `release_year` (numeric): Year (YYYY) when the album was released
1171
1172 Available for `chapter:` prefix when using `--split-chapters` for videos with internal chapters:
1173
1174 - `section_title` (string): Title of the chapter
1175 - `section_number` (numeric): Number of the chapter within the file
1176 - `section_start` (numeric): Start time of the chapter in seconds
1177 - `section_end` (numeric): End time of the chapter in seconds
1178
1179 Available only when used in `--print`:
1180
1181 - `urls` (string): The URLs of all requested formats, one in each line
1182 - `filename` (string): Name of the video file. Note that the actual filename may be different due to post-processing. Use `--exec echo` to get the name after all postprocessing is complete
1183
1184 Available only in `--sponsorblock-chapter-title`:
1185
1186 - `start_time` (numeric): Start time of the chapter in seconds
1187 - `end_time` (numeric): End time of the chapter in seconds
1188 - `categories` (list): The SponsorBlock categories the chapter belongs to
1189 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1190 - `category_names` (list): Friendly names of the categories
1191 - `name` (string): Friendly name of the smallest category
1192
1193 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. For example 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.
1194
1195 Note that 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).
1196
1197 **Tip**: Look at the `-j` output to identify which fields are available for the particular URL
1198
1199 For numeric sequences you can use [numeric related formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting), for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.
1200
1201 Output templates can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
1202
1203 To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
1204
1205 The current default template is `%(title)s [%(id)s].%(ext)s`.
1206
1207 In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:
1208
1209 #### Output template and Windows batch files
1210
1211 If you are using an output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
1212
1213 #### Output template examples
1214
1215 Note that on Windows you need to use double quotes instead of single.
1216
1217 ```bash
1218 $ yt-dlp --get-filename -o 'test video.%(ext)s' BaW_jenozKc
1219 test video.webm # Literal name with correct extension
1220
1221 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
1222 youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
1223
1224 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
1225 youtube-dl_test_video_.webm # Restricted file name
1226
1227 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1228 $ yt-dlp -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1229
1230 # Download YouTube playlist videos in separate directories according to their uploaded year
1231 $ yt-dlp -o '%(upload_date>%Y)s/%(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1232
1233 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1234 $ yt-dlp -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
1235
1236 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1237 $ 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/
1238
1239 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1240 $ 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
1241
1242 # Stream the video being downloaded to stdout
1243 $ yt-dlp -o - BaW_jenozKc
1244 ```
1245
1246 # FORMAT SELECTION
1247
1248 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1249 This is generally equivalent to using `-f bestvideo*+bestaudio/best`. However, if multiple audiostreams is enabled (`--audio-multistreams`), the default format changes to `-f bestvideo+bestaudio/best`. Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to `stdout` (`-o -`), the default becomes `-f best/bestvideo+bestaudio`.
1250
1251 **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.
1252
1253 The general syntax for format selection is `-f FORMAT` (or `--format FORMAT`) where `FORMAT` is a *selector expression*, i.e. an expression that describes format or formats you would like to download.
1254
1255 **tl;dr:** [navigate me to examples](#format-selection-examples).
1256
1257 The simplest case is requesting a specific format, for example 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.
1258
1259 You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
1260
1261 You can also use special names to select particular edge case formats:
1262
1263 - `all`: Select **all formats** separately
1264 - `mergeall`: Select and **merge all formats** (Must be used with `--audio-multistreams`, `--video-multistreams` or both)
1265 - `b*`, `best*`: Select the best quality format that **contains either** a video or an audio
1266 - `b`, `best`: Select the best quality format that **contains both** video and audio. Equivalent to `best*[vcodec!=none][acodec!=none]`
1267 - `bv`, `bestvideo`: Select the best quality **video-only** format. Equivalent to `best*[acodec=none]`
1268 - `bv*`, `bestvideo*`: Select the best quality format that **contains video**. It may also contain audio. Equivalent to `best*[vcodec!=none]`
1269 - `ba`, `bestaudio`: Select the best quality **audio-only** format. Equivalent to `best*[vcodec=none]`
1270 - `ba*`, `bestaudio*`: Select the best quality format that **contains audio**. It may also contain video. Equivalent to `best*[acodec!=none]`
1271 - `w*`, `worst*`: Select the worst quality format that contains either a video or an audio
1272 - `w`, `worst`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]`
1273 - `wv`, `worstvideo`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]`
1274 - `wv*`, `worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]`
1275 - `wa`, `worstaudio`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]`
1276 - `wa*`, `worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]`
1277
1278 For example, to download the worst quality video-only format you can use `-f worstvideo`. It is however recommended not to use `worst` and related options. When your format selector is `worst`, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-f best -S +size,+br,+res,+fps` instead of `-f worst`. See [sorting formats](#sorting-formats) for more details.
1279
1280 You can select the n'th best format of a type by using `best<type>.<n>`. For example, `best.2` will select the 2nd best combined format. Similarly, `bv*.3` will select the 3rd best format that contains a video stream.
1281
1282 If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred, for example `-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.
1283
1284 If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
1285
1286 You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...` (requires ffmpeg installed), for example `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg.
1287
1288 **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
1289
1290 Unless `--video-multistreams` is used, all formats with a video stream except the first one are ignored. Similarly, unless `--audio-multistreams` is used, all formats with an audio stream except the first one are ignored. For example, `-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 and merge both formats while `-f bestaudio+best --no-audio-multistreams` will ignore `best` and download only `bestaudio`.
1291
1292 ## Filtering Formats
1293
1294 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
1295
1296 The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
1297
1298 - `filesize`: The number of bytes, if known in advance
1299 - `width`: Width of the video, if known
1300 - `height`: Height of the video, if known
1301 - `tbr`: Average bitrate of audio and video in KBit/s
1302 - `abr`: Average audio bitrate in KBit/s
1303 - `vbr`: Average video bitrate in KBit/s
1304 - `asr`: Audio sampling rate in Hertz
1305 - `fps`: Frame rate
1306
1307 Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
1308
1309 - `ext`: File extension
1310 - `acodec`: Name of the audio codec in use
1311 - `vcodec`: Name of the video codec in use
1312 - `container`: Name of the container format
1313 - `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`)
1314 - `format_id`: A short description of the format
1315 - `language`: Language code
1316
1317 Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
1318
1319 Note that 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.
1320
1321 Formats for which the value is not known are excluded unless you put a question mark (`?`) after the operator. You can combine format filters, so `-f "[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. For example, `-f "all[vcodec=none]"` selects all audio-only formats.
1322
1323 Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than 480 you can use `-f '(mp4,webm)[height<480]'`.
1324
1325 ## Sorting Formats
1326
1327 You can change the criteria for being considered the `best` by using `-S` (`--format-sort`). The general format for this is `--format-sort field1,field2...`.
1328
1329 The available fields are:
1330
1331 - `hasvid`: Gives priority to formats that has a video stream
1332 - `hasaud`: Gives priority to formats that has a audio stream
1333 - `ie_pref`: The format preference as given by the extractor
1334 - `lang`: Language preference as given by the extractor
1335 - `quality`: The quality of the format as given by the extractor
1336 - `source`: Preference of the source as given by the extractor
1337 - `proto`: Protocol used for download (`https`/`ftps` > `http`/`ftp` > `m3u8_native`/`m3u8` > `http_dash_segments`> `websocket_frag` > other > `mms`/`rtsp` > unknown > `f4f`/`f4m`)
1338 - `vcodec`: Video Codec (`av01` > `vp9.2` > `vp9` > `h265` > `h264` > `vp8` > `h263` > `theora` > other > unknown)
1339 - `acodec`: Audio Codec (`opus` > `vorbis` > `aac` > `mp4a` > `mp3` > `eac3` > `ac3` > `dts` > other > unknown)
1340 - `codec`: Equivalent to `vcodec,acodec`
1341 - `vext`: Video Extension (`mp4` > `webm` > `flv` > other > unknown). If `--prefer-free-formats` is used, `webm` is prefered.
1342 - `aext`: Audio Extension (`m4a` > `aac` > `mp3` > `ogg` > `opus` > `webm` > other > unknown). If `--prefer-free-formats` is used, the order changes to `opus` > `ogg` > `webm` > `m4a` > `mp3` > `aac`.
1343 - `ext`: Equivalent to `vext,aext`
1344 - `filesize`: Exact filesize, if known in advance
1345 - `fs_approx`: Approximate filesize calculated from the manifests
1346 - `size`: Exact filesize if available, otherwise approximate filesize
1347 - `height`: Height of video
1348 - `width`: Width of video
1349 - `res`: Video resolution, calculated as the smallest dimension.
1350 - `fps`: Framerate of video
1351 - `hdr`: The dynamic range of the video (`DV` > `HDR12` > `HDR10+` > `HDR10` > `HLG` > `SDR`)
1352 - `tbr`: Total average bitrate in KBit/s
1353 - `vbr`: Average video bitrate in KBit/s
1354 - `abr`: Average audio bitrate in KBit/s
1355 - `br`: Equivalent to using `tbr,vbr,abr`
1356 - `asr`: Audio sample rate in Hz
1357
1358 **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.
1359
1360 All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a `+`. Eg: `+res` prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a `:`. Eg: `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. Eg: `+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. Eg: `filesize~1G` prefers the format with filesize closest to 1 GiB.
1361
1362 The 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,codec:vp9.2,size,br,asr,proto,ext,hasaud,source,id`. The extractors may override this default order, but they cannot override the user-provided order.
1363
1364 Note that the default has `codec:vp9.2`; i.e. `av1` is not prefered. Similarly, the default for hdr is `hdr:12`; i.e. dolby vision is not prefered. 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.
1365
1366 If your format selector is `worst`, the last item is selected after sorting. This means it will select the format that is worst in all respects. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-f best -S +size,+br,+res,+fps`.
1367
1368 **Tip**: You can use the `-v -F` to see how the formats have been sorted (worst to best).
1369
1370 ## Format Selection examples
1371
1372 Note that on Windows you may need to use double quotes instead of single.
1373
1374 ```bash
1375 # Download and merge the best video-only format and the best audio-only format,
1376 # or download the best combined format if video-only format is not available
1377 $ yt-dlp -f 'bv+ba/b'
1378
1379 # Download best format that contains video,
1380 # and if it doesn't already have an audio stream, merge it with best audio-only format
1381 $ yt-dlp -f 'bv*+ba/b'
1382
1383 # Same as above
1384 $ yt-dlp
1385
1386 # Download the best video-only format and the best audio-only format without merging them
1387 # For this case, an output template should be used since
1388 # by default, bestvideo and bestaudio will have the same file name.
1389 $ yt-dlp -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s'
1390
1391 # Download and merge the best format that has a video stream,
1392 # and all audio-only formats into one file
1393 $ yt-dlp -f 'bv*+mergeall[vcodec=none]' --audio-multistreams
1394
1395 # Download and merge the best format that has a video stream,
1396 # and the best 2 audio-only formats into one file
1397 $ yt-dlp -f 'bv*+ba+ba.2' --audio-multistreams
1398
1399
1400 # The following examples show the old method (without -S) of format selection
1401 # and how to use -S to achieve a similar but (generally) better result
1402
1403 # Download the worst video available (old method)
1404 $ yt-dlp -f 'wv*+wa/w'
1405
1406 # Download the best video available but with the smallest resolution
1407 $ yt-dlp -S '+res'
1408
1409 # Download the smallest video available
1410 $ yt-dlp -S '+size,+br'
1411
1412
1413
1414 # Download the best mp4 video available, or the best video if no mp4 available
1415 $ yt-dlp -f 'bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b'
1416
1417 # Download the best video with the best extension
1418 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1419 $ yt-dlp -S 'ext'
1420
1421
1422
1423 # Download the best video available but no better than 480p,
1424 # or the worst video if there is no video under 480p
1425 $ yt-dlp -f 'bv*[height<=480]+ba/b[height<=480] / wv*+ba/w'
1426
1427 # Download the best video available with the largest height but no better than 480p,
1428 # or the best video with the smallest resolution if there is no video under 480p
1429 $ yt-dlp -S 'height:480'
1430
1431 # Download the best video available with the largest resolution but no better than 480p,
1432 # or the best video with the smallest resolution if there is no video under 480p
1433 # Resolution is determined by using the smallest dimension.
1434 # So this works correctly for vertical videos as well
1435 $ yt-dlp -S 'res:480'
1436
1437
1438
1439 # Download the best video (that also has audio) but no bigger than 50 MB,
1440 # or the worst video (that also has audio) if there is no video under 50 MB
1441 $ yt-dlp -f 'b[filesize<50M] / w'
1442
1443 # Download largest video (that also has audio) but no bigger than 50 MB,
1444 # or the smallest video (that also has audio) if there is no video under 50 MB
1445 $ yt-dlp -f 'b' -S 'filesize:50M'
1446
1447 # Download best video (that also has audio) that is closest in size to 50 MB
1448 $ yt-dlp -f 'b' -S 'filesize~50M'
1449
1450
1451
1452 # Download best video available via direct link over HTTP/HTTPS protocol,
1453 # or the best video available via any protocol if there is no such video
1454 $ yt-dlp -f '(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)'
1455
1456 # Download best video available via the best protocol
1457 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1458 $ yt-dlp -S 'proto'
1459
1460
1461
1462 # Download the best video with h264 codec, or the best video if there is no such video
1463 $ yt-dlp -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'
1464
1465 # Download the best video with best codec no better than h264,
1466 # or the best video with worst codec if there is no such video
1467 $ yt-dlp -S 'codec:h264'
1468
1469 # Download the best video with worst codec no worse than h264,
1470 # or the best video with best codec if there is no such video
1471 $ yt-dlp -S '+codec:h264'
1472
1473
1474
1475 # More complex examples
1476
1477 # Download the best video no better than 720p preferring framerate greater than 30,
1478 # or the worst video (still preferring framerate greater than 30) if there is no such video
1479 $ yt-dlp -f '((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)'
1480
1481 # Download the video with the largest resolution no better than 720p,
1482 # or the video with the smallest resolution available if there is no such video,
1483 # preferring larger framerate for formats with the same resolution
1484 $ yt-dlp -S 'res:720,fps'
1485
1486
1487
1488 # Download the video with smallest resolution no worse than 480p,
1489 # or the video with the largest resolution available if there is no such video,
1490 # preferring better codec and then larger total bitrate for the same resolution
1491 $ yt-dlp -S '+res:480,codec,br'
1492 ```
1493
1494 # MODIFYING METADATA
1495
1496 The metadata obtained by the extractors can be modified by using `--parse-metadata` and `--replace-in-metadata`
1497
1498 `--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.
1499
1500 The general syntax of `--parse-metadata FROM:TO` is to give the name of a field or an [output template](#output-template) to extract data from, and the format to interpret it as, separated by a colon `:`. Either a [python regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) with named capture groups 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.
1501
1502 Note that any field created by this can be used in the [output template](#output-template) and will also affect the media file's metadata added when using `--add-metadata`.
1503
1504 This option also has a few special uses:
1505 * 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. Eg: `--parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)` will download the first vimeo video found in the description
1506 * 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. For example, you can use this to set a different "description" and "synopsis". Any value set to the `meta_` field will overwrite all default values.
1507
1508 For reference, these are the fields yt-dlp adds by default to the file metadata:
1509
1510 Metadata fields|From
1511 :---|:---
1512 `title`|`track` or `title`
1513 `date`|`upload_date`
1514 `description`, `synopsis`|`description`
1515 `purl`, `comment`|`webpage_url`
1516 `track`|`track_number`
1517 `artist`|`artist`, `creator`, `uploader` or `uploader_id`
1518 `genre`|`genre`
1519 `album`|`album`
1520 `album_artist`|`album_artist`
1521 `disc`|`disc_number`
1522 `show`|`series`
1523 `season_number`|`season_number`
1524 `episode_id`|`episode` or `episode_id`
1525 `episode_sort`|`episode_number`
1526 `language` of each stream|From the format's `language`
1527 **Note**: The file format may not support some of these fields
1528
1529
1530 ## Modifying metadata examples
1531
1532 Note that on Windows you may need to use double quotes instead of single.
1533
1534 ```bash
1535 # Interpret the title as "Artist - Title"
1536 $ yt-dlp --parse-metadata 'title:%(artist)s - %(title)s'
1537
1538 # Regex example
1539 $ yt-dlp --parse-metadata 'description:Artist - (?P<artist>.+)'
1540
1541 # Set title as "Series name S01E05"
1542 $ yt-dlp --parse-metadata '%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s'
1543
1544 # Set "comment" field in video metadata using description instead of webpage_url
1545 $ yt-dlp --parse-metadata 'description:(?s)(?P<meta_comment>.+)' --add-metadata
1546
1547 # Remove "formats" field from the infojson by setting it to an empty string
1548 $ yt-dlp --parse-metadata ':(?P<formats>)' -j
1549
1550 # Replace all spaces and "_" in title and uploader with a `-`
1551 $ yt-dlp --replace-in-metadata 'title,uploader' '[ _]' '-'
1552
1553 ```
1554
1555 # EXTRACTOR ARGUMENTS
1556
1557 Some extractors accept additional arguments which can be passed using `--extractor-args KEY:ARGS`. `ARGS` is a `;` (semicolon) separated string of `ARG=VAL1,VAL2`. Eg: `--extractor-args "youtube:player-client=android_agegate,web;include_live_dash" --extractor-args "funimation:version=uncut"`
1558
1559 The following extractors use this feature:
1560
1561 #### youtube
1562 * `skip`: `hls` or `dash` (or both) to skip download of the respective manifests
1563 * `player_client`: Clients to extract video data from. The main clients are `web`, `android`, `ios`, `mweb`. These also have `_music`, `_embedded`, `_agegate`, and `_creator` variants (Eg: `web_embedded`) (`mweb` has only `_agegate`). By default, `android,web` is used, but the agegate and creator variants are added as required for age-gated videos. Similarly the music variants are added for `music.youtube.com` urls. You can also use `all` to use all the clients, and `default` for the default clients.
1564 * `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
1565 * `include_live_dash`: Include live dash formats (These formats don't download properly)
1566 * `comment_sort`: `top` or `new` (default) - choose comment sorting mode (on YouTube's side)
1567 * `max_comments`: Maximum amount of comments to download (default all)
1568 * `max_comment_depth`: Maximum depth for nested comments. YouTube supports depths 1 or 2 (default)
1569
1570 #### youtubetab (YouTube playlists, channels, feeds, etc.)
1571 * `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)
1572
1573 #### funimation
1574 * `language`: Languages to extract. Eg: `funimation:language=english,japanese`
1575 * `version`: The video version to extract - `uncut` or `simulcast`
1576
1577 #### crunchyroll
1578 * `language`: Languages to extract. Eg: `crunchyroll:language=jaJp`
1579 * `hardsub`: Which hard-sub versions to extract. Eg: `crunchyroll:hardsub=None,enUS`
1580
1581 #### vikichannel
1582 * `video_types`: Types of videos to download - one or more of `episodes`, `movies`, `clips`, `trailers`
1583
1584 NOTE: These options may be changed/removed in the future without concern for backward compatibility
1585
1586
1587 # PLUGINS
1588
1589 Plugins are loaded from `<root-dir>/ytdlp_plugins/<type>/__init__.py`; where `<root-dir>` is the directory of the binary (`<root-dir>/yt-dlp`), or the root directory of the module if you are running directly from source-code (`<root dir>/yt_dlp/__main__.py`). Plugins are currently not supported for the `pip` version
1590
1591 Plugins can be of `<type>`s `extractor` or `postprocessor`. Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it. Postprocessor plugins can be invoked using `--use-postprocessor NAME`.
1592
1593 See [ytdlp_plugins](ytdlp_plugins) for example plugins.
1594
1595 Note that **all** plugins are imported even if not invoked, and that **there are no checks** performed on plugin code. Use plugins at your own risk and only if you trust the code
1596
1597 If you are a plugin author, add [ytdlp-plugins](https://github.com/topics/ytdlp-plugins) as a topic to your repository for discoverability
1598
1599
1600
1601 # EMBEDDING YT-DLP
1602
1603 yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1604
1605 Your program should avoid parsing the normal stdout since they may change in future versions. Instead they should use options such as `-J`, `--print`, `--progress-template`, `--exec` etc to create console output that you can reliably reproduce and parse.
1606
1607 From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1608
1609 ```python
1610 from yt_dlp import YoutubeDL
1611
1612 ydl_opts = {'format': 'bestaudio'}
1613 with YoutubeDL(ydl_opts) as ydl:
1614 ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
1615 ```
1616
1617 Most likely, you'll want to use various options. For a list of options available, have a look at [`yt_dlp/YoutubeDL.py`](yt_dlp/YoutubeDL.py#L154-L452).
1618
1619 Here's a more complete example demonstrating various functionality:
1620
1621 ```python
1622 import json
1623 import yt_dlp
1624
1625
1626 class MyLogger:
1627 def debug(self, msg):
1628 # For compatability with youtube-dl, both debug and info are passed into debug
1629 # You can distinguish them by the prefix '[debug] '
1630 if msg.startswith('[debug] '):
1631 pass
1632 else:
1633 self.info(msg)
1634
1635 def info(self, msg):
1636 pass
1637
1638 def warning(self, msg):
1639 pass
1640
1641 def error(self, msg):
1642 print(msg)
1643
1644
1645 # ℹ️ See the docstring of yt_dlp.postprocessor.common.PostProcessor
1646 class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
1647 # ℹ️ See docstring of yt_dlp.postprocessor.common.PostProcessor.run
1648 def run(self, info):
1649 self.to_screen('Doing stuff')
1650 return [], info
1651
1652
1653 # ℹ️ See "progress_hooks" in the docstring of yt_dlp.YoutubeDL
1654 def my_hook(d):
1655 if d['status'] == 'finished':
1656 print('Done downloading, now converting ...')
1657
1658
1659 def format_selector(ctx):
1660 """ Select the best video and the best audio that won't result in an mkv.
1661 This is just an example and does not handle all cases """
1662
1663 # formats are already sorted worst to best
1664 formats = ctx.get('formats')[::-1]
1665
1666 # acodec='none' means there is no audio
1667 best_video = next(f for f in formats
1668 if f['vcodec'] != 'none' and f['acodec'] == 'none')
1669
1670 # find compatible audio extension
1671 audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
1672 # vcodec='none' means there is no video
1673 best_audio = next(f for f in formats if (
1674 f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
1675
1676 yield {
1677 # These are the minimum required fields for a merged format
1678 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
1679 'ext': best_video['ext'],
1680 'requested_formats': [best_video, best_audio],
1681 # Must be + seperated list of protocols
1682 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
1683 }
1684
1685
1686 # ℹ️ See docstring of yt_dlp.YoutubeDL for a description of the options
1687 ydl_opts = {
1688 'format': format_selector,
1689 'postprocessors': [{
1690 # Embed metadata in video using ffmpeg.
1691 # ℹ️ See yt_dlp.postprocessor.FFmpegMetadataPP for the arguments it accepts
1692 'key': 'FFmpegMetadata',
1693 'add_chapters': True,
1694 'add_metadata': True,
1695 }],
1696 'logger': MyLogger(),
1697 'progress_hooks': [my_hook],
1698 }
1699
1700
1701 # Add custom headers
1702 yt_dlp.utils.std_headers.update({'Referer': 'https://www.google.com'})
1703
1704 # ℹ️ See the public functions in yt_dlp.YoutubeDL for for other available functions.
1705 # Eg: "ydl.download", "ydl.download_with_info_file"
1706 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1707 ydl.add_post_processor(MyCustomPP())
1708 info = ydl.extract_info('https://www.youtube.com/watch?v=BaW_jenozKc')
1709
1710 # ℹ️ ydl.sanitize_info makes the info json-serializable
1711 print(json.dumps(ydl.sanitize_info(info)))
1712 ```
1713
1714 **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 above
1715
1716
1717 # DEPRECATED OPTIONS
1718
1719 These are all the deprecated options and the current alternative to achieve the same effect
1720
1721 #### Redundant options
1722 While these options are redundant, they are still expected to be used due to their ease of use
1723
1724 --get-description --print description
1725 --get-duration --print duration_string
1726 --get-filename --print filename
1727 --get-format --print format
1728 --get-id --print id
1729 --get-thumbnail --print thumbnail
1730 -e, --get-title --print title
1731 -g, --get-url --print urls
1732 -j, --dump-json --print "%()j"
1733 --match-title REGEX --match-filter "title ~= (?i)REGEX"
1734 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
1735 --min-views COUNT --match-filter "view_count >=? COUNT"
1736 --max-views COUNT --match-filter "view_count <=? COUNT"
1737
1738
1739 #### Not recommended
1740 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1741
1742 --all-formats -f all
1743 --all-subs --sub-langs all --write-subs
1744 --print-json -j --no-simulate
1745 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)03d
1746 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1747 --id -o "%(id)s.%(ext)s"
1748 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1749 --hls-prefer-native --downloader "m3u8:native"
1750 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1751 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1752 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1753 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
1754 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
1755 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
1756 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
1757
1758
1759 #### Developer options
1760 These options are not intended to be used by the end-user
1761
1762 --test Download only part of video for testing extractors
1763 --youtube-print-sig-code For testing youtube signatures
1764 --allow-unplayable-formats List unplayable formats also
1765 --no-allow-unplayable-formats Default
1766
1767
1768 #### Old aliases
1769 These are aliases that are no longer documented for various reasons
1770
1771 --avconv-location --ffmpeg-location
1772 --cn-verification-proxy URL --geo-verification-proxy URL
1773 --dump-headers --print-traffic
1774 --dump-intermediate-pages --dump-pages
1775 --force-write-download-archive --force-write-archive
1776 --load-info --load-info-json
1777 --no-split-tracks --no-split-chapters
1778 --no-write-srt --no-write-subs
1779 --prefer-unsecure --prefer-insecure
1780 --rate-limit RATE --limit-rate RATE
1781 --split-tracks --split-chapters
1782 --srt-lang LANGS --sub-langs LANGS
1783 --trim-file-names LENGTH --trim-filenames LENGTH
1784 --write-srt --write-subs
1785 --yes-overwrites --force-overwrites
1786
1787 #### Sponskrub Options
1788 Support for [SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of `--sponsorblock`
1789
1790 --sponskrub --sponsorblock-mark all
1791 --no-sponskrub --no-sponsorblock
1792 --sponskrub-cut --sponsorblock-remove all
1793 --no-sponskrub-cut --sponsorblock-remove -all
1794 --sponskrub-force Not applicable
1795 --no-sponskrub-force Not applicable
1796 --sponskrub-location Not applicable
1797 --sponskrub-args Not applicable
1798
1799 #### No longer supported
1800 These options may no longer work as intended
1801
1802 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
1803 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
1804 -C, --call-home Not implemented
1805 --no-call-home Default
1806 --include-ads No longer supported
1807 --no-include-ads Default
1808 --write-annotations No supported site has annotations now
1809 --no-write-annotations Default
1810
1811 #### Removed
1812 These options were deprecated since 2014 and have now been entirely removed
1813
1814 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
1815 -t, --title -o "%(title)s-%(id)s.%(ext)s"
1816 -l, --literal -o accepts literal names
1817
1818 # CONTRIBUTING
1819 See [CONTRIBUTING.md](CONTRIBUTING.md#contributing-to-yt-dlp) for instructions on [Opening an Issue](CONTRIBUTING.md#opening-an-issue) and [Contributing code to the project](CONTRIBUTING.md#developer-instructions)
1820
1821 # MORE
1822 For FAQ see the [youtube-dl README](https://github.com/ytdl-org/youtube-dl#faq)