1 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
4 [](#readme)
6 [](#release-files "Release")
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)
29 * [Release Files](#release-files)
30 * [Dependencies](#dependencies)
32 * [USAGE AND OPTIONS](#usage-and-options)
33 * [General Options](#general-options)
34 * [Network Options](#network-options)
35 * [Geo-restriction](#geo-restriction)
36 * [Video Selection](#video-selection)
37 * [Download Options](#download-options)
38 * [Filesystem Options](#filesystem-options)
39 * [Thumbnail Options](#thumbnail-options)
40 * [Internet Shortcut Options](#internet-shortcut-options)
41 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
42 * [Workarounds](#workarounds)
43 * [Video Format Options](#video-format-options)
44 * [Subtitle Options](#subtitle-options)
45 * [Authentication Options](#authentication-options)
46 * [Post-processing Options](#post-processing-options)
47 * [SponsorBlock Options](#sponsorblock-options)
48 * [Extractor Options](#extractor-options)
49 * [CONFIGURATION](#configuration)
50 * [Authentication with .netrc file](#authentication-with-netrc-file)
51 * [OUTPUT TEMPLATE](#output-template)
52 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
53 * [Output template examples](#output-template-examples)
54 * [FORMAT SELECTION](#format-selection)
55 * [Filtering Formats](#filtering-formats)
56 * [Sorting Formats](#sorting-formats)
57 * [Format Selection examples](#format-selection-examples)
58 * [MODIFYING METADATA](#modifying-metadata)
59 * [Modifying metadata examples](#modifying-metadata-examples)
60 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
62 * [EMBEDDING YT-DLP](#embedding-yt-dlp)
63 * [DEPRECATED OPTIONS](#deprecated-options)
64 * [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
65 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
66 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
68 <!-- MANPAGE: END EXCLUDED SECTION -->
73 * Based on **youtube-dl
2021.12.17 [commit/6508688](https://github.com/ytdl-org/youtube-dl/commit/6508688e88c83bb811653083db9351702cd39a6a)** (
[exceptions](https://github.com/yt-dlp/yt-dlp/issues/21)) and **youtube-dlc
2020.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)
75 * **
[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
77 * **[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))
79 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from
[animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including
`--write-comments`,
`BiliBiliSearch`,
`BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that the NicoNico livestreams are not available. See
[#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details.
81 * **Youtube improvements**:
82 * All Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`,
`:ytnotif`) and private playlists supports downloading multiple pages of content
83 * Search (
`ytsearch:`,
`ytsearchdate:`), search URLs and in-channel search works
84 * Mixes supports downloading multiple pages of content
85 * Some (but not all) age-gated content can be downloaded without cookies
86 * Fix for
[n-sig based throttling](https://github.com/ytdl-org/youtube-dl/issues/29326)
87 * Redirect channel's home URL automatically to
`/video` to preserve the old behaviour
88 * `255kbps` audio is extracted (if available) from youtube music when premium cookies are given
89 * Youtube music Albums, channels etc can be downloaded (
[except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723))
90 * Download livestreams from the start using
`--live-from-start` (experimental)
92 * **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using
`--cookies-from-browser BROWSER[+KEYRING][:PROFILE]`
94 * **Split video by chapters**: Videos can be split into multiple files based on chapters using
`--split-chapters`
96 * **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
98 * **Aria2c with HLS/DASH**: You can use
`aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
100 * **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)
102 * **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN
104 * **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
106 * **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`)
108 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
110 * **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`
112 * **Other new options**: Many new options have been added such as
`--concat-playlist`,
`--print`,
`--wait-for-video`,
`--sleep-requests`,
`--convert-thumbnails`,
`--write-link`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
114 * **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
116 * **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins](#plugins) for details
118 * **Self-updater**: The releases can be updated using
`yt-dlp -U`
120 See
[changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
122 ### Differences in default behavior
124 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
126 * The options
`--auto-number` (
`-A`),
`--title` (
`-t`) and
`--literal` (
`-l`), no longer work. See [removed options](#Removed) for details
127 * `avconv` is not supported as an alternative to
`ffmpeg`
128 * yt-dlp stores config files in slightly different locations to youtube-dl. See [configuration](#configuration) for a list of correct locations
129 * 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`
130 * 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
131 * 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
132 * 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
133 * `--no-abort-on-error` is enabled by default. Use
`--abort-on-error` or
`--compat-options abort-on-error` to abort on errors instead
134 * 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
135 * `--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
136 * 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
137 * `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
138 * The output of
`-F` is listed in a new format. Use
`--compat-options list-formats` to revert this
139 * All *experiences* of a funimation episode are considered as a single video. This behavior breaks existing archives. Use
`--compat-options seperate-video-versions` to extract information from only the default player
140 * Youtube live chat (if available) is considered as a subtitle. Use
`--sub-langs all,-live_chat` to download all subtitles except live chat. You can also use
`--compat-options no-live-chat` to prevent live chat from downloading
141 * Youtube channel URLs are automatically redirected to
`/video`. Append a
`/featured` to the URL to download only the videos in the home page. If the channel does not have a videos tab, we try to download the equivalent
`UU` playlist instead. For all other tabs, 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
142 * Unavailable videos are also listed for youtube playlists. Use
`--compat-options no-youtube-unavailable-videos` to remove this
143 * 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
144 * Thumbnail embedding in
`mp4` is done with mutagen if possible. Use
`--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
145 * 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
146 * 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
147 * `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`
148 * youtube-dl tries to remove some superfluous punctuations from filenames. While this can sometimes be helpfull, it is often undesirable. So yt-dlp tries to keep the fields in the filenames as close to their original values as possible. You can use
`--compat-options filename-sanitization` to revert to youtube-dl's behavior
150 For ease of use, a few more compat options are available:
152 * `--compat-options all`: Use all compat options
153 * `--compat-options youtube-dl`: Same as
`--compat-options all,-multistreams`
154 * `--compat-options youtube-dlc`: Same as
`--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
159 You can install yt-dlp using one of the following methods:
161 ### Using the release binary
163 You can simply download the [correct binary file](#release-files) for your OS
165 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
166 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)
167 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)
168 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
169 [](#release-files)
170 []
(https://github.com/yt-dlp/yt-dlp/releases)
171 <!-- MANPAGE: END EXCLUDED SECTION -->
173 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)
175 <!-- TODO: Move to Wiki -->
176 In UNIX-like OSes (MacOS, Linux, BSD), you can also install the same in one of the following ways:
179 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
180 sudo chmod a+rx /usr/local/bin/yt-dlp
184 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
185 sudo chmod a+rx /usr/local/bin/yt-dlp
189 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp --dir /usr/local/bin -o yt-dlp
190 sudo chmod a+rx /usr/local/bin/yt-dlp
194 ### With [PIP](https://pypi.org/project/pip)
196 You can install the
[PyPI package](https://pypi.org/project/yt-dlp) with:
198 python3 -m pip install -U yt-dlp
201 You can install without any of the optional dependencies using:
203 python3 -m pip install --no-deps -U yt-dlp
206 If you want to be on the cutting edge, you can also install the master branch with:
208 python3 -m pip install --force-reinstall https://github.com/yt-dlp/yt-dlp/archive/master.tar.gz
211 Note that on some systems, you may need to use
`py` or
`python` instead of
`python3`
213 <!-- TODO: Add to Wiki, Remove Taps -->
214 ### With [Homebrew](https://brew.sh)
216 macOS or Linux users that are using Homebrew can also install it by:
219 brew install yt-dlp/taps/yt-dlp
223 You can use
`yt-dlp -U` to update if you are [using the provided release](#using-the-release-binary)
225 If you [installed with pip](#with-pip), simply re-run the same command that was used to install the program
227 If you [installed using Homebrew](#with-homebrew), run
`brew upgrade yt-dlp/taps/yt-dlp`
229 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
236 [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform-independant binary. Needs Python (recommended for **Linux/BSD**)
237 [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**)
238 [yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|MacOS (
10.15+) standalone executable (recommended for **MacOS**)
244 [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
245 [yt-dlp_min.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_min.exe)|Windows (Win7 SP1+) standalone x64 binary built with
`py2exe`.<br/> Does not contain
`pycryptodomex`, needs VC++
14
246 [yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged Windows executable (no auto-update)
247 [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)
253 [yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)|Source tarball. Also contains manpages, completions, etc
254 [SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
255 [SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
256 <!-- MANPAGE: END EXCLUDED SECTION -->
259 Python versions
3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
261 <!-- Python
3.5+ uses VC++
14 and it is already embedded in the binary created
262 <!x-- https://www.microsoft.com/en-us/download/details.aspx?id=
26999 --x>
263 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.
266 While all the other dependencies are optional,
`ffmpeg` and
`ffprobe` are highly recommended
268 * [**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)
269 * [**mutagen**](https://github.com/quodlibet/mutagen)\* - For embedding thumbnail in certain formats. Licensed under
[GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
270 * [**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)
271 * [**websockets**](https://github.com/aaugustin/websockets)\* - For downloading over websocket. Licensed under
[BSD-3-Clause](https://github.com/aaugustin/websockets/blob/main/LICENSE)
272 * [**secretstorage**](https://github.com/mitya57/secretstorage)\* - For accessing 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)
273 * [**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>
274 * [**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)
275 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For embedding thumbnail in mp4/m4a if mutagen/ffmpeg cannot. Licensed under
[GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
276 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading
`rtmp` streams. ffmpeg will be used as a fallback. Licensed under
[GPLv2+](http://rtmpdump.mplayerhq.hu)
277 * [**mplayer**](http://mplayerhq.hu/design7/info.html) or
[**mpv**](https://mpv.io) - For downloading
`rstp` streams. ffmpeg will be used as a fallback. Licensed under
[GPLv2+](https://github.com/mpv-player/mpv/blob/master/Copyright)
278 * [**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)
279 * [**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)
280 * Any external downloader that you want to use with
`--downloader`
282 To use or redistribute the dependencies, you must agree to their respective licensing terms.
284 The Windows and MacOS standalone release binaries are already built with the python interpreter and all optional python packages (marked with \*) included.
286 <!-- TODO: ffmpeg has merged this patch. Remove this note once there is new release -->
287 **Note**: There are some regressions in newer ffmpeg versions 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 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
293 To build the Windows executable, you must have pyinstaller (and any of yt-dlp's optional dependencies if needed). Once you have all the necessary dependencies installed, (optionally) build lazy extractors using
`devscripts/make_lazy_extractors.py`, and then just run
`pyinst.py`. The executable will be built for the same architecture (
32/
64 bit) as the python used to build it.
295 py -m pip install -U pyinstaller -r requirements.txt
296 py devscripts/make_lazy_extractors.py
299 Note that pyinstaller
[does not support](https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms) Python installed from the Windows store without using a virtual environment
302 You will need the required build tools:
`python`,
`make` (GNU),
`pandoc`,
`zip`,
`pytest`
303 Then simply run
`make`. You can also run
`make yt-dlp` instead to compile only the binary without updating any of the additional files
305 **Note**: In either platform,
`devscripts/update-version.py` can be used to automatically update the version number
307 You can also fork the project on github and run your fork's [build workflow](.github/workflows/build.yml) to automatically build a release
311 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
312 yt-dlp [OPTIONS] [--] URL [URL...]
314 `Ctrl+F` is your friend :D
315 <!-- MANPAGE: END EXCLUDED SECTION -->
317 <!-- Auto generated -->
319 -h, --help Print this help text and exit
320 --version Print program version and exit
321 -U, --update Update this program to latest version. Make
322 sure that you have sufficient permissions
323 (run with sudo if needed)
324 -i, --ignore-errors Ignore download and postprocessing errors.
325 The download will be considered successful
326 even if the postprocessing fails
327 --no-abort-on-error Continue with next video on download
328 errors; e.g. to skip unavailable videos in
330 --abort-on-error Abort downloading of further videos if an
331 error occurs (Alias: --no-ignore-errors)
332 --dump-user-agent Display the current user-agent and exit
333 --list-extractors List all supported extractors and exit
334 --extractor-descriptions Output descriptions of all supported
336 --force-generic-extractor Force extraction to use the generic
338 --default-search PREFIX Use this prefix for unqualified URLs. For
339 example "gvsearch2:" downloads two videos
340 from google videos for the search term
341 "large apple". Use the value "auto" to let
342 yt-dlp guess ("auto_warning" to emit a
343 warning when guessing). "error" just throws
344 an error. The default value "fixup_error"
345 repairs broken URLs, but emits an error if
346 this is not possible instead of searching
347 --ignore-config Don't load any more configuration files
348 except those given by --config-locations.
349 For backward compatibility, if this option
350 is found inside the system configuration
351 file, the user configuration is not loaded.
353 --no-config-locations Do not load any custom configuration files
354 (default). When given inside a
355 configuration file, ignore all previous
356 --config-locations defined in the current
358 --config-locations PATH Location of the main configuration file;
359 either the path to the config or its
360 containing directory. Can be used multiple
361 times and inside other configuration files
362 --flat-playlist Do not extract the videos of a playlist,
364 --no-flat-playlist Extract the videos of a playlist
365 --live-from-start Download livestreams from the start.
366 Currently only supported for YouTube
368 --no-live-from-start Download livestreams from the current time
370 --wait-for-video MIN[-MAX] Wait for scheduled streams to become
371 available. Pass the minimum number of
372 seconds (or range) to wait between retries
373 --no-wait-for-video Do not wait for scheduled streams (default)
374 --mark-watched Mark videos watched (even with --simulate)
375 --no-mark-watched Do not mark videos watched (default)
376 --no-colors Do not emit color codes in output
377 --compat-options OPTS Options that can help keep compatibility
378 with youtube-dl or youtube-dlc
379 configurations by reverting some of the
380 changes made in yt-dlp. See "Differences in
381 default behavior" for details
384 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
385 To enable SOCKS proxy, specify a proper
387 socks5://user:pass@
127.0.0.1:
1080/. Pass in
388 an empty string (--proxy "") for direct
390 --socket-timeout SECONDS Time to wait before giving up, in seconds
391 --source-address IP Client-side IP address to bind to
392 -4, --force-ipv4 Make all connections via IPv4
393 -6, --force-ipv6 Make all connections via IPv6
396 --geo-verification-proxy URL Use this proxy to verify the IP address for
397 some geo-restricted sites. The default
398 proxy specified by --proxy (or none, if the
399 option is not present) is used for the
401 --geo-bypass Bypass geographic restriction via faking
402 X-Forwarded-For HTTP header (default)
403 --no-geo-bypass Do not bypass geographic restriction via
404 faking X-Forwarded-For HTTP header
405 --geo-bypass-country CODE Force bypass geographic restriction with
406 explicitly provided two-letter ISO
3166-
2
408 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
409 explicitly provided IP block in CIDR
413 --playlist-start NUMBER Playlist video to start at (default is
1)
414 --playlist-end NUMBER Playlist video to end at (default is last)
415 --playlist-items ITEM_SPEC Playlist video items to download. Specify
416 indices of the videos in the playlist
417 separated by commas like: "--playlist-items
418 1,
2,
5,
8" if you want to download videos
419 indexed
1,
2,
5,
8 in the playlist. You can
420 specify range: "--playlist-items
421 1-
3,
7,
10-
13", it will download the videos
422 at index
1,
2,
3,
7,
10,
11,
12 and
13
423 --min-filesize SIZE Do not download any videos smaller than
424 SIZE (e.g.
50k or
44.6m)
425 --max-filesize SIZE Do not download any videos larger than SIZE
427 --date DATE Download only videos uploaded on this date.
428 The date can be "YYYYMMDD" or in the format
429 "(now|today)[+-][
0-
9](day|week|month|year)(s)?"
430 --datebefore DATE Download only videos uploaded on or before
431 this date. The date formats accepted is the
433 --dateafter DATE Download only videos uploaded on or after
434 this date. The date formats accepted is the
436 --match-filters FILTER Generic video filter. Any field (see
437 "OUTPUT TEMPLATE") can be compared with a
438 number or a string using the operators
439 defined in "Filtering formats". You can
440 also simply specify a field to match if the
441 field is present, use "!field" to check if
442 the field is not present, and "&" to check
443 multiple conditions. Use a "
\" to escape
444 "&" or quotes if needed. If used multiple
445 times, the filter matches if atleast one of
446 the conditions are met. Eg: --match-filter
447 !is_live --match-filter "like_count>?
100 &
448 description~='(?i)
\bcats \& dogs
\b'"
449 matches only videos that are not live OR
450 those that have a like count more than
100
451 (or the like field is not available) and
452 also has a description that contains the
453 phrase "cats & dogs" (ignoring case)
454 --no-match-filter Do not use generic video filter (default)
455 --no-playlist Download only the video, if the URL refers
456 to a video and a playlist
457 --yes-playlist Download the playlist, if the URL refers to
458 a video and a playlist
459 --age-limit YEARS Download only videos suitable for the given
461 --download-archive FILE Download only videos not listed in the
462 archive file. Record the IDs of all
463 downloaded videos in it
464 --no-download-archive Do not use archive file (default)
465 --max-downloads NUMBER Abort after downloading NUMBER files
466 --break-on-existing Stop the download process when encountering
467 a file that is in the archive
468 --break-on-reject Stop the download process when encountering
469 a file that has been filtered out
470 --break-per-input Make --break-on-existing and --break-on-
471 reject act only on the current input URL
472 --no-break-per-input --break-on-existing and --break-on-reject
473 terminates the entire download queue
474 --skip-playlist-after-errors N Number of allowed failures until the rest
475 of the playlist is skipped
478 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
479 video that should be downloaded
480 concurrently (default is
1)
481 -r, --limit-rate RATE Maximum download rate in bytes per second
483 --throttled-rate RATE Minimum download rate in bytes per second
484 below which throttling is assumed and the
485 video data is re-extracted (e.g.
100K)
486 -R, --retries RETRIES Number of retries (default is
10), or
488 --file-access-retries RETRIES Number of times to retry on file access
489 error (default is
3), or "infinite"
490 --fragment-retries RETRIES Number of retries for a fragment (default
491 is
10), or "infinite" (DASH, hlsnative and
493 --skip-unavailable-fragments Skip unavailable fragments for DASH,
494 hlsnative and ISM (default)
495 (Alias: --no-abort-on-unavailable-fragment)
496 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
497 (Alias: --no-skip-unavailable-fragments)
498 --keep-fragments Keep downloaded fragments on disk after
499 downloading is finished
500 --no-keep-fragments Delete downloaded fragments after
501 downloading is finished (default)
502 --buffer-size SIZE Size of download buffer (e.g.
1024 or
16K)
504 --resize-buffer The buffer size is automatically resized
505 from an initial value of --buffer-size
507 --no-resize-buffer Do not automatically adjust the buffer size
508 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
509 downloading (e.g.
10485760 or
10M) (default
510 is disabled). May be useful for bypassing
511 bandwidth throttling imposed by a webserver
513 --playlist-reverse Download playlist videos in reverse order
514 --no-playlist-reverse Download playlist videos in default order
516 --playlist-random Download playlist videos in random order
517 --xattr-set-filesize Set file xattribute ytdl.filesize with
519 --hls-use-mpegts Use the mpegts container for HLS videos;
520 allowing some players to play the video
521 while downloading, and reducing the chance
522 of file corruption if download is
523 interrupted. This is enabled by default for
525 --no-hls-use-mpegts Do not use the mpegts container for HLS
526 videos. This is default when not
527 downloading live streams
528 --downloader [PROTO:]NAME Name or path of the external downloader to
529 use (optionally) prefixed by the protocols
530 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
531 use it for. Currently supports native,
532 aria2c, avconv, axel, curl, ffmpeg, httpie,
533 wget (Recommended: aria2c). You can use
534 this option multiple times to set different
535 downloaders for different protocols. For
536 example, --downloader aria2c --downloader
537 "dash,m3u8:native" will use aria2c for
538 http/ftp downloads, and the native
539 downloader for dash/m3u8 downloads (Alias:
540 --external-downloader)
541 --downloader-args NAME:ARGS Give these arguments to the external
542 downloader. Specify the downloader name and
543 the arguments separated by a colon ":". For
544 ffmpeg, arguments can be passed to
545 different positions using the same syntax
546 as --postprocessor-args. You can use this
547 option multiple times to give different
548 arguments to different downloaders (Alias:
549 --external-downloader-args)
551 ## Filesystem Options:
552 -a, --batch-file FILE File containing URLs to download ("-" for
553 stdin), one URL per line. Lines starting
554 with "#", ";" or "]" are considered as
556 --no-batch-file Do not read URLs from batch file (default)
557 -P, --paths [TYPES:]PATH The paths where the files should be
558 downloaded. Specify the type of file and
559 the path separated by a colon ":". All the
560 same TYPES as --output are supported.
561 Additionally, you can also provide "home"
562 (default) and "temp" paths. All
563 intermediary files are first downloaded to
564 the temp path and then the final files are
565 moved over to the home path after download
566 is finished. This option is ignored if
567 --output is an absolute path
568 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
569 TEMPLATE" for details
570 --output-na-placeholder TEXT Placeholder value for unavailable meta
571 fields in output filename template
573 --restrict-filenames Restrict filenames to only ASCII
574 characters, and avoid "&" and spaces in
576 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
578 --windows-filenames Force filenames to be Windows-compatible
579 --no-windows-filenames Make filenames Windows-compatible only if
580 using Windows (default)
581 --trim-filenames LENGTH Limit the filename length (excluding
582 extension) to the specified number of
584 -w, --no-overwrites Do not overwrite any files
585 --force-overwrites Overwrite all video and metadata files.
586 This option includes --no-continue
587 --no-force-overwrites Do not overwrite the video, but overwrite
588 related files (default)
589 -c, --continue Resume partially downloaded files/fragments
591 --no-continue Do not resume partially downloaded
592 fragments. If the file is not fragmented,
593 restart download of the entire file
594 --part Use .part files instead of writing directly
595 into output file (default)
596 --no-part Do not use .part files - write directly
598 --mtime Use the Last-modified header to set the
599 file modification time (default)
600 --no-mtime Do not use the Last-modified header to set
601 the file modification time
602 --write-description Write video description to a .description
604 --no-write-description Do not write video description (default)
605 --write-info-json Write video metadata to a .info.json file
606 (this may contain personal information)
607 --no-write-info-json Do not write video metadata (default)
608 --write-playlist-metafiles Write playlist metadata in addition to the
609 video metadata when using --write-info-json,
610 --write-description etc. (default)
611 --no-write-playlist-metafiles Do not write playlist metadata when using
612 --write-info-json, --write-description etc.
613 --clean-info-json Remove some private fields such as
614 filenames from the infojson. Note that it
615 could still contain some personal
616 information (default)
617 --no-clean-info-json Write all fields to the infojson
618 --write-comments Retrieve video comments to be placed in the
619 infojson. The comments are fetched even
620 without this option if the extraction is
621 known to be quick (Alias: --get-comments)
622 --no-write-comments Do not retrieve video comments unless the
623 extraction is known to be quick (Alias:
625 --load-info-json FILE JSON file containing the video information
626 (created with the "--write-info-json"
628 --cookies FILE Netscape formatted file to read cookies
629 from and dump cookie jar in
630 --no-cookies Do not read/dump cookies from/to file
632 --cookies-from-browser BROWSER[+KEYRING][:PROFILE]
633 The name of the browser and (optionally)
634 the name/path of the profile to load
635 cookies from, separated by a ":". Currently
636 supported browsers are: brave, chrome,
637 chromium, edge, firefox, opera, safari,
638 vivaldi. By default, the most recently
639 accessed profile is used. The keyring used
640 for decrypting Chromium cookies on Linux
641 can be (optionally) specified after the
642 browser name separated by a "+". Currently
643 supported keyrings are: basictext,
644 gnomekeyring, kwallet
645 --no-cookies-from-browser Do not load cookies from browser (default)
646 --cache-dir DIR Location in the filesystem where youtube-dl
647 can store some downloaded information (such
648 as client ids and signatures) permanently.
649 By default $XDG_CACHE_HOME/yt-dlp or
651 --no-cache-dir Disable filesystem caching
652 --rm-cache-dir Delete all filesystem cache files
654 ## Thumbnail Options:
655 --write-thumbnail Write thumbnail image to disk
656 --no-write-thumbnail Do not write thumbnail image to disk
658 --write-all-thumbnails Write all thumbnail image formats to disk
659 --list-thumbnails List available thumbnails of each video.
660 Simulate unless --no-simulate is used
662 ## Internet Shortcut Options:
663 --write-link Write an internet shortcut file, depending
664 on the current platform (.url, .webloc or
665 .desktop). The URL may be cached by the OS
666 --write-url-link Write a .url Windows internet shortcut. The
667 OS caches the URL based on the file path
668 --write-webloc-link Write a .webloc macOS internet shortcut
669 --write-desktop-link Write a .desktop Linux internet shortcut
671 ## Verbosity and Simulation Options:
672 -q, --quiet Activate quiet mode. If used with
673 --verbose, print the log to stderr
674 --no-warnings Ignore warnings
675 -s, --simulate Do not download the video and do not write
677 --no-simulate Download the video even if printing/listing
679 --ignore-no-formats-error Ignore "No video formats" error. Useful for
680 extracting metadata even if the videos are
681 not actually available for download
683 --no-ignore-no-formats-error Throw error when no downloadable video
684 formats are found (default)
685 --skip-download Do not download the video but write all
686 related files (Alias: --no-download)
687 -O, --print [WHEN:]TEMPLATE Field name or output template to print to
688 screen, optionally prefixed with when to
689 print it, separated by a ":". Supported
690 values of "WHEN" are the same as that of
691 --use-postprocessor, and "video" (default).
692 Implies --quiet and --simulate (unless
693 --no-simulate is used). This option can be
695 --print-to-file [WHEN:]TEMPLATE FILE
696 Append given template to the file. The
697 values of WHEN and TEMPLATE are same as
698 that of --print. FILE uses the same syntax
699 as the output template. This option can be
701 -j, --dump-json Quiet, but print JSON information for each
702 video. Simulate unless --no-simulate is
703 used. See "OUTPUT TEMPLATE" for a
704 description of available keys
705 -J, --dump-single-json Quiet, but print JSON information for each
706 url or infojson passed. Simulate unless
707 --no-simulate is used. If the URL refers to
708 a playlist, the whole playlist information
709 is dumped in a single line
710 --force-write-archive Force download archive entries to be
711 written as far as no errors occur, even if
712 -s or another simulation option is used
713 (Alias: --force-download-archive)
714 --newline Output progress bar as new lines
715 --no-progress Do not print progress bar
716 --progress Show progress bar, even if in quiet mode
717 --console-title Display progress in console titlebar
718 --progress-template [TYPES:]TEMPLATE
719 Template for progress outputs, optionally
720 prefixed with one of "download:" (default),
721 "download-title:" (the console title),
722 "postprocess:", or "postprocess-title:".
723 The video's fields are accessible under the
724 "info" key and the progress attributes are
725 accessible under "progress" key. E.g.:
726 --console-title --progress-template
727 "download-title:%(info.id)s-%(progress.eta)s"
728 -v, --verbose Print various debugging information
729 --dump-pages Print downloaded pages encoded using base64
730 to debug problems (very verbose)
731 --write-pages Write downloaded intermediary pages to
732 files in the current directory to debug
734 --print-traffic Display sent and read HTTP traffic
737 --encoding ENCODING Force the specified encoding (experimental)
738 --legacy-server-connect Explicitly allow HTTPS connection to
739 servers that do not support RFC
5746 secure
741 --no-check-certificates Suppress HTTPS certificate validation
742 --prefer-insecure Use an unencrypted connection to retrieve
743 information about the video (Currently
744 supported only for YouTube)
745 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
746 separated by a colon ":". You can use this
747 option multiple times
748 --bidi-workaround Work around terminals that lack
749 bidirectional text support. Requires bidiv
750 or fribidi executable in PATH
751 --sleep-requests SECONDS Number of seconds to sleep between requests
752 during data extraction
753 --sleep-interval SECONDS Number of seconds to sleep before each
754 download. This is the minimum time to sleep
755 when used along with --max-sleep-interval
756 (Alias: --min-sleep-interval)
757 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
758 only be used along with --min-sleep-interval
759 --sleep-subtitles SECONDS Number of seconds to sleep before each
762 ## Video Format Options:
763 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
765 -S, --format-sort SORTORDER Sort the formats by the fields given, see
766 "Sorting Formats" for more details
767 --S-force, --format-sort-force Force user specified sort order to have
768 precedence over all fields, see "Sorting
769 Formats" for more details
770 --no-format-sort-force Some fields have precedence over the user
771 specified sort order (default), see
772 "Sorting Formats" for more details
773 --video-multistreams Allow multiple video streams to be merged
775 --no-video-multistreams Only one video stream is downloaded for
776 each output file (default)
777 --audio-multistreams Allow multiple audio streams to be merged
779 --no-audio-multistreams Only one audio stream is downloaded for
780 each output file (default)
781 --prefer-free-formats Prefer video formats with free containers
782 over non-free ones of same quality. Use
783 with "-S ext" to strictly prefer free
784 containers irrespective of quality
785 --no-prefer-free-formats Don't give any special preference to free
787 --check-formats Make sure formats are selected only from
788 those that are actually downloadable
789 --check-all-formats Check all formats for whether they are
790 actually downloadable
791 --no-check-formats Do not check that the formats are actually
793 -F, --list-formats List available formats of each video.
794 Simulate unless --no-simulate is used
795 --merge-output-format FORMAT If a merge is required (e.g.
796 bestvideo+bestaudio), output to given
797 container format. One of mkv, mp4, ogg,
798 webm, flv. Ignored if no merge is required
801 --write-subs Write subtitle file
802 --no-write-subs Do not write subtitle file (default)
803 --write-auto-subs Write automatically generated subtitle file
804 (Alias: --write-automatic-subs)
805 --no-write-auto-subs Do not write auto-generated subtitles
806 (default) (Alias: --no-write-automatic-subs)
807 --list-subs List available subtitles of each video.
808 Simulate unless --no-simulate is used
809 --sub-format FORMAT Subtitle format, accepts formats
810 preference, for example: "srt" or
812 --sub-langs LANGS Languages of the subtitles to download (can
813 be regex) or "all" separated by commas.
814 (Eg: --sub-langs "en.*,ja") You can prefix
815 the language code with a "-" to exempt it
816 from the requested languages. (Eg:
817 --sub-langs all,-live_chat) Use --list-subs
818 for a list of available language tags
820 ## Authentication Options:
821 -u, --username USERNAME Login with this account ID
822 -p, --password PASSWORD Account password. If this option is left
823 out, yt-dlp will ask interactively
824 -2, --twofactor TWOFACTOR Two-factor authentication code
825 -n, --netrc Use .netrc authentication data
826 --netrc-location PATH Location of .netrc authentication data;
827 either the path or its containing
828 directory. Defaults to ~/.netrc
829 --video-password PASSWORD Video password (vimeo, youku)
830 --ap-mso MSO Adobe Pass multiple-system operator (TV
831 provider) identifier, use --ap-list-mso for
832 a list of available MSOs
833 --ap-username USERNAME Multiple-system operator account login
834 --ap-password PASSWORD Multiple-system operator account password.
835 If this option is left out, yt-dlp will ask
837 --ap-list-mso List all supported multiple-system
840 ## Post-Processing Options:
841 -x, --extract-audio Convert video files to audio-only files
842 (requires ffmpeg and ffprobe)
843 --audio-format FORMAT Specify audio format to convert the audio
844 to when -x is used. Currently supported
845 formats are: best (default) or one of aac,
846 flac, mp3, m4a, opus, vorbis, wav, alac
847 --audio-quality QUALITY Specify ffmpeg audio quality to use when
848 converting the audio with -x. Insert a
849 value between
0 (best) and
10 (worst) for
850 VBR or a specific bitrate like
128K
852 --remux-video FORMAT Remux the video into another container if
853 necessary (currently supported: mp4, mkv,
854 flv, webm, mov, avi, mka, ogg, aac, flac,
855 mp3, m4a, opus, vorbis, wav, alac). If
856 target container does not support the
857 video/audio codec, remuxing will fail. You
858 can specify multiple rules; Eg.
859 "aac>m4a/mov>mp4/mkv" will remux aac to
860 m4a, mov to mp4 and anything else to mkv.
861 --recode-video FORMAT Re-encode the video into another format if
862 re-encoding is necessary. The syntax and
863 supported formats are the same as --remux-video
864 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
865 Specify the postprocessor/executable name
866 and the arguments separated by a colon ":"
867 to give the argument to the specified
868 postprocessor/executable. Supported PP are:
869 Merger, ModifyChapters, SplitChapters,
870 ExtractAudio, VideoRemuxer, VideoConvertor,
871 Metadata, EmbedSubtitle, EmbedThumbnail,
872 SubtitlesConvertor, ThumbnailsConvertor,
873 FixupStretched, FixupM4a, FixupM3u8,
874 FixupTimestamp and FixupDuration. The
875 supported executables are: AtomicParsley,
876 FFmpeg and FFprobe. You can also specify
877 "PP+EXE:ARGS" to give the arguments to the
878 specified executable only when being used
879 by the specified postprocessor.
880 Additionally, for ffmpeg/ffprobe, "_i"/"_o"
881 can be appended to the prefix optionally
882 followed by a number to pass the argument
883 before the specified input/output file. Eg:
884 --ppa "Merger+ffmpeg_i1:-v quiet". You can
885 use this option multiple times to give
886 different arguments to different
887 postprocessors. (Alias: --ppa)
888 -k, --keep-video Keep the intermediate video file on disk
889 after post-processing
890 --no-keep-video Delete the intermediate video file after
891 post-processing (default)
892 --post-overwrites Overwrite post-processed files (default)
893 --no-post-overwrites Do not overwrite post-processed files
894 --embed-subs Embed subtitles in the video (only for mp4,
896 --no-embed-subs Do not embed subtitles (default)
897 --embed-thumbnail Embed thumbnail in the video as cover art
898 --no-embed-thumbnail Do not embed thumbnail (default)
899 --embed-metadata Embed metadata to the video file. Also
900 embeds chapters/infojson if present unless
901 --no-embed-chapters/--no-embed-info-json
902 are used (Alias: --add-metadata)
903 --no-embed-metadata Do not add metadata to file (default)
904 (Alias: --no-add-metadata)
905 --embed-chapters Add chapter markers to the video file
906 (Alias: --add-chapters)
907 --no-embed-chapters Do not add chapter markers (default)
908 (Alias: --no-add-chapters)
909 --embed-info-json Embed the infojson as an attachment to
911 --no-embed-info-json Do not embed the infojson as an attachment
913 --parse-metadata FROM:TO Parse additional metadata like title/artist
914 from other fields; see "MODIFYING METADATA"
916 --replace-in-metadata FIELDS REGEX REPLACE
917 Replace text in a metadata field using the
918 given regex. This option can be used
920 --xattrs Write metadata to the video file's xattrs
921 (using dublin core and xdg standards)
922 --concat-playlist POLICY Concatenate videos in a playlist. One of
923 "never", "always", or "multi_video"
924 (default; only when the videos form a
925 single show). All the video files must have
926 same codecs and number of streams to be
927 concatable. The "pl_video:" prefix can be
928 used with "--paths" and "--output" to set
929 the output filename for the concatenated
930 files. See "OUTPUT TEMPLATE" for details
931 --fixup POLICY Automatically correct known faults of the
932 file. One of never (do nothing), warn (only
933 emit a warning), detect_or_warn (the
934 default; fix file if we can, warn
935 otherwise), force (try fixing even if file
937 --ffmpeg-location PATH Location of the ffmpeg binary; either the
938 path to the binary or its containing
940 --exec [WHEN:]CMD Execute a command, optionally prefixed with
941 when to execute it (after_move if
942 unspecified), separated by a ":". Supported
943 values of "WHEN" are the same as that of
944 --use-postprocessor. Same syntax as the
945 output template can be used to pass any
946 field as arguments to the command. After
947 download, an additional field "filepath"
948 that contains the final path of the
949 downloaded file is also available, and if
950 no fields are passed, %(filepath)q is
951 appended to the end of the command. This
952 option can be used multiple times
953 --no-exec Remove any previously defined --exec
954 --convert-subs FORMAT Convert the subtitles to another format
955 (currently supported: srt, vtt, ass, lrc)
956 (Alias: --convert-subtitles)
957 --convert-thumbnails FORMAT Convert the thumbnails to another format
958 (currently supported: jpg, png, webp)
959 --split-chapters Split video into multiple files based on
960 internal chapters. The "chapter:" prefix
961 can be used with "--paths" and "--output"
962 to set the output filename for the split
963 files. See "OUTPUT TEMPLATE" for details
964 --no-split-chapters Do not split video based on chapters
966 --remove-chapters REGEX Remove chapters whose title matches the
967 given regular expression. Time ranges
968 prefixed by a "*" can also be used in place
969 of chapters to remove the specified range.
970 Eg: --remove-chapters "*
10:
15-
15:
00"
971 --remove-chapters "intro". This option can
972 be used multiple times
973 --no-remove-chapters Do not remove any chapters from the file
975 --force-keyframes-at-cuts Force keyframes around the chapters before
976 removing/splitting them. Requires a
977 re-encode and thus is very slow, but the
978 resulting video may have fewer artifacts
980 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
981 when cutting/splitting (default)
982 --use-postprocessor NAME[:ARGS] The (case sensitive) name of plugin
983 postprocessors to be enabled, and
984 (optionally) arguments to be passed to it,
985 separated by a colon ":". ARGS are a
986 semicolon ";" delimited list of NAME=VALUE.
987 The "when" argument determines when the
988 postprocessor is invoked. It can be one of
989 "pre_process" (after video extraction),
990 "after_filter" (after video passes filter),
991 "before_dl" (before each video download),
992 "post_process" (after each video download;
993 default), "after_move" (after moving video
994 file to it's final locations),
995 "after_video" (after downloading and
996 processing all formats of a video), or
997 "playlist" (at end of playlist). This
998 option can be used multiple times to add
999 different postprocessors
1001 ## SponsorBlock Options:
1002 Make chapter entries for, or remove various segments (sponsor,
1003 introductions, etc.) from downloaded YouTube videos using the
1004 [SponsorBlock API](https://sponsor.ajay.app)
1006 --sponsorblock-mark CATS SponsorBlock categories to create chapters
1007 for, separated by commas. Available
1008 categories are all, default(=all), sponsor,
1009 intro, outro, selfpromo, preview, filler,
1010 interaction, music_offtopic, poi_highlight.
1011 You can prefix the category with a "-" to
1012 exempt it. See [
1] for description of the
1013 categories. Eg: --sponsorblock-mark all,-preview
1014 [
1] https://wiki.sponsor.ajay.app/w/Segment_Categories
1015 --sponsorblock-remove CATS SponsorBlock categories to be removed from
1016 the video file, separated by commas. If a
1017 category is present in both mark and
1018 remove, remove takes precedence. The syntax
1019 and available categories are the same as
1020 for --sponsorblock-mark except that
1021 "default" refers to "all,-filler" and
1022 poi_highlight is not available
1023 --sponsorblock-chapter-title TEMPLATE
1024 The title template for SponsorBlock
1025 chapters created by --sponsorblock-mark.
1026 The same syntax as the output template is
1027 used, but the only available fields are
1028 start_time, end_time, category, categories,
1029 name, category_names. Defaults to
1030 "[SponsorBlock]: %(category_names)l"
1031 --no-sponsorblock Disable both --sponsorblock-mark and
1032 --sponsorblock-remove
1033 --sponsorblock-api URL SponsorBlock API location, defaults to
1034 https://sponsor.ajay.app
1036 ## Extractor Options:
1037 --extractor-retries RETRIES Number of retries for known extractor
1038 errors (default is
3), or "infinite"
1039 --allow-dynamic-mpd Process dynamic DASH manifests (default)
1040 (Alias: --no-ignore-dynamic-mpd)
1041 --ignore-dynamic-mpd Do not process dynamic DASH manifests
1042 (Alias: --no-allow-dynamic-mpd)
1043 --hls-split-discontinuity Split HLS playlists to different formats at
1044 discontinuities such as ad breaks
1045 --no-hls-split-discontinuity Do not split HLS playlists to different
1046 formats at discontinuities such as ad
1048 --extractor-args KEY:ARGS Pass these arguments to the extractor. See
1049 "EXTRACTOR ARGUMENTS" for details. You can
1050 use this option multiple times to give
1051 arguments for different extractors
1055 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
1057 1. **Main Configuration**: The file given by
`--config-location`
1058 1. **Portable Configuration**:
`yt-dlp.conf` in the same directory as the bundled binary. If you are running from source-code (
`<root dir>/yt_dlp/__main__.py`), the root directory is used instead.
1059 1. **Home Configuration**:
`yt-dlp.conf` in the home path given by
`-P`, or in the current directory if no such path is given
1060 1. **User Configuration**:
1061 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
1062 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
1063 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
1064 * `%APPDATA%/yt-dlp/config.txt`
1066 * `~/yt-dlp.conf.txt`
1068 `%XDG_CONFIG_HOME%` defaults to
`~/.config` if undefined. On windows,
`%APPDATA%` generally points to
`C:\Users\<user name>\AppData\Roaming` and
`~` points to
`%HOME%` if present,
`%USERPROFILE%` (generally
`C:\Users\<user name>`), or
`%HOMEDRIVE%%HOMEPATH%`
1070 1. **System Configuration**:
`/etc/yt-dlp.conf`
1072 For example, with the following configuration file yt-dlp will always extract the audio, not copy the mtime, use a proxy and save all videos under
`YouTube` directory in your home directory:
1074 # Lines starting with # are comments
1076 # Always extract audio
1079 # Do not copy the mtime
1083 --proxy 127.0.0.1:3128
1085 # Save all videos under YouTube directory in your home directory
1086 -o ~/YouTube/%(title)s.%(ext)s
1089 Note that options in configuration file are just the same options aka switches used in regular command line calls; thus there **must be no whitespace** after
`-` or
`--`, e.g.
`-o` or
`--proxy` but not
`- o` or
`-- proxy`.
1091 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.
1093 ### Authentication with `.netrc` file
1095 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:
1098 chmod a-rwx,u+rw $HOME/.netrc
1100 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1102 machine <extractor> login <username> password <password>
1106 machine youtube login myaccount@gmail.com password my_youtube_password
1107 machine twitch login my_twitch_account_name password my_twitch_password
1109 To activate authentication with the
`.netrc` file you should pass
`--netrc` to yt-dlp or place it in the [configuration file](#configuration).
1111 The default location of the .netrc file is
`$HOME` (
`~`) in UNIX. On Windows, it is
`%HOME%` if present,
`%USERPROFILE%` (generally
`C:\Users\<user name>`) or
`%HOMEDRIVE%%HOMEPATH%`
1115 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.
1117 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1118 **tl;dr:** [navigate me to examples](#output-template-examples).
1119 <!-- MANPAGE: END EXCLUDED SECTION -->
1121 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).
1123 It may however also contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to
[Python string formatting operations](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting). For example,
`%(NAME)s` or
`%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations.
1125 The field names themselves (the part inside the parenthesis) can also have some special formatting:
1127 1. **Object traversal**: The dictionaries and lists available in metadata can be traversed by using a
`.` (dot) separator. You can also do python slicing using
`:`. Eg:
`%(tags.0)s`,
`%(subtitles.en.-1.ext)s`,
`%(id.3:7:-1)s`,
`%(formats.:.format_id)s`.
`%()s` refers to the entire infodict. Note that all the fields that become available using this method are not listed below. Use
`-j` to see such fields
1129 1. **Addition**: Addition and subtraction of numeric fields can be done using
`+` and
`-` respectively. Eg:
`%(playlist_index+10)03d`,
`%(n_entries+1-playlist_index)d`
1131 1. **Date/time Formatting**: Date/time fields can be formatted according to
[strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it separated from the field name using a
`>`. Eg:
`%(duration>%H-%M-%S)s`,
`%(upload_date>%Y-%m-%d)s`,
`%(epoch-3600>%H-%M-%S)s`
1133 1. **Alternatives**: Alternate fields can be specified separated with a
`,`. Eg:
`%(release_date>%Y,upload_date>%Y|Unknown)s`
1135 1. **Replacement**: A replacement value can 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.
1137 1. **Default**: A literal default value can be specified for when the field is empty using a
`|` separator. This overrides
`--output-na-template`. Eg:
`%(uploader|Unknown)s`
1139 1. **More Conversions**: In addition to the normal format types
`diouxXeEfFgGcrs`,
`B`,
`j`,
`l`,
`q`,
`D`,
`S` can be used for converting to **B**ytes, **j**son (flag
`#` for pretty-printing), a comma separated **l**ist (flag
`#` for
`\n` newline-separated), a string **q**uoted for the terminal (flag
`#` to split a list into different arguments), to add **D**ecimal suffixes (Eg:
10M) (flag
`#` to use
1024 as factor), and to **S**anitize as filename (flag
`#` for restricted), respectively
1141 1. **Unicode normalization**: The format type
`U` can be used for NFC
[unicode normalization](https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize). The alternate form flag (
`#`) changes the normalization to NFD and the conversion flag
`+` can be used for NFKC/NFKD compatibility equivalence normalization. Eg:
`%(title)+.100U` is NFKC
1143 To summarize, the general syntax for a field is:
1145 %(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
1148 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`. For example,
`-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"` will put the thumbnails in a folder with the same name as the video. If any of the templates is empty, that type of file will not be written. Eg:
`--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
1150 The available fields are:
1152 - `id` (string): Video identifier
1153 - `title` (string): Video title
1154 - `fulltitle` (string): Video title ignoring live timestamp and generic title
1155 - `url` (string): Video URL
1156 - `ext` (string): Video filename extension
1157 - `alt_title` (string): A secondary title of the video
1158 - `description` (string): The description of the video
1159 - `display_id` (string): An alternative identifier for the video
1160 - `uploader` (string): Full name of the video uploader
1161 - `license` (string): License name the video is licensed under
1162 - `creator` (string): The creator of the video
1163 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
1164 - `upload_date` (string): Video upload date in UTC (YYYYMMDD)
1165 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
1166 - `release_date` (string): The date (YYYYMMDD) when the video was released in UTC
1167 - `modified_timestamp` (numeric): UNIX timestamp of the moment the video was last modified
1168 - `modified_date` (string): The date (YYYYMMDD) when the video was last modified in UTC
1169 - `uploader_id` (string): Nickname or id of the video uploader
1170 - `channel` (string): Full name of the channel the video is uploaded on
1171 - `channel_id` (string): Id of the channel
1172 - `channel_follower_count` (numeric): Number of followers of the channel
1173 - `location` (string): Physical location where the video was filmed
1174 - `duration` (numeric): Length of the video in seconds
1175 - `duration_string` (string): Length of the video (HH:mm:ss)
1176 - `view_count` (numeric): How many users have watched the video on the platform
1177 - `like_count` (numeric): Number of positive ratings of the video
1178 - `dislike_count` (numeric): Number of negative ratings of the video
1179 - `repost_count` (numeric): Number of reposts of the video
1180 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
1181 - `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)
1182 - `age_limit` (numeric): Age restriction for the video (years)
1183 - `live_status` (string): One of "is_live", "was_live", "is_upcoming", "not_live"
1184 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
1185 - `was_live` (boolean): Whether this video was originally a live stream
1186 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
1187 - `availability` (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
1188 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1189 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
1190 - `format` (string): A human-readable description of the format
1191 - `format_id` (string): Format code specified by
`--format`
1192 - `format_note` (string): Additional info about the format
1193 - `width` (numeric): Width of the video
1194 - `height` (numeric): Height of the video
1195 - `resolution` (string): Textual description of width and height
1196 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
1197 - `abr` (numeric): Average audio bitrate in KBit/s
1198 - `acodec` (string): Name of the audio codec in use
1199 - `asr` (numeric): Audio sampling rate in Hertz
1200 - `vbr` (numeric): Average video bitrate in KBit/s
1201 - `fps` (numeric): Frame rate
1202 - `dynamic_range` (string): The dynamic range of the video
1203 - `vcodec` (string): Name of the video codec in use
1204 - `container` (string): Name of the container format
1205 - `filesize` (numeric): The number of bytes, if known in advance
1206 - `filesize_approx` (numeric): An estimate for the number of bytes
1207 - `protocol` (string): The protocol that will be used for the actual download
1208 - `extractor` (string): Name of the extractor
1209 - `extractor_key` (string): Key name of the extractor
1210 - `epoch` (numeric): Unix epoch of when the information extraction was completed
1211 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
1212 - `video_autonumber` (numeric): Number that will be increased with each video
1213 - `n_entries` (numeric): Total number of extracted items in the playlist
1214 - `playlist_id` (string): Identifier of the playlist that contains the video
1215 - `playlist_title` (string): Name of the playlist that contains the video
1216 - `playlist` (string):
`playlist_id` or
`playlist_title`
1217 - `playlist_count` (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
1218 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1219 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
1220 - `playlist_uploader` (string): Full name of the playlist uploader
1221 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
1222 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
1223 - `webpage_url_basename` (string): The basename of the webpage URL
1224 - `webpage_url_domain` (string): The domain of the webpage URL
1225 - `original_url` (string): The URL given by the user (or same as
`webpage_url` for playlist entries)
1227 Available for the video that belongs to some logical chapter or section:
1229 - `chapter` (string): Name or title of the chapter the video belongs to
1230 - `chapter_number` (numeric): Number of the chapter the video belongs to
1231 - `chapter_id` (string): Id of the chapter the video belongs to
1233 Available for the video that is an episode of some series or programme:
1235 - `series` (string): Title of the series or programme the video episode belongs to
1236 - `season` (string): Title of the season the video episode belongs to
1237 - `season_number` (numeric): Number of the season the video episode belongs to
1238 - `season_id` (string): Id of the season the video episode belongs to
1239 - `episode` (string): Title of the video episode
1240 - `episode_number` (numeric): Number of the video episode within a season
1241 - `episode_id` (string): Id of the video episode
1243 Available for the media that is a track or a part of a music album:
1245 - `track` (string): Title of the track
1246 - `track_number` (numeric): Number of the track within an album or a disc
1247 - `track_id` (string): Id of the track
1248 - `artist` (string): Artist(s) of the track
1249 - `genre` (string): Genre(s) of the track
1250 - `album` (string): Title of the album the track belongs to
1251 - `album_type` (string): Type of the album
1252 - `album_artist` (string): List of all artists appeared on the album
1253 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1254 - `release_year` (numeric): Year (YYYY) when the album was released
1256 Available for
`chapter:` prefix when using
`--split-chapters` for videos with internal chapters:
1258 - `section_title` (string): Title of the chapter
1259 - `section_number` (numeric): Number of the chapter within the file
1260 - `section_start` (numeric): Start time of the chapter in seconds
1261 - `section_end` (numeric): End time of the chapter in seconds
1263 Available only when used in
`--print`:
1265 - `urls` (string): The URLs of all requested formats, one in each line
1266 - `filename` (string): Name of the video file. Note that the actual filename may be different due to post-processing. Use
`--exec echo` to get the name after all postprocessing is complete
1267 - `formats_table` (table): The video format table as printed by
`--list-formats`
1268 - `thumbnails_table` (table): The thumbnail format table as printed by
`--list-thumbnails`
1269 - `subtitles_table` (table): The subtitle format table as printed by
`--list-subs`
1270 - `automatic_captions_table` (table): The automatic subtitle format table as printed by
`--list-subs`
1273 Available only in
`--sponsorblock-chapter-title`:
1275 - `start_time` (numeric): Start time of the chapter in seconds
1276 - `end_time` (numeric): End time of the chapter in seconds
1277 - `categories` (list): The SponsorBlock categories the chapter belongs to
1278 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1279 - `category_names` (list): Friendly names of the categories
1280 - `name` (string): Friendly name of the smallest category
1282 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. For example for
`-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title
`yt-dlp test video` and id
`BaW_jenozKc`, this will result in a
`yt-dlp test video-BaW_jenozKc.mp4` file created in the current directory.
1284 Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with
`--output-na-placeholder` (
`NA` by default).
1286 **Tip**: Look at the
`-j` output to identify which fields are available for the particular URL
1288 For numeric sequences you can use
[numeric related formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting), for example,
`%(view_count)05d` will result in a string with view count padded with zeros up to
5 characters, like in
`00042`.
1290 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.
1292 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
1294 The current default template is
`%(title)s [%(id)s].%(ext)s`.
1296 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.
1298 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1299 #### Output template and Windows batch files
1301 If you are using an output template inside a Windows batch file then you must escape plain percent characters (
`%`) by doubling, so that
`-o "%(title)s-%(id)s.%(ext)s"` should become
`-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch
`%`'s that are not plain characters, e.g. environment variables for expansion should stay intact:
`-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
1302 <!-- MANPAGE: END EXCLUDED SECTION -->
1304 #### Output template examples
1307 $ yt-dlp --get-filename -o "test video.%(ext)s" BaW_jenozKc
1308 test video.webm # Literal name with correct extension
1310 $ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
1311 youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
1313 $ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
1314 youtube-dl_test_video_.webm # Restricted file name
1316 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1317 $ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1319 # Download YouTube playlist videos in separate directories according to their uploaded year
1320 $ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1322 # Prefix playlist index with " - " separator, but only if it is available
1323 $ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1325 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1326 $ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1328 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1329 $ 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"
1331 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1332 $ 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"
1334 # Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
1335 # and put all temporary files in "C:\MyVideos\tmp"
1336 $ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs
1338 # Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
1339 $ 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
1341 # Stream the video being downloaded to stdout
1342 $ yt-dlp -o - BaW_jenozKc
1347 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1348 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`.
1350 **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.
1352 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.
1354 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1355 **tl;dr:** [navigate me to examples](#format-selection-examples).
1356 <!-- MANPAGE: END EXCLUDED SECTION -->
1358 The simplest case is requesting a specific format, for example with
`-f 22` you can download the format with format code equal to
22. You can get the list of available format codes for particular video using
`--list-formats` or
`-F`. Note that these format codes are extractor specific.
1360 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.
1362 You can use
`-f -` to interactively provide the format selector *for each video*
1364 You can also use special names to select particular edge case formats:
1366 - `all`: Select **all formats** separately
1367 - `mergeall`: Select and **merge all formats** (Must be used with
`--audio-multistreams`,
`--video-multistreams` or both)
1368 - `b*`,
`best*`: Select the best quality format that **contains either** a video or an audio
1369 - `b`,
`best`: Select the best quality format that **contains both** video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
1370 - `bv`,
`bestvideo`: Select the best quality **video-only** format. Equivalent to
`best*[acodec=none]`
1371 - `bv*`,
`bestvideo*`: Select the best quality format that **contains video**. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
1372 - `ba`,
`bestaudio`: Select the best quality **audio-only** format. Equivalent to
`best*[vcodec=none]`
1373 - `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))
1374 - `w*
`, `worst*
`: Select the worst quality format that contains either a video or an audio
1375 - `w
`, `worst
`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]
`
1376 - `wv
`, `worstvideo
`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]
`
1377 - `wv*
`, `worstvideo*
`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]
`
1378 - `wa
`, `worstaudio
`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]
`
1379 - `wa*
`, `worstaudio*
`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]
`
1381 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.
1383 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.
1385 If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred, for example `-f
22/
17/
18` will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
1387 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
`.
1389 You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...
` (requires ffmpeg installed), for example `-f bestvideo+bestaudio
` will download the best video-only format, the best audio-only format and mux them together with ffmpeg.
1391 **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
1393 Unless `--video-multistreams
` is used, all formats with a video stream except the first one are ignored. Similarly, unless `--audio-multistreams
` is used, all formats with an audio stream except the first one are ignored. For example, `-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams
` will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But `-f bestvideo+best+bestaudio --no-video-multistreams
` will download and merge only `bestvideo
` and `bestaudio
`. `best
` is ignored since another format containing a video stream (`bestvideo
`) has already been selected. The order of the formats is therefore important. `-f best+bestaudio --no-audio-multistreams
` will download and merge both formats while `-f bestaudio+best --no-audio-multistreams
` will ignore `best
` and download only `bestaudio
`.
1395 ## Filtering Formats
1397 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=
720]"
` (or `-f "[filesize>
10M]"
`).
1399 The following numeric meta fields can be used with comparisons `<
`, `<=
`, `>
`, `>=
`, `=
` (equals), `!=
` (not equals):
1401 - `filesize
`: The number of bytes, if known in advance
1402 - `width
`: Width of the video, if known
1403 - `height
`: Height of the video, if known
1404 - `tbr
`: Average bitrate of audio and video in KBit/s
1405 - `abr
`: Average audio bitrate in KBit/s
1406 - `vbr
`: Average video bitrate in KBit/s
1407 - `asr
`: Audio sampling rate in Hertz
1410 Also filtering work for comparisons `=
` (equals), `^=
` (starts with), `$=
` (ends with), `*=
` (contains), `~=
` (matches regex) and following string meta fields:
1412 - `ext
`: File extension
1413 - `acodec
`: Name of the audio codec in use
1414 - `vcodec
`: Name of the video codec in use
1415 - `container
`: Name of the container format
1416 - `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
`)
1417 - `format_id
`: A short description of the format
1418 - `language
`: Language code
1420 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 `._-
`.
1422 Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.
1424 Formats for which the value is not known are excluded unless you put a question mark (`?
`) after the operator. You can combine format filters, so `-f "[height<=?
720][tbr>
500]"
` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s. You can also use the filters with `all
` to download all formats that satisfy the filter. For example, `-f "all[vcodec=none]"
` selects all audio-only formats.
1426 Format selectors can also be grouped using parentheses, for example if you want to download the best pre-merged mp4 and webm formats with a height lower than 480 you can use `-f "(mp4,webm)[height<
480]"
`.
1430 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...
`.
1432 The available fields are:
1434 - `hasvid
`: Gives priority to formats that has a video stream
1435 - `hasaud
`: Gives priority to formats that has a audio stream
1436 - `ie_pref
`: The format preference
1437 - `lang
`: The language preference
1438 - `quality
`: The quality of the format
1439 - `source
`: The preference of the source
1440 - `proto
`: Protocol used for download (`https
`/`ftps
` > `http
`/`ftp
` > `m3u8_native
`/`m3u8
` > `http_dash_segments
`> `websocket_frag
` > `mms
`/`rtsp
` > `f4f
`/`f4m
`)
1441 - `vcodec
`: Video Codec (`av01
` > `vp9.2
` > `vp9
` > `h265
` > `h264
` > `vp8
` > `h263
` > `theora
` > other)
1442 - `acodec
`: Audio Codec (`flac
`/`alac
` > `wav
`/`aiff
` > `opus
` > `vorbis
` > `aac
` > `mp4a
` > `mp3
` > `eac3
` > `ac3
` > `dts
` > other)
1443 - `codec
`: Equivalent to `vcodec,acodec
`
1444 - `vext
`: Video Extension (`mp4
` > `webm
` > `flv
` > other). If `--prefer-free-formats
` is used, `webm
` is preferred.
1445 - `aext
`: Audio Extension (`m4a
` > `aac
` > `mp3
` > `ogg
` > `opus
` > `webm
` > other). If `--prefer-free-formats
` is used, the order changes to `opus
` > `ogg
` > `webm
` > `m4a
` > `mp3
` > `aac
`.
1446 - `ext
`: Equivalent to `vext,aext
`
1447 - `filesize
`: Exact filesize, if known in advance
1448 - `fs_approx
`: Approximate filesize calculated from the manifests
1449 - `size
`: Exact filesize if available, otherwise approximate filesize
1450 - `height
`: Height of video
1451 - `width
`: Width of video
1452 - `res
`: Video resolution, calculated as the smallest dimension.
1453 - `fps
`: Framerate of video
1454 - `hdr
`: The dynamic range of the video (`DV
` > `HDR12
` > `HDR10+
` > `HDR10
` > `HLG
` > `SDR
`)
1455 - `tbr
`: Total average bitrate in KBit/s
1456 - `vbr
`: Average video bitrate in KBit/s
1457 - `abr
`: Average audio bitrate in KBit/s
1458 - `br
`: Equivalent to using `tbr,vbr,abr
`
1459 - `asr
`: Audio sample rate in Hz
1461 **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.
1463 All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a `+
`. Eg: `+res
` prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a `:
`. Eg: `res:
720` prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For `codec
` and `ext
`, you can provide two preferred values, the first for video and the second for audio. Eg: `+codec:avc:m4a
` (equivalent to `+vcodec:avc,+acodec:m4a
`) sets the video codec preference to `h264
` > `h265
` > `vp9
` > `vp9.2
` > `av01
` > `vp8
` > `h263
` > `theora
` and audio codec preference to `mp4a
` > `aac
` > `vorbis
` > `opus
` > `mp3
` > `ac3
` > `dts
`. You can also make the sorting prefer the nearest values to the provided by using `~
` as the delimiter. Eg: `filesize~
1G
` prefers the format with filesize closest to 1 GiB.
1465 The fields `hasvid
` and `ie_pref
` are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using `--format-sort-force
`. Apart from these, the default order used is: `lang,quality,res,fps,hdr:
12,codec:vp9.2,size,br,asr,proto,ext,hasaud,source,id
`. The extractors may override this default order, but they cannot override the user-provided order.
1467 Note that the default has `codec: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.
1469 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
`.
1471 **Tip**: You can use the `-v -F
` to see how the formats have been sorted (worst to best).
1473 ## Format Selection examples
1476 # Download and merge the best video-only format and the best audio-only format,
1477 # or download the best combined format if video-only format is not available
1478 $ yt-dlp -f "bv+ba/b"
1480 # Download best format that contains video,
1481 # and if it doesn't already have an audio stream, merge it with best audio-only format
1482 $ yt-dlp -f "bv*+ba/b"
1487 # Download the best video-only format and the best audio-only format without merging them
1488 # For this case, an output template should be used since
1489 # by default, bestvideo and bestaudio will have the same file name.
1490 $ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
1492 # Download and merge the best format that has a video stream,
1493 # and all audio-only formats into one file
1494 $ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
1496 # Download and merge the best format that has a video stream,
1497 # and the best 2 audio-only formats into one file
1498 $ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
1501 # The following examples show the old method (without -S) of format selection
1502 # and how to use -S to achieve a similar but (generally) better result
1504 # Download the worst video available (old method)
1505 $ yt-dlp -f "wv*+wa/w"
1507 # Download the best video available but with the smallest resolution
1510 # Download the smallest video available
1511 $ yt-dlp -S "+size,+br"
1515 # Download the best mp4 video available, or the best video if no mp4 available
1516 $ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
1518 # Download the best video with the best extension
1519 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1524 # Download the best video available but no better than 480p,
1525 # or the worst video if there is no video under 480p
1526 $ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"
1528 # Download the best video available with the largest height but no better than 480p,
1529 # or the best video with the smallest resolution if there is no video under 480p
1530 $ yt-dlp -S "height:480"
1532 # Download the best video available with the largest resolution but no better than 480p,
1533 # or the best video with the smallest resolution if there is no video under 480p
1534 # Resolution is determined by using the smallest dimension.
1535 # So this works correctly for vertical videos as well
1536 $ yt-dlp -S "res:480"
1540 # Download the best video (that also has audio) but no bigger than 50 MB,
1541 # or the worst video (that also has audio) if there is no video under 50 MB
1542 $ yt-dlp -f "b[filesize<50M] / w"
1544 # Download largest video (that also has audio) but no bigger than 50 MB,
1545 # or the smallest video (that also has audio) if there is no video under 50 MB
1546 $ yt-dlp -f "b" -S "filesize:50M"
1548 # Download best video (that also has audio) that is closest in size to 50 MB
1549 $ yt-dlp -f "b" -S "filesize~50M"
1553 # Download best video available via direct link over HTTP/HTTPS protocol,
1554 # or the best video available via any protocol if there is no such video
1555 $ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
1557 # Download best video available via the best protocol
1558 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1563 # Download the best video with either h264 or h265 codec,
1564 # or the best video if there is no such video
1565 $ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"
1567 # Download the best video with best codec no better than h264,
1568 # or the best video with worst codec if there is no such video
1569 $ yt-dlp -S "codec:h264"
1571 # Download the best video with worst codec no worse than h264,
1572 # or the best video with best codec if there is no such video
1573 $ yt-dlp -S "+codec:h264"
1577 # More complex examples
1579 # Download the best video no better than 720p preferring framerate greater than 30,
1580 # or the worst video (still preferring framerate greater than 30) if there is no such video
1581 $ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"
1583 # Download the video with the largest resolution no better than 720p,
1584 # or the video with the smallest resolution available if there is no such video,
1585 # preferring larger framerate for formats with the same resolution
1586 $ yt-dlp -S "res:720,fps"
1590 # Download the video with smallest resolution no worse than 480p,
1591 # or the video with the largest resolution available if there is no such video,
1592 # preferring better codec and then larger total bitrate for the same resolution
1593 $ yt-dlp -S "+res:480,codec,br"
1596 # MODIFYING METADATA
1598 The metadata obtained by the extractors can be modified by using `--parse-metadata
` and `--replace-in-metadata
`
1600 `--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.
1602 The general syntax of `--parse-metadata FROM:TO
` is to give the name of a field or an [output template](#output-template) to extract data from, and the format to interpret it as, separated by a colon `:`. Either a [python regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) with named capture groups or a similar syntax to the [output template](#output-template) (only `%(field)s
` formatting is supported) can be used for `TO
`. The option can be used multiple times to parse and modify various fields.
1604 Note that any field created by this can be used in the [output template](#output-template) and will also affect the media file's metadata added when using `--add-metadata
`.
1606 This option also has a few special uses:
1608 * You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field `additional_urls
` to the URL that you want to download. Eg: `--parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)
` will download the first vimeo video found in the description
1610 * You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a `meta_
` prefix. For example, any value you set to `meta_description
` field will be added to the `description
` field in the file. For example, you can use this to set a different "description" and "synopsis". To modify the metadata of individual streams, use the `meta<n>_
` prefix (Eg: `meta1_language
`). Any value set to the `meta_
` field will overwrite all default values.
1612 **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.
1614 For reference, these are the fields yt-dlp adds by default to the file metadata:
1616 Metadata fields | From
1617 :--------------------------|:------------------------------------------------
1618 `title
` | `track
` or `title
`
1619 `date
` | `upload_date
`
1620 `description
`, `synopsis
` | `description
`
1621 `purl
`, `comment
` | `webpage_url
`
1622 `track
` | `track_number
`
1623 `artist
` | `artist
`, `creator
`, `uploader
` or `uploader_id
`
1626 `album_artist
` | `album_artist
`
1627 `disc
` | `disc_number
`
1629 `season_number
` | `season_number
`
1630 `episode_id
` | `episode
` or `episode_id
`
1631 `episode_sort
` | `episode_number
`
1632 `language
` of each stream | the format's `language
`
1634 **Note**: The file format may not support some of these fields
1637 ## Modifying metadata examples
1640 # Interpret the title as "Artist - Title"
1641 $ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
1644 $ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"
1646 # Set title as "Series name S01E05"
1647 $ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
1649 # Prioritize uploader as the "artist" field in video metadata
1650 $ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --add-metadata
1652 # Set "comment" field in video metadata using description instead of webpage_url,
1653 # handling multiple lines correctly
1654 $ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --add-metadata
1656 # Remove "formats" field from the infojson by setting it to an empty string
1657 $ yt-dlp --parse-metadata ":(?P<formats>)" -j
1659 # Replace all spaces and "_" in title and uploader with a `-`
1660 $ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
1664 # EXTRACTOR ARGUMENTS
1666 Some extractors accept additional arguments which can be passed using `--extractor-args KEY:ARGS
`. `ARGS
` is a `;
` (semicolon) separated string of `ARG=VAL1,VAL2
`. Eg: `--extractor-args "youtube:player-client=android_embedded,web;include_live_dash" --extractor-args "funimation:version=uncut"
`
1668 The following extractors use this feature:
1671 * `skip
`: One or more of `hls
`, `dash
` or `translated_subs
` to skip extraction of the m3u8 manifests, dash manifests and auto-translated subtitles respectively
1672 * `player_client
`: Clients to extract video data from. The main clients are `web
`, `android
` and `ios
` with variants `_music
`, `_embedded
`, `_embedscreen
`, `_creator
` (Eg: `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.
1673 * `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
1674 * `include_live_dash
`: Include live dash formats even without `--live-from-start
` (These formats don't download properly)
1675 * `comment_sort
`: `top
` or `new
` (default) - choose comment sorting mode (on YouTube's side)
1676 * `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
`
1677 * 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
1679 #### youtubetab (YouTube playlists, channels, feeds, etc.)
1680 * `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)
1681 * `approximate_date
`: Extract approximate `upload_date
` in flat-playlist. This may cause date-based filters to be slightly off
1684 * `language
`: Languages to extract. Eg: `funimation:language=english,japanese
`
1685 * `version
`: The video version to extract - `uncut
` or `simulcast
`
1688 * `language
`: Languages to extract. Eg: `crunchyroll:language=jaJp
`
1689 * `hardsub
`: Which hard-sub versions to extract. Eg: `crunchyroll:hardsub=None,enUS
`
1691 #### crunchyrollbeta
1692 * `format
`: Which stream type(s) to extract. Default is `adaptive_hls
` Eg: `crunchyrollbeta:format=vo_adaptive_hls
`
1693 * Potentially useful values include `adaptive_hls
`, `adaptive_dash
`, `vo_adaptive_hls
`, `vo_adaptive_dash
`, `download_hls
`, `trailer_hls
`, `trailer_dash
`
1694 * `hardsub
`: Preference order for which hardsub versions to extract. Default is `None
` (no hardsubs). Eg: `crunchyrollbeta:hardsub=en-US,None
`
1697 * `video_types
`: Types of videos to download - one or more of `episodes
`, `movies
`, `clips
`, `trailers
`
1700 * `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.**
1702 #### youtubewebarchive
1703 * `check_all
`: Try to check more at the cost of more requests. One or more of `thumbnails
`, `captures
`
1706 * `comment_sort
`: `hot
` (default), `you
` (cookies needed), `top
`, `new
` - choose comment sorting mode (on GameJolt's side)
1709 * `res
`: resolution to ignore - one or more of `sd
`, `hd
`, `fhd
`
1710 * `vcodec
`: vcodec to ignore - one or more of `h264
`, `h265
`, `dvh265
`
1711 * `dr
`: dynamic range to ignore - one or more of `sdr
`, `hdr10
`, `dv
`
1714 * `app_version
`: App version to call mobile APIs with - should be set along with `manifest_app_version
`. (e.g. `20.2.1`)
1715 * `manifest_app_version
`: Numeric app version to call mobile APIs with. (e.g. `221`)
1718 * `tab
`: Which tab to download. One of `new
`, `top
`, `videos
`, `podcasts
`, `streams
`, `stacks
`. (E.g. `rokfinchannel:tab=streams
`)
1721 NOTE: These options may be changed/removed in the future without concern for backward compatibility
1723 <!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
1728 Plugins are loaded from `<root-dir>/ytdlp_plugins/<type>/__init__.py
`; where `<root-dir>
` is the directory of the binary (`<root-dir>/yt-dlp
`), or the root directory of the module if you are running directly from source-code (`<root dir>/yt_dlp/__main__.py
`). Plugins are currently not supported for the `pip
` version
1730 Plugins can be of `<type>
`s `extractor
` or `postprocessor
`. Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it. Postprocessor plugins can be invoked using `--use-postprocessor NAME
`.
1732 See [ytdlp_plugins](ytdlp_plugins) for example plugins.
1734 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
1736 If you are a plugin author, add [ytdlp-plugins](https://github.com/topics/ytdlp-plugins) as a topic to your repository for discoverability
1742 yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1744 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.
1746 From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1749 from yt_dlp import YoutubeDL
1751 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1752 with YoutubeDL() as ydl:
1756 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#L181).
1758 **Tip**: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of `YoutubeDL.extract_info
` to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through `YoutubeDL.sanitize_info
` as shown in the example above
1760 ## Embedding examples
1762 ### Extracting information
1768 URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'
1770 # ℹ️ See help(yt_dlp.YoutubeDL) for a list of available options and public functions
1772 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1773 info = ydl.extract_info(URL, download=False)
1775 # ℹ️ ydl.sanitize_info makes the info json-serializable
1776 print(json.dumps(ydl.sanitize_info(info)))
1778 ### Download from info-json
1783 INFO_FILE = 'path/to/video.info.json'
1785 with yt_dlp.YoutubeDL() as ydl:
1786 error_code = ydl.download_with_info_file(INFO_FILE)
1788 print('Some videos failed to download' if error_code
1789 else 'All videos successfully downloaded')
1797 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1800 'format': 'm4a/bestaudio/best'
1801 # ℹ️ See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
1802 'postprocessors': [{ # Extract audio using ffmpeg
1803 'key': 'FFmpegExtractAudio',
1804 'preferredcodec': 'm4a',
1808 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1809 error_code = ydl.download(URLS)
1811 ### Adding logger and progress hook
1816 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1819 def debug(self, msg):
1820 # For compatibility with youtube-dl, both debug and info are passed into debug
1821 # You can distinguish them by the prefix '[debug] '
1822 if msg.startswith('[debug] '):
1827 def info(self, msg):
1830 def warning(self, msg):
1833 def error(self, msg):
1837 # ℹ️ See "progress_hooks" in help(yt_dlp.YoutubeDL)
1839 if d['status'] == 'finished':
1840 print('Done downloading, now post-processing ...')
1844 'logger': MyLogger(),
1845 'progress_hooks': [my_hook],
1848 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1852 ### Add a custom PostProcessor
1857 URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1859 # ℹ️ See help(yt_dlp.postprocessor.PostProcessor)
1860 class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
1861 def run(self, info):
1862 self.to_screen('Doing stuff')
1866 with yt_dlp.YoutubeDL() as ydl:
1867 ydl.add_post_processor(MyCustomPP())
1872 ### Use a custom format selector
1877 URL = ['https://www.youtube.com/watch?v=BaW_jenozKc']
1879 def format_selector(ctx):
1880 """ Select the best video and the best audio that won't result in an mkv.
1881 NOTE: This is just an example and does not handle all cases """
1883 # formats are already sorted worst to best
1884 formats = ctx.get('formats')[::-1]
1886 # acodec='none' means there is no audio
1887 best_video = next(f for f in formats
1888 if f['vcodec'] != 'none' and f['acodec'] == 'none')
1890 # find compatible audio extension
1891 audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
1892 # vcodec='none' means there is no video
1893 best_audio = next(f for f in formats if (
1894 f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
1896 # These are the minimum required fields for a merged format
1898 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
1899 'ext': best_video['ext'],
1900 'requested_formats': [best_video, best_audio],
1901 # Must be + separated list of protocols
1902 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
1907 'format': format_selector,
1910 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1914 <!-- MANPAGE: MOVE "NEW FEATURES" SECTION HERE -->
1916 # DEPRECATED OPTIONS
1918 These are all the deprecated options and the current alternative to achieve the same effect
1920 #### Almost redundant options
1921 While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant
1923 -j, --dump-json --print "%()j"
1924 -F, --list-formats --print formats_table
1925 --list-thumbnails --print thumbnails_table --print playlist:thumbnails_table
1926 --list-subs --print automatic_captions_table --print subtitles_table
1928 #### Redundant options
1929 While these options are redundant, they are still expected to be used due to their ease of use
1931 --get-description --print description
1932 --get-duration --print duration_string
1933 --get-filename --print filename
1934 --get-format --print format
1936 --get-thumbnail --print thumbnail
1937 -e, --get-title --print title
1938 -g, --get-url --print urls
1939 --match-title REGEX --match-filter "title ~= (?i)REGEX"
1940 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
1941 --min-views COUNT --match-filter "view_count >=? COUNT"
1942 --max-views COUNT --match-filter "view_count <=? COUNT"
1943 --user-agent UA --add-header "User-Agent:UA"
1944 --referer URL --add-header "Referer:URL"
1947 #### Not recommended
1948 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1950 --exec-before-download CMD --exec "before_dl:CMD"
1951 --no-exec-before-download --no-exec
1952 --all-formats -f all
1953 --all-subs --sub-langs all --write-subs
1954 --print-json -j --no-simulate
1955 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)03d
1956 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1957 --id -o "%(id)s.%(ext)s"
1958 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1959 --hls-prefer-native --downloader "m3u8:native"
1960 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1961 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1962 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1963 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
1964 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
1965 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
1966 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
1969 #### Developer options
1970 These options are not intended to be used by the end-user
1972 --test Download only part of video for testing extractors
1973 --youtube-print-sig-code For testing youtube signatures
1974 --allow-unplayable-formats List unplayable formats also
1975 --no-allow-unplayable-formats Default
1979 These are aliases that are no longer documented for various reasons
1981 --avconv-location --ffmpeg-location
1982 --clean-infojson --clean-info-json
1983 --cn-verification-proxy URL --geo-verification-proxy URL
1984 --dump-headers --print-traffic
1985 --dump-intermediate-pages --dump-pages
1986 --force-write-download-archive --force-write-archive
1987 --load-info --load-info-json
1988 --no-clean-infojson --no-clean-info-json
1989 --no-split-tracks --no-split-chapters
1990 --no-write-srt --no-write-subs
1991 --prefer-unsecure --prefer-insecure
1992 --rate-limit RATE --limit-rate RATE
1993 --split-tracks --split-chapters
1994 --srt-lang LANGS --sub-langs LANGS
1995 --trim-file-names LENGTH --trim-filenames LENGTH
1996 --write-srt --write-subs
1997 --yes-overwrites --force-overwrites
1999 #### Sponskrub Options
2000 Support for [SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of the `--sponsorblock
` options
2002 --sponskrub --sponsorblock-mark all
2003 --no-sponskrub --no-sponsorblock
2004 --sponskrub-cut --sponsorblock-remove all
2005 --no-sponskrub-cut --sponsorblock-remove -all
2006 --sponskrub-force Not applicable
2007 --no-sponskrub-force Not applicable
2008 --sponskrub-location Not applicable
2009 --sponskrub-args Not applicable
2011 #### No longer supported
2012 These options may no longer work as intended
2014 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
2015 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
2016 -C, --call-home Not implemented
2017 --no-call-home Default
2018 --include-ads No longer supported
2019 --no-include-ads Default
2020 --write-annotations No supported site has annotations now
2021 --no-write-annotations Default
2024 These options were deprecated since 2014 and have now been entirely removed
2026 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
2027 -t, -l, --title, --literal -o "%(title)s-%(id)s.%(ext)s"
2030 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)
2033 For FAQ see the [youtube-dl README](https://github.com/ytdl-org/youtube-dl#faq)
projects / yt-dlp.git / blob