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