1 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
4 [](#readme)
6 [](#installation "Installation")
7 []
(https://pypi.org/project/yt-dlp "PyPi")
8 [](Collaborators.md#collaborators "Donate")
9 []
(https://matrix.to/#/#yt-dlp:matrix.org "Matrix")
10 []
(https://discord.gg/H5MNcFW63r "Discord")
11 [](supportedsites.md "Supported Sites")
12 [](LICENSE "License")
13 []
(https://github.com/yt-dlp/yt-dlp/actions "CI Status")
14 []
(https://github.com/yt-dlp/yt-dlp/commits "Commit History")
15 []
(https://github.com/yt-dlp/yt-dlp/commits "Commit History")
18 <!-- MANPAGE: END EXCLUDED SECTION -->
20 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
22 <!-- MANPAGE: MOVE "USAGE AND OPTIONS" SECTION HERE -->
24 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
25 * [NEW FEATURES](#new-features)
26 * [Differences in default behavior](#differences-in-default-behavior)
27 * [INSTALLATION](#installation)
28 * [Detailed instructions](https://github.com/yt-dlp/yt-dlp/wiki/Installation)
30 * [Release Files](#release-files)
31 * [Dependencies](#dependencies)
33 * [USAGE AND OPTIONS](#usage-and-options)
34 * [General Options](#general-options)
35 * [Network Options](#network-options)
36 * [Geo-restriction](#geo-restriction)
37 * [Video Selection](#video-selection)
38 * [Download Options](#download-options)
39 * [Filesystem Options](#filesystem-options)
40 * [Thumbnail Options](#thumbnail-options)
41 * [Internet Shortcut Options](#internet-shortcut-options)
42 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
43 * [Workarounds](#workarounds)
44 * [Video Format Options](#video-format-options)
45 * [Subtitle Options](#subtitle-options)
46 * [Authentication Options](#authentication-options)
47 * [Post-processing Options](#post-processing-options)
48 * [SponsorBlock Options](#sponsorblock-options)
49 * [Extractor Options](#extractor-options)
50 * [CONFIGURATION](#configuration)
51 * [Configuration file encoding](#configuration-file-encoding)
52 * [Authentication with .netrc file](#authentication-with-netrc-file)
53 * [Notes about environment variables](#notes-about-environment-variables)
54 * [OUTPUT TEMPLATE](#output-template)
55 * [Output template examples](#output-template-examples)
56 * [FORMAT SELECTION](#format-selection)
57 * [Filtering Formats](#filtering-formats)
58 * [Sorting Formats](#sorting-formats)
59 * [Format Selection examples](#format-selection-examples)
60 * [MODIFYING METADATA](#modifying-metadata)
61 * [Modifying metadata examples](#modifying-metadata-examples)
62 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
64 * [Installing Plugins](#installing-plugins)
65 * [Developing Plugins](#developing-plugins)
66 * [EMBEDDING YT-DLP](#embedding-yt-dlp)
67 * [Embedding examples](#embedding-examples)
68 * [DEPRECATED OPTIONS](#deprecated-options)
69 * [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
70 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
71 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
72 * [WIKI](https://github.com/yt-dlp/yt-dlp/wiki)
73 * [FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ)
74 <!-- MANPAGE: END EXCLUDED SECTION -->
79 * Merged with **youtube-dl v2021.12
.17+
[commit/2dd6c6e](https://github.com/ytdl-org/youtube-dl/commit/2dd6c6e)** (
[exceptions](https://github.com/yt-dlp/yt-dlp/issues/21)) and **youtube-dlc v2020.11
.11-
3+
[commit/f9401f2](https://github.com/blackjack4494/yt-dlc/commit/f9401f2a91987068139c5f757b12fc711d4c0cee)**: You get all the features and patches of
[youtube-dlc](https://github.com/blackjack4494/yt-dlc) in addition to the latest
[youtube-dl](https://github.com/ytdl-org/youtube-dl)
81 * **
[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in YouTube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
83 * **[Format Sorting](#sorting-formats)**: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using
`-S`. This allows for much easier format selection than what is possible by simply using
`--format` ([examples](#format-selection-examples))
85 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from
[animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including
`--write-comments`,
`BiliBiliSearch`,
`BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that NicoNico livestreams are not available. See
[#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details.
87 * **YouTube improvements**:
88 * Supports Clips, Stories (
`ytstories:<channel UCID>`), Search (including filters)**\***, YouTube Music Search, Channel-specific search, Search prefixes (
`ytsearch:`,
`ytsearchdate:`)**\***, Mixes, YouTube Music Albums/Channels (
[except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723)), and Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`,
`:ytnotif`)
89 * Fix for
[n-sig based throttling](https://github.com/ytdl-org/youtube-dl/issues/29326) **\***
90 * Supports some (but not all) age-gated content without cookies
91 * Download livestreams from the start using
`--live-from-start` (*experimental*)
92 * `255kbps` audio is extracted (if available) from YouTube Music when premium cookies are given
93 * Channel URLs download all uploads of the channel, including shorts and live
95 * **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using
`--cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]`
97 * **Download time range**: Videos can be downloaded partially based on either timestamps or chapters using
`--download-sections`
99 * **Split video by chapters**: Videos can be split into multiple files based on chapters using
`--split-chapters`
101 * **Multi-threaded fragment downloads**: Download multiple fragments of m3u8/mpd videos in parallel. Use
`--concurrent-fragments` (
`-N`) option to set the number of threads used
103 * **Aria2c with HLS/DASH**: You can use
`aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
105 * **New and fixed extractors**: Many new extractors have been added and a lot of existing ones have been fixed. See the [changelog](Changelog.md) or the [list of supported sites](supportedsites.md)
107 * **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN etc.
109 * **Subtitle extraction from manifests**: Subtitles can be extracted from streaming media manifests. See
[commit/be6202f](https://github.com/yt-dlp/yt-dlp/commit/be6202f12b97858b9d716e608394b51065d0419f) for details
111 * **Multiple paths and output templates**: You can give different [output templates](#output-template) and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to using
`--paths` (
`-P`)
113 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [CONFIGURATION](#configuration) for details
115 * **Output template improvements**: Output templates can now have date-time formatting, numeric offsets, object traversal etc. See [output template](#output-template) for details. Even more advanced operations can also be done with the help of
`--parse-metadata` and
`--replace-in-metadata`
117 * **Other new options**: Many new options have been added such as
`--alias`,
`--print`,
`--concat-playlist`,
`--wait-for-video`,
`--retry-sleep`,
`--sleep-requests`,
`--convert-thumbnails`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
119 * **Improvements**: Regex and other operators in
`--format`/
`--match-filter`, multiple
`--postprocessor-args` and
`--downloader-args`, faster archive checking, more [format selection options](#format-selection), merge multi-video/audio, multiple
`--config-locations`,
`--exec` at different stages, etc
121 * **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins](#plugins) for details
123 * **Self updater**: The releases can be updated using
`yt-dlp -U`, and downgraded using
`--update-to` if required
125 * **Nightly builds**: [Automated nightly builds](#update-channels) can be used with
`--update-to nightly`
127 See
[changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
129 Features marked with a **\*** have been back-ported to youtube-dl
131 ### Differences in default behavior
133 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
135 * yt-dlp supports only
[Python 3.7+](## "Windows 7"), and *may* remove support for more versions as they [become EOL](https://devguide.python.org/versions/#python-release-cycle); while
[youtube-dl still supports Python 2.6+ and 3.2+](https://github.com/ytdl-org/youtube-dl/issues/30568#issue-1118238743)
136 * The options
`--auto-number` (
`-A`),
`--title` (
`-t`) and
`--literal` (
`-l`), no longer work. See [removed options](#Removed) for details
137 * `avconv` is not supported as an alternative to
`ffmpeg`
138 * yt-dlp stores config files in slightly different locations to youtube-dl. See [CONFIGURATION](#configuration) for a list of correct locations
139 * The default [output template](#output-template) is
`%(title)s [%(id)s].%(ext)s`. There is no real reason for this change. This was changed before yt-dlp was ever made public and now there are no plans to change it back to
`%(title)s-%(id)s.%(ext)s`. Instead, you may use
`--compat-options filename`
140 * The default [format sorting](#sorting-formats) is different from youtube-dl and prefers higher resolution and better codecs rather than higher bitrates. You can use the
`--format-sort` option to change this to any order you prefer, or use
`--compat-options format-sort` to use youtube-dl's sorting order
141 * The default format selector is
`bv*+ba/b`. This means that if a combined video + audio format that is better than the best video-only format is found, the former will be preferred. Use
`-f bv+ba/b` or
`--compat-options format-spec` to revert this
142 * Unlike youtube-dlc, yt-dlp does not allow merging multiple audio/video streams into one file by default (since this conflicts with the use of
`-f bv*+ba`). If needed, this feature must be enabled using
`--audio-multistreams` and
`--video-multistreams`. You can also use
`--compat-options multistreams` to enable both
143 * `--no-abort-on-error` is enabled by default. Use
`--abort-on-error` or
`--compat-options abort-on-error` to abort on errors instead
144 * When writing metadata files such as thumbnails, description or infojson, the same information (if available) is also written for playlists. Use
`--no-write-playlist-metafiles` or
`--compat-options no-playlist-metafiles` to not write these files
145 * `--add-metadata` attaches the
`infojson` to
`mkv` files in addition to writing the metadata when used with
`--write-info-json`. Use
`--no-embed-info-json` or
`--compat-options no-attach-info-json` to revert this
146 * Some metadata are embedded into different fields when using
`--add-metadata` as compared to youtube-dl. Most notably,
`comment` field contains the
`webpage_url` and
`synopsis` contains the
`description`. You can [use
`--parse-metadata`](#modifying-metadata) to modify this to your liking or use
`--compat-options embed-metadata` to revert this
147 * `playlist_index` behaves differently when used with options like
`--playlist-reverse` and
`--playlist-items`. See
[#302](https://github.com/yt-dlp/yt-dlp/issues/302) for details. You can use
`--compat-options playlist-index` if you want to keep the earlier behavior
148 * The output of
`-F` is listed in a new format. Use
`--compat-options list-formats` to revert this
149 * Live chats (if available) are considered as subtitles. Use
`--sub-langs all,-live_chat` to download all subtitles except live chat. You can also use
`--compat-options no-live-chat` to prevent any live chat/danmaku from downloading
150 * YouTube channel URLs download all uploads of the channel. To download only the videos in a specific tab, pass the tab's URL. If the channel does not show the requested tab, an error will be raised. Also,
`/live` URLs raise an error if there are no live videos instead of silently downloading the entire channel. You may use
`--compat-options no-youtube-channel-redirect` to revert all these redirections
151 * Unavailable videos are also listed for YouTube playlists. Use
`--compat-options no-youtube-unavailable-videos` to remove this
152 * The upload dates extracted from YouTube are in UTC
[when available](https://github.com/yt-dlp/yt-dlp/blob/89e4d86171c7b7c997c77d4714542e0383bf0db0/yt_dlp/extractor/youtube.py#L3898-L3900). Use
`--compat-options no-youtube-prefer-utc-upload-date` to prefer the non-UTC upload date.
153 * If
`ffmpeg` is used as the downloader, the downloading and merging of formats happen in a single step when possible. Use
`--compat-options no-direct-merge` to revert this
154 * Thumbnail embedding in
`mp4` is done with mutagen if possible. Use
`--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
155 * Some private fields such as filenames are removed by default from the infojson. Use
`--no-clean-infojson` or
`--compat-options no-clean-infojson` to revert this
156 * When
`--embed-subs` and
`--write-subs` are used together, the subtitles are written to disk and also embedded in the media file. You can use just
`--embed-subs` to embed the subs and automatically delete the separate file. See
[#630 (comment)](https://github.com/yt-dlp/yt-dlp/issues/630#issuecomment-893659460) for more info.
`--compat-options no-keep-subs` can be used to revert this
157 * `certifi` will be used for SSL root certificates, if installed. If you want to use system certificates (e.g. self-signed), use
`--compat-options no-certifi`
158 * yt-dlp's sanitization of invalid characters in filenames is different/smarter than in youtube-dl. You can use
`--compat-options filename-sanitization` to revert to youtube-dl's behavior
159 * yt-dlp tries to parse the external downloader outputs into the standard progress output if possible (Currently implemented:
[~~aria2c~~](https://github.com/yt-dlp/yt-dlp/issues/5931)). You can use
`--compat-options no-external-downloader-progress` to get the downloader output as-is
161 For ease of use, a few more compat options are available:
163 * `--compat-options all`: Use all compat options (Do NOT use)
164 * `--compat-options youtube-dl`: Same as
`--compat-options all,-multistreams`
165 * `--compat-options youtube-dlc`: Same as
`--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
166 * `--compat-options 2021`: Same as
`--compat-options 2022,no-certifi,filename-sanitization,no-youtube-prefer-utc-upload-date`
167 * `--compat-options 2022`: Same as
`--compat-options no-external-downloader-progress`. Use this to enable all future compat options
172 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
173 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)
174 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)
175 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)
176 []
(https://pypi.org/project/yt-dlp)
177 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
178 [](#release-files)
179 []
(https://github.com/yt-dlp/yt-dlp/releases)
180 <!-- MANPAGE: END EXCLUDED SECTION -->
182 You can install yt-dlp using
[the binaries](#release-files), [PIP](https://pypi.org/project/yt-dlp) or one using a third-party package manager. See
[the wiki](https://github.com/yt-dlp/yt-dlp/wiki/Installation) for detailed instructions
186 You can use
`yt-dlp -U` to update if you are [using the release binaries](#release-files)
188 If you
[installed with PIP](https://github.com/yt-dlp/yt-dlp/wiki/Installation#with-pip), simply re-run the same command that was used to install the program
190 For other third-party package managers, see
[the wiki](https://github.com/yt-dlp/yt-dlp/wiki/Installation#third-party-package-managers) or refer their documentation
192 <a id="update-channels"/>
194 There are currently two release channels for binaries,
`stable` and
`nightly`.
195 `stable` releases are what the program will update to by default, and have had many of their changes tested by users of the master branch.
196 `nightly` releases are built after each push to the master branch, and will have the most recent fixes and additions, but also have the potential for bugs.
197 The latest
`nightly` is available as a
[pre-release from this repository](https://github.com/yt-dlp/yt-dlp/releases/tag/nightly), and all
`nightly` releases are
[archived in their own repo](https://github.com/yt-dlp/yt-dlp-nightly-builds/releases).
199 When using
`--update`/
`-U`, a release binary will only update to its current channel.
200 This release channel can be changed by using the
`--update-to` option.
`--update-to` can also be used to upgrade or downgrade to specific tags from a channel.
203 * `yt-dlp --update-to nightly` change to
`nightly` channel and update to its latest release
204 * `yt-dlp --update-to stable@2023.02.17` upgrade/downgrade to release to
`stable` channel tag
`2023.02.17`
205 * `yt-dlp --update-to 2023.01.06` upgrade/downgrade to tag
`2023.01.06` if it exists on the current channel
207 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
214 [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform-independent
[zipimport](https://docs.python.org/3/library/zipimport.html) binary. Needs Python (recommended for **Linux/BSD**)
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 [yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|Universal MacOS (
10.15+) standalone executable (recommended for **MacOS**)
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/> ([Not recommended](#standalone-py2exe-builds-windows))
224 [yt-dlp_linux](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux)|Linux standalone x64 binary
225 [yt-dlp_linux.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux.zip)|Unpackaged Linux executable (no auto-update)
226 [yt-dlp_linux_armv7l](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l)|Linux standalone armv7l (
32-bit) binary
227 [yt-dlp_linux_aarch64](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_aarch64)|Linux standalone aarch64 (
64-bit) binary
228 [yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged Windows executable (no auto-update)
229 [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)
230 [yt-dlp_macos_legacy](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos_legacy)|MacOS (
10.9+) standalone x64 executable
236 [yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)|Source tarball
237 [SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
238 [SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
239 <!-- MANPAGE: END EXCLUDED SECTION -->
242 **Note**: The manpages, shell completion files etc. are available in the
[source tarball](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
245 Python versions
3.7+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
247 <!-- Python
3.5+ uses VC++
14 and it is already embedded in the binary created
248 <!x-- https://www.microsoft.com/en-us/download/details.aspx?id=
26999 --x>
249 On windows,
[Microsoft Visual C++ 2010 SP1 Redistributable Package (x86)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe) is also necessary to run yt-dlp. You probably already have this, but if the executable throws an error due to missing
`MSVCR100.dll` you need to install it manually.
252 While all the other dependencies are optional,
`ffmpeg` and
`ffprobe` are highly recommended
254 ### Strongly recommended
256 * [**ffmpeg** and **ffprobe**](https://www.ffmpeg.org) - Required for
[merging separate video and audio files](#format-selection) as well as for various [post-processing](#post-processing-options) tasks. License [depends on the build](https://www.ffmpeg.org/legal.html)
258 There are bugs in ffmpeg that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependency, we provide
[custom builds](https://github.com/yt-dlp/FFmpeg-Builds#ffmpeg-static-auto-builds) with patches for some of these issues at
[yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds). See
[the readme](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied) for details on the specific issues solved by these builds
260 **Important**: What you need is ffmpeg *binary*, **NOT**
[the python package of the same name](https://pypi.org/project/ffmpeg)
263 * [**certifi**](https://github.com/certifi/python-certifi)\* - Provides Mozilla's root certificate bundle. Licensed under
[MPLv2](https://github.com/certifi/python-certifi/blob/master/LICENSE)
264 * [**brotli**](https://github.com/google/brotli)\* or
[**brotlicffi**](https://github.com/python-hyper/brotlicffi) -
[Brotli](https://en.wikipedia.org/wiki/Brotli) content encoding support. Both licensed under MIT <sup>
[1](https://github.com/google/brotli/blob/master/LICENSE) [2](https://github.com/python-hyper/brotlicffi/blob/master/LICENSE) </sup>
265 * [**websockets**](https://github.com/aaugustin/websockets)\* - For downloading over websocket. Licensed under
[BSD-3-Clause](https://github.com/aaugustin/websockets/blob/main/LICENSE)
269 * [**mutagen**](https://github.com/quodlibet/mutagen)\* - For
`--embed-thumbnail` in certain formats. Licensed under
[GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
270 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For
`--embed-thumbnail` in
`mp4`/
`m4a` files when
`mutagen`/
`ffmpeg` cannot. Licensed under
[GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
271 * [**xattr**](https://github.com/xattr/xattr),
[**pyxattr**](https://github.com/iustin/pyxattr) or
[**setfattr**](http://savannah.nongnu.org/projects/attr) - For writing xattr metadata (
`--xattr`) on **Linux**. Licensed under
[MIT](https://github.com/xattr/xattr/blob/master/LICENSE.txt),
[LGPL2.1](https://github.com/iustin/pyxattr/blob/master/COPYING) and
[GPLv2+](http://git.savannah.nongnu.org/cgit/attr.git/tree/doc/COPYING) respectively
275 * [**pycryptodomex**](https://github.com/Legrandin/pycryptodome)\* - For decrypting AES-
128 HLS streams and various other data. Licensed under
[BSD-2-Clause](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
276 * [**phantomjs**](https://github.com/ariya/phantomjs) - Used in extractors where javascript needs to be run. Licensed under
[BSD-3-Clause](https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD)
277 * [**secretstorage**](https://github.com/mitya57/secretstorage) - For
`--cookies-from-browser` to access the **Gnome** keyring while decrypting cookies of **Chromium**-based browsers on **Linux**. Licensed under
[BSD-3-Clause](https://github.com/mitya57/secretstorage/blob/master/LICENSE)
278 * Any external downloader that you want to use with
`--downloader`
282 * [**avconv** and **avprobe**](https://www.libav.org) - Now **deprecated** alternative to ffmpeg. License
[depends on the build](https://libav.org/legal)
283 * [**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)
284 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading
`rtmp` streams. ffmpeg can be used instead with
`--downloader ffmpeg`. Licensed under
[GPLv2+](http://rtmpdump.mplayerhq.hu)
285 * [**mplayer**](http://mplayerhq.hu/design7/info.html) or
[**mpv**](https://mpv.io) - For downloading
`rstp`/
`mms` streams. ffmpeg can be used instead with
`--downloader ffmpeg`. Licensed under
[GPLv2+](https://github.com/mpv-player/mpv/blob/master/Copyright)
287 To use or redistribute the dependencies, you must agree to their respective licensing terms.
289 The standalone release binaries are built with the Python interpreter and the packages marked with **\*** included.
291 If you do not have the necessary dependencies for a task you are attempting, yt-dlp will warn you. All the currently available dependencies are visible at the top of the
`--verbose` output
296 ### Standalone PyInstaller Builds
297 To build the standalone executable, you must have Python and
`pyinstaller` (plus any of yt-dlp's [optional dependencies](#dependencies) if needed). Once you have all the necessary dependencies installed, simply run
`pyinst.py`. The executable will be built for the same architecture (x86/ARM,
32/
64 bit) as the Python used.
299 python3 -m pip install -U pyinstaller -r requirements.txt
300 python3 devscripts/make_lazy_extractors.py
303 On some systems, you may need to use
`py` or
`python` instead of
`python3`.
305 `pyinst.py` accepts any arguments that can be passed to
`pyinstaller`, such as
`--onefile/-F` or
`--onedir/-D`, which is further
[documented here](https://pyinstaller.org/en/stable/usage.html#what-to-generate).
307 **Note**: Pyinstaller versions below
4.4 [do not support](https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms) Python installed from the Windows store without using a virtual environment.
309 **Important**: Running
`pyinstaller` directly **without** using
`pyinst.py` is **not** officially supported. This may or may not work correctly.
311 ### Platform-independent Binary (UNIX)
312 You will need the build tools
`python` (
3.7+),
`zip`,
`make` (GNU),
`pandoc`\* and
`pytest`\*.
314 After installing these, simply run
`make`.
316 You can also run
`make yt-dlp` instead to compile only the binary without updating any of the additional files. (The build tools marked with **\*** are not needed for this)
318 ### Standalone Py2Exe Builds (Windows)
320 While we provide the option to build with
[py2exe](https://www.py2exe.org), it is recommended to build [using PyInstaller](#standalone-pyinstaller-builds) instead since the py2exe builds **cannot contain
`pycryptodomex`/
`certifi` and needs VC++
14** on the target computer to run.
322 If you wish to build it anyway, install Python and py2exe, and then simply run
`setup.py py2exe`
324 py -m pip install -U py2exe -r requirements.txt
325 py devscripts/make_lazy_extractors.py
330 * **
`devscripts/update-version.py`** - Update the version number based on current date.
331 * **
`devscripts/set-variant.py`** - Set the build variant of the executable.
332 * **
`devscripts/make_changelog.py`** - Create a markdown changelog using short commit messages and update
`CONTRIBUTORS` file.
333 * **
`devscripts/make_lazy_extractors.py`** - Create lazy extractors. Running this before building the binaries (any variant) will improve their startup performance. Set the environment variable
`YTDLP_NO_LAZY_EXTRACTORS=1` if you wish to forcefully disable lazy extractor loading.
335 Note: See their
`--help` for more info.
337 ### Forking the project
338 If you fork the project on GitHub, you can run your fork's [build workflow](.github/workflows/build.yml) to automatically build the selected version(s) as artifacts. Alternatively, you can run the [release workflow](.github/workflows/release.yml) or enable the [nightly workflow](.github/workflows/release-nightly.yml) to create full (pre-)releases.
342 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
343 yt-dlp [OPTIONS] [--] URL [URL...]
345 `Ctrl+F` is your friend :D
346 <!-- MANPAGE: END EXCLUDED SECTION -->
348 <!-- Auto generated -->
350 -h, --help Print this help text and exit
351 --version Print program version and exit
352 -U, --update Update this program to the latest version
353 --no-update Do not check for updates (default)
354 --update-to [CHANNEL]@[TAG] Upgrade/downgrade to a specific version.
355 CHANNEL and TAG defaults to "stable" and
356 "latest" respectively if ommited; See
357 "UPDATE" for details. Supported channels:
359 -i, --ignore-errors Ignore download and postprocessing errors.
360 The download will be considered successful
361 even if the postprocessing fails
362 --no-abort-on-error Continue with next video on download errors;
363 e.g. to skip unavailable videos in a
365 --abort-on-error Abort downloading of further videos if an
366 error occurs (Alias: --no-ignore-errors)
367 --dump-user-agent Display the current user-agent and exit
368 --list-extractors List all supported extractors and exit
369 --extractor-descriptions Output descriptions of all supported
371 --use-extractors NAMES Extractor names to use separated by commas.
372 You can also use regexes, "all", "default"
373 and "end" (end URL matching); e.g. --ies
374 "holodex.*,end,youtube". Prefix the name
375 with a "-" to exclude it, e.g. --ies
376 default,-generic. Use --list-extractors for
377 a list of extractor names. (Alias: --ies)
378 --default-search PREFIX Use this prefix for unqualified URLs. E.g.
379 "gvsearch2:python" downloads two videos from
380 google videos for the search term "python".
381 Use the value "auto" to let yt-dlp guess
382 ("auto_warning" to emit a warning when
383 guessing). "error" just throws an error. The
384 default value "fixup_error" repairs broken
385 URLs, but emits an error if this is not
386 possible instead of searching
387 --ignore-config Don't load any more configuration files
388 except those given by --config-locations.
389 For backward compatibility, if this option
390 is found inside the system configuration
391 file, the user configuration is not loaded.
393 --no-config-locations Do not load any custom configuration files
394 (default). When given inside a configuration
395 file, ignore all previous --config-locations
396 defined in the current file
397 --config-locations PATH Location of the main configuration file;
398 either the path to the config or its
399 containing directory ("-" for stdin). Can be
400 used multiple times and inside other
402 --flat-playlist Do not extract the videos of a playlist,
404 --no-flat-playlist Extract the videos of a playlist
405 --live-from-start Download livestreams from the start.
406 Currently only supported for YouTube
408 --no-live-from-start Download livestreams from the current time
410 --wait-for-video MIN[-MAX] Wait for scheduled streams to become
411 available. Pass the minimum number of
412 seconds (or range) to wait between retries
413 --no-wait-for-video Do not wait for scheduled streams (default)
414 --mark-watched Mark videos watched (even with --simulate)
415 --no-mark-watched Do not mark videos watched (default)
416 --no-colors Do not emit color codes in output (Alias:
418 --compat-options OPTS Options that can help keep compatibility
419 with youtube-dl or youtube-dlc
420 configurations by reverting some of the
421 changes made in yt-dlp. See "Differences in
422 default behavior" for details
423 --alias ALIASES OPTIONS Create aliases for an option string. Unless
424 an alias starts with a dash "-", it is
425 prefixed with "--". Arguments are parsed
426 according to the Python string formatting
427 mini-language. E.g. --alias get-audio,-X
428 "-S=aext:{
0},abr -x --audio-format {
0}"
429 creates options "--get-audio" and "-X" that
430 takes an argument (ARG0) and expands to
431 "-S=aext:ARG0,abr -x --audio-format ARG0".
432 All defined aliases are listed in the --help
433 output. Alias options can trigger more
434 aliases; so be careful to avoid defining
435 recursive options. As a safety measure, each
436 alias may be triggered a maximum of
100
437 times. This option can be used multiple times
440 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. To
441 enable SOCKS proxy, specify a proper scheme,
442 e.g. socks5://user:pass@
127.0.0.1:
1080/.
443 Pass in an empty string (--proxy "") for
445 --socket-timeout SECONDS Time to wait before giving up, in seconds
446 --source-address IP Client-side IP address to bind to
447 -4, --force-ipv4 Make all connections via IPv4
448 -6, --force-ipv6 Make all connections via IPv6
449 --enable-file-urls Enable file:// URLs. This is disabled by
450 default for security reasons.
453 --geo-verification-proxy URL Use this proxy to verify the IP address for
454 some geo-restricted sites. The default proxy
455 specified by --proxy (or none, if the option
456 is not present) is used for the actual
458 --geo-bypass Bypass geographic restriction via faking
459 X-Forwarded-For HTTP header (default)
460 --no-geo-bypass Do not bypass geographic restriction via
461 faking X-Forwarded-For HTTP header
462 --geo-bypass-country CODE Force bypass geographic restriction with
463 explicitly provided two-letter ISO
3166-
2
465 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
466 explicitly provided IP block in CIDR notation
469 -I, --playlist-items ITEM_SPEC Comma separated playlist_index of the items
470 to download. You can specify a range using
471 "[START]:[STOP][:STEP]". For backward
472 compatibility, START-STOP is also supported.
473 Use negative indices to count from the right
474 and negative STEP to download in reverse
475 order. E.g. "-I
1:
3,
7,-
5::
2" used on a
476 playlist of size
15 will download the items
477 at index
1,
2,
3,
7,
11,
13,
15
478 --min-filesize SIZE Abort download if filesize is smaller than
479 SIZE, e.g.
50k or
44.6M
480 --max-filesize SIZE Abort download if filesize is larger than
481 SIZE, e.g.
50k or
44.6M
482 --date DATE Download only videos uploaded on this date.
483 The date can be "YYYYMMDD" or in the format
484 [now|today|yesterday][-N[day|week|month|year]].
485 E.g. "--date today-
2weeks" downloads only
486 videos uploaded on the same day two weeks ago
487 --datebefore DATE Download only videos uploaded on or before
488 this date. The date formats accepted is the
490 --dateafter DATE Download only videos uploaded on or after
491 this date. The date formats accepted is the
493 --match-filters FILTER Generic video filter. Any "OUTPUT TEMPLATE"
494 field can be compared with a number or a
495 string using the operators defined in
496 "Filtering Formats". You can also simply
497 specify a field to match if the field is
498 present, use "!field" to check if the field
499 is not present, and "&" to check multiple
500 conditions. Use a "
\" to escape "&" or
501 quotes if needed. If used multiple times,
502 the filter matches if atleast one of the
503 conditions are met. E.g. --match-filter
504 !is_live --match-filter "like_count>?
100 &
505 description~='(?i)
\bcats \& dogs
\b'" matches
506 only videos that are not live OR those that
507 have a like count more than
100 (or the like
508 field is not available) and also has a
509 description that contains the phrase "cats &
510 dogs" (caseless). Use "--match-filter -" to
511 interactively ask whether to download each
513 --no-match-filter Do not use generic video filter (default)
514 --no-playlist Download only the video, if the URL refers
515 to a video and a playlist
516 --yes-playlist Download the playlist, if the URL refers to
517 a video and a playlist
518 --age-limit YEARS Download only videos suitable for the given
520 --download-archive FILE Download only videos not listed in the
521 archive file. Record the IDs of all
522 downloaded videos in it
523 --no-download-archive Do not use archive file (default)
524 --max-downloads NUMBER Abort after downloading NUMBER files
525 --break-on-existing Stop the download process when encountering
526 a file that is in the archive
527 --break-on-reject Stop the download process when encountering
528 a file that has been filtered out
529 --break-per-input Alters --max-downloads, --break-on-existing,
530 --break-on-reject, and autonumber to reset
532 --no-break-per-input --break-on-existing and similar options
533 terminates the entire download queue
534 --skip-playlist-after-errors N Number of allowed failures until the rest of
535 the playlist is skipped
538 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
539 video that should be downloaded concurrently
541 -r, --limit-rate RATE Maximum download rate in bytes per second,
543 --throttled-rate RATE Minimum download rate in bytes per second
544 below which throttling is assumed and the
545 video data is re-extracted, e.g.
100K
546 -R, --retries RETRIES Number of retries (default is
10), or
548 --file-access-retries RETRIES Number of times to retry on file access
549 error (default is
3), or "infinite"
550 --fragment-retries RETRIES Number of retries for a fragment (default is
551 10), or "infinite" (DASH, hlsnative and ISM)
552 --retry-sleep [TYPE:]EXPR Time to sleep between retries in seconds
553 (optionally) prefixed by the type of retry
554 (http (default), fragment, file_access,
555 extractor) to apply the sleep to. EXPR can
556 be a number, linear=START[:END[:STEP=
1]] or
557 exp=START[:END[:BASE=
2]]. This option can be
558 used multiple times to set the sleep for the
559 different retry types, e.g. --retry-sleep
560 linear=
1::
2 --retry-sleep fragment:exp=
1:
20
561 --skip-unavailable-fragments Skip unavailable fragments for DASH,
562 hlsnative and ISM downloads (default)
563 (Alias: --no-abort-on-unavailable-fragments)
564 --abort-on-unavailable-fragments
565 Abort download if a fragment is unavailable
566 (Alias: --no-skip-unavailable-fragments)
567 --keep-fragments Keep downloaded fragments on disk after
568 downloading is finished
569 --no-keep-fragments Delete downloaded fragments after
570 downloading is finished (default)
571 --buffer-size SIZE Size of download buffer, e.g.
1024 or
16K
573 --resize-buffer The buffer size is automatically resized
574 from an initial value of --buffer-size
576 --no-resize-buffer Do not automatically adjust the buffer size
577 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
578 downloading, e.g.
10485760 or
10M (default
579 is disabled). May be useful for bypassing
580 bandwidth throttling imposed by a webserver
582 --playlist-random Download playlist videos in random order
583 --lazy-playlist Process entries in the playlist as they are
584 received. This disables n_entries,
585 --playlist-random and --playlist-reverse
586 --no-lazy-playlist Process videos in the playlist only after
587 the entire playlist is parsed (default)
588 --xattr-set-filesize Set file xattribute ytdl.filesize with
590 --hls-use-mpegts Use the mpegts container for HLS videos;
591 allowing some players to play the video
592 while downloading, and reducing the chance
593 of file corruption if download is
594 interrupted. This is enabled by default for
596 --no-hls-use-mpegts Do not use the mpegts container for HLS
597 videos. This is default when not downloading
599 --download-sections REGEX Download only chapters whose title matches
600 the given regular expression. Time ranges
601 prefixed by a "*" can also be used in place
602 of chapters to download the specified range.
603 Needs ffmpeg. This option can be used
604 multiple times to download multiple
605 sections, e.g. --download-sections
606 "*
10:
15-inf" --download-sections "intro"
607 --downloader [PROTO:]NAME Name or path of the external downloader to
608 use (optionally) prefixed by the protocols
609 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
610 use it for. Currently supports native,
611 aria2c, avconv, axel, curl, ffmpeg, httpie,
612 wget. You can use this option multiple times
613 to set different downloaders for different
614 protocols. E.g. --downloader aria2c
615 --downloader "dash,m3u8:native" will use
616 aria2c for http/ftp downloads, and the
617 native downloader for dash/m3u8 downloads
618 (Alias: --external-downloader)
619 --downloader-args NAME:ARGS Give these arguments to the external
620 downloader. Specify the downloader name and
621 the arguments separated by a colon ":". For
622 ffmpeg, arguments can be passed to different
623 positions using the same syntax as
624 --postprocessor-args. You can use this
625 option multiple times to give different
626 arguments to different downloaders (Alias:
627 --external-downloader-args)
629 ## Filesystem Options:
630 -a, --batch-file FILE File containing URLs to download ("-" for
631 stdin), one URL per line. Lines starting
632 with "#", ";" or "]" are considered as
634 --no-batch-file Do not read URLs from batch file (default)
635 -P, --paths [TYPES:]PATH The paths where the files should be
636 downloaded. Specify the type of file and the
637 path separated by a colon ":". All the same
638 TYPES as --output are supported.
639 Additionally, you can also provide "home"
640 (default) and "temp" paths. All intermediary
641 files are first downloaded to the temp path
642 and then the final files are moved over to
643 the home path after download is finished.
644 This option is ignored if --output is an
646 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
647 TEMPLATE" for details
648 --output-na-placeholder TEXT Placeholder for unavailable fields in
649 "OUTPUT TEMPLATE" (default: "NA")
650 --restrict-filenames Restrict filenames to only ASCII characters,
651 and avoid "&" and spaces in filenames
652 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
654 --windows-filenames Force filenames to be Windows-compatible
655 --no-windows-filenames Make filenames Windows-compatible only if
656 using Windows (default)
657 --trim-filenames LENGTH Limit the filename length (excluding
658 extension) to the specified number of
660 -w, --no-overwrites Do not overwrite any files
661 --force-overwrites Overwrite all video and metadata files. This
662 option includes --no-continue
663 --no-force-overwrites Do not overwrite the video, but overwrite
664 related files (default)
665 -c, --continue Resume partially downloaded files/fragments
667 --no-continue Do not resume partially downloaded
668 fragments. If the file is not fragmented,
669 restart download of the entire file
670 --part Use .part files instead of writing directly
671 into output file (default)
672 --no-part Do not use .part files - write directly into
674 --mtime Use the Last-modified header to set the file
675 modification time (default)
676 --no-mtime Do not use the Last-modified header to set
677 the file modification time
678 --write-description Write video description to a .description file
679 --no-write-description Do not write video description (default)
680 --write-info-json Write video metadata to a .info.json file
681 (this may contain personal information)
682 --no-write-info-json Do not write video metadata (default)
683 --write-playlist-metafiles Write playlist metadata in addition to the
684 video metadata when using --write-info-json,
685 --write-description etc. (default)
686 --no-write-playlist-metafiles Do not write playlist metadata when using
687 --write-info-json, --write-description etc.
688 --clean-info-json Remove some private fields such as filenames
689 from the infojson. Note that it could still
690 contain some personal information (default)
691 --no-clean-info-json Write all fields to the infojson
692 --write-comments Retrieve video comments to be placed in the
693 infojson. The comments are fetched even
694 without this option if the extraction is
695 known to be quick (Alias: --get-comments)
696 --no-write-comments Do not retrieve video comments unless the
697 extraction is known to be quick (Alias:
699 --load-info-json FILE JSON file containing the video information
700 (created with the "--write-info-json" option)
701 --cookies FILE Netscape formatted file to read cookies from
702 and dump cookie jar in
703 --no-cookies Do not read/dump cookies from/to file
705 --cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]
706 The name of the browser to load cookies
707 from. Currently supported browsers are:
708 brave, chrome, chromium, edge, firefox,
709 opera, safari, vivaldi. Optionally, the
710 KEYRING used for decrypting Chromium cookies
711 on Linux, the name/path of the PROFILE to
712 load cookies from, and the CONTAINER name
713 (if Firefox) ("none" for no container) can
714 be given with their respective seperators.
715 By default, all containers of the most
716 recently accessed profile are used.
717 Currently supported keyrings are: basictext,
718 gnomekeyring, kwallet
719 --no-cookies-from-browser Do not load cookies from browser (default)
720 --cache-dir DIR Location in the filesystem where yt-dlp can
721 store some downloaded information (such as
722 client ids and signatures) permanently. By
723 default ${XDG_CACHE_HOME}/yt-dlp
724 --no-cache-dir Disable filesystem caching
725 --rm-cache-dir Delete all filesystem cache files
727 ## Thumbnail Options:
728 --write-thumbnail Write thumbnail image to disk
729 --no-write-thumbnail Do not write thumbnail image to disk (default)
730 --write-all-thumbnails Write all thumbnail image formats to disk
731 --list-thumbnails List available thumbnails of each video.
732 Simulate unless --no-simulate is used
734 ## Internet Shortcut Options:
735 --write-link Write an internet shortcut file, depending
736 on the current platform (.url, .webloc or
737 .desktop). The URL may be cached by the OS
738 --write-url-link Write a .url Windows internet shortcut. The
739 OS caches the URL based on the file path
740 --write-webloc-link Write a .webloc macOS internet shortcut
741 --write-desktop-link Write a .desktop Linux internet shortcut
743 ## Verbosity and Simulation Options:
744 -q, --quiet Activate quiet mode. If used with --verbose,
745 print the log to stderr
746 --no-warnings Ignore warnings
747 -s, --simulate Do not download the video and do not write
749 --no-simulate Download the video even if printing/listing
751 --ignore-no-formats-error Ignore "No video formats" error. Useful for
752 extracting metadata even if the videos are
753 not actually available for download
755 --no-ignore-no-formats-error Throw error when no downloadable video
756 formats are found (default)
757 --skip-download Do not download the video but write all
758 related files (Alias: --no-download)
759 -O, --print [WHEN:]TEMPLATE Field name or output template to print to
760 screen, optionally prefixed with when to
761 print it, separated by a ":". Supported
762 values of "WHEN" are the same as that of
763 --use-postprocessor (default: video).
764 Implies --quiet. Implies --simulate unless
765 --no-simulate or later stages of WHEN are
766 used. This option can be used multiple times
767 --print-to-file [WHEN:]TEMPLATE FILE
768 Append given template to the file. The
769 values of WHEN and TEMPLATE are same as that
770 of --print. FILE uses the same syntax as the
771 output template. This option can be used
773 -j, --dump-json Quiet, but print JSON information for each
774 video. Simulate unless --no-simulate is
775 used. See "OUTPUT TEMPLATE" for a
776 description of available keys
777 -J, --dump-single-json Quiet, but print JSON information for each
778 url or infojson passed. Simulate unless
779 --no-simulate is used. If the URL refers to
780 a playlist, the whole playlist information
781 is dumped in a single line
782 --force-write-archive Force download archive entries to be written
783 as far as no errors occur, even if -s or
784 another simulation option is used (Alias:
785 --force-download-archive)
786 --newline Output progress bar as new lines
787 --no-progress Do not print progress bar
788 --progress Show progress bar, even if in quiet mode
789 --console-title Display progress in console titlebar
790 --progress-template [TYPES:]TEMPLATE
791 Template for progress outputs, optionally
792 prefixed with one of "download:" (default),
793 "download-title:" (the console title),
794 "postprocess:", or "postprocess-title:".
795 The video's fields are accessible under the
796 "info" key and the progress attributes are
797 accessible under "progress" key. E.g.
798 --console-title --progress-template
799 "download-title:%(info.id)s-%(progress.eta)s"
800 -v, --verbose Print various debugging information
801 --dump-pages Print downloaded pages encoded using base64
802 to debug problems (very verbose)
803 --write-pages Write downloaded intermediary pages to files
804 in the current directory to debug problems
805 --print-traffic Display sent and read HTTP traffic
808 --encoding ENCODING Force the specified encoding (experimental)
809 --legacy-server-connect Explicitly allow HTTPS connection to servers
810 that do not support RFC
5746 secure
812 --no-check-certificates Suppress HTTPS certificate validation
813 --prefer-insecure Use an unencrypted connection to retrieve
814 information about the video (Currently
815 supported only for YouTube)
816 --add-headers FIELD:VALUE Specify a custom HTTP header and its value,
817 separated by a colon ":". You can use this
818 option multiple times
819 --bidi-workaround Work around terminals that lack
820 bidirectional text support. Requires bidiv
821 or fribidi executable in PATH
822 --sleep-requests SECONDS Number of seconds to sleep between requests
823 during data extraction
824 --sleep-interval SECONDS Number of seconds to sleep before each
825 download. This is the minimum time to sleep
826 when used along with --max-sleep-interval
827 (Alias: --min-sleep-interval)
828 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can only
829 be used along with --min-sleep-interval
830 --sleep-subtitles SECONDS Number of seconds to sleep before each
833 ## Video Format Options:
834 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
836 -S, --format-sort SORTORDER Sort the formats by the fields given, see
837 "Sorting Formats" for more details
838 --format-sort-force Force user specified sort order to have
839 precedence over all fields, see "Sorting
840 Formats" for more details (Alias: --S-force)
841 --no-format-sort-force Some fields have precedence over the user
842 specified sort order (default)
843 --video-multistreams Allow multiple video streams to be merged
845 --no-video-multistreams Only one video stream is downloaded for each
846 output file (default)
847 --audio-multistreams Allow multiple audio streams to be merged
849 --no-audio-multistreams Only one audio stream is downloaded for each
850 output file (default)
851 --prefer-free-formats Prefer video formats with free containers
852 over non-free ones of same quality. Use with
853 "-S ext" to strictly prefer free containers
854 irrespective of quality
855 --no-prefer-free-formats Don't give any special preference to free
857 --check-formats Make sure formats are selected only from
858 those that are actually downloadable
859 --check-all-formats Check all formats for whether they are
860 actually downloadable
861 --no-check-formats Do not check that the formats are actually
863 -F, --list-formats List available formats of each video.
864 Simulate unless --no-simulate is used
865 --merge-output-format FORMAT Containers that may be used when merging
866 formats, separated by "/", e.g. "mp4/mkv".
867 Ignored if no merge is required. (currently
868 supported: avi, flv, mkv, mov, mp4, webm)
871 --write-subs Write subtitle file
872 --no-write-subs Do not write subtitle file (default)
873 --write-auto-subs Write automatically generated subtitle file
874 (Alias: --write-automatic-subs)
875 --no-write-auto-subs Do not write auto-generated subtitles
876 (default) (Alias: --no-write-automatic-subs)
877 --list-subs List available subtitles of each video.
878 Simulate unless --no-simulate is used
879 --sub-format FORMAT Subtitle format; accepts formats preference,
880 e.g. "srt" or "ass/srt/best"
881 --sub-langs LANGS Languages of the subtitles to download (can
882 be regex) or "all" separated by commas, e.g.
883 --sub-langs "en.*,ja". You can prefix the
884 language code with a "-" to exclude it from
885 the requested languages, e.g. --sub-langs
886 all,-live_chat. Use --list-subs for a list
887 of available language tags
889 ## Authentication Options:
890 -u, --username USERNAME Login with this account ID
891 -p, --password PASSWORD Account password. If this option is left
892 out, yt-dlp will ask interactively
893 -2, --twofactor TWOFACTOR Two-factor authentication code
894 -n, --netrc Use .netrc authentication data
895 --netrc-location PATH Location of .netrc authentication data;
896 either the path or its containing directory.
898 --video-password PASSWORD Video password (vimeo, youku)
899 --ap-mso MSO Adobe Pass multiple-system operator (TV
900 provider) identifier, use --ap-list-mso for
901 a list of available MSOs
902 --ap-username USERNAME Multiple-system operator account login
903 --ap-password PASSWORD Multiple-system operator account password.
904 If this option is left out, yt-dlp will ask
906 --ap-list-mso List all supported multiple-system operators
907 --client-certificate CERTFILE Path to client certificate file in PEM
908 format. May include the private key
909 --client-certificate-key KEYFILE
910 Path to private key file for client
912 --client-certificate-password PASSWORD
913 Password for client certificate private key,
914 if encrypted. If not provided, and the key
915 is encrypted, yt-dlp will ask interactively
917 ## Post-Processing Options:
918 -x, --extract-audio Convert video files to audio-only files
919 (requires ffmpeg and ffprobe)
920 --audio-format FORMAT Format to convert the audio to when -x is
921 used. (currently supported: best (default),
922 aac, alac, flac, m4a, mp3, opus, vorbis,
923 wav). You can specify multiple rules using
924 similar syntax as --remux-video
925 --audio-quality QUALITY Specify ffmpeg audio quality to use when
926 converting the audio with -x. Insert a value
927 between
0 (best) and
10 (worst) for VBR or a
928 specific bitrate like
128K (default
5)
929 --remux-video FORMAT Remux the video into another container if
930 necessary (currently supported: avi, flv,
931 gif, mkv, mov, mp4, webm, aac, aiff, alac,
932 flac, m4a, mka, mp3, ogg, opus, vorbis,
933 wav). If target container does not support
934 the video/audio codec, remuxing will fail.
935 You can specify multiple rules; e.g.
936 "aac>m4a/mov>mp4/mkv" will remux aac to m4a,
937 mov to mp4 and anything else to mkv
938 --recode-video FORMAT Re-encode the video into another format if
939 necessary. The syntax and supported formats
940 are the same as --remux-video
941 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
942 Specify the postprocessor/executable name
943 and the arguments separated by a colon ":"
944 to give the argument to the specified
945 postprocessor/executable. Supported PP are:
946 Merger, ModifyChapters, SplitChapters,
947 ExtractAudio, VideoRemuxer, VideoConvertor,
948 Metadata, EmbedSubtitle, EmbedThumbnail,
949 SubtitlesConvertor, ThumbnailsConvertor,
950 FixupStretched, FixupM4a, FixupM3u8,
951 FixupTimestamp and FixupDuration. The
952 supported executables are: AtomicParsley,
953 FFmpeg and FFprobe. You can also specify
954 "PP+EXE:ARGS" to give the arguments to the
955 specified executable only when being used by
956 the specified postprocessor. Additionally,
957 for ffmpeg/ffprobe, "_i"/"_o" can be
958 appended to the prefix optionally followed
959 by a number to pass the argument before the
960 specified input/output file, e.g. --ppa
961 "Merger+ffmpeg_i1:-v quiet". You can use
962 this option multiple times to give different
963 arguments to different postprocessors.
965 -k, --keep-video Keep the intermediate video file on disk
966 after post-processing
967 --no-keep-video Delete the intermediate video file after
968 post-processing (default)
969 --post-overwrites Overwrite post-processed files (default)
970 --no-post-overwrites Do not overwrite post-processed files
971 --embed-subs Embed subtitles in the video (only for mp4,
973 --no-embed-subs Do not embed subtitles (default)
974 --embed-thumbnail Embed thumbnail in the video as cover art
975 --no-embed-thumbnail Do not embed thumbnail (default)
976 --embed-metadata Embed metadata to the video file. Also
977 embeds chapters/infojson if present unless
978 --no-embed-chapters/--no-embed-info-json are
979 used (Alias: --add-metadata)
980 --no-embed-metadata Do not add metadata to file (default)
981 (Alias: --no-add-metadata)
982 --embed-chapters Add chapter markers to the video file
983 (Alias: --add-chapters)
984 --no-embed-chapters Do not add chapter markers (default) (Alias:
986 --embed-info-json Embed the infojson as an attachment to
988 --no-embed-info-json Do not embed the infojson as an attachment
990 --parse-metadata [WHEN:]FROM:TO
991 Parse additional metadata like title/artist
992 from other fields; see "MODIFYING METADATA"
993 for details. Supported values of "WHEN" are
994 the same as that of --use-postprocessor
995 (default: pre_process)
996 --replace-in-metadata [WHEN:]FIELDS REGEX REPLACE
997 Replace text in a metadata field using the
998 given regex. This option can be used
999 multiple times. Supported values of "WHEN"
1000 are the same as that of --use-postprocessor
1001 (default: pre_process)
1002 --xattrs Write metadata to the video file's xattrs
1003 (using dublin core and xdg standards)
1004 --concat-playlist POLICY Concatenate videos in a playlist. One of
1005 "never", "always", or "multi_video"
1006 (default; only when the videos form a single
1007 show). All the video files must have same
1008 codecs and number of streams to be
1009 concatable. The "pl_video:" prefix can be
1010 used with "--paths" and "--output" to set
1011 the output filename for the concatenated
1012 files. See "OUTPUT TEMPLATE" for details
1013 --fixup POLICY Automatically correct known faults of the
1014 file. One of never (do nothing), warn (only
1015 emit a warning), detect_or_warn (the
1016 default; fix file if we can, warn
1017 otherwise), force (try fixing even if file
1019 --ffmpeg-location PATH Location of the ffmpeg binary; either the
1020 path to the binary or its containing directory
1021 --exec [WHEN:]CMD Execute a command, optionally prefixed with
1022 when to execute it, separated by a ":".
1023 Supported values of "WHEN" are the same as
1024 that of --use-postprocessor (default:
1025 after_move). Same syntax as the output
1026 template can be used to pass any field as
1027 arguments to the command. After download, an
1028 additional field "filepath" that contains
1029 the final path of the downloaded file is
1030 also available, and if no fields are passed,
1031 %(filepath,_filename|)q is appended to the
1032 end of the command. This option can be used
1034 --no-exec Remove any previously defined --exec
1035 --convert-subs FORMAT Convert the subtitles to another format
1036 (currently supported: ass, lrc, srt, vtt)
1037 (Alias: --convert-subtitles)
1038 --convert-thumbnails FORMAT Convert the thumbnails to another format
1039 (currently supported: jpg, png, webp). You
1040 can specify multiple rules using similar
1041 syntax as --remux-video
1042 --split-chapters Split video into multiple files based on
1043 internal chapters. The "chapter:" prefix can
1044 be used with "--paths" and "--output" to set
1045 the output filename for the split files. See
1046 "OUTPUT TEMPLATE" for details
1047 --no-split-chapters Do not split video based on chapters (default)
1048 --remove-chapters REGEX Remove chapters whose title matches the
1049 given regular expression. The syntax is the
1050 same as --download-sections. This option can
1051 be used multiple times
1052 --no-remove-chapters Do not remove any chapters from the file
1054 --force-keyframes-at-cuts Force keyframes at cuts when
1055 downloading/splitting/removing sections.
1056 This is slow due to needing a re-encode, but
1057 the resulting video may have fewer artifacts
1059 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
1060 when cutting/splitting (default)
1061 --use-postprocessor NAME[:ARGS]
1062 The (case sensitive) name of plugin
1063 postprocessors to be enabled, and
1064 (optionally) arguments to be passed to it,
1065 separated by a colon ":". ARGS are a
1066 semicolon ";" delimited list of NAME=VALUE.
1067 The "when" argument determines when the
1068 postprocessor is invoked. It can be one of
1069 "pre_process" (after video extraction),
1070 "after_filter" (after video passes filter),
1071 "video" (after --format; before
1072 --print/--output), "before_dl" (before each
1073 video download), "post_process" (after each
1074 video download; default), "after_move"
1075 (after moving video file to it's final
1076 locations), "after_video" (after downloading
1077 and processing all formats of a video), or
1078 "playlist" (at end of playlist). This option
1079 can be used multiple times to add different
1082 ## SponsorBlock Options:
1083 Make chapter entries for, or remove various segments (sponsor,
1084 introductions, etc.) from downloaded YouTube videos using the
1085 [SponsorBlock API](https://sponsor.ajay.app)
1087 --sponsorblock-mark CATS SponsorBlock categories to create chapters
1088 for, separated by commas. Available
1089 categories are sponsor, intro, outro,
1090 selfpromo, preview, filler, interaction,
1091 music_offtopic, poi_highlight, chapter, all
1092 and default (=all). You can prefix the
1093 category with a "-" to exclude it. See [
1]
1094 for description of the categories. E.g.
1095 --sponsorblock-mark all,-preview
1096 [
1] https://wiki.sponsor.ajay.app/w/Segment_Categories
1097 --sponsorblock-remove CATS SponsorBlock categories to be removed from
1098 the video file, separated by commas. If a
1099 category is present in both mark and remove,
1100 remove takes precedence. The syntax and
1101 available categories are the same as for
1102 --sponsorblock-mark except that "default"
1103 refers to "all,-filler" and poi_highlight,
1104 chapter are not available
1105 --sponsorblock-chapter-title TEMPLATE
1106 An output template for the title of the
1107 SponsorBlock chapters created by
1108 --sponsorblock-mark. The only available
1109 fields are start_time, end_time, category,
1110 categories, name, category_names. Defaults
1111 to "[SponsorBlock]: %(category_names)l"
1112 --no-sponsorblock Disable both --sponsorblock-mark and
1113 --sponsorblock-remove
1114 --sponsorblock-api URL SponsorBlock API location, defaults to
1115 https://sponsor.ajay.app
1117 ## Extractor Options:
1118 --extractor-retries RETRIES Number of retries for known extractor errors
1119 (default is
3), or "infinite"
1120 --allow-dynamic-mpd Process dynamic DASH manifests (default)
1121 (Alias: --no-ignore-dynamic-mpd)
1122 --ignore-dynamic-mpd Do not process dynamic DASH manifests
1123 (Alias: --no-allow-dynamic-mpd)
1124 --hls-split-discontinuity Split HLS playlists to different formats at
1125 discontinuities such as ad breaks
1126 --no-hls-split-discontinuity Do not split HLS playlists to different
1127 formats at discontinuities such as ad breaks
1129 --extractor-args IE_KEY:ARGS Pass ARGS arguments to the IE_KEY extractor.
1130 See "EXTRACTOR ARGUMENTS" for details. You
1131 can use this option multiple times to give
1132 arguments for different extractors
1136 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
1138 1. **Main Configuration**:
1139 * The file given by
`--config-location`
1140 1. **Portable Configuration**: (Recommended for portable installations)
1141 * If using a binary,
`yt-dlp.conf` in the same directory as the binary
1142 * If running from source-code,
`yt-dlp.conf` in the parent directory of
`yt_dlp`
1143 1. **Home Configuration**:
1144 * `yt-dlp.conf` in the home path given by
`-P`
1145 * If
`-P` is not given, the current directory is searched
1146 1. **User Configuration**:
1147 * `${XDG_CONFIG_HOME}/yt-dlp.conf`
1148 * `${XDG_CONFIG_HOME}/yt-dlp/config` (recommended on Linux/macOS)
1149 * `${XDG_CONFIG_HOME}/yt-dlp/config.txt`
1150 * `${APPDATA}/yt-dlp.conf`
1151 * `${APPDATA}/yt-dlp/config` (recommended on Windows)
1152 * `${APPDATA}/yt-dlp/config.txt`
1154 * `~/yt-dlp.conf.txt`
1155 * `~/.yt-dlp/config`
1156 * `~/.yt-dlp/config.txt`
1158 See also: [Notes about environment variables](#notes-about-environment-variables)
1159 1. **System Configuration**:
1160 * `/etc/yt-dlp.conf`
1161 * `/etc/yt-dlp/config`
1162 * `/etc/yt-dlp/config.txt`
1164 E.g. with the following configuration file yt-dlp will always extract the audio, not copy the mtime, use a proxy and save all videos under
`YouTube` directory in your home directory:
1166 # Lines starting with # are comments
1168 # Always extract audio
1171 # Do not copy the mtime
1175 --proxy 127.0.0.1:3128
1177 # Save all videos under YouTube directory in your home directory
1178 -o ~/YouTube/%(title)s.%(ext)s
1181 **Note**: Options in configuration file are just the same options aka switches used in regular command line calls; thus there **must be no whitespace** after
`-` or
`--`, e.g.
`-o` or
`--proxy` but not
`- o` or
`-- proxy`. They must also be quoted when necessary as-if it were a UNIX shell.
1183 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.
1185 ### Configuration file encoding
1187 The configuration files are decoded according to the UTF BOM if present, and in the encoding from system locale otherwise.
1189 If you want your file to be decoded differently, add
`# coding: ENCODING` to the beginning of the file (e.g.
`# coding: shift-jis`). There must be no characters before that, even spaces or BOM.
1191 ### Authentication with `.netrc` file
1193 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:
1195 touch ${HOME}/.netrc
1196 chmod a-rwx,u+rw ${HOME}/.netrc
1198 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1200 machine <extractor> login <username> password <password>
1204 machine youtube login myaccount@gmail.com password my_youtube_password
1205 machine twitch login my_twitch_account_name password my_twitch_password
1207 To activate authentication with the
`.netrc` file you should pass
`--netrc` to yt-dlp or place it in the [configuration file](#configuration).
1209 The default location of the .netrc file is
`~` (see below).
1211 ### Notes about environment variables
1212 * Environment variables are normally specified as
`${VARIABLE}`/
`$VARIABLE` on UNIX and
`%VARIABLE%` on Windows; but is always shown as
`${VARIABLE}` in this documentation
1213 * yt-dlp also allow using UNIX-style variables on Windows for path-like options; e.g.
`--output`,
`--config-location`
1214 * If unset,
`${XDG_CONFIG_HOME}` defaults to
`~/.config` and
`${XDG_CACHE_HOME}` to
`~/.cache`
1215 * On Windows,
`~` points to
`${HOME}` if present; or,
`${USERPROFILE}` or
`${HOMEDRIVE}${HOMEPATH}` otherwise
1216 * On Windows,
`${USERPROFILE}` generally points to
`C:\Users\<user name>` and
`${APPDATA}` to
`${USERPROFILE}\AppData\Roaming`
1220 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.
1222 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1223 **tl;dr:** [navigate me to examples](#output-template-examples).
1224 <!-- MANPAGE: END EXCLUDED SECTION -->
1226 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).
1228 It may however also contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to
[Python string formatting operations](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting), e.g.
`%(NAME)s` or
`%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations.
1230 The field names themselves (the part inside the parenthesis) can also have some special formatting:
1232 1. **Object traversal**: The dictionaries and lists available in metadata can be traversed by using a dot
`.` separator; e.g.
`%(tags.0)s`,
`%(subtitles.en.-1.ext)s`. You can do Python slicing with colon
`:`; E.g.
`%(id.3:7:-1)s`,
`%(formats.:.format_id)s`. Curly braces
`{}` can be used to build dictionaries with only specific keys; e.g.
`%(formats.:.{format_id,height})#j`. An empty field name
`%()s` refers to the entire infodict; e.g.
`%(.{id,title})s`. Note that all the fields that become available using this method are not listed below. Use
`-j` to see such fields
1234 1. **Addition**: Addition and subtraction of numeric fields can be done using
`+` and
`-` respectively. E.g.
`%(playlist_index+10)03d`,
`%(n_entries+1-playlist_index)d`
1236 1. **Date/time Formatting**: Date/time fields can be formatted according to
[strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it separated from the field name using a
`>`. E.g.
`%(duration>%H-%M-%S)s`,
`%(upload_date>%Y-%m-%d)s`,
`%(epoch-3600>%H-%M-%S)s`
1238 1. **Alternatives**: Alternate fields can be specified separated with a
`,`. E.g.
`%(release_date>%Y,upload_date>%Y|Unknown)s`
1240 1. **Replacement**: A replacement value can be specified using a
`&` separator. If the field is *not* empty, this replacement value will be used instead of the actual field content. This is done after alternate fields are considered; thus the replacement is used if *any* of the alternative fields is *not* empty.
1242 1. **Default**: A literal default value can be specified for when the field is empty using a
`|` separator. This overrides
`--output-na-placeholder`. E.g.
`%(uploader|Unknown)s`
1244 1. **More Conversions**: In addition to the normal format types
`diouxXeEfFgGcrs`, yt-dlp additionally supports converting to
`B` = **B**ytes,
`j` = **j**son (flag
`#` for pretty-printing,
`+` for Unicode),
`h` = HTML escaping,
`l` = a comma separated **l**ist (flag
`#` for
`\n` newline-separated),
`q` = a string **q**uoted for the terminal (flag
`#` to split a list into different arguments),
`D` = add **D**ecimal suffixes (e.g.
10M) (flag
`#` to use
1024 as factor), and
`S` = **S**anitize as filename (flag
`#` for restricted)
1246 1. **Unicode normalization**: The format type
`U` can be used for NFC
[Unicode normalization](https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize). The alternate form flag (
`#`) changes the normalization to NFD and the conversion flag
`+` can be used for NFKC/NFKD compatibility equivalence normalization. E.g.
`%(title)+.100U` is NFKC
1248 To summarize, the general syntax for a field is:
1250 %(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
1253 Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon
`:`. The different file types supported are
`subtitle`,
`thumbnail`,
`description`,
`annotation` (deprecated),
`infojson`,
`link`,
`pl_thumbnail`,
`pl_description`,
`pl_infojson`,
`chapter`,
`pl_video`. E.g.
`-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"` will put the thumbnails in a folder with the same name as the video. If any of the templates is empty, that type of file will not be written. E.g.
`--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
1255 <a id="outtmpl-postprocess-note"></a>
1257 **Note**: Due to post-processing (i.e. merging etc.), the actual output filename might differ. Use
`--print after_move:filepath` to get the name after all post-processing is complete.
1259 The available fields are:
1261 - `id` (string): Video identifier
1262 - `title` (string): Video title
1263 - `fulltitle` (string): Video title ignoring live timestamp and generic title
1264 - `ext` (string): Video filename extension
1265 - `alt_title` (string): A secondary title of the video
1266 - `description` (string): The description of the video
1267 - `display_id` (string): An alternative identifier for the video
1268 - `uploader` (string): Full name of the video uploader
1269 - `license` (string): License name the video is licensed under
1270 - `creator` (string): The creator of the video
1271 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
1272 - `upload_date` (string): Video upload date in UTC (YYYYMMDD)
1273 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
1274 - `release_date` (string): The date (YYYYMMDD) when the video was released in UTC
1275 - `modified_timestamp` (numeric): UNIX timestamp of the moment the video was last modified
1276 - `modified_date` (string): The date (YYYYMMDD) when the video was last modified in UTC
1277 - `uploader_id` (string): Nickname or id of the video uploader
1278 - `channel` (string): Full name of the channel the video is uploaded on
1279 - `channel_id` (string): Id of the channel
1280 - `channel_follower_count` (numeric): Number of followers of the channel
1281 - `location` (string): Physical location where the video was filmed
1282 - `duration` (numeric): Length of the video in seconds
1283 - `duration_string` (string): Length of the video (HH:mm:ss)
1284 - `view_count` (numeric): How many users have watched the video on the platform
1285 - `concurrent_view_count` (numeric): How many users are currently watching the video on the platform.
1286 - `like_count` (numeric): Number of positive ratings of the video
1287 - `dislike_count` (numeric): Number of negative ratings of the video
1288 - `repost_count` (numeric): Number of reposts of the video
1289 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
1290 - `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)
1291 - `age_limit` (numeric): Age restriction for the video (years)
1292 - `live_status` (string): One of "not_live", "is_live", "is_upcoming", "was_live", "post_live" (was live, but VOD is not yet processed)
1293 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
1294 - `was_live` (boolean): Whether this video was originally a live stream
1295 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
1296 - `availability` (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
1297 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1298 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
1299 - `extractor` (string): Name of the extractor
1300 - `extractor_key` (string): Key name of the extractor
1301 - `epoch` (numeric): Unix epoch of when the information extraction was completed
1302 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
1303 - `video_autonumber` (numeric): Number that will be increased with each video
1304 - `n_entries` (numeric): Total number of extracted items in the playlist
1305 - `playlist_id` (string): Identifier of the playlist that contains the video
1306 - `playlist_title` (string): Name of the playlist that contains the video
1307 - `playlist` (string):
`playlist_id` or
`playlist_title`
1308 - `playlist_count` (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
1309 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1310 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
1311 - `playlist_uploader` (string): Full name of the playlist uploader
1312 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
1313 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
1314 - `webpage_url_basename` (string): The basename of the webpage URL
1315 - `webpage_url_domain` (string): The domain of the webpage URL
1316 - `original_url` (string): The URL given by the user (or same as
`webpage_url` for playlist entries)
1318 All the fields in [Filtering Formats](#filtering-formats) can also be used
1320 Available for the video that belongs to some logical chapter or section:
1322 - `chapter` (string): Name or title of the chapter the video belongs to
1323 - `chapter_number` (numeric): Number of the chapter the video belongs to
1324 - `chapter_id` (string): Id of the chapter the video belongs to
1326 Available for the video that is an episode of some series or programme:
1328 - `series` (string): Title of the series or programme the video episode belongs to
1329 - `season` (string): Title of the season the video episode belongs to
1330 - `season_number` (numeric): Number of the season the video episode belongs to
1331 - `season_id` (string): Id of the season the video episode belongs to
1332 - `episode` (string): Title of the video episode
1333 - `episode_number` (numeric): Number of the video episode within a season
1334 - `episode_id` (string): Id of the video episode
1336 Available for the media that is a track or a part of a music album:
1338 - `track` (string): Title of the track
1339 - `track_number` (numeric): Number of the track within an album or a disc
1340 - `track_id` (string): Id of the track
1341 - `artist` (string): Artist(s) of the track
1342 - `genre` (string): Genre(s) of the track
1343 - `album` (string): Title of the album the track belongs to
1344 - `album_type` (string): Type of the album
1345 - `album_artist` (string): List of all artists appeared on the album
1346 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1347 - `release_year` (numeric): Year (YYYY) when the album was released
1349 Available only when using
`--download-sections` and for
`chapter:` prefix when using
`--split-chapters` for videos with internal chapters:
1351 - `section_title` (string): Title of the chapter
1352 - `section_number` (numeric): Number of the chapter within the file
1353 - `section_start` (numeric): Start time of the chapter in seconds
1354 - `section_end` (numeric): End time of the chapter in seconds
1356 Available only when used in
`--print`:
1358 - `urls` (string): The URLs of all requested formats, one in each line
1359 - `filename` (string): Name of the video file. Note that the [actual filename may differ](#outtmpl-postprocess-note)
1360 - `formats_table` (table): The video format table as printed by
`--list-formats`
1361 - `thumbnails_table` (table): The thumbnail format table as printed by
`--list-thumbnails`
1362 - `subtitles_table` (table): The subtitle format table as printed by
`--list-subs`
1363 - `automatic_captions_table` (table): The automatic subtitle format table as printed by
`--list-subs`
1366 Available only in
`--sponsorblock-chapter-title`:
1368 - `start_time` (numeric): Start time of the chapter in seconds
1369 - `end_time` (numeric): End time of the chapter in seconds
1370 - `categories` (list): The
[SponsorBlock categories](https://wiki.sponsor.ajay.app/w/Types#Category) the chapter belongs to
1371 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1372 - `category_names` (list): Friendly names of the categories
1373 - `name` (string): Friendly name of the smallest category
1374 - `type` (string): The
[SponsorBlock action type](https://wiki.sponsor.ajay.app/w/Types#Action_Type) of the chapter
1376 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. E.g. for
`-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title
`yt-dlp test video` and id
`BaW_jenozKc`, this will result in a
`yt-dlp test video-BaW_jenozKc.mp4` file created in the current directory.
1378 **Note**: Some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with
`--output-na-placeholder` (
`NA` by default).
1380 **Tip**: Look at the
`-j` output to identify which fields are available for the particular URL
1382 For numeric sequences you can use
[numeric related formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting); e.g.
`%(view_count)05d` will result in a string with view count padded with zeros up to
5 characters, like in
`00042`.
1384 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.
1386 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
1388 The current default template is
`%(title)s [%(id)s].%(ext)s`.
1390 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.
1392 #### Output template examples
1395 $ yt-dlp --print filename -o "test video.%(ext)s" BaW_jenozKc
1396 test video.webm # Literal name with correct extension
1398 $ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc
1399 youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
1401 $ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
1402 youtube-dl_test_video_.webm # Restricted file name
1404 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1405 $ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1407 # Download YouTube playlist videos in separate directories according to their uploaded year
1408 $ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1410 # Prefix playlist index with " - " separator, but only if it is available
1411 $ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1413 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1414 $ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1416 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1417 $ 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"
1419 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1420 $ 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"
1422 # Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
1423 # and put all temporary files in "C:\MyVideos\tmp"
1424 $ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs
1426 # Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
1427 $ yt-dlp -P "C:/MyVideos" -o "%(uploader)s/%(title)s.%(ext)s" -o "subtitle:%(uploader)s/subs/%(title)s.%(ext)s" BaW_jenozKc --write-subs
1429 # Stream the video being downloaded to stdout
1430 $ yt-dlp -o - BaW_jenozKc
1435 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1436 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`.
1438 **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.
1440 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.
1442 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1443 **tl;dr:** [navigate me to examples](#format-selection-examples).
1444 <!-- MANPAGE: END EXCLUDED SECTION -->
1446 The simplest case is requesting a specific format; e.g. with
`-f 22` you can download the format with format code equal to
22. You can get the list of available format codes for particular video using
`--list-formats` or
`-F`. Note that these format codes are extractor specific.
1448 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.
1450 You can use
`-f -` to interactively provide the format selector *for each video*
1452 You can also use special names to select particular edge case formats:
1454 - `all`: Select **all formats** separately
1455 - `mergeall`: Select and **merge all formats** (Must be used with
`--audio-multistreams`,
`--video-multistreams` or both)
1456 - `b*`,
`best*`: Select the best quality format that **contains either** a video or an audio or both (ie;
`vcodec!=none or acodec!=none`)
1457 - `b`,
`best`: Select the best quality format that **contains both** video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
1458 - `bv`,
`bestvideo`: Select the best quality **video-only** format. Equivalent to
`best*[acodec=none]`
1459 - `bv*`,
`bestvideo*`: Select the best quality format that **contains video**. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
1460 - `ba`,
`bestaudio`: Select the best quality **audio-only** format. Equivalent to
`best*[vcodec=none]`
1461 - `ba*`,
`bestaudio*`: Select the best quality format that **contains audio**. It may also contain video. Equivalent to
`best*[acodec!=none]` ([Do not use!](https://github.com/yt-dlp/yt-dlp/issues/979#issuecomment-919629354))
1462 - `w*
`, `worst*
`: Select the worst quality format that contains either a video or an audio
1463 - `w
`, `worst
`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]
`
1464 - `wv
`, `worstvideo
`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]
`
1465 - `wv*
`, `worstvideo*
`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]
`
1466 - `wa
`, `worstaudio
`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]
`
1467 - `wa*
`, `worstaudio*
`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]
`
1469 For example, to download the worst quality video-only format you can use `-f worstvideo
`. It is however recommended not to use `worst
` and related options. When your format selector is `worst
`, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-S +size
` or more rigorously, `-S +size,+br,+res,+fps
` instead of `-f worst
`. See [Sorting Formats](#sorting-formats) for more details.
1471 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.
1473 If you want to download multiple videos, and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred; e.g. `-f
22/
17/
18` will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
1475 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
`.
1477 You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...
` (requires ffmpeg installed); e.g. `-f bestvideo+bestaudio
` will download the best video-only format, the best audio-only format and mux them together with ffmpeg.
1479 **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
1481 Unless `--video-multistreams
` is used, all formats with a video stream except the first one are ignored. Similarly, unless `--audio-multistreams
` is used, all formats with an audio stream except the first one are ignored. E.g. `-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams
` will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But `-f bestvideo+best+bestaudio --no-video-multistreams
` will download and merge only `bestvideo
` and `bestaudio
`. `best
` is ignored since another format containing a video stream (`bestvideo
`) has already been selected. The order of the formats is therefore important. `-f best+bestaudio --no-audio-multistreams
` will download only `best
` while `-f bestaudio+best --no-audio-multistreams
` will ignore `best
` and download only `bestaudio
`.
1483 ## Filtering Formats
1485 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=
720]"
` (or `-f "[filesize>
10M]"
`).
1487 The following numeric meta fields can be used with comparisons `<
`, `<=
`, `>
`, `>=
`, `=
` (equals), `!=
` (not equals):
1489 - `filesize
`: The number of bytes, if known in advance
1490 - `filesize_approx
`: An estimate for the number of bytes
1491 - `width
`: Width of the video, if known
1492 - `height
`: Height of the video, if known
1493 - `aspect_ratio
`: Aspect ratio of the video, if known
1494 - `tbr
`: Average bitrate of audio and video in KBit/s
1495 - `abr
`: Average audio bitrate in KBit/s
1496 - `vbr
`: Average video bitrate in KBit/s
1497 - `asr
`: Audio sampling rate in Hertz
1499 - `audio_channels
`: The number of audio channels
1500 - `stretched_ratio
`: `width:height
` of the video's pixels, if not square
1502 Also filtering work for comparisons `=
` (equals), `^=
` (starts with), `$=
` (ends with), `*=
` (contains), `~=
` (matches regex) and following string meta fields:
1505 - `ext
`: File extension
1506 - `acodec
`: Name of the audio codec in use
1507 - `vcodec
`: Name of the video codec in use
1508 - `container
`: Name of the container format
1509 - `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
`)
1510 - `language
`: Language code
1511 - `dynamic_range
`: The dynamic range of the video
1512 - `format_id
`: A short description of the format
1513 - `format
`: A human-readable description of the format
1514 - `format_note
`: Additional info about the format
1515 - `resolution
`: Textual description of width and height
1517 Any string comparison may be prefixed with negation `!
` in order to produce an opposite comparison, e.g. `!*=
` (does not contain). The comparand of a string comparison needs to be quoted with either double or single quotes if it contains spaces or special characters other than `._-
`.
1519 **Note**: None of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.
1521 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, e.g. `-f "all[vcodec=none]"
` selects all audio-only formats.
1523 Format selectors can also be grouped using parentheses; e.g. `-f "(mp4,webm)[height<
480]"
` will download the best pre-merged mp4 and webm formats with a height lower than 480.
1527 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...
`.
1529 The available fields are:
1531 - `hasvid
`: Gives priority to formats that have a video stream
1532 - `hasaud
`: Gives priority to formats that have an audio stream
1533 - `ie_pref
`: The format preference
1534 - `lang
`: The language preference
1535 - `quality
`: The quality of the format
1536 - `source
`: The preference of the source
1537 - `proto
`: Protocol used for download (`https
`/`ftps
` > `http
`/`ftp
` > `m3u8_native
`/`m3u8
` > `http_dash_segments
`> `websocket_frag
` > `mms
`/`rtsp
` > `f4f
`/`f4m
`)
1538 - `vcodec
`: Video Codec (`av01
` > `vp9.2
` > `vp9
` > `h265
` > `h264
` > `vp8
` > `h263
` > `theora
` > other)
1539 - `acodec
`: Audio Codec (`flac
`/`alac
` > `wav
`/`aiff
` > `opus
` > `vorbis
` > `aac
` > `mp4a
` > `mp3
` > `ac4
` > `eac3
` > `ac3
` > `dts
` > other)
1540 - `codec
`: Equivalent to `vcodec,acodec
`
1541 - `vext
`: Video Extension (`mp4
` > `mov
` > `webm
` > `flv
` > other). If `--prefer-free-formats
` is used, `webm
` is preferred.
1542 - `aext
`: Audio Extension (`m4a
` > `aac
` > `mp3
` > `ogg
` > `opus
` > `webm
` > other). If `--prefer-free-formats
` is used, the order changes to `ogg
` > `opus
` > `webm
` > `mp3
` > `m4a
` > `aac
`
1543 - `ext
`: Equivalent to `vext,aext
`
1544 - `filesize
`: Exact filesize, if known in advance
1545 - `fs_approx
`: Approximate filesize calculated from the manifests
1546 - `size
`: Exact filesize if available, otherwise approximate filesize
1547 - `height
`: Height of video
1548 - `width
`: Width of video
1549 - `res
`: Video resolution, calculated as the smallest dimension.
1550 - `fps
`: Framerate of video
1551 - `hdr
`: The dynamic range of the video (`DV
` > `HDR12
` > `HDR10+
` > `HDR10
` > `HLG
` > `SDR
`)
1552 - `channels
`: The number of audio channels
1553 - `tbr
`: Total average bitrate in KBit/s
1554 - `vbr
`: Average video bitrate in KBit/s
1555 - `abr
`: Average audio bitrate in KBit/s
1556 - `br
`: Equivalent to using `tbr,vbr,abr
`
1557 - `asr
`: Audio sample rate in Hz
1559 **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.
1561 All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a `+
`. E.g. `+res
` prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a `:
`. E.g. `res:
720` prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For `codec
` and `ext
`, you can provide two preferred values, the first for video and the second for audio. E.g. `+codec:avc:m4a
` (equivalent to `+vcodec:avc,+acodec:m4a
`) sets the video codec preference to `h264
` > `h265
` > `vp9
` > `vp9.2
` > `av01
` > `vp8
` > `h263
` > `theora
` and audio codec preference to `mp4a
` > `aac
` > `vorbis
` > `opus
` > `mp3
` > `ac3
` > `dts
`. You can also make the sorting prefer the nearest values to the provided by using `~
` as the delimiter. E.g. `filesize~
1G
` prefers the format with filesize closest to 1 GiB.
1563 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,vcodec:vp9.2,channels,acodec,size,br,asr,proto,ext,hasaud,source,id
`. The extractors may override this default order, but they cannot override the user-provided order.
1565 Note that the default has `vcodec:vp9.2
`; i.e. `av1
` is not preferred. Similarly, the default for hdr is `hdr:
12`; i.e. dolby vision is not preferred. These choices are made since DV and AV1 formats are not yet fully compatible with most devices. This may be changed in the future as more devices become capable of smoothly playing back these formats.
1567 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
`.
1569 **Tip**: You can use the `-v -F
` to see how the formats have been sorted (worst to best).
1571 ## Format Selection examples
1574 # Download and merge the best video-only format and the best audio-only format,
1575 # or download the best combined format if video-only format is not available
1576 $ yt-dlp -f "bv+ba/b"
1578 # Download best format that contains video,
1579 # and if it doesn't already have an audio stream, merge it with best audio-only format
1580 $ yt-dlp -f "bv*+ba/b"
1585 # Download the best video-only format and the best audio-only format without merging them
1586 # For this case, an output template should be used since
1587 # by default, bestvideo and bestaudio will have the same file name.
1588 $ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
1590 # Download and merge the best format that has a video stream,
1591 # and all audio-only formats into one file
1592 $ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
1594 # Download and merge the best format that has a video stream,
1595 # and the best 2 audio-only formats into one file
1596 $ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
1599 # The following examples show the old method (without -S) of format selection
1600 # and how to use -S to achieve a similar but (generally) better result
1602 # Download the worst video available (old method)
1603 $ yt-dlp -f "wv*+wa/w"
1605 # Download the best video available but with the smallest resolution
1608 # Download the smallest video available
1609 $ yt-dlp -S "+size,+br"
1613 # Download the best mp4 video available, or the best video if no mp4 available
1614 $ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
1616 # Download the best video with the best extension
1617 # (For video, mp4 > mov > webm > flv. For audio, m4a > aac > mp3 ...)
1622 # Download the best video available but no better than 480p,
1623 # or the worst video if there is no video under 480p
1624 $ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"
1626 # Download the best video available with the largest height but no better than 480p,
1627 # or the best video with the smallest resolution if there is no video under 480p
1628 $ yt-dlp -S "height:480"
1630 # Download the best video available with the largest resolution but no better than 480p,
1631 # or the best video with the smallest resolution if there is no video under 480p
1632 # Resolution is determined by using the smallest dimension.
1633 # So this works correctly for vertical videos as well
1634 $ yt-dlp -S "res:480"
1638 # Download the best video (that also has audio) but no bigger than 50 MB,
1639 # or the worst video (that also has audio) if there is no video under 50 MB
1640 $ yt-dlp -f "b[filesize<50M] / w"
1642 # Download largest video (that also has audio) but no bigger than 50 MB,
1643 # or the smallest video (that also has audio) if there is no video under 50 MB
1644 $ yt-dlp -f "b" -S "filesize:50M"
1646 # Download best video (that also has audio) that is closest in size to 50 MB
1647 $ yt-dlp -f "b" -S "filesize~50M"
1651 # Download best video available via direct link over HTTP/HTTPS protocol,
1652 # or the best video available via any protocol if there is no such video
1653 $ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
1655 # Download best video available via the best protocol
1656 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1661 # Download the best video with either h264 or h265 codec,
1662 # or the best video if there is no such video
1663 $ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"
1665 # Download the best video with best codec no better than h264,
1666 # or the best video with worst codec if there is no such video
1667 $ yt-dlp -S "codec:h264"
1669 # Download the best video with worst codec no worse than h264,
1670 # or the best video with best codec if there is no such video
1671 $ yt-dlp -S "+codec:h264"
1675 # More complex examples
1677 # Download the best video no better than 720p preferring framerate greater than 30,
1678 # or the worst video (still preferring framerate greater than 30) if there is no such video
1679 $ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"
1681 # Download the video with the largest resolution no better than 720p,
1682 # or the video with the smallest resolution available if there is no such video,
1683 # preferring larger framerate for formats with the same resolution
1684 $ yt-dlp -S "res:720,fps"
1688 # Download the video with smallest resolution no worse than 480p,
1689 # or the video with the largest resolution available if there is no such video,
1690 # preferring better codec and then larger total bitrate for the same resolution
1691 $ yt-dlp -S "+res:480,codec,br"
1694 # MODIFYING METADATA
1696 The metadata obtained by the extractors can be modified by using `--parse-metadata
` and `--replace-in-metadata
`
1698 `--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.
1700 The general syntax of `--parse-metadata FROM:TO
` is to give the name of a field or an [output template](#output-template) to extract data from, and the format to interpret it as, separated by a colon `:`. Either a [python regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) with named capture groups, a single field name, or a similar syntax to the [output template](#output-template) (only `%(field)s
` formatting is supported) can be used for `TO
`. The option can be used multiple times to parse and modify various fields.
1702 Note that these options preserve their relative order, allowing replacements to be made in parsed fields and viceversa. Also, any field thus created can be used in the [output template](#output-template) and will also affect the media file's metadata added when using `--embed-metadata
`.
1704 This option also has a few special uses:
1706 * You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field `additional_urls
` to the URL that you want to download. E.g. `--parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)
` will download the first vimeo video found in the description
1708 * You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a `meta_
` prefix. For example, any value you set to `meta_description
` field will be added to the `description
` field in the file - you can use this to set a different "description" and "synopsis". To modify the metadata of individual streams, use the `meta<n>_
` prefix (e.g. `meta1_language
`). Any value set to the `meta_
` field will overwrite all default values.
1710 **Note**: Metadata modification happens before format selection, post-extraction and other post-processing operations. Some fields may be added or changed during these steps, overriding your changes.
1712 For reference, these are the fields yt-dlp adds by default to the file metadata:
1714 Metadata fields | From
1715 :--------------------------|:------------------------------------------------
1716 `title
` | `track
` or `title
`
1717 `date
` | `upload_date
`
1718 `description
`, `synopsis
` | `description
`
1719 `purl
`, `comment
` | `webpage_url
`
1720 `track
` | `track_number
`
1721 `artist
` | `artist
`, `creator
`, `uploader
` or `uploader_id
`
1724 `album_artist
` | `album_artist
`
1725 `disc
` | `disc_number
`
1727 `season_number
` | `season_number
`
1728 `episode_id
` | `episode
` or `episode_id
`
1729 `episode_sort
` | `episode_number
`
1730 `language
` of each stream | the format's `language
`
1732 **Note**: The file format may not support some of these fields
1735 ## Modifying metadata examples
1738 # Interpret the title as "Artist - Title"
1739 $ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
1742 $ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"
1744 # Set title as "Series name S01E05"
1745 $ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
1747 # Prioritize uploader as the "artist" field in video metadata
1748 $ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --embed-metadata
1750 # Set "comment" field in video metadata using description instead of webpage_url,
1751 # handling multiple lines correctly
1752 $ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --embed-metadata
1754 # Do not set any "synopsis" in the video metadata
1755 $ yt-dlp --parse-metadata ":(?P<meta_synopsis>)"
1757 # Remove "formats" field from the infojson by setting it to an empty string
1758 $ yt-dlp --parse-metadata ":(?P<formats>)" -j
1760 # Replace all spaces and "_" in title and uploader with a `-`
1761 $ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
1765 # EXTRACTOR ARGUMENTS
1767 Some extractors accept additional arguments which can be passed using `--extractor-args KEY:ARGS
`. `ARGS
` is a `;
` (semicolon) separated string of `ARG=VAL1,VAL2
`. E.g. `--extractor-args "youtube:player-client=android_embedded,web;include_live_dash" --extractor-args "funimation:version=uncut"
`
1769 Note: In CLI, `ARG
` can use `-
` instead of `_
`; e.g. `youtube:player-client"
` becomes `youtube:player_client"
`
1771 The following extractors use this feature:
1774 * `lang
`: Prefer translated metadata (`title
`, `description
` etc) of this language code (case-sensitive). By default, the video primary language metadata is preferred, with a fallback to `en
` translated. See [youtube.py](https://github.com/yt-dlp/yt-dlp/blob/c26f9b991a0681fd3ea548d535919cec1fbbd430/yt_dlp/extractor/youtube.py#L381-L390) for list of supported content language codes
1775 * `skip
`: One or more of `hls
`, `dash
` or `translated_subs
` to skip extraction of the m3u8 manifests, dash manifests and [auto-translated subtitles](https://github.com/yt-dlp/yt-dlp/issues/4090#issuecomment-1158102032) respectively
1776 * `player_client
`: Clients to extract video data from. The main clients are `web
`, `android
` and `ios
` with variants `_music
`, `_embedded
`, `_embedscreen
`, `_creator
` (e.g. `web_embedded
`); and `mweb
` and `tv_embedded
` (agegate bypass) with no variants. By default, `android,web
` is used, but `tv_embedded
` and `creator
` variants are added as required for age-gated videos. Similarly, the music variants are added for `music.youtube.com
` urls. You can use `all
` to use all the clients, and `default
` for the default clients.
1777 * `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
1778 * `comment_sort
`: `top
` or `new
` (default) - choose comment sorting mode (on YouTube's side)
1779 * `max_comments
`: Limit the amount of comments to gather. Comma-separated list of integers representing `max-comments,max-parents,max-replies,max-replies-per-thread
`. Default is `all,all,all,all
`
1780 * E.g. `all,all,
1000,
10` will get a maximum of 1000 replies total, with up to 10 replies per thread. `1000,all,
100` will get a maximum of 1000 comments, with a maximum of 100 replies total
1781 * `include_incomplete_formats
`: Extract formats that cannot be downloaded completely (live dash and post-live m3u8)
1782 * `innertube_host
`: Innertube API host to use for all API requests; e.g. `studio.youtube.com
`, `youtubei.googleapis.com
`. Note that cookies exported from one subdomain will not work on others
1783 * `innertube_key
`: Innertube API key to use for all API requests
1785 #### youtubetab (YouTube playlists, channels, feeds, etc.)
1786 * `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)
1787 * `approximate_date
`: Extract approximate `upload_date
` and `timestamp
` in flat-playlist. This may cause date-based filters to be slightly off
1790 * `fragment_query
`: Passthrough any query in mpd/m3u8 manifest URLs to their fragments. Does not apply to ffmpeg
1793 * `language
`: Audio languages to extract, e.g. `funimation:language=english,japanese
`
1794 * `version
`: The video version to extract - `uncut
` or `simulcast
`
1796 #### crunchyrollbeta (Crunchyroll)
1797 * `format
`: Which stream type(s) to extract (default: `adaptive_hls
`). Potentially useful values include `adaptive_hls
`, `adaptive_dash
`, `vo_adaptive_hls
`, `vo_adaptive_dash
`, `download_hls
`, `download_dash
`, `multitrack_adaptive_hls_v2
`
1798 * `hardsub
`: Preference order for which hardsub versions to extract, or `all
` (default: `None
` = no hardsubs), e.g. `crunchyrollbeta:hardsub=en-US,None
`
1801 * `video_types
`: Types of videos to download - one or more of `episodes
`, `movies
`, `clips
`, `trailers
`
1804 * `segment_duration
`: Segment duration in milliseconds for HLS-DMC formats. Use it at your own risk since this feature **may result in your account termination.**
1806 #### youtubewebarchive
1807 * `check_all
`: Try to check more at the cost of more requests. One or more of `thumbnails
`, `captures
`
1810 * `comment_sort
`: `hot
` (default), `you
` (cookies needed), `top
`, `new
` - choose comment sorting mode (on GameJolt's side)
1813 * `res
`: resolution to ignore - one or more of `sd
`, `hd
`, `fhd
`
1814 * `vcodec
`: vcodec to ignore - one or more of `h264
`, `h265
`, `dvh265
`
1815 * `dr
`: dynamic range to ignore - one or more of `sdr
`, `hdr10
`, `dv
`
1818 * `api_hostname
`: Hostname to use for mobile API requests, e.g. `api-h2.tiktokv.com
`
1819 * `app_version
`: App version to call mobile APIs with - should be set along with `manifest_app_version
`, e.g. `20.2.1`
1820 * `manifest_app_version
`: Numeric app version to call mobile APIs with, e.g. `221`
1823 * `tab
`: Which tab to download - one of `new
`, `top
`, `videos
`, `podcasts
`, `streams
`, `stacks
`
1826 * `force_graphql
`: Force usage of the GraphQL API. By default it will only be used if login cookies are provided
1828 **Note**: These options may be changed/removed in the future without concern for backward compatibility
1830 <!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
1835 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!**
1837 Plugins can be of `<type>
`s `extractor
` or `postprocessor
`.
1838 - Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it.
1839 - Extractor plugins take priority over builtin extractors.
1840 - Postprocessor plugins can be invoked using `--use-postprocessor NAME
`.
1843 Plugins are loaded from the namespace packages `yt_dlp_plugins.extractor
` and `yt_dlp_plugins.postprocessor
`.
1845 In other words, the file structure on the disk looks something like:
1853 yt-dlp looks for these `yt_dlp_plugins
` namespace folders in many locations (see below) and loads in plugins from **all** of them.
1855 See the [wiki for some known plugins](https://github.com/yt-dlp/yt-dlp/wiki/Plugins)
1857 ## Installing Plugins
1859 Plugins can be installed using various methods and locations.
1861 1. **Configuration directories**:
1862 Plugin packages (containing a `yt_dlp_plugins
` namespace folder) can be dropped into the following standard [configuration locations](#configuration):
1864 * `${XDG_CONFIG_HOME}/yt-dlp/plugins/<package name>/yt_dlp_plugins/
` (recommended on Linux/macOS)
1865 * `${XDG_CONFIG_HOME}/yt-dlp-plugins/<package name>/yt_dlp_plugins/
`
1866 * `${APPDATA}/yt-dlp/plugins/<package name>/yt_dlp_plugins/
` (recommended on Windows)
1867 * `${APPDATA}/yt-dlp-plugins/<package name>/yt_dlp_plugins/
`
1868 * `~/.yt-dlp/plugins/<package name>/yt_dlp_plugins/
`
1869 * `~/yt-dlp-plugins/<package name>/yt_dlp_plugins/
`
1870 * **System Plugins**
1871 * `/etc/yt-dlp/plugins/<package name>/yt_dlp_plugins/
`
1872 * `/etc/yt-dlp-plugins/<package name>/yt_dlp_plugins/
`
1873 2. **Executable location**: Plugin packages can similarly be installed in a `yt-dlp-plugins
` directory under the executable location:
1874 * Binary: where `<root-dir>/yt-dlp.exe
`, `<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/
`
1875 * Source: where `<root-dir>/yt_dlp/__main__.py
`, `<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/
`
1877 3. **pip and other locations in `PYTHONPATH
`**
1878 * Plugin packages can be installed and managed using `pip
`. See [yt-dlp-sample-plugins](https://github.com/yt-dlp/yt-dlp-sample-plugins) for an example.
1879 * Note: plugin files between plugin packages installed with pip must have unique filenames.
1880 * Any path in `PYTHONPATH
` is searched in for the `yt_dlp_plugins
` namespace folder.
1881 * Note: This does not apply for Pyinstaller/py2exe builds.
1884 `.zip
`, `.egg
` and `.whl
` archives containing a `yt_dlp_plugins
` namespace folder in their root are also supported as plugin packages.
1885 * e.g. `${XDG_CONFIG_HOME}/yt-dlp/plugins/mypluginpkg.zip
` where `mypluginpkg.zip
` contains `yt_dlp_plugins/<type>/myplugin.py
`
1887 Run yt-dlp with `--verbose
` to check if the plugin has been loaded.
1889 ## Developing Plugins
1891 See the [yt-dlp-sample-plugins](https://github.com/yt-dlp/yt-dlp-sample-plugins) repo for a template plugin package and the [Plugin Development](https://github.com/yt-dlp/yt-dlp/wiki/Plugin-Development) section of the wiki for a plugin development guide.
1893 All public classes with a name ending in `IE
`/`PP
` are imported from each file for extractors and postprocessors repectively. This respects underscore prefix (e.g. `_MyBasePluginIE
` is private) and `__all__
`. Modules can similarly be excluded by prefixing the module name with an underscore (e.g. `_myplugin.py
`).
1895 To replace an existing extractor with a subclass of one, set the `plugin_name
` class keyword argument (e.g. `class MyPluginIE(ABuiltInIE, plugin_name='myplugin')
` will replace `ABuiltInIE
` with `MyPluginIE
`). Since the extractor replaces the parent, you should exclude the subclass extractor from being imported separately by making it private using one of the methods described above.
1897 If you are a plugin author, add [yt-dlp-plugins](https://github.com/topics/yt-dlp-plugins) as a topic to your repository for discoverability.
1899 See the [Developer Instructions](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions) on how to write and test an extractor.
1903 yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1905 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.
1907 From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1910 from yt_dlp import YoutubeDL
1912 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1913 with YoutubeDL() as ydl:
1917 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#L184).
1919 **Tip**: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of `YoutubeDL.extract_info
` to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through `YoutubeDL.sanitize_info
` as shown in the [example below](#extracting-information)
1921 ## Embedding examples
1923 #### Extracting information
1929 URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'
1931 # ℹ️ See help(yt_dlp.YoutubeDL) for a list of available options and public functions
1933 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1934 info = ydl.extract_info(URL, download=False)
1936 # ℹ️ ydl.sanitize_info makes the info json-serializable
1937 print(json.dumps(ydl.sanitize_info(info)))
1939 #### Download using an info-json
1944 INFO_FILE = 'path/to/video.info.json'
1946 with yt_dlp.YoutubeDL() as ydl:
1947 error_code = ydl.download_with_info_file(INFO_FILE)
1949 print('Some videos failed to download' if error_code
1950 else 'All videos successfully downloaded')
1958 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1961 'format': 'm4a/bestaudio/best',
1962 # ℹ️ See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
1963 'postprocessors': [{ # Extract audio using ffmpeg
1964 'key': 'FFmpegExtractAudio',
1965 'preferredcodec': 'm4a',
1969 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1970 error_code = ydl.download(URLS)
1978 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1980 def longer_than_a_minute(info, *, incomplete):
1981 """Download only videos longer than a minute (or with unknown duration)"""
1982 duration = info.get('duration')
1983 if duration and duration < 60:
1984 return 'The video is too short'
1987 'match_filter': longer_than_a_minute,
1990 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1991 error_code = ydl.download(URLS)
1994 #### Adding logger and progress hook
1999 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2002 def debug(self, msg):
2003 # For compatibility with youtube-dl, both debug and info are passed into debug
2004 # You can distinguish them by the prefix '[debug] '
2005 if msg.startswith('[debug] '):
2010 def info(self, msg):
2013 def warning(self, msg):
2016 def error(self, msg):
2020 # ℹ️ See "progress_hooks" in help(yt_dlp.YoutubeDL)
2022 if d['status'] == 'finished':
2023 print('Done downloading, now post-processing ...')
2027 'logger': MyLogger(),
2028 'progress_hooks': [my_hook],
2031 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
2035 #### Add a custom PostProcessor
2040 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2042 # ℹ️ See help(yt_dlp.postprocessor.PostProcessor)
2043 class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
2044 def run(self, info):
2045 self.to_screen('Doing stuff')
2049 with yt_dlp.YoutubeDL() as ydl:
2050 # ℹ️ "when" can take any value in yt_dlp.utils.POSTPROCESS_WHEN
2051 ydl.add_post_processor(MyCustomPP(), when='pre_process')
2056 #### Use a custom format selector
2061 URL = ['https://www.youtube.com/watch?v=BaW_jenozKc']
2063 def format_selector(ctx):
2064 """ Select the best video and the best audio that won't result in an mkv.
2065 NOTE: This is just an example and does not handle all cases """
2067 # formats are already sorted worst to best
2068 formats = ctx.get('formats')[::-1]
2070 # acodec='none' means there is no audio
2071 best_video = next(f for f in formats
2072 if f['vcodec'] != 'none' and f['acodec'] == 'none')
2074 # find compatible audio extension
2075 audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
2076 # vcodec='none' means there is no video
2077 best_audio = next(f for f in formats if (
2078 f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
2080 # These are the minimum required fields for a merged format
2082 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
2083 'ext': best_video['ext'],
2084 'requested_formats': [best_video, best_audio],
2085 # Must be + separated list of protocols
2086 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
2091 'format': format_selector,
2094 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
2098 <!-- MANPAGE: MOVE "NEW FEATURES" SECTION HERE -->
2100 # DEPRECATED OPTIONS
2102 These are all the deprecated options and the current alternative to achieve the same effect
2104 #### Almost redundant options
2105 While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant
2107 -j, --dump-json --print "%()j"
2108 -F, --list-formats --print formats_table
2109 --list-thumbnails --print thumbnails_table --print playlist:thumbnails_table
2110 --list-subs --print automatic_captions_table --print subtitles_table
2112 #### Redundant options
2113 While these options are redundant, they are still expected to be used due to their ease of use
2115 --get-description --print description
2116 --get-duration --print duration_string
2117 --get-filename --print filename
2118 --get-format --print format
2120 --get-thumbnail --print thumbnail
2121 -e, --get-title --print title
2122 -g, --get-url --print urls
2123 --match-title REGEX --match-filter "title ~= (?i)REGEX"
2124 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
2125 --min-views COUNT --match-filter "view_count >=? COUNT"
2126 --max-views COUNT --match-filter "view_count <=? COUNT"
2127 --user-agent UA --add-header "User-Agent:UA"
2128 --referer URL --add-header "Referer:URL"
2129 --playlist-start NUMBER -I NUMBER:
2130 --playlist-end NUMBER -I :NUMBER
2131 --playlist-reverse -I ::-1
2132 --no-playlist-reverse Default
2135 #### Not recommended
2136 While these options still work, their use is not recommended since there are other alternatives to achieve the same
2138 --force-generic-extractor --ies generic,default
2139 --exec-before-download CMD --exec "before_dl:CMD"
2140 --no-exec-before-download --no-exec
2141 --all-formats -f all
2142 --all-subs --sub-langs all --write-subs
2143 --print-json -j --no-simulate
2144 --autonumber-size NUMBER Use string formatting, e.g. %(autonumber)03d
2145 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
2146 --id -o "%(id)s.%(ext)s"
2147 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
2148 --hls-prefer-native --downloader "m3u8:native"
2149 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
2150 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
2151 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
2152 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
2153 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
2154 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
2155 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
2158 #### Developer options
2159 These options are not intended to be used by the end-user
2161 --test Download only part of video for testing extractors
2162 --load-pages Load pages dumped by --write-pages
2163 --youtube-print-sig-code For testing youtube signatures
2164 --allow-unplayable-formats List unplayable formats also
2165 --no-allow-unplayable-formats Default
2169 These are aliases that are no longer documented for various reasons
2171 --avconv-location --ffmpeg-location
2172 --clean-infojson --clean-info-json
2173 --cn-verification-proxy URL --geo-verification-proxy URL
2174 --dump-headers --print-traffic
2175 --dump-intermediate-pages --dump-pages
2176 --force-write-download-archive --force-write-archive
2177 --load-info --load-info-json
2178 --no-clean-infojson --no-clean-info-json
2179 --no-split-tracks --no-split-chapters
2180 --no-write-srt --no-write-subs
2181 --prefer-unsecure --prefer-insecure
2182 --rate-limit RATE --limit-rate RATE
2183 --split-tracks --split-chapters
2184 --srt-lang LANGS --sub-langs LANGS
2185 --trim-file-names LENGTH --trim-filenames LENGTH
2186 --write-srt --write-subs
2187 --yes-overwrites --force-overwrites
2189 #### Sponskrub Options
2190 Support for [SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of the `--sponsorblock
` options
2192 --sponskrub --sponsorblock-mark all
2193 --no-sponskrub --no-sponsorblock
2194 --sponskrub-cut --sponsorblock-remove all
2195 --no-sponskrub-cut --sponsorblock-remove -all
2196 --sponskrub-force Not applicable
2197 --no-sponskrub-force Not applicable
2198 --sponskrub-location Not applicable
2199 --sponskrub-args Not applicable
2201 #### No longer supported
2202 These options may no longer work as intended
2204 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
2205 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
2206 -C, --call-home Not implemented
2207 --no-call-home Default
2208 --include-ads No longer supported
2209 --no-include-ads Default
2210 --write-annotations No supported site has annotations now
2211 --no-write-annotations Default
2212 --compat-options seperate-video-versions No longer needed
2215 These options were deprecated since 2014 and have now been entirely removed
2217 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
2218 -t, -l, --title, --literal -o "%(title)s-%(id)s.%(ext)s"
2221 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)
2224 See the [Wiki](https://github.com/yt-dlp/yt-dlp/wiki) for more information
projects / yt-dlp.git / blob