1 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
4 [![YT-DLP](https://raw.githubusercontent.com/yt-dlp/yt-dlp/master/.github/banner.svg)](#readme)
6 [![Release version](https://img.shields.io/github/v/release/yt-dlp/yt-dlp?color=blue&label=&style=for-the-badge)]
(https://github.com/yt-dlp/yt-dlp/releases/latest)
7 [![CI Status](https://img.shields.io/github/workflow/status/yt-dlp/yt-dlp/Core%20Tests/master?label=&style=for-the-badge)]
(https://github.com/yt-dlp/yt-dlp/actions)
8 [![License: Unlicense](https://img.shields.io/badge/-Unlicense-blue.svg?style=for-the-badge)](LICENSE)
9 [![Donate](https://img.shields.io/badge/_-Donate-red.svg?logo=githubsponsors&labelColor=555555&style=for-the-badge)](Collaborators.md#collaborators)
10 [![Supported Sites](https://img.shields.io/badge/-Supported_Sites-brightgreen.svg?style=for-the-badge)](supportedsites.md)
11 [![Discord](https://img.shields.io/discord/807245652072857610?color=blue&label=&logo=discord&style=for-the-badge)]
(https://discord.gg/H5MNcFW63r)
12 [![Doc Status](https://readthedocs.org/projects/yt-dlp/badge/?version=latest&style=for-the-badge)]
(https://yt-dlp.readthedocs.io)
13 [![Commits](https://img.shields.io/github/commit-activity/m/yt-dlp/yt-dlp?label=commits&style=for-the-badge)]
(https://github.com/yt-dlp/yt-dlp/commits)
14 [![Last Commit](https://img.shields.io/github/last-commit/yt-dlp/yt-dlp/master?label=&style=for-the-badge)]
(https://github.com/yt-dlp/yt-dlp/commits)
15 [![Downloads](https://img.shields.io/github/downloads/yt-dlp/yt-dlp/total?style=for-the-badge&color=blue)]
(https://github.com/yt-dlp/yt-dlp/releases/latest)
16 [![PyPi Downloads](https://img.shields.io/pypi/dm/yt-dlp?label=PyPi&style=for-the-badge)]
(https://pypi.org/project/yt-dlp)
19 <!-- MANPAGE: END EXCLUDED SECTION -->
21 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
23 <!-- MANPAGE: MOVE "USAGE AND OPTIONS" SECTION HERE -->
25 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
26 * [NEW FEATURES](#new-features)
27 * [Differences in default behavior](#differences-in-default-behavior)
28 * [INSTALLATION](#installation)
30 * [Release Files](#release-files)
31 * [Dependencies](#dependencies)
33 * [USAGE AND OPTIONS](#usage-and-options)
34 * [General Options](#general-options)
35 * [Network Options](#network-options)
36 * [Geo-restriction](#geo-restriction)
37 * [Video Selection](#video-selection)
38 * [Download Options](#download-options)
39 * [Filesystem Options](#filesystem-options)
40 * [Thumbnail Options](#thumbnail-options)
41 * [Internet Shortcut Options](#internet-shortcut-options)
42 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
43 * [Workarounds](#workarounds)
44 * [Video Format Options](#video-format-options)
45 * [Subtitle Options](#subtitle-options)
46 * [Authentication Options](#authentication-options)
47 * [Post-processing Options](#post-processing-options)
48 * [SponsorBlock Options](#sponsorblock-options)
49 * [Extractor Options](#extractor-options)
50 * [CONFIGURATION](#configuration)
51 * [Authentication with .netrc file](#authentication-with-netrc-file)
52 * [OUTPUT TEMPLATE](#output-template)
53 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
54 * [Output template examples](#output-template-examples)
55 * [FORMAT SELECTION](#format-selection)
56 * [Filtering Formats](#filtering-formats)
57 * [Sorting Formats](#sorting-formats)
58 * [Format Selection examples](#format-selection-examples)
59 * [MODIFYING METADATA](#modifying-metadata)
60 * [Modifying metadata examples](#modifying-metadata-examples)
61 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
63 * [EMBEDDING YT-DLP](#embedding-yt-dlp)
64 * [DEPRECATED OPTIONS](#deprecated-options)
65 * [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
66 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
67 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
69 <!-- MANPAGE: END EXCLUDED SECTION -->
74 * Based on **youtube-dl
2021.12.17 [commit/5014bd6](https://github.com/ytdl-org/youtube-dl/commit/5014bd67c22b421207b2650d4dc874b95b36dda1)** 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)
76 * **
[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
78 * **[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))
80 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from
[animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including
`--write-comments`,
`BiliBiliSearch`,
`BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that the NicoNico improvements are not available. See
[#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details.
82 * **Youtube improvements**:
83 * All Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`) and private playlists supports downloading multiple pages of content
84 * Search (
`ytsearch:`,
`ytsearchdate:`), search URLs and in-channel search works
85 * Mixes supports downloading multiple pages of content
86 * Some (but not all) age-gated content can be downloaded without cookies
87 * Fix for
[n-sig based throttling](https://github.com/ytdl-org/youtube-dl/issues/29326)
88 * Redirect channel's home URL automatically to
`/video` to preserve the old behaviour
89 * `255kbps` audio is extracted (if available) from youtube music when premium cookies are given
90 * Youtube music Albums, channels etc can be downloaded (
[except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723))
91 * Download livestreams from the start using
`--live-from-start`
93 * **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using
`--cookies-from-browser BROWSER[+KEYRING][:PROFILE]`
95 * **Split video by chapters**: Videos can be split into multiple files based on chapters using
`--split-chapters`
97 * **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
99 * **Aria2c with HLS/DASH**: You can use
`aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
101 * **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)
103 * **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN
105 * **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
107 * **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`)
109 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
111 * **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`
113 * **Other new options**: Many new options have been added such as
`--print`,
`--wait-for-video`,
`--sleep-requests`,
`--convert-thumbnails`,
`--write-link`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
115 * **Improvements**: Regex and other operators in
`--match-filter`, multiple
`--postprocessor-args` and
`--downloader-args`, faster archive checking, more [format selection options](#format-selection), merge multi-video/audio etc
117 * **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins](#plugins) for details
119 * **Self-updater**: The releases can be updated using
`yt-dlp -U`
121 See
[changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
123 ### Differences in default behavior
125 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
127 * The options
`--auto-number` (
`-A`),
`--title` (
`-t`) and
`--literal` (
`-l`), no longer work. See [removed options](#Removed) for details
128 * `avconv` is not supported as an alternative to
`ffmpeg`
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 * `--ignore-errors` 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`](https://github.com/yt-dlp/yt-dlp#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. 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
148 For ease of use, a few more compat options are available:
149 * `--compat-options all`: Use all compat options
150 * `--compat-options youtube-dl`: Same as
`--compat-options all,-multistreams`
151 * `--compat-options youtube-dlc`: Same as
`--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
156 You can install yt-dlp using one of the following methods:
158 ### Using the release binary
160 You can simply download the
[correct binary file](#release-files) for your OS: **[[Windows](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)]
[[UNIX-like](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)]**
162 In UNIX-like OSes (MacOS, Linux, BSD), you can also install the same in one of the following ways:
165 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
166 sudo chmod a+rx /usr/local/bin/yt-dlp
170 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
171 sudo chmod a+rx /usr/local/bin/yt-dlp
175 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp --dir /usr/local/bin -o yt-dlp
176 sudo chmod a+rx /usr/local/bin/yt-dlp
179 PS: The manpages, shell completion files etc. are available in
[yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
181 ### With [PIP](https://pypi.org/project/pip)
183 You can install the
[PyPI package](https://pypi.org/project/yt-dlp) with:
185 python3 -m pip install -U yt-dlp
188 You can install without any of the optional dependencies using:
190 python3 -m pip install --no-deps -U yt-dlp
193 If you want to be on the cutting edge, you can also install the master branch with:
195 python3 -m pip install --force-reinstall https://github.com/yt-dlp/yt-dlp/archive/master.zip
198 Note that on some systems, you may need to use
`py` or
`python` instead of
`python3`
200 ### With [Homebrew](https://brew.sh)
202 macOS or Linux users that are using Homebrew can also install it by:
205 brew install yt-dlp/taps/yt-dlp
209 You can use
`yt-dlp -U` to update if you are [using the provided release](#using-the-release-binary)
211 If you [installed with pip](#with-pip), simply re-run the same command that was used to install the program
213 If you [installed using Homebrew](#with-homebrew), run
`brew upgrade yt-dlp/taps/yt-dlp`
215 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
222 [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform-independant binary. Needs Python (recommended for **UNIX-like systems**)
223 [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**)
229 [yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|MacOS (
10.15+) standalone executable
230 [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
231 [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
232 [yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged Windows executable (no auto-update)
233 [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)
239 [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
240 [SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
241 [SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
242 <!-- MANPAGE: END EXCLUDED SECTION -->
245 Python versions
3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
247 <!-- Python
3.5+ uses VC++
14 and it is already embedded in the binary created
248 <!x-- https://www.microsoft.com/en-us/download/details.aspx?id=
26999 --x>
249 On windows,
[Microsoft Visual C++ 2010 SP1 Redistributable Package (x86)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe) is also necessary to run yt-dlp. You probably already have this, but if the executable throws an error due to missing
`MSVCR100.dll` you need to install it manually.
252 While all the other dependencies are optional,
`ffmpeg` and
`ffprobe` are highly recommended
254 * [**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)
255 * [**mutagen**](https://github.com/quodlibet/mutagen) - For embedding thumbnail in certain formats. Licensed under
[GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
256 * [**pycryptodomex**](https://github.com/Legrandin/pycryptodome) - For decrypting AES-
128 HLS streams and various other data. Licensed under
[BSD2](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
257 * [**websockets**](https://github.com/aaugustin/websockets) - For downloading over websocket. Licensed under
[BSD3](https://github.com/aaugustin/websockets/blob/main/LICENSE)
258 * [**secretstorage**](https://github.com/mitya57/secretstorage) - For accessing the Gnome keyring while decrypting cookies of Chromium-based browsers on Linux. Licensed under
[BSD](https://github.com/mitya57/secretstorage/blob/master/LICENSE)
259 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For embedding thumbnail in mp4/m4a if mutagen is not present. Licensed under
[GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
260 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading
`rtmp` streams. ffmpeg will be used as a fallback. Licensed under
[GPLv2+](http://rtmpdump.mplayerhq.hu)
261 * [**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)
262 * [**phantomjs**](https://github.com/ariya/phantomjs) - Used in extractors where javascript needs to be run. Licensed under
[BSD3](https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD)
263 * [**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)
264 * Any external downloader that you want to use with
`--downloader`
266 To use or redistribute the dependencies, you must agree to their respective licensing terms.
268 The Windows and MacOS standalone release binaries are already built with the python interpreter, mutagen, pycryptodomex and websockets included.
270 **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/wiki/Latest#latest-autobuilds) with patches for these issues at
[yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds). See
[the readme](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied) for details on the specific issues solved by these builds
276 To build the Windows executable, you must have pyinstaller (and optionally mutagen, pycryptodomex, websockets). Once you have all the necessary dependencies installed, (optionally) build lazy extractors using
`devscripts/make_lazy_extractors.py`, and then just run
`pyinst.py`. The executable will be built for the same architecture (
32/
64 bit) as the python used to build it.
278 py -m pip install -U pyinstaller -r requirements.txt
279 py devscripts/make_lazy_extractors.py
282 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
285 You will need the required build tools:
`python`,
`make` (GNU),
`pandoc`,
`zip`,
`pytest`
286 Then simply run
`make`. You can also run
`make yt-dlp` instead to compile only the binary without updating any of the additional files
288 **Note**: In either platform,
`devscripts/update-version.py` can be used to automatically update the version number
290 You can also fork the project on github and run your fork's [build workflow](.github/workflows/build.yml) to automatically build a release
294 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
295 yt-dlp [OPTIONS] [--] URL [URL...]
297 `Ctrl+F` is your friend :D
298 <!-- MANPAGE: END EXCLUDED SECTION -->
300 <!-- Auto generated -->
302 -h, --help Print this help text and exit
303 --version Print program version and exit
304 -U, --update Update this program to latest version. Make
305 sure that you have sufficient permissions
306 (run with sudo if needed)
307 -i, --ignore-errors Ignore download and postprocessing errors.
308 The download will be considered successful
309 even if the postprocessing fails
310 --no-abort-on-error Continue with next video on download
311 errors; e.g. to skip unavailable videos in
313 --abort-on-error Abort downloading of further videos if an
314 error occurs (Alias: --no-ignore-errors)
315 --dump-user-agent Display the current user-agent and exit
316 --list-extractors List all supported extractors and exit
317 --extractor-descriptions Output descriptions of all supported
319 --force-generic-extractor Force extraction to use the generic
321 --default-search PREFIX Use this prefix for unqualified URLs. For
322 example "gvsearch2:" downloads two videos
323 from google videos for the search term
324 "large apple". Use the value "auto" to let
325 yt-dlp guess ("auto_warning" to emit a
326 warning when guessing). "error" just throws
327 an error. The default value "fixup_error"
328 repairs broken URLs, but emits an error if
329 this is not possible instead of searching
330 --ignore-config, --no-config Disable loading any configuration files
331 except the one provided by --config-location.
332 When given inside a configuration
333 file, no further configuration files are
334 loaded. Additionally, (for backward
335 compatibility) if this option is found
336 inside the system configuration file, the
337 user configuration is not loaded
338 --config-location PATH Location of the main configuration file;
339 either the path to the config or its
341 --flat-playlist Do not extract the videos of a playlist,
343 --no-flat-playlist Extract the videos of a playlist
344 --live-from-start Download livestreams from the start.
345 Currently only supported for YouTube
346 --no-live-from-start Download livestreams from the current time
348 --wait-for-video MIN[-MAX] Wait for scheduled streams to become
349 available. Pass the minimum number of
350 seconds (or range) to wait between retries
351 --no-wait-for-video Do not wait for scheduled streams (default)
352 --mark-watched Mark videos watched (even with --simulate).
353 Currently only supported for YouTube
354 --no-mark-watched Do not mark videos watched (default)
355 --no-colors Do not emit color codes in output
356 --compat-options OPTS Options that can help keep compatibility
357 with youtube-dl or youtube-dlc
358 configurations by reverting some of the
359 changes made in yt-dlp. See "Differences in
360 default behavior" for details
363 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
364 To enable SOCKS proxy, specify a proper
366 socks5://
127.0.0.1:
1080/. Pass in an empty
367 string (--proxy "") for direct connection
368 --socket-timeout SECONDS Time to wait before giving up, in seconds
369 --source-address IP Client-side IP address to bind to
370 -4, --force-ipv4 Make all connections via IPv4
371 -6, --force-ipv6 Make all connections via IPv6
374 --geo-verification-proxy URL Use this proxy to verify the IP address for
375 some geo-restricted sites. The default
376 proxy specified by --proxy (or none, if the
377 option is not present) is used for the
379 --geo-bypass Bypass geographic restriction via faking
380 X-Forwarded-For HTTP header
381 --no-geo-bypass Do not bypass geographic restriction via
382 faking X-Forwarded-For HTTP header
383 --geo-bypass-country CODE Force bypass geographic restriction with
384 explicitly provided two-letter ISO
3166-
2
386 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
387 explicitly provided IP block in CIDR
391 --playlist-start NUMBER Playlist video to start at (default is
1)
392 --playlist-end NUMBER Playlist video to end at (default is last)
393 --playlist-items ITEM_SPEC Playlist video items to download. Specify
394 indices of the videos in the playlist
395 separated by commas like: "--playlist-items
396 1,
2,
5,
8" if you want to download videos
397 indexed
1,
2,
5,
8 in the playlist. You can
398 specify range: "--playlist-items
399 1-
3,
7,
10-
13", it will download the videos
400 at index
1,
2,
3,
7,
10,
11,
12 and
13
401 --min-filesize SIZE Do not download any videos smaller than
402 SIZE (e.g.
50k or
44.6m)
403 --max-filesize SIZE Do not download any videos larger than SIZE
405 --date DATE Download only videos uploaded on this date.
406 The date can be "YYYYMMDD" or in the format
407 "(now|today)[+-][
0-
9](day|week|month|year)(s)?"
408 --datebefore DATE Download only videos uploaded on or before
409 this date. The date formats accepted is the
411 --dateafter DATE Download only videos uploaded on or after
412 this date. The date formats accepted is the
414 --match-filter FILTER Generic video filter. Any field (see
415 "OUTPUT TEMPLATE") can be compared with a
416 number or a string using the operators
417 defined in "Filtering formats". You can
418 also simply specify a field to match if the
419 field is present and "!field" to check if
420 the field is not present. In addition,
421 Python style regular expression matching
422 can be done using "~=", and multiple
423 filters can be checked with "&". Use a "
\"
424 to escape "&" or quotes if needed. Eg:
425 --match-filter "!is_live & like_count>?
100
426 & description~='(?i)
\bcats \& dogs
\b'"
427 matches only videos that are not live, has
428 a like count more than
100 (or the like
429 field is not available), and also has a
430 description that contains the phrase "cats
431 & dogs" (ignoring case)
432 --no-match-filter Do not use generic video filter (default)
433 --no-playlist Download only the video, if the URL refers
434 to a video and a playlist
435 --yes-playlist Download the playlist, if the URL refers to
436 a video and a playlist
437 --age-limit YEARS Download only videos suitable for the given
439 --download-archive FILE Download only videos not listed in the
440 archive file. Record the IDs of all
441 downloaded videos in it
442 --no-download-archive Do not use archive file (default)
443 --max-downloads NUMBER Abort after downloading NUMBER files
444 --break-on-existing Stop the download process when encountering
445 a file that is in the archive
446 --break-on-reject Stop the download process when encountering
447 a file that has been filtered out
448 --break-per-input Make --break-on-existing and --break-on-
449 reject act only on the current input URL
450 --no-break-per-input --break-on-existing and --break-on-reject
451 terminates the entire download queue
452 --skip-playlist-after-errors N Number of allowed failures until the rest
453 of the playlist is skipped
456 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
457 video that should be downloaded
458 concurrently (default is
1)
459 -r, --limit-rate RATE Maximum download rate in bytes per second
461 --throttled-rate RATE Minimum download rate in bytes per second
462 below which throttling is assumed and the
463 video data is re-extracted (e.g.
100K)
464 -R, --retries RETRIES Number of retries (default is
10), or
466 --file-access-retries RETRIES Number of times to retry on file access
467 error (default is
10), or "infinite"
468 --fragment-retries RETRIES Number of retries for a fragment (default
469 is
10), or "infinite" (DASH, hlsnative and
471 --skip-unavailable-fragments Skip unavailable fragments for DASH,
472 hlsnative and ISM (default)
473 (Alias: --no-abort-on-unavailable-fragment)
474 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
475 (Alias: --no-skip-unavailable-fragments)
476 --keep-fragments Keep downloaded fragments on disk after
477 downloading is finished
478 --no-keep-fragments Delete downloaded fragments after
479 downloading is finished (default)
480 --buffer-size SIZE Size of download buffer (e.g.
1024 or
16K)
482 --resize-buffer The buffer size is automatically resized
483 from an initial value of --buffer-size
485 --no-resize-buffer Do not automatically adjust the buffer size
486 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
487 downloading (e.g.
10485760 or
10M) (default
488 is disabled). May be useful for bypassing
489 bandwidth throttling imposed by a webserver
491 --playlist-reverse Download playlist videos in reverse order
492 --no-playlist-reverse Download playlist videos in default order
494 --playlist-random Download playlist videos in random order
495 --xattr-set-filesize Set file xattribute ytdl.filesize with
497 --hls-use-mpegts Use the mpegts container for HLS videos;
498 allowing some players to play the video
499 while downloading, and reducing the chance
500 of file corruption if download is
501 interrupted. This is enabled by default for
503 --no-hls-use-mpegts Do not use the mpegts container for HLS
504 videos. This is default when not
505 downloading live streams
506 --downloader [PROTO:]NAME Name or path of the external downloader to
507 use (optionally) prefixed by the protocols
508 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
509 use it for. Currently supports native,
510 aria2c, avconv, axel, curl, ffmpeg, httpie,
511 wget (Recommended: aria2c). You can use
512 this option multiple times to set different
513 downloaders for different protocols. For
514 example, --downloader aria2c --downloader
515 "dash,m3u8:native" will use aria2c for
516 http/ftp downloads, and the native
517 downloader for dash/m3u8 downloads
518 (Alias: --external-downloader)
519 --downloader-args NAME:ARGS Give these arguments to the external
520 downloader. Specify the downloader name and
521 the arguments separated by a colon ":". For
522 ffmpeg, arguments can be passed to
523 different positions using the same syntax
524 as --postprocessor-args. You can use this
525 option multiple times to give different
526 arguments to different downloaders
527 (Alias: --external-downloader-args)
529 ## Filesystem Options:
530 -a, --batch-file FILE File containing URLs to download ("-" for
531 stdin), one URL per line. Lines starting
532 with "#", ";" or "]" are considered as
534 --no-batch-file Do not read URLs from batch file (default)
535 -P, --paths [TYPES:]PATH The paths where the files should be
536 downloaded. Specify the type of file and
537 the path separated by a colon ":". All the
538 same TYPES as --output are supported.
539 Additionally, you can also provide "home"
540 (default) and "temp" paths. All
541 intermediary files are first downloaded to
542 the temp path and then the final files are
543 moved over to the home path after download
544 is finished. This option is ignored if
545 --output is an absolute path
546 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
547 TEMPLATE" for details
548 --output-na-placeholder TEXT Placeholder value for unavailable meta
549 fields in output filename template
551 --restrict-filenames Restrict filenames to only ASCII
552 characters, and avoid "&" and spaces in
554 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
556 --windows-filenames Force filenames to be Windows-compatible
557 --no-windows-filenames Make filenames Windows-compatible only if
558 using Windows (default)
559 --trim-filenames LENGTH Limit the filename length (excluding
560 extension) to the specified number of
562 -w, --no-overwrites Do not overwrite any files
563 --force-overwrites Overwrite all video and metadata files.
564 This option includes --no-continue
565 --no-force-overwrites Do not overwrite the video, but overwrite
566 related files (default)
567 -c, --continue Resume partially downloaded files/fragments
569 --no-continue Do not resume partially downloaded
570 fragments. If the file is not fragmented,
571 restart download of the entire file
572 --part Use .part files instead of writing directly
573 into output file (default)
574 --no-part Do not use .part files - write directly
576 --mtime Use the Last-modified header to set the
577 file modification time (default)
578 --no-mtime Do not use the Last-modified header to set
579 the file modification time
580 --write-description Write video description to a .description
582 --no-write-description Do not write video description (default)
583 --write-info-json Write video metadata to a .info.json file
584 (this may contain personal information)
585 --no-write-info-json Do not write video metadata (default)
586 --write-playlist-metafiles Write playlist metadata in addition to the
587 video metadata when using --write-info-json,
588 --write-description etc. (default)
589 --no-write-playlist-metafiles Do not write playlist metadata when using
590 --write-info-json, --write-description etc.
591 --clean-infojson Remove some private fields such as
592 filenames from the infojson. Note that it
593 could still contain some personal
594 information (default)
595 --no-clean-infojson Write all fields to the infojson
596 --write-comments Retrieve video comments to be placed in the
597 infojson. The comments are fetched even
598 without this option if the extraction is
599 known to be quick (Alias: --get-comments)
600 --no-write-comments Do not retrieve video comments unless the
601 extraction is known to be quick
602 (Alias: --no-get-comments)
603 --load-info-json FILE JSON file containing the video information
604 (created with the "--write-info-json"
606 --cookies FILE Netscape formatted file to read cookies
607 from and dump cookie jar in
608 --no-cookies Do not read/dump cookies from/to file
610 --cookies-from-browser BROWSER[+KEYRING][:PROFILE]
611 The name of the browser and (optionally)
612 the name/path of the profile to load
613 cookies from, separated by a ":". Currently
614 supported browsers are: brave, chrome,
615 chromium, edge, firefox, opera, safari,
616 vivaldi. By default, the most recently
617 accessed profile is used. The keyring used
618 for decrypting Chromium cookies on Linux
619 can be (optionally) specified after the
620 browser name separated by a "+". Currently
621 supported keyrings are: basictext,
622 gnomekeyring, kwallet
623 --no-cookies-from-browser Do not load cookies from browser (default)
624 --cache-dir DIR Location in the filesystem where youtube-dl
625 can store some downloaded information (such
626 as client ids and signatures) permanently.
627 By default $XDG_CACHE_HOME/yt-dlp or
629 --no-cache-dir Disable filesystem caching
630 --rm-cache-dir Delete all filesystem cache files
632 ## Thumbnail Options:
633 --write-thumbnail Write thumbnail image to disk
634 --no-write-thumbnail Do not write thumbnail image to disk
636 --write-all-thumbnails Write all thumbnail image formats to disk
637 --list-thumbnails List available thumbnails of each video.
638 Simulate unless --no-simulate is used
640 ## Internet Shortcut Options:
641 --write-link Write an internet shortcut file, depending
642 on the current platform (.url, .webloc or
643 .desktop). The URL may be cached by the OS
644 --write-url-link Write a .url Windows internet shortcut. The
645 OS caches the URL based on the file path
646 --write-webloc-link Write a .webloc macOS internet shortcut
647 --write-desktop-link Write a .desktop Linux internet shortcut
649 ## Verbosity and Simulation Options:
650 -q, --quiet Activate quiet mode. If used with
651 --verbose, print the log to stderr
652 --no-warnings Ignore warnings
653 -s, --simulate Do not download the video and do not write
655 --no-simulate Download the video even if printing/listing
657 --ignore-no-formats-error Ignore "No video formats" error. Useful for
658 extracting metadata even if the videos are
659 not actually available for download
661 --no-ignore-no-formats-error Throw error when no downloadable video
662 formats are found (default)
663 --skip-download Do not download the video but write all
664 related files (Alias: --no-download)
665 -O, --print [WHEN:]TEMPLATE Field name or output template to print to
666 screen per video. Prefix the template with
667 "playlist:" to print it once per playlist
668 instead. Implies --quiet and --simulate
669 (unless --no-simulate is used). This option
670 can be used multiple times
671 -j, --dump-json Quiet, but print JSON information for each
672 video. Simulate unless --no-simulate is
673 used. See "OUTPUT TEMPLATE" for a
674 description of available keys
675 -J, --dump-single-json Quiet, but print JSON information for each
676 url or infojson passed. Simulate unless
677 --no-simulate is used. If the URL refers to
678 a playlist, the whole playlist information
679 is dumped in a single line
680 --force-write-archive Force download archive entries to be
681 written as far as no errors occur, even if
682 -s or another simulation option is used
683 (Alias: --force-download-archive)
684 --newline Output progress bar as new lines
685 --no-progress Do not print progress bar
686 --progress Show progress bar, even if in quiet mode
687 --console-title Display progress in console titlebar
688 --progress-template [TYPES:]TEMPLATE
689 Template for progress outputs, optionally
690 prefixed with one of "download:" (default),
691 "download-title:" (the console title),
692 "postprocess:", or "postprocess-title:".
693 The video's fields are accessible under the
694 "info" key and the progress attributes are
695 accessible under "progress" key. E.g.:
696 --console-title --progress-template
697 "download-title:%(info.id)s-%(progress.eta)s"
698 -v, --verbose Print various debugging information
699 --dump-pages Print downloaded pages encoded using base64
700 to debug problems (very verbose)
701 --write-pages Write downloaded intermediary pages to
702 files in the current directory to debug
704 --print-traffic Display sent and read HTTP traffic
707 --encoding ENCODING Force the specified encoding (experimental)
708 --no-check-certificates Suppress HTTPS certificate validation
709 --prefer-insecure Use an unencrypted connection to retrieve
710 information about the video (Currently
711 supported only for YouTube)
712 --user-agent UA Specify a custom user agent
713 --referer URL Specify a custom referer, use if the video
714 access is restricted to one domain
715 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
716 separated by a colon ":". You can use this
717 option multiple times
718 --bidi-workaround Work around terminals that lack
719 bidirectional text support. Requires bidiv
720 or fribidi executable in PATH
721 --sleep-requests SECONDS Number of seconds to sleep between requests
722 during data extraction
723 --sleep-interval SECONDS Number of seconds to sleep before each
724 download. This is the minimum time to sleep
725 when used along with --max-sleep-interval
726 (Alias: --min-sleep-interval)
727 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
728 only be used along with --min-sleep-interval
729 --sleep-subtitles SECONDS Number of seconds to sleep before each
732 ## Video Format Options:
733 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
735 -S, --format-sort SORTORDER Sort the formats by the fields given, see
736 "Sorting Formats" for more details
737 --S-force, --format-sort-force Force user specified sort order to have
738 precedence over all fields, see "Sorting
739 Formats" for more details
740 --no-format-sort-force Some fields have precedence over the user
741 specified sort order (default), see
742 "Sorting Formats" for more details
743 --video-multistreams Allow multiple video streams to be merged
745 --no-video-multistreams Only one video stream is downloaded for
746 each output file (default)
747 --audio-multistreams Allow multiple audio streams to be merged
749 --no-audio-multistreams Only one audio stream is downloaded for
750 each output file (default)
751 --prefer-free-formats Prefer video formats with free containers
752 over non-free ones of same quality. Use
753 with "-S ext" to strictly prefer free
754 containers irrespective of quality
755 --no-prefer-free-formats Don't give any special preference to free
757 --check-formats Check that the selected formats are
758 actually downloadable
759 --check-all-formats Check all formats for whether they are
760 actually downloadable
761 --no-check-formats Do not check that the formats are actually
763 -F, --list-formats List available formats of each video.
764 Simulate unless --no-simulate is used
765 --merge-output-format FORMAT If a merge is required (e.g.
766 bestvideo+bestaudio), output to given
767 container format. One of mkv, mp4, ogg,
768 webm, flv. Ignored if no merge is required
771 --write-subs Write subtitle file
772 --no-write-subs Do not write subtitle file (default)
773 --write-auto-subs Write automatically generated subtitle file
774 (Alias: --write-automatic-subs)
775 --no-write-auto-subs Do not write auto-generated subtitles
776 (default) (Alias: --no-write-automatic-subs)
777 --list-subs List available subtitles of each video.
778 Simulate unless --no-simulate is used
779 --sub-format FORMAT Subtitle format, accepts formats
780 preference, for example: "srt" or
782 --sub-langs LANGS Languages of the subtitles to download (can
783 be regex) or "all" separated by commas.
784 (Eg: --sub-langs "en.*,ja") You can prefix
785 the language code with a "-" to exempt it
786 from the requested languages. (Eg: --sub-
787 langs all,-live_chat) Use --list-subs for a
788 list of available language tags
790 ## Authentication Options:
791 -u, --username USERNAME Login with this account ID
792 -p, --password PASSWORD Account password. If this option is left
793 out, yt-dlp will ask interactively
794 -2, --twofactor TWOFACTOR Two-factor authentication code
795 -n, --netrc Use .netrc authentication data
796 --netrc-location PATH Location of .netrc authentication data;
797 either the path or its containing
798 directory. Defaults to ~/.netrc
799 --video-password PASSWORD Video password (vimeo, youku)
800 --ap-mso MSO Adobe Pass multiple-system operator (TV
801 provider) identifier, use --ap-list-mso for
802 a list of available MSOs
803 --ap-username USERNAME Multiple-system operator account login
804 --ap-password PASSWORD Multiple-system operator account password.
805 If this option is left out, yt-dlp will ask
807 --ap-list-mso List all supported multiple-system
810 ## Post-Processing Options:
811 -x, --extract-audio Convert video files to audio-only files
812 (requires ffmpeg and ffprobe)
813 --audio-format FORMAT Specify audio format to convert the audio
814 to when -x is used. Currently supported
815 formats are: best (default) or one of
816 best|aac|flac|mp3|m4a|opus|vorbis|wav|alac
817 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
818 value between
0 (best) and
10 (worst) for
819 VBR or a specific bitrate like
128K
821 --remux-video FORMAT Remux the video into another container if
822 necessary (currently supported: mp4|mkv|flv
823 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
824 target container does not support the
825 video/audio codec, remuxing will fail. You
826 can specify multiple rules; Eg.
827 "aac>m4a/mov>mp4/mkv" will remux aac to
828 m4a, mov to mp4 and anything else to mkv.
829 --recode-video FORMAT Re-encode the video into another format if
830 re-encoding is necessary. The syntax and
831 supported formats are the same as --remux-video
832 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
833 Specify the postprocessor/executable name
834 and the arguments separated by a colon ":"
835 to give the argument to the specified
836 postprocessor/executable. Supported PP are:
837 Merger, ModifyChapters, SplitChapters,
838 ExtractAudio, VideoRemuxer, VideoConvertor,
839 Metadata, EmbedSubtitle, EmbedThumbnail,
840 SubtitlesConvertor, ThumbnailsConvertor,
841 FixupStretched, FixupM4a, FixupM3u8,
842 FixupTimestamp and FixupDuration. The
843 supported executables are: AtomicParsley,
844 FFmpeg and FFprobe. You can also specify
845 "PP+EXE:ARGS" to give the arguments to the
846 specified executable only when being used
847 by the specified postprocessor.
848 Additionally, for ffmpeg/ffprobe, "_i"/"_o"
849 can be appended to the prefix optionally
850 followed by a number to pass the argument
851 before the specified input/output file. Eg:
852 --ppa "Merger+ffmpeg_i1:-v quiet". You can
853 use this option multiple times to give
854 different arguments to different
855 postprocessors. (Alias: --ppa)
856 -k, --keep-video Keep the intermediate video file on disk
857 after post-processing
858 --no-keep-video Delete the intermediate video file after
859 post-processing (default)
860 --post-overwrites Overwrite post-processed files (default)
861 --no-post-overwrites Do not overwrite post-processed files
862 --embed-subs Embed subtitles in the video (only for mp4,
864 --no-embed-subs Do not embed subtitles (default)
865 --embed-thumbnail Embed thumbnail in the video as cover art
866 --no-embed-thumbnail Do not embed thumbnail (default)
867 --embed-metadata Embed metadata to the video file. Also
868 embeds chapters/infojson if present unless
869 --no-embed-chapters/--no-embed-info-json
870 are used (Alias: --add-metadata)
871 --no-embed-metadata Do not add metadata to file (default)
872 (Alias: --no-add-metadata)
873 --embed-chapters Add chapter markers to the video file
874 (Alias: --add-chapters)
875 --no-embed-chapters Do not add chapter markers (default)
876 (Alias: --no-add-chapters)
877 --embed-info-json Embed the infojson as an attachment to
879 --no-embed-info-json Do not embed the infojson as an attachment
881 --parse-metadata FROM:TO Parse additional metadata like title/artist
882 from other fields; see "MODIFYING METADATA"
884 --replace-in-metadata FIELDS REGEX REPLACE
885 Replace text in a metadata field using the
886 given regex. This option can be used
888 --xattrs Write metadata to the video file's xattrs
889 (using dublin core and xdg standards)
890 --fixup POLICY Automatically correct known faults of the
891 file. One of never (do nothing), warn (only
892 emit a warning), detect_or_warn (the
893 default; fix file if we can, warn
894 otherwise), force (try fixing even if file
896 --ffmpeg-location PATH Location of the ffmpeg binary; either the
897 path to the binary or its containing
899 --exec CMD Execute a command on the file after
900 downloading and post-processing. Same
901 syntax as the output template can be used
902 to pass any field as arguments to the
903 command. An additional field "filepath"
904 that contains the final path of the
905 downloaded file is also available. If no
906 fields are passed, %(filepath)q is appended
907 to the end of the command. This option can
908 be used multiple times
909 --no-exec Remove any previously defined --exec
910 --exec-before-download CMD Execute a command before the actual
911 download. The syntax is the same as --exec
912 but "filepath" is not available. This
913 option can be used multiple times
914 --no-exec-before-download Remove any previously defined
915 --exec-before-download
916 --convert-subs FORMAT Convert the subtitles to another format
917 (currently supported: srt|vtt|ass|lrc)
918 (Alias: --convert-subtitles)
919 --convert-thumbnails FORMAT Convert the thumbnails to another format
920 (currently supported: jpg|png)
921 --split-chapters Split video into multiple files based on
922 internal chapters. The "chapter:" prefix
923 can be used with "--paths" and "--output"
924 to set the output filename for the split
925 files. See "OUTPUT TEMPLATE" for details
926 --no-split-chapters Do not split video based on chapters
928 --remove-chapters REGEX Remove chapters whose title matches the
929 given regular expression. Time ranges
930 prefixed by a "*" can also be used in place
931 of chapters to remove the specified range.
932 Eg: --remove-chapters "*
10:
15-
15:
00"
933 --remove-chapters "intro". This option can
934 be used multiple times
935 --no-remove-chapters Do not remove any chapters from the file
937 --force-keyframes-at-cuts Force keyframes around the chapters before
938 removing/splitting them. Requires a
939 re-encode and thus is very slow, but the
940 resulting video may have fewer artifacts
942 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
943 when cutting/splitting (default)
944 --use-postprocessor NAME[:ARGS] The (case sensitive) name of plugin
945 postprocessors to be enabled, and
946 (optionally) arguments to be passed to it,
947 separated by a colon ":". ARGS are a
948 semicolon ";" delimited list of NAME=VALUE.
949 The "when" argument determines when the
950 postprocessor is invoked. It can be one of
951 "pre_process" (after extraction),
952 "before_dl" (before video download),
953 "post_process" (after video download;
954 default) or "after_move" (after moving file
955 to their final locations). This option can
956 be used multiple times to add different
959 ## SponsorBlock Options:
960 Make chapter entries for, or remove various segments (sponsor,
961 introductions, etc.) from downloaded YouTube videos using the
962 [SponsorBlock API](https://sponsor.ajay.app)
964 --sponsorblock-mark CATS SponsorBlock categories to create chapters
965 for, separated by commas. Available
966 categories are all, default(=all), sponsor,
967 intro, outro, selfpromo, preview, filler,
968 interaction, music_offtopic, poi_highlight.
969 You can prefix the category with a "-" to
970 exempt it. See [
1] for description of the
971 categories. Eg: --sponsorblock-mark all,-preview
972 [
1] https://wiki.sponsor.ajay.app/w/Segment_Categories
973 --sponsorblock-remove CATS SponsorBlock categories to be removed from
974 the video file, separated by commas. If a
975 category is present in both mark and
976 remove, remove takes precedence. The syntax
977 and available categories are the same as
978 for --sponsorblock-mark except that
979 "default" refers to "all,-filler" and
980 poi_highlight is not available
981 --sponsorblock-chapter-title TEMPLATE
982 The title template for SponsorBlock
983 chapters created by --sponsorblock-mark.
984 The same syntax as the output template is
985 used, but the only available fields are
986 start_time, end_time, category, categories,
987 name, category_names. Defaults to
988 "[SponsorBlock]: %(category_names)l"
989 --no-sponsorblock Disable both --sponsorblock-mark and
990 --sponsorblock-remove
991 --sponsorblock-api URL SponsorBlock API location, defaults to
992 https://sponsor.ajay.app
994 ## Extractor Options:
995 --extractor-retries RETRIES Number of retries for known extractor
996 errors (default is
3), or "infinite"
997 --allow-dynamic-mpd Process dynamic DASH manifests (default)
998 (Alias: --no-ignore-dynamic-mpd)
999 --ignore-dynamic-mpd Do not process dynamic DASH manifests
1000 (Alias: --no-allow-dynamic-mpd)
1001 --hls-split-discontinuity Split HLS playlists to different formats at
1002 discontinuities such as ad breaks
1003 --no-hls-split-discontinuity Do not split HLS playlists to different
1004 formats at discontinuities such as ad
1006 --extractor-args KEY:ARGS Pass these arguments to the extractor. See
1007 "EXTRACTOR ARGUMENTS" for details. You can
1008 use this option multiple times to give
1009 arguments for different extractors
1013 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
1015 1. **Main Configuration**: The file given by
`--config-location`
1016 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.
1017 1. **Home Configuration**:
`yt-dlp.conf` in the home path given by
`-P "home:<path>"`, or in the current directory if no such path is given
1018 1. **User Configuration**:
1019 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
1020 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
1021 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
1022 * `%APPDATA%/yt-dlp/config.txt`
1024 * `~/yt-dlp.conf.txt`
1026 `%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%`
1027 1. **System Configuration**:
`/etc/yt-dlp.conf`
1029 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:
1031 # Lines starting with # are comments
1033 # Always extract audio
1036 # Do not copy the mtime
1040 --proxy 127.0.0.1:3128
1042 # Save all videos under YouTube directory in your home directory
1043 -o ~/YouTube/%(title)s.%(ext)s
1046 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`.
1048 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.
1050 ### Authentication with `.netrc` file
1052 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:
1055 chmod a-rwx,u+rw $HOME/.netrc
1057 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1059 machine <extractor> login <username> password <password>
1063 machine youtube login myaccount@gmail.com password my_youtube_password
1064 machine twitch login my_twitch_account_name password my_twitch_password
1066 To activate authentication with the
`.netrc` file you should pass
`--netrc` to yt-dlp or place it in the [configuration file](#configuration).
1068 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%`
1072 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.
1074 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1075 **tl;dr:** [navigate me to examples](#output-template-examples).
1076 <!-- MANPAGE: END EXCLUDED SECTION -->
1078 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).
1080 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.
1082 The field names themselves (the part inside the parenthesis) can also have some special formatting:
1083 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
1085 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`
1087 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`
1089 1. **Alternatives**: Alternate fields can be specified separated with a
`,`. Eg:
`%(release_date>%Y,upload_date>%Y|Unknown)s`
1091 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.
1093 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`
1095 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
1097 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
1099 To summarize, the general syntax for a field is:
1101 %(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
1104 Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon
`:`. The different file types supported are
`subtitle`,
`thumbnail`,
`description`,
`annotation` (deprecated),
`infojson`,
`link`,
`pl_thumbnail`,
`pl_description`,
`pl_infojson`,
`chapter`. For example,
`-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"` will put the thumbnails in a folder with the same name as the video. If any of the templates (except default) is empty, that type of file will not be written. Eg:
`--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
1106 The available fields are:
1108 - `id` (string): Video identifier
1109 - `title` (string): Video title
1110 - `url` (string): Video URL
1111 - `ext` (string): Video filename extension
1112 - `alt_title` (string): A secondary title of the video
1113 - `description` (string): The description of the video
1114 - `display_id` (string): An alternative identifier for the video
1115 - `uploader` (string): Full name of the video uploader
1116 - `license` (string): License name the video is licensed under
1117 - `creator` (string): The creator of the video
1118 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
1119 - `upload_date` (string): Video upload date (YYYYMMDD)
1120 - `release_date` (string): The date (YYYYMMDD) when the video was released
1121 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
1122 - `uploader_id` (string): Nickname or id of the video uploader
1123 - `channel` (string): Full name of the channel the video is uploaded on
1124 - `channel_id` (string): Id of the channel
1125 - `location` (string): Physical location where the video was filmed
1126 - `duration` (numeric): Length of the video in seconds
1127 - `duration_string` (string): Length of the video (HH:mm:ss)
1128 - `view_count` (numeric): How many users have watched the video on the platform
1129 - `like_count` (numeric): Number of positive ratings of the video
1130 - `dislike_count` (numeric): Number of negative ratings of the video
1131 - `repost_count` (numeric): Number of reposts of the video
1132 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
1133 - `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)
1134 - `age_limit` (numeric): Age restriction for the video (years)
1135 - `live_status` (string): One of "is_live", "was_live", "is_upcoming", "not_live"
1136 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
1137 - `was_live` (boolean): Whether this video was originally a live stream
1138 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
1139 - `availability` (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
1140 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1141 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
1142 - `format` (string): A human-readable description of the format
1143 - `format_id` (string): Format code specified by
`--format`
1144 - `format_note` (string): Additional info about the format
1145 - `width` (numeric): Width of the video
1146 - `height` (numeric): Height of the video
1147 - `resolution` (string): Textual description of width and height
1148 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
1149 - `abr` (numeric): Average audio bitrate in KBit/s
1150 - `acodec` (string): Name of the audio codec in use
1151 - `asr` (numeric): Audio sampling rate in Hertz
1152 - `vbr` (numeric): Average video bitrate in KBit/s
1153 - `fps` (numeric): Frame rate
1154 - `dynamic_range` (string): The dynamic range of the video
1155 - `vcodec` (string): Name of the video codec in use
1156 - `container` (string): Name of the container format
1157 - `filesize` (numeric): The number of bytes, if known in advance
1158 - `filesize_approx` (numeric): An estimate for the number of bytes
1159 - `protocol` (string): The protocol that will be used for the actual download
1160 - `extractor` (string): Name of the extractor
1161 - `extractor_key` (string): Key name of the extractor
1162 - `epoch` (numeric): Unix epoch when creating the file
1163 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
1164 - `n_entries` (numeric): Total number of extracted items in the playlist
1165 - `playlist` (string): Name or id of the playlist that contains the video
1166 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1167 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
1168 - `playlist_id` (string): Playlist identifier
1169 - `playlist_title` (string): Playlist title
1170 - `playlist_uploader` (string): Full name of the playlist uploader
1171 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
1172 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
1173 - `webpage_url_basename` (string): The basename of the webpage URL
1174 - `webpage_url_domain` (string): The domain of the webpage URL
1175 - `original_url` (string): The URL given by the user (or same as
`webpage_url` for playlist entries)
1177 Available for the video that belongs to some logical chapter or section:
1179 - `chapter` (string): Name or title of the chapter the video belongs to
1180 - `chapter_number` (numeric): Number of the chapter the video belongs to
1181 - `chapter_id` (string): Id of the chapter the video belongs to
1183 Available for the video that is an episode of some series or programme:
1185 - `series` (string): Title of the series or programme the video episode belongs to
1186 - `season` (string): Title of the season the video episode belongs to
1187 - `season_number` (numeric): Number of the season the video episode belongs to
1188 - `season_id` (string): Id of the season the video episode belongs to
1189 - `episode` (string): Title of the video episode
1190 - `episode_number` (numeric): Number of the video episode within a season
1191 - `episode_id` (string): Id of the video episode
1193 Available for the media that is a track or a part of a music album:
1195 - `track` (string): Title of the track
1196 - `track_number` (numeric): Number of the track within an album or a disc
1197 - `track_id` (string): Id of the track
1198 - `artist` (string): Artist(s) of the track
1199 - `genre` (string): Genre(s) of the track
1200 - `album` (string): Title of the album the track belongs to
1201 - `album_type` (string): Type of the album
1202 - `album_artist` (string): List of all artists appeared on the album
1203 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1204 - `release_year` (numeric): Year (YYYY) when the album was released
1206 Available for
`chapter:` prefix when using
`--split-chapters` for videos with internal chapters:
1208 - `section_title` (string): Title of the chapter
1209 - `section_number` (numeric): Number of the chapter within the file
1210 - `section_start` (numeric): Start time of the chapter in seconds
1211 - `section_end` (numeric): End time of the chapter in seconds
1213 Available only when used in
`--print`:
1215 - `urls` (string): The URLs of all requested formats, one in each line
1216 - `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
1218 Available only in
`--sponsorblock-chapter-title`:
1220 - `start_time` (numeric): Start time of the chapter in seconds
1221 - `end_time` (numeric): End time of the chapter in seconds
1222 - `categories` (list): The SponsorBlock categories the chapter belongs to
1223 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1224 - `category_names` (list): Friendly names of the categories
1225 - `name` (string): Friendly name of the smallest category
1227 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.
1229 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).
1231 **Tip**: Look at the
`-j` output to identify which fields are available for the particular URL
1233 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`.
1235 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.
1237 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
1239 The current default template is
`%(title)s [%(id)s].%(ext)s`.
1241 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.
1243 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1244 #### Output template and Windows batch files
1246 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"`.
1247 <!-- MANPAGE: END EXCLUDED SECTION -->
1249 #### Output template examples
1252 $ yt-dlp --get-filename -o "test video.%(ext)s" BaW_jenozKc
1253 test video.webm # Literal name with correct extension
1255 $ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
1256 youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
1258 $ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
1259 youtube-dl_test_video_.webm # Restricted file name
1261 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1262 $ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1264 # Download YouTube playlist videos in separate directories according to their uploaded year
1265 $ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1267 # Prefix playlist index with " - " separator, but only if it is available
1268 $ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1270 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1271 $ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1273 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1274 $ 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"
1276 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1277 $ 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"
1279 # Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
1280 # and put all temporary files in "C:\MyVideos\tmp"
1281 $ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs
1283 # Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
1284 $ 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
1286 # Stream the video being downloaded to stdout
1287 $ yt-dlp -o - BaW_jenozKc
1292 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1293 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`.
1295 **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.
1297 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.
1299 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1300 **tl;dr:** [navigate me to examples](#format-selection-examples).
1301 <!-- MANPAGE: END EXCLUDED SECTION -->
1303 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.
1305 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.
1307 You can use
`-f -` to interactively provide the format selector *for each video*
1309 You can also use special names to select particular edge case formats:
1311 - `all`: Select **all formats** separately
1312 - `mergeall`: Select and **merge all formats** (Must be used with
`--audio-multistreams`,
`--video-multistreams` or both)
1313 - `b*`,
`best*`: Select the best quality format that **contains either** a video or an audio
1314 - `b`,
`best`: Select the best quality format that **contains both** video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
1315 - `bv`,
`bestvideo`: Select the best quality **video-only** format. Equivalent to
`best*[acodec=none]`
1316 - `bv*`,
`bestvideo*`: Select the best quality format that **contains video**. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
1317 - `ba`,
`bestaudio`: Select the best quality **audio-only** format. Equivalent to
`best*[vcodec=none]`
1318 - `ba*`,
`bestaudio*`: Select the best quality format that **contains audio**. It may also contain video. Equivalent to
`best*[acodec!=none]`
1319 - `w*`,
`worst*`: Select the worst quality format that contains either a video or an audio
1320 - `w`,
`worst`: Select the worst quality format that contains both video and audio. Equivalent to
`worst*[vcodec!=none][acodec!=none]`
1321 - `wv`,
`worstvideo`: Select the worst quality video-only format. Equivalent to
`worst*[acodec=none]`
1322 - `wv*`,
`worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to
`worst*[vcodec!=none]`
1323 - `wa`,
`worstaudio`: Select the worst quality audio-only format. Equivalent to
`worst*[vcodec=none]`
1324 - `wa*`,
`worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to
`worst*[acodec!=none]`
1326 For example, to download the worst quality video-only format you can use
`-f worstvideo`. It is however recommended not to use
`worst` and related options. When your format selector is
`worst`, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use
`-f best -S +size,+br,+res,+fps` instead of
`-f worst`. See [sorting formats](#sorting-formats) for more details.
1328 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.
1330 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.
1332 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`.
1334 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.
1336 **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
1338 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`.
1340 ## Filtering Formats
1342 You can also filter the video formats by putting a condition in brackets, as in
`-f "best[height=720]"` (or
`-f "[filesize>10M]"`).
1344 The following numeric meta fields can be used with comparisons
`<`,
`<=`,
`>`,
`>=`,
`=` (equals),
`!=` (not equals):
1346 - `filesize`: The number of bytes, if known in advance
1347 - `width`: Width of the video, if known
1348 - `height`: Height of the video, if known
1349 - `tbr`: Average bitrate of audio and video in KBit/s
1350 - `abr`: Average audio bitrate in KBit/s
1351 - `vbr`: Average video bitrate in KBit/s
1352 - `asr`: Audio sampling rate in Hertz
1355 Also filtering work for comparisons
`=` (equals),
`^=` (starts with),
`$=` (ends with),
`*=` (contains) and following string meta fields:
1357 - `ext`: File extension
1358 - `acodec`: Name of the audio codec in use
1359 - `vcodec`: Name of the video codec in use
1360 - `container`: Name of the container format
1361 - `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`)
1362 - `format_id`: A short description of the format
1363 - `language`: Language code
1365 Any string comparison may be prefixed with negation
`!` in order to produce an opposite comparison, e.g.
`!*=` (does not contain).
1367 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.
1369 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.
1371 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]"`.
1375 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...`.
1377 The available fields are:
1379 - `hasvid`: Gives priority to formats that has a video stream
1380 - `hasaud`: Gives priority to formats that has a audio stream
1381 - `ie_pref`: The format preference as given by the extractor
1382 - `lang`: Language preference as given by the extractor
1383 - `quality`: The quality of the format as given by the extractor
1384 - `source`: Preference of the source as given by the extractor
1385 - `proto`: Protocol used for download (
`https`/
`ftps` >
`http`/
`ftp` >
`m3u8_native`/
`m3u8` >
`http_dash_segments`>
`websocket_frag` >
`mms`/
`rtsp` >
`f4f`/
`f4m`)
1386 - `vcodec`: Video Codec (
`av01` >
`vp9.2` >
`vp9` >
`h265` >
`h264` >
`vp8` >
`h263` >
`theora` > other)
1387 - `acodec`: Audio Codec (
`flac`/
`alac` >
`wav`/
`aiff` >
`opus` >
`vorbis` >
`aac` >
`mp4a` >
`mp3` >
`eac3` >
`ac3` >
`dts` > other)
1388 - `codec`: Equivalent to
`vcodec,acodec`
1389 - `vext`: Video Extension (
`mp4` >
`webm` >
`flv` > other). If
`--prefer-free-formats` is used,
`webm` is preferred.
1390 - `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`.
1391 - `ext`: Equivalent to
`vext,aext`
1392 - `filesize`: Exact filesize, if known in advance
1393 - `fs_approx`: Approximate filesize calculated from the manifests
1394 - `size`: Exact filesize if available, otherwise approximate filesize
1395 - `height`: Height of video
1396 - `width`: Width of video
1397 - `res`: Video resolution, calculated as the smallest dimension.
1398 - `fps`: Framerate of video
1399 - `hdr`: The dynamic range of the video (
`DV` >
`HDR12` >
`HDR10+` >
`HDR10` >
`HLG` >
`SDR`)
1400 - `tbr`: Total average bitrate in KBit/s
1401 - `vbr`: Average video bitrate in KBit/s
1402 - `abr`: Average audio bitrate in KBit/s
1403 - `br`: Equivalent to using
`tbr,vbr,abr`
1404 - `asr`: Audio sample rate in Hz
1406 **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.
1408 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.
1410 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.
1412 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.
1414 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`.
1416 **Tip**: You can use the
`-v -F` to see how the formats have been sorted (worst to best).
1418 ## Format Selection examples
1421 # Download and merge the best video-only format and the best audio-only format,
1422 # or download the best combined format if video-only format is not available
1423 $ yt-dlp -f "bv+ba/b"
1425 # Download best format that contains video,
1426 # and if it doesn't already have an audio stream, merge it with best audio-only format
1427 $ yt-dlp -f "bv*+ba/b"
1432 # Download the best video-only format and the best audio-only format without merging them
1433 # For this case, an output template should be used since
1434 # by default, bestvideo and bestaudio will have the same file name.
1435 $ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
1437 # Download and merge the best format that has a video stream,
1438 # and all audio-only formats into one file
1439 $ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
1441 # Download and merge the best format that has a video stream,
1442 # and the best 2 audio-only formats into one file
1443 $ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
1446 # The following examples show the old method (without -S) of format selection
1447 # and how to use -S to achieve a similar but (generally) better result
1449 # Download the worst video available (old method)
1450 $ yt-dlp -f "wv*+wa/w"
1452 # Download the best video available but with the smallest resolution
1455 # Download the smallest video available
1456 $ yt-dlp -S "+size,+br"
1460 # Download the best mp4 video available, or the best video if no mp4 available
1461 $ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
1463 # Download the best video with the best extension
1464 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1469 # Download the best video available but no better than 480p,
1470 # or the worst video if there is no video under 480p
1471 $ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"
1473 # Download the best video available with the largest height but no better than 480p,
1474 # or the best video with the smallest resolution if there is no video under 480p
1475 $ yt-dlp -S "height:480"
1477 # Download the best video available with the largest resolution but no better than 480p,
1478 # or the best video with the smallest resolution if there is no video under 480p
1479 # Resolution is determined by using the smallest dimension.
1480 # So this works correctly for vertical videos as well
1481 $ yt-dlp -S "res:480"
1485 # Download the best video (that also has audio) but no bigger than 50 MB,
1486 # or the worst video (that also has audio) if there is no video under 50 MB
1487 $ yt-dlp -f "b[filesize<50M] / w"
1489 # Download largest video (that also has audio) but no bigger than 50 MB,
1490 # or the smallest video (that also has audio) if there is no video under 50 MB
1491 $ yt-dlp -f "b" -S "filesize:50M"
1493 # Download best video (that also has audio) that is closest in size to 50 MB
1494 $ yt-dlp -f "b" -S "filesize~50M"
1498 # Download best video available via direct link over HTTP/HTTPS protocol,
1499 # or the best video available via any protocol if there is no such video
1500 $ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
1502 # Download best video available via the best protocol
1503 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1508 # Download the best video with h264 codec, or the best video if there is no such video
1509 $ yt-dlp -f "(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)"
1511 # Download the best video with best codec no better than h264,
1512 # or the best video with worst codec if there is no such video
1513 $ yt-dlp -S "codec:h264"
1515 # Download the best video with worst codec no worse than h264,
1516 # or the best video with best codec if there is no such video
1517 $ yt-dlp -S "+codec:h264"
1521 # More complex examples
1523 # Download the best video no better than 720p preferring framerate greater than 30,
1524 # or the worst video (still preferring framerate greater than 30) if there is no such video
1525 $ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"
1527 # Download the video with the largest resolution no better than 720p,
1528 # or the video with the smallest resolution available if there is no such video,
1529 # preferring larger framerate for formats with the same resolution
1530 $ yt-dlp -S "res:720,fps"
1534 # Download the video with smallest resolution no worse than 480p,
1535 # or the video with the largest resolution available if there is no such video,
1536 # preferring better codec and then larger total bitrate for the same resolution
1537 $ yt-dlp -S "+res:480,codec,br"
1540 # MODIFYING METADATA
1542 The metadata obtained by the extractors can be modified by using
`--parse-metadata` and
`--replace-in-metadata`
1544 `--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.
1546 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.
1548 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`.
1550 This option also has a few special uses:
1551 * 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
1552 * 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.
1554 For reference, these are the fields yt-dlp adds by default to the file metadata:
1556 Metadata fields|From
1558 `title`|
`track` or
`title`
1559 `date`|
`upload_date`
1560 `description`,
`synopsis`|
`description`
1561 `purl`,
`comment`|
`webpage_url`
1562 `track`|
`track_number`
1563 `artist`|
`artist`,
`creator`,
`uploader` or
`uploader_id`
1566 `album_artist`|
`album_artist`
1567 `disc`|
`disc_number`
1569 `season_number`|
`season_number`
1570 `episode_id`|
`episode` or
`episode_id`
1571 `episode_sort`|
`episode_number`
1572 `language` of each stream|From the format's
`language`
1573 **Note**: The file format may not support some of these fields
1576 ## Modifying metadata examples
1579 # Interpret the title as "Artist - Title"
1580 $ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
1583 $ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"
1585 # Set title as "Series name S01E05"
1586 $ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
1588 # Set "comment" field in video metadata using description instead of webpage_url
1589 $ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --add-metadata
1591 # Remove "formats" field from the infojson by setting it to an empty string
1592 $ yt-dlp --parse-metadata ":(?P<formats>)" -j
1594 # Replace all spaces and "_" in title and uploader with a `-`
1595 $ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
1599 # EXTRACTOR ARGUMENTS
1601 Some extractors accept additional arguments which can be passed using
`--extractor-args KEY:ARGS`.
`ARGS` is a
`;` (semicolon) separated string of
`ARG=VAL1,VAL2`. Eg:
`--extractor-args "youtube:player-client=android_agegate,web;include_live_dash" --extractor-args "funimation:version=uncut"`
1603 The following extractors use this feature:
1606 * `skip`:
`hls` or
`dash` (or both) to skip download of the respective manifests
1607 * `player_client`: Clients to extract video data from. The main clients are
`web`,
`android`,
`ios`,
`mweb`. These also have
`_music`,
`_embedded`,
`_agegate`, and
`_creator` variants (Eg:
`web_embedded`) (
`mweb` has only
`_agegate`). By default,
`android,web` is used, but the agegate and creator variants are added as required for age-gated videos. Similarly the music variants are added for
`music.youtube.com` urls. You can also use
`all` to use all the clients, and
`default` for the default clients.
1608 * `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
1609 * `include_live_dash`: Include live dash formats even without
`--live-from-start` (These formats don't download properly)
1610 * `comment_sort`:
`top` or
`new` (default) - choose comment sorting mode (on YouTube's side)
1611 * `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`.
1612 * 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.
1613 * `max_comment_depth` Maximum depth for nested comments. YouTube supports depths
1 or
2 (default)
1614 * **Deprecated**: Set
`max-replies` to
`0` or
`all` in
`max_comments` instead (e.g.
`max_comments=all,all,0` to get no replies)
1616 #### youtubetab (YouTube playlists, channels, feeds, etc.)
1617 * `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)
1620 * `language`: Languages to extract. Eg:
`funimation:language=english,japanese`
1621 * `version`: The video version to extract -
`uncut` or
`simulcast`
1624 * `language`: Languages to extract. Eg:
`crunchyroll:language=jaJp`
1625 * `hardsub`: Which hard-sub versions to extract. Eg:
`crunchyroll:hardsub=None,enUS`
1628 * `video_types`: Types of videos to download - one or more of
`episodes`,
`movies`,
`clips`,
`trailers`
1630 #### youtubewebarchive
1631 * `check_all`: Try to check more at the cost of more requests. One or more of
`thumbnails`,
`captures`
1634 * `comment_sort`:
`hot` (default),
`you` (cookies needed),
`top`,
`new` - choose comment sorting mode (on GameJolt's side)
1637 * `res`: resolution to ignore - one or more of
`sd`,
`hd`,
`fhd`
1638 * `vcodec`: vcodec to ignore - one or more of
`h264`,
`h265`,
`dvh265`
1639 * `dr`: dynamic range to ignore - one or more of
`sdr`,
`hdr10`,
`dv`
1641 NOTE: These options may be changed/removed in the future without concern for backward compatibility
1643 <!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
1648 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
1650 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`.
1652 See [ytdlp_plugins](ytdlp_plugins) for example plugins.
1654 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
1656 If you are a plugin author, add
[ytdlp-plugins](https://github.com/topics/ytdlp-plugins) as a topic to your repository for discoverability
1662 yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1664 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.
1666 From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1669 from yt_dlp import YoutubeDL
1671 ydl_opts = {'format': 'bestaudio'}
1672 with YoutubeDL(ydl_opts) as ydl:
1673 ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
1676 Most likely, you'll want to use various options. For a list of options available, have a look at [
`yt_dlp/YoutubeDL.py`](yt_dlp/YoutubeDL.py#L162).
1678 Here's a more complete example demonstrating various functionality:
1686 def debug(self, msg):
1687 # For compatibility with youtube-dl, both debug and info are passed into debug
1688 # You can distinguish them by the prefix '[debug] '
1689 if msg.startswith('[debug] '):
1694 def info(self, msg):
1697 def warning(self, msg):
1700 def error(self, msg):
1704 # ℹ️ See the docstring of yt_dlp.postprocessor.common.PostProcessor
1705 class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
1706 # ℹ️ See docstring of yt_dlp.postprocessor.common.PostProcessor.run
1707 def run(self, info):
1708 self.to_screen('Doing stuff')
1712 # ℹ️ See "progress_hooks" in the docstring of yt_dlp.YoutubeDL
1714 if d['status'] == 'finished':
1715 print('Done downloading, now converting ...')
1718 def format_selector(ctx):
1719 """ Select the best video and the best audio that won't result in an mkv.
1720 This is just an example and does not handle all cases """
1722 # formats are already sorted worst to best
1723 formats = ctx.get('formats')[::-1]
1725 # acodec='none' means there is no audio
1726 best_video = next(f for f in formats
1727 if f['vcodec'] != 'none' and f['acodec'] == 'none')
1729 # find compatible audio extension
1730 audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
1731 # vcodec='none' means there is no video
1732 best_audio = next(f for f in formats if (
1733 f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
1736 # These are the minimum required fields for a merged format
1737 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
1738 'ext': best_video['ext'],
1739 'requested_formats': [best_video, best_audio],
1740 # Must be + separated list of protocols
1741 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
1745 # ℹ️ See docstring of yt_dlp.YoutubeDL for a description of the options
1747 'format': format_selector,
1748 'postprocessors': [{
1749 # Embed metadata in video using ffmpeg.
1750 # ℹ️ See yt_dlp.postprocessor.FFmpegMetadataPP for the arguments it accepts
1751 'key': 'FFmpegMetadata',
1752 'add_chapters': True,
1753 'add_metadata': True,
1755 'logger': MyLogger(),
1756 'progress_hooks': [my_hook],
1760 # Add custom headers
1761 yt_dlp.utils.std_headers.update({'Referer': 'https://www.google.com'})
1763 # ℹ️ See the public functions in yt_dlp.YoutubeDL for for other available functions.
1764 # Eg: "ydl.download", "ydl.download_with_info_file"
1765 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1766 ydl.add_post_processor(MyCustomPP())
1767 info = ydl.extract_info('https://www.youtube.com/watch?v=BaW_jenozKc')
1769 # ℹ️ ydl.sanitize_info makes the info json-serializable
1770 print(json.dumps(ydl.sanitize_info(info)))
1773 **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
1776 <!-- MANPAGE: MOVE "NEW FEATURES" SECTION HERE -->
1778 # DEPRECATED OPTIONS
1780 These are all the deprecated options and the current alternative to achieve the same effect
1782 #### Redundant options
1783 While these options are redundant, they are still expected to be used due to their ease of use
1785 --get-description --print description
1786 --get-duration --print duration_string
1787 --get-filename --print filename
1788 --get-format --print format
1790 --get-thumbnail --print thumbnail
1791 -e, --get-title --print title
1792 -g, --get-url --print urls
1793 -j, --dump-json --print "%()j"
1794 --match-title REGEX --match-filter "title ~= (?i)REGEX"
1795 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
1796 --min-views COUNT --match-filter "view_count >=? COUNT"
1797 --max-views COUNT --match-filter "view_count <=? COUNT"
1800 #### Not recommended
1801 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1803 --all-formats -f all
1804 --all-subs --sub-langs all --write-subs
1805 --print-json -j --no-simulate
1806 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)
03d
1807 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1808 --id -o "%(id)s.%(ext)s"
1809 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1810 --hls-prefer-native --downloader "m3u8:native"
1811 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1812 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1813 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1814 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
1815 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
1816 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
1817 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
1820 #### Developer options
1821 These options are not intended to be used by the end-user
1823 --test Download only part of video for testing extractors
1824 --youtube-print-sig-code For testing youtube signatures
1825 --allow-unplayable-formats List unplayable formats also
1826 --no-allow-unplayable-formats Default
1830 These are aliases that are no longer documented for various reasons
1832 --avconv-location --ffmpeg-location
1833 --cn-verification-proxy URL --geo-verification-proxy URL
1834 --dump-headers --print-traffic
1835 --dump-intermediate-pages --dump-pages
1836 --force-write-download-archive --force-write-archive
1837 --load-info --load-info-json
1838 --no-split-tracks --no-split-chapters
1839 --no-write-srt --no-write-subs
1840 --prefer-unsecure --prefer-insecure
1841 --rate-limit RATE --limit-rate RATE
1842 --split-tracks --split-chapters
1843 --srt-lang LANGS --sub-langs LANGS
1844 --trim-file-names LENGTH --trim-filenames LENGTH
1845 --write-srt --write-subs
1846 --yes-overwrites --force-overwrites
1848 #### Sponskrub Options
1849 Support for
[SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of the
`--sponsorblock` options
1851 --sponskrub --sponsorblock-mark all
1852 --no-sponskrub --no-sponsorblock
1853 --sponskrub-cut --sponsorblock-remove all
1854 --no-sponskrub-cut --sponsorblock-remove -all
1855 --sponskrub-force Not applicable
1856 --no-sponskrub-force Not applicable
1857 --sponskrub-location Not applicable
1858 --sponskrub-args Not applicable
1860 #### No longer supported
1861 These options may no longer work as intended
1863 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
1864 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
1865 -C, --call-home Not implemented
1866 --no-call-home Default
1867 --include-ads No longer supported
1868 --no-include-ads Default
1869 --write-annotations No supported site has annotations now
1870 --no-write-annotations Default
1873 These options were deprecated since
2014 and have now been entirely removed
1875 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
1876 -t, --title -o "%(title)s-%(id)s.%(ext)s"
1877 -l, --literal -o accepts literal names
1880 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)
1883 For FAQ see the
[youtube-dl README](https://github.com/ytdl-org/youtube-dl#faq)