1 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
4 [](#readme)
6 [](#release-files "Release")
7 []
(https://pypi.org/project/yt-dlp "PyPi")
8 [](Collaborators.md#collaborators "Donate")
9 []
(https://matrix.to/#/#yt-dlp:matrix.org "Matrix")
10 []
(https://discord.gg/H5MNcFW63r "Discord")
11 [](supportedsites.md "Supported Sites")
12 [](LICENSE "License")
13 []
(https://github.com/yt-dlp/yt-dlp/actions "CI Status")
14 []
(https://github.com/yt-dlp/yt-dlp/commits "Commit History")
15 []
(https://github.com/yt-dlp/yt-dlp/commits "Commit History")
18 <!-- MANPAGE: END EXCLUDED SECTION -->
20 yt-dlp is a
[youtube-dl](https://github.com/ytdl-org/youtube-dl) fork based on the now inactive
[youtube-dlc](https://github.com/blackjack4494/yt-dlc). The main focus of this project is adding new features and patches while also keeping up to date with the original project
22 <!-- MANPAGE: MOVE "USAGE AND OPTIONS" SECTION HERE -->
24 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
25 * [NEW FEATURES](#new-features)
26 * [Differences in default behavior](#differences-in-default-behavior)
27 * [INSTALLATION](#installation)
29 * [Release Files](#release-files)
30 * [Dependencies](#dependencies)
32 * [USAGE AND OPTIONS](#usage-and-options)
33 * [General Options](#general-options)
34 * [Network Options](#network-options)
35 * [Geo-restriction](#geo-restriction)
36 * [Video Selection](#video-selection)
37 * [Download Options](#download-options)
38 * [Filesystem Options](#filesystem-options)
39 * [Thumbnail Options](#thumbnail-options)
40 * [Internet Shortcut Options](#internet-shortcut-options)
41 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
42 * [Workarounds](#workarounds)
43 * [Video Format Options](#video-format-options)
44 * [Subtitle Options](#subtitle-options)
45 * [Authentication Options](#authentication-options)
46 * [Post-processing Options](#post-processing-options)
47 * [SponsorBlock Options](#sponsorblock-options)
48 * [Extractor Options](#extractor-options)
49 * [CONFIGURATION](#configuration)
50 * [Authentication with .netrc file](#authentication-with-netrc-file)
51 * [OUTPUT TEMPLATE](#output-template)
52 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
53 * [Output template examples](#output-template-examples)
54 * [FORMAT SELECTION](#format-selection)
55 * [Filtering Formats](#filtering-formats)
56 * [Sorting Formats](#sorting-formats)
57 * [Format Selection examples](#format-selection-examples)
58 * [MODIFYING METADATA](#modifying-metadata)
59 * [Modifying metadata examples](#modifying-metadata-examples)
60 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
62 * [EMBEDDING YT-DLP](#embedding-yt-dlp)
63 * [DEPRECATED OPTIONS](#deprecated-options)
64 * [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
65 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
66 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
68 <!-- MANPAGE: END EXCLUDED SECTION -->
73 * Based on **youtube-dl
2021.12.17 [commit/6508688](https://github.com/ytdl-org/youtube-dl/commit/6508688e88c83bb811653083db9351702cd39a6a)** and **youtube-dlc
2020.11.11-
3 [commit/f9401f2](https://github.com/blackjack4494/yt-dlc/commit/f9401f2a91987068139c5f757b12fc711d4c0cee)**: You get all the features and patches of
[youtube-dlc](https://github.com/blackjack4494/yt-dlc) in addition to the latest
[youtube-dl](https://github.com/ytdl-org/youtube-dl)
75 * **
[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
77 * **[Format Sorting](#sorting-formats)**: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using
`-S`. This allows for much easier format selection than what is possible by simply using
`--format` ([examples](#format-selection-examples))
79 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from
[animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including
`--write-comments`,
`BiliBiliSearch`,
`BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that the NicoNico livestreams are not available. See
[#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details.
81 * **Youtube improvements**:
82 * All Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`) and private playlists supports downloading multiple pages of content
83 * Search (
`ytsearch:`,
`ytsearchdate:`), search URLs and in-channel search works
84 * Mixes supports downloading multiple pages of content
85 * Some (but not all) age-gated content can be downloaded without cookies
86 * Fix for
[n-sig based throttling](https://github.com/ytdl-org/youtube-dl/issues/29326)
87 * Redirect channel's home URL automatically to
`/video` to preserve the old behaviour
88 * `255kbps` audio is extracted (if available) from youtube music when premium cookies are given
89 * Youtube music Albums, channels etc can be downloaded (
[except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723))
90 * Download livestreams from the start using
`--live-from-start` (experimental)
92 * **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using
`--cookies-from-browser BROWSER[+KEYRING][:PROFILE]`
94 * **Split video by chapters**: Videos can be split into multiple files based on chapters using
`--split-chapters`
96 * **Multi-threaded fragment downloads**: Download multiple fragments of m3u8/mpd videos in parallel. Use
`--concurrent-fragments` (
`-N`) option to set the number of threads used
98 * **Aria2c with HLS/DASH**: You can use
`aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
100 * **New and fixed extractors**: Many new extractors have been added and a lot of existing ones have been fixed. See the [changelog](Changelog.md) or the [list of supported sites](supportedsites.md)
102 * **New MSOs**: Philo, Spectrum, SlingTV, Cablevision, RCN
104 * **Subtitle extraction from manifests**: Subtitles can be extracted from streaming media manifests. See
[commit/be6202f](https://github.com/yt-dlp/yt-dlp/commit/be6202f12b97858b9d716e608394b51065d0419f) for details
106 * **Multiple paths and output templates**: You can give different [output templates](#output-template) and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to using
`--paths` (
`-P`)
108 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
110 * **Output template improvements**: Output templates can now have date-time formatting, numeric offsets, object traversal etc. See [output template](#output-template) for details. Even more advanced operations can also be done with the help of
`--parse-metadata` and
`--replace-in-metadata`
112 * **Other new options**: Many new options have been added such as
`--concat-playlist`,
`--print`,
`--wait-for-video`,
`--sleep-requests`,
`--convert-thumbnails`,
`--write-link`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
114 * **Improvements**: Regex and other operators in
`--format`/
`--match-filter`, multiple
`--postprocessor-args` and
`--downloader-args`, faster archive checking, more [format selection options](#format-selection), merge multi-video/audio, multiple
`--config-locations`,
`--exec` at different stages, etc
116 * **Plugins**: Extractors and PostProcessors can be loaded from an external file. See [plugins](#plugins) for details
118 * **Self-updater**: The releases can be updated using
`yt-dlp -U`
120 See
[changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
122 ### Differences in default behavior
124 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc:
126 * The options
`--auto-number` (
`-A`),
`--title` (
`-t`) and
`--literal` (
`-l`), no longer work. See [removed options](#Removed) for details
127 * `avconv` is not supported as an alternative to
`ffmpeg`
128 * 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`
129 * 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
130 * 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
131 * 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
132 * `--no-abort-on-error` is enabled by default. Use
`--abort-on-error` or
`--compat-options abort-on-error` to abort on errors instead
133 * 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
134 * `--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
135 * Some metadata are embedded into different fields when using
`--add-metadata` as compared to youtube-dl. Most notably,
`comment` field contains the
`webpage_url` and
`synopsis` contains the
`description`. You can [use
`--parse-metadata`](#modifying-metadata) to modify this to your liking or use
`--compat-options embed-metadata` to revert this
136 * `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
137 * The output of
`-F` is listed in a new format. Use
`--compat-options list-formats` to revert this
138 * 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
139 * 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
140 * Youtube channel URLs are automatically redirected to
`/video`. Append a
`/featured` to the URL to download only the videos in the home page. If the channel does not have a videos tab, we try to download the equivalent
`UU` playlist instead. For all other tabs, if the channel does not show the requested tab, an error will be raised. Also,
`/live` URLs raise an error if there are no live videos instead of silently downloading the entire channel. You may use
`--compat-options no-youtube-channel-redirect` to revert all these redirections
141 * Unavailable videos are also listed for youtube playlists. Use
`--compat-options no-youtube-unavailable-videos` to remove this
142 * 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
143 * Thumbnail embedding in
`mp4` is done with mutagen if possible. Use
`--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
144 * 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
145 * 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
146 * `certifi` will be used for SSL root certificates, if installed. If you want to use system certificates (e.g. self-signed), use
`--compat-options no-certifi`
148 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
162 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
163 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)
164 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)
165 []
(https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
166 [](#release-files)
167 []
(https://github.com/yt-dlp/yt-dlp/releases)
168 <!-- MANPAGE: END EXCLUDED SECTION -->
170 Note: The manpages, shell completion files etc. are available in the
[source tarball](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
172 <!-- TODO: Move to Wiki -->
173 In UNIX-like OSes (MacOS, Linux, BSD), you can also install the same in one of the following ways:
176 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
177 sudo chmod a+rx /usr/local/bin/yt-dlp
181 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
182 sudo chmod a+rx /usr/local/bin/yt-dlp
186 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp --dir /usr/local/bin -o yt-dlp
187 sudo chmod a+rx /usr/local/bin/yt-dlp
191 ### With [PIP](https://pypi.org/project/pip)
193 You can install the
[PyPI package](https://pypi.org/project/yt-dlp) with:
195 python3 -m pip install -U yt-dlp
198 You can install without any of the optional dependencies using:
200 python3 -m pip install --no-deps -U yt-dlp
203 If you want to be on the cutting edge, you can also install the master branch with:
205 python3 -m pip install --force-reinstall https://github.com/yt-dlp/yt-dlp/archive/master.tar.gz
208 Note that on some systems, you may need to use
`py` or
`python` instead of
`python3`
210 <!-- TODO: Add to Wiki, Remove Taps -->
211 ### With [Homebrew](https://brew.sh)
213 macOS or Linux users that are using Homebrew can also install it by:
216 brew install yt-dlp/taps/yt-dlp
220 You can use
`yt-dlp -U` to update if you are [using the provided release](#using-the-release-binary)
222 If you [installed with pip](#with-pip), simply re-run the same command that was used to install the program
224 If you [installed using Homebrew](#with-homebrew), run
`brew upgrade yt-dlp/taps/yt-dlp`
226 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
233 [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform-independant binary. Needs Python (recommended for **Linux/BSD**)
234 [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**)
235 [yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|MacOS (
10.15+) standalone executable (recommended for **MacOS**)
241 [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
242 [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
243 [yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged Windows executable (no auto-update)
244 [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)
250 [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
251 [SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
252 [SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
253 <!-- MANPAGE: END EXCLUDED SECTION -->
256 Python versions
3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
258 <!-- Python
3.5+ uses VC++
14 and it is already embedded in the binary created
259 <!x-- https://www.microsoft.com/en-us/download/details.aspx?id=
26999 --x>
260 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.
263 While all the other dependencies are optional,
`ffmpeg` and
`ffprobe` are highly recommended
265 * [**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)
266 * [**mutagen**](https://github.com/quodlibet/mutagen)\* - For embedding thumbnail in certain formats. Licensed under
[GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
267 * [**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)
268 * [**websockets**](https://github.com/aaugustin/websockets)\* - For downloading over websocket. Licensed under
[BSD3](https://github.com/aaugustin/websockets/blob/main/LICENSE)
269 * [**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)
270 * [**brotli**](https://github.com/google/brotli)\* or
[**brotlicffi**](https://github.com/python-hyper/brotlicffi) -
[Brotli](https://en.wikipedia.org/wiki/Brotli) content encoding support. Both licensed under MIT <sup>
[1](https://github.com/google/brotli/blob/master/LICENSE) [2](https://github.com/python-hyper/brotlicffi/blob/master/LICENSE) </sup>
271 * [**certifi**](https://github.com/certifi/python-certifi)\* - Provides Mozilla's root certificate bundle. Licensed under
[MPLv2](https://github.com/certifi/python-certifi/blob/master/LICENSE)
272 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For embedding thumbnail in mp4/m4a if mutagen/ffmpeg cannot. Licensed under
[GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
273 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading
`rtmp` streams. ffmpeg will be used as a fallback. Licensed under
[GPLv2+](http://rtmpdump.mplayerhq.hu)
274 * [**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)
275 * [**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)
276 * [**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)
277 * Any external downloader that you want to use with
`--downloader`
279 To use or redistribute the dependencies, you must agree to their respective licensing terms.
281 The Windows and MacOS standalone release binaries are already built with the python interpreter and all optional python packages (marked with \*) included.
283 <!-- TODO: ffmpeg has merged this patch. Remove this note once there is new release -->
284 **Note**: There are some regressions in newer ffmpeg versions that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependency, we provide
[custom builds](https://github.com/yt-dlp/FFmpeg-Builds#ffmpeg-static-auto-builds) with patches for these issues at
[yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds). See
[the readme](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied) for details on the specific issues solved by these builds
290 To build the Windows executable, you must have pyinstaller (and any of yt-dlp's optional dependencies if needed). Once you have all the necessary dependencies installed, (optionally) build lazy extractors using
`devscripts/make_lazy_extractors.py`, and then just run
`pyinst.py`. The executable will be built for the same architecture (
32/
64 bit) as the python used to build it.
292 py -m pip install -U pyinstaller -r requirements.txt
293 py devscripts/make_lazy_extractors.py
296 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
299 You will need the required build tools:
`python`,
`make` (GNU),
`pandoc`,
`zip`,
`pytest`
300 Then simply run
`make`. You can also run
`make yt-dlp` instead to compile only the binary without updating any of the additional files
302 **Note**: In either platform,
`devscripts/update-version.py` can be used to automatically update the version number
304 You can also fork the project on github and run your fork's [build workflow](.github/workflows/build.yml) to automatically build a release
308 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
309 yt-dlp [OPTIONS] [--] URL [URL...]
311 `Ctrl+F` is your friend :D
312 <!-- MANPAGE: END EXCLUDED SECTION -->
314 <!-- Auto generated -->
316 -h, --help Print this help text and exit
317 --version Print program version and exit
318 -U, --update Update this program to latest version. Make
319 sure that you have sufficient permissions
320 (run with sudo if needed)
321 -i, --ignore-errors Ignore download and postprocessing errors.
322 The download will be considered successful
323 even if the postprocessing fails
324 --no-abort-on-error Continue with next video on download
325 errors; e.g. to skip unavailable videos in
327 --abort-on-error Abort downloading of further videos if an
328 error occurs (Alias: --no-ignore-errors)
329 --dump-user-agent Display the current user-agent and exit
330 --list-extractors List all supported extractors and exit
331 --extractor-descriptions Output descriptions of all supported
333 --force-generic-extractor Force extraction to use the generic
335 --default-search PREFIX Use this prefix for unqualified URLs. For
336 example "gvsearch2:" downloads two videos
337 from google videos for the search term
338 "large apple". Use the value "auto" to let
339 yt-dlp guess ("auto_warning" to emit a
340 warning when guessing). "error" just throws
341 an error. The default value "fixup_error"
342 repairs broken URLs, but emits an error if
343 this is not possible instead of searching
344 --ignore-config Don't load any more configuration files
345 except those given by --config-locations.
346 For backward compatibility, if this option
347 is found inside the system configuration
348 file, the user configuration is not loaded.
350 --no-config-locations Do not load any custom configuration files
351 (default). When given inside a
352 configuration file, ignore all previous
353 --config-locations defined in the current
355 --config-locations PATH Location of the main configuration file;
356 either the path to the config or its
357 containing directory. Can be used multiple
358 times and inside other configuration files
359 --flat-playlist Do not extract the videos of a playlist,
361 --no-flat-playlist Extract the videos of a playlist
362 --live-from-start Download livestreams from the start.
363 Currently only supported for YouTube
365 --no-live-from-start Download livestreams from the current time
367 --wait-for-video MIN[-MAX] Wait for scheduled streams to become
368 available. Pass the minimum number of
369 seconds (or range) to wait between retries
370 --no-wait-for-video Do not wait for scheduled streams (default)
371 --mark-watched Mark videos watched (even with --simulate)
372 --no-mark-watched Do not mark videos watched (default)
373 --no-colors Do not emit color codes in output
374 --compat-options OPTS Options that can help keep compatibility
375 with youtube-dl or youtube-dlc
376 configurations by reverting some of the
377 changes made in yt-dlp. See "Differences in
378 default behavior" for details
381 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
382 To enable SOCKS proxy, specify a proper
384 socks5://user:pass@
127.0.0.1:
1080/. Pass in
385 an empty string (--proxy "") for direct
387 --socket-timeout SECONDS Time to wait before giving up, in seconds
388 --source-address IP Client-side IP address to bind to
389 -4, --force-ipv4 Make all connections via IPv4
390 -6, --force-ipv6 Make all connections via IPv6
393 --geo-verification-proxy URL Use this proxy to verify the IP address for
394 some geo-restricted sites. The default
395 proxy specified by --proxy (or none, if the
396 option is not present) is used for the
398 --geo-bypass Bypass geographic restriction via faking
399 X-Forwarded-For HTTP header (default)
400 --no-geo-bypass Do not bypass geographic restriction via
401 faking X-Forwarded-For HTTP header
402 --geo-bypass-country CODE Force bypass geographic restriction with
403 explicitly provided two-letter ISO
3166-
2
405 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
406 explicitly provided IP block in CIDR
410 --playlist-start NUMBER Playlist video to start at (default is
1)
411 --playlist-end NUMBER Playlist video to end at (default is last)
412 --playlist-items ITEM_SPEC Playlist video items to download. Specify
413 indices of the videos in the playlist
414 separated by commas like: "--playlist-items
415 1,
2,
5,
8" if you want to download videos
416 indexed
1,
2,
5,
8 in the playlist. You can
417 specify range: "--playlist-items
418 1-
3,
7,
10-
13", it will download the videos
419 at index
1,
2,
3,
7,
10,
11,
12 and
13
420 --min-filesize SIZE Do not download any videos smaller than
421 SIZE (e.g.
50k or
44.6m)
422 --max-filesize SIZE Do not download any videos larger than SIZE
424 --date DATE Download only videos uploaded on this date.
425 The date can be "YYYYMMDD" or in the format
426 "(now|today)[+-][
0-
9](day|week|month|year)(s)?"
427 --datebefore DATE Download only videos uploaded on or before
428 this date. The date formats accepted is the
430 --dateafter DATE Download only videos uploaded on or after
431 this date. The date formats accepted is the
433 --match-filter FILTER Generic video filter. Any field (see
434 "OUTPUT TEMPLATE") can be compared with a
435 number or a string using the operators
436 defined in "Filtering formats". You can
437 also simply specify a field to match if the
438 field is present and "!field" to check if
439 the field is not present. In addition,
440 Python style regular expression matching
441 can be done using "~=", and multiple
442 filters can be checked with "&". Use a "
\"
443 to escape "&" or quotes if needed. Eg:
444 --match-filter "!is_live & like_count>?
100
445 & description~='(?i)
\bcats \& dogs
\b'"
446 matches only videos that are not live, has
447 a like count more than
100 (or the like
448 field is not available), and also has a
449 description that contains the phrase "cats
450 & dogs" (ignoring case)
451 --no-match-filter Do not use generic video filter (default)
452 --no-playlist Download only the video, if the URL refers
453 to a video and a playlist
454 --yes-playlist Download the playlist, if the URL refers to
455 a video and a playlist
456 --age-limit YEARS Download only videos suitable for the given
458 --download-archive FILE Download only videos not listed in the
459 archive file. Record the IDs of all
460 downloaded videos in it
461 --no-download-archive Do not use archive file (default)
462 --max-downloads NUMBER Abort after downloading NUMBER files
463 --break-on-existing Stop the download process when encountering
464 a file that is in the archive
465 --break-on-reject Stop the download process when encountering
466 a file that has been filtered out
467 --break-per-input Make --break-on-existing and --break-on-
468 reject act only on the current input URL
469 --no-break-per-input --break-on-existing and --break-on-reject
470 terminates the entire download queue
471 --skip-playlist-after-errors N Number of allowed failures until the rest
472 of the playlist is skipped
475 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
476 video that should be downloaded
477 concurrently (default is
1)
478 -r, --limit-rate RATE Maximum download rate in bytes per second
480 --throttled-rate RATE Minimum download rate in bytes per second
481 below which throttling is assumed and the
482 video data is re-extracted (e.g.
100K)
483 -R, --retries RETRIES Number of retries (default is
10), or
485 --file-access-retries RETRIES Number of times to retry on file access
486 error (default is
10), or "infinite"
487 --fragment-retries RETRIES Number of retries for a fragment (default
488 is
10), or "infinite" (DASH, hlsnative and
490 --skip-unavailable-fragments Skip unavailable fragments for DASH,
491 hlsnative and ISM (default)
492 (Alias: --no-abort-on-unavailable-fragment)
493 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
494 (Alias: --no-skip-unavailable-fragments)
495 --keep-fragments Keep downloaded fragments on disk after
496 downloading is finished
497 --no-keep-fragments Delete downloaded fragments after
498 downloading is finished (default)
499 --buffer-size SIZE Size of download buffer (e.g.
1024 or
16K)
501 --resize-buffer The buffer size is automatically resized
502 from an initial value of --buffer-size
504 --no-resize-buffer Do not automatically adjust the buffer size
505 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
506 downloading (e.g.
10485760 or
10M) (default
507 is disabled). May be useful for bypassing
508 bandwidth throttling imposed by a webserver
510 --playlist-reverse Download playlist videos in reverse order
511 --no-playlist-reverse Download playlist videos in default order
513 --playlist-random Download playlist videos in random order
514 --xattr-set-filesize Set file xattribute ytdl.filesize with
516 --hls-use-mpegts Use the mpegts container for HLS videos;
517 allowing some players to play the video
518 while downloading, and reducing the chance
519 of file corruption if download is
520 interrupted. This is enabled by default for
522 --no-hls-use-mpegts Do not use the mpegts container for HLS
523 videos. This is default when not
524 downloading live streams
525 --downloader [PROTO:]NAME Name or path of the external downloader to
526 use (optionally) prefixed by the protocols
527 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
528 use it for. Currently supports native,
529 aria2c, avconv, axel, curl, ffmpeg, httpie,
530 wget (Recommended: aria2c). You can use
531 this option multiple times to set different
532 downloaders for different protocols. For
533 example, --downloader aria2c --downloader
534 "dash,m3u8:native" will use aria2c for
535 http/ftp downloads, and the native
536 downloader for dash/m3u8 downloads (Alias:
537 --external-downloader)
538 --downloader-args NAME:ARGS Give these arguments to the external
539 downloader. Specify the downloader name and
540 the arguments separated by a colon ":". For
541 ffmpeg, arguments can be passed to
542 different positions using the same syntax
543 as --postprocessor-args. You can use this
544 option multiple times to give different
545 arguments to different downloaders (Alias:
546 --external-downloader-args)
548 ## Filesystem Options:
549 -a, --batch-file FILE File containing URLs to download ("-" for
550 stdin), one URL per line. Lines starting
551 with "#", ";" or "]" are considered as
553 --no-batch-file Do not read URLs from batch file (default)
554 -P, --paths [TYPES:]PATH The paths where the files should be
555 downloaded. Specify the type of file and
556 the path separated by a colon ":". All the
557 same TYPES as --output are supported.
558 Additionally, you can also provide "home"
559 (default) and "temp" paths. All
560 intermediary files are first downloaded to
561 the temp path and then the final files are
562 moved over to the home path after download
563 is finished. This option is ignored if
564 --output is an absolute path
565 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
566 TEMPLATE" for details
567 --output-na-placeholder TEXT Placeholder value for unavailable meta
568 fields in output filename template
570 --restrict-filenames Restrict filenames to only ASCII
571 characters, and avoid "&" and spaces in
573 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
575 --windows-filenames Force filenames to be Windows-compatible
576 --no-windows-filenames Make filenames Windows-compatible only if
577 using Windows (default)
578 --trim-filenames LENGTH Limit the filename length (excluding
579 extension) to the specified number of
581 -w, --no-overwrites Do not overwrite any files
582 --force-overwrites Overwrite all video and metadata files.
583 This option includes --no-continue
584 --no-force-overwrites Do not overwrite the video, but overwrite
585 related files (default)
586 -c, --continue Resume partially downloaded files/fragments
588 --no-continue Do not resume partially downloaded
589 fragments. If the file is not fragmented,
590 restart download of the entire file
591 --part Use .part files instead of writing directly
592 into output file (default)
593 --no-part Do not use .part files - write directly
595 --mtime Use the Last-modified header to set the
596 file modification time (default)
597 --no-mtime Do not use the Last-modified header to set
598 the file modification time
599 --write-description Write video description to a .description
601 --no-write-description Do not write video description (default)
602 --write-info-json Write video metadata to a .info.json file
603 (this may contain personal information)
604 --no-write-info-json Do not write video metadata (default)
605 --write-playlist-metafiles Write playlist metadata in addition to the
606 video metadata when using --write-info-json,
607 --write-description etc. (default)
608 --no-write-playlist-metafiles Do not write playlist metadata when using
609 --write-info-json, --write-description etc.
610 --clean-info-json Remove some private fields such as
611 filenames from the infojson. Note that it
612 could still contain some personal
613 information (default)
614 --no-clean-info-json Write all fields to the infojson
615 --write-comments Retrieve video comments to be placed in the
616 infojson. The comments are fetched even
617 without this option if the extraction is
618 known to be quick (Alias: --get-comments)
619 --no-write-comments Do not retrieve video comments unless the
620 extraction is known to be quick (Alias:
622 --load-info-json FILE JSON file containing the video information
623 (created with the "--write-info-json"
625 --cookies FILE Netscape formatted file to read cookies
626 from and dump cookie jar in
627 --no-cookies Do not read/dump cookies from/to file
629 --cookies-from-browser BROWSER[+KEYRING][:PROFILE]
630 The name of the browser and (optionally)
631 the name/path of the profile to load
632 cookies from, separated by a ":". Currently
633 supported browsers are: brave, chrome,
634 chromium, edge, firefox, opera, safari,
635 vivaldi. By default, the most recently
636 accessed profile is used. The keyring used
637 for decrypting Chromium cookies on Linux
638 can be (optionally) specified after the
639 browser name separated by a "+". Currently
640 supported keyrings are: basictext,
641 gnomekeyring, kwallet
642 --no-cookies-from-browser Do not load cookies from browser (default)
643 --cache-dir DIR Location in the filesystem where youtube-dl
644 can store some downloaded information (such
645 as client ids and signatures) permanently.
646 By default $XDG_CACHE_HOME/yt-dlp or
648 --no-cache-dir Disable filesystem caching
649 --rm-cache-dir Delete all filesystem cache files
651 ## Thumbnail Options:
652 --write-thumbnail Write thumbnail image to disk
653 --no-write-thumbnail Do not write thumbnail image to disk
655 --write-all-thumbnails Write all thumbnail image formats to disk
656 --list-thumbnails List available thumbnails of each video.
657 Simulate unless --no-simulate is used
659 ## Internet Shortcut Options:
660 --write-link Write an internet shortcut file, depending
661 on the current platform (.url, .webloc or
662 .desktop). The URL may be cached by the OS
663 --write-url-link Write a .url Windows internet shortcut. The
664 OS caches the URL based on the file path
665 --write-webloc-link Write a .webloc macOS internet shortcut
666 --write-desktop-link Write a .desktop Linux internet shortcut
668 ## Verbosity and Simulation Options:
669 -q, --quiet Activate quiet mode. If used with
670 --verbose, print the log to stderr
671 --no-warnings Ignore warnings
672 -s, --simulate Do not download the video and do not write
674 --no-simulate Download the video even if printing/listing
676 --ignore-no-formats-error Ignore "No video formats" error. Useful for
677 extracting metadata even if the videos are
678 not actually available for download
680 --no-ignore-no-formats-error Throw error when no downloadable video
681 formats are found (default)
682 --skip-download Do not download the video but write all
683 related files (Alias: --no-download)
684 -O, --print [WHEN:]TEMPLATE Field name or output template to print to
685 screen, optionally prefixed with when to
686 print it, separated by a ":". Supported
687 values of "WHEN" are the same as that of
688 --use-postprocessor, and "video" (default).
689 Implies --quiet and --simulate (unless
690 --no-simulate is used). This option can be
692 --print-to-file [WHEN:]TEMPLATE FILE
693 Append given template to the file. The
694 values of WHEN and TEMPLATE are same as
695 that of --print. FILE uses the same syntax
696 as the output template. This option can be
698 -j, --dump-json Quiet, but print JSON information for each
699 video. Simulate unless --no-simulate is
700 used. See "OUTPUT TEMPLATE" for a
701 description of available keys
702 -J, --dump-single-json Quiet, but print JSON information for each
703 url or infojson passed. Simulate unless
704 --no-simulate is used. If the URL refers to
705 a playlist, the whole playlist information
706 is dumped in a single line
707 --force-write-archive Force download archive entries to be
708 written as far as no errors occur, even if
709 -s or another simulation option is used
710 (Alias: --force-download-archive)
711 --newline Output progress bar as new lines
712 --no-progress Do not print progress bar
713 --progress Show progress bar, even if in quiet mode
714 --console-title Display progress in console titlebar
715 --progress-template [TYPES:]TEMPLATE
716 Template for progress outputs, optionally
717 prefixed with one of "download:" (default),
718 "download-title:" (the console title),
719 "postprocess:", or "postprocess-title:".
720 The video's fields are accessible under the
721 "info" key and the progress attributes are
722 accessible under "progress" key. E.g.:
723 --console-title --progress-template
724 "download-title:%(info.id)s-%(progress.eta)s"
725 -v, --verbose Print various debugging information
726 --dump-pages Print downloaded pages encoded using base64
727 to debug problems (very verbose)
728 --write-pages Write downloaded intermediary pages to
729 files in the current directory to debug
731 --print-traffic Display sent and read HTTP traffic
734 --encoding ENCODING Force the specified encoding (experimental)
735 --legacy-server-connect Explicitly allow HTTPS connection to
736 servers that do not support RFC
5746 secure
738 --no-check-certificates Suppress HTTPS certificate validation
739 --prefer-insecure Use an unencrypted connection to retrieve
740 information about the video (Currently
741 supported only for YouTube)
742 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
743 separated by a colon ":". You can use this
744 option multiple times
745 --bidi-workaround Work around terminals that lack
746 bidirectional text support. Requires bidiv
747 or fribidi executable in PATH
748 --sleep-requests SECONDS Number of seconds to sleep between requests
749 during data extraction
750 --sleep-interval SECONDS Number of seconds to sleep before each
751 download. This is the minimum time to sleep
752 when used along with --max-sleep-interval
753 (Alias: --min-sleep-interval)
754 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
755 only be used along with --min-sleep-interval
756 --sleep-subtitles SECONDS Number of seconds to sleep before each
759 ## Video Format Options:
760 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
762 -S, --format-sort SORTORDER Sort the formats by the fields given, see
763 "Sorting Formats" for more details
764 --S-force, --format-sort-force Force user specified sort order to have
765 precedence over all fields, see "Sorting
766 Formats" for more details
767 --no-format-sort-force Some fields have precedence over the user
768 specified sort order (default), see
769 "Sorting Formats" for more details
770 --video-multistreams Allow multiple video streams to be merged
772 --no-video-multistreams Only one video stream is downloaded for
773 each output file (default)
774 --audio-multistreams Allow multiple audio streams to be merged
776 --no-audio-multistreams Only one audio stream is downloaded for
777 each output file (default)
778 --prefer-free-formats Prefer video formats with free containers
779 over non-free ones of same quality. Use
780 with "-S ext" to strictly prefer free
781 containers irrespective of quality
782 --no-prefer-free-formats Don't give any special preference to free
784 --check-formats Check that the selected formats are
785 actually downloadable
786 --check-all-formats Check all formats for whether they are
787 actually downloadable
788 --no-check-formats Do not check that the formats are actually
790 -F, --list-formats List available formats of each video.
791 Simulate unless --no-simulate is used
792 --merge-output-format FORMAT If a merge is required (e.g.
793 bestvideo+bestaudio), output to given
794 container format. One of mkv, mp4, ogg,
795 webm, flv. Ignored if no merge is required
798 --write-subs Write subtitle file
799 --no-write-subs Do not write subtitle file (default)
800 --write-auto-subs Write automatically generated subtitle file
801 (Alias: --write-automatic-subs)
802 --no-write-auto-subs Do not write auto-generated subtitles
803 (default) (Alias: --no-write-automatic-subs)
804 --list-subs List available subtitles of each video.
805 Simulate unless --no-simulate is used
806 --sub-format FORMAT Subtitle format, accepts formats
807 preference, for example: "srt" or
809 --sub-langs LANGS Languages of the subtitles to download (can
810 be regex) or "all" separated by commas.
811 (Eg: --sub-langs "en.*,ja") You can prefix
812 the language code with a "-" to exempt it
813 from the requested languages. (Eg:
814 --sub-langs all,-live_chat) Use --list-subs
815 for a list of available language tags
817 ## Authentication Options:
818 -u, --username USERNAME Login with this account ID
819 -p, --password PASSWORD Account password. If this option is left
820 out, yt-dlp will ask interactively
821 -2, --twofactor TWOFACTOR Two-factor authentication code
822 -n, --netrc Use .netrc authentication data
823 --netrc-location PATH Location of .netrc authentication data;
824 either the path or its containing
825 directory. Defaults to ~/.netrc
826 --video-password PASSWORD Video password (vimeo, youku)
827 --ap-mso MSO Adobe Pass multiple-system operator (TV
828 provider) identifier, use --ap-list-mso for
829 a list of available MSOs
830 --ap-username USERNAME Multiple-system operator account login
831 --ap-password PASSWORD Multiple-system operator account password.
832 If this option is left out, yt-dlp will ask
834 --ap-list-mso List all supported multiple-system
837 ## Post-Processing Options:
838 -x, --extract-audio Convert video files to audio-only files
839 (requires ffmpeg and ffprobe)
840 --audio-format FORMAT Specify audio format to convert the audio
841 to when -x is used. Currently supported
842 formats are: best (default) or one of
843 best|aac|flac|mp3|m4a|opus|vorbis|wav|alac
844 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
845 value between
0 (best) and
10 (worst) for
846 VBR or a specific bitrate like
128K
848 --remux-video FORMAT Remux the video into another container if
849 necessary (currently supported: mp4|mkv|flv
850 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
851 target container does not support the
852 video/audio codec, remuxing will fail. You
853 can specify multiple rules; Eg.
854 "aac>m4a/mov>mp4/mkv" will remux aac to
855 m4a, mov to mp4 and anything else to mkv.
856 --recode-video FORMAT Re-encode the video into another format if
857 re-encoding is necessary. The syntax and
858 supported formats are the same as --remux-video
859 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
860 Specify the postprocessor/executable name
861 and the arguments separated by a colon ":"
862 to give the argument to the specified
863 postprocessor/executable. Supported PP are:
864 Merger, ModifyChapters, SplitChapters,
865 ExtractAudio, VideoRemuxer, VideoConvertor,
866 Metadata, EmbedSubtitle, EmbedThumbnail,
867 SubtitlesConvertor, ThumbnailsConvertor,
868 FixupStretched, FixupM4a, FixupM3u8,
869 FixupTimestamp and FixupDuration. The
870 supported executables are: AtomicParsley,
871 FFmpeg and FFprobe. You can also specify
872 "PP+EXE:ARGS" to give the arguments to the
873 specified executable only when being used
874 by the specified postprocessor.
875 Additionally, for ffmpeg/ffprobe, "_i"/"_o"
876 can be appended to the prefix optionally
877 followed by a number to pass the argument
878 before the specified input/output file. Eg:
879 --ppa "Merger+ffmpeg_i1:-v quiet". You can
880 use this option multiple times to give
881 different arguments to different
882 postprocessors. (Alias: --ppa)
883 -k, --keep-video Keep the intermediate video file on disk
884 after post-processing
885 --no-keep-video Delete the intermediate video file after
886 post-processing (default)
887 --post-overwrites Overwrite post-processed files (default)
888 --no-post-overwrites Do not overwrite post-processed files
889 --embed-subs Embed subtitles in the video (only for mp4,
891 --no-embed-subs Do not embed subtitles (default)
892 --embed-thumbnail Embed thumbnail in the video as cover art
893 --no-embed-thumbnail Do not embed thumbnail (default)
894 --embed-metadata Embed metadata to the video file. Also
895 embeds chapters/infojson if present unless
896 --no-embed-chapters/--no-embed-info-json
897 are used (Alias: --add-metadata)
898 --no-embed-metadata Do not add metadata to file (default)
899 (Alias: --no-add-metadata)
900 --embed-chapters Add chapter markers to the video file
901 (Alias: --add-chapters)
902 --no-embed-chapters Do not add chapter markers (default)
903 (Alias: --no-add-chapters)
904 --embed-info-json Embed the infojson as an attachment to
906 --no-embed-info-json Do not embed the infojson as an attachment
908 --parse-metadata FROM:TO Parse additional metadata like title/artist
909 from other fields; see "MODIFYING METADATA"
911 --replace-in-metadata FIELDS REGEX REPLACE
912 Replace text in a metadata field using the
913 given regex. This option can be used
915 --xattrs Write metadata to the video file's xattrs
916 (using dublin core and xdg standards)
917 --concat-playlist POLICY Concatenate videos in a playlist. One of
918 "never", "always", or "multi_video"
919 (default; only when the videos form a
920 single show). All the video files must have
921 same codecs and number of streams to be
922 concatable. The "pl_video:" prefix can be
923 used with "--paths" and "--output" to set
924 the output filename for the split files.
925 See "OUTPUT TEMPLATE" for details
926 --fixup POLICY Automatically correct known faults of the
927 file. One of never (do nothing), warn (only
928 emit a warning), detect_or_warn (the
929 default; fix file if we can, warn
930 otherwise), force (try fixing even if file
932 --ffmpeg-location PATH Location of the ffmpeg binary; either the
933 path to the binary or its containing
935 --exec [WHEN:]CMD Execute a command, optionally prefixed with
936 when to execute it (after_move if
937 unspecified), separated by a ":". Supported
938 values of "WHEN" are the same as that of
939 --use-postprocessor. Same syntax as the
940 output template can be used to pass any
941 field as arguments to the command. After
942 download, an additional field "filepath"
943 that contains the final path of the
944 downloaded file is also available, and if
945 no fields are passed, %(filepath)q is
946 appended to the end of the command. This
947 option can be used multiple times
948 --no-exec Remove any previously defined --exec
949 --convert-subs FORMAT Convert the subtitles to another format
950 (currently supported: srt|vtt|ass|lrc)
951 (Alias: --convert-subtitles)
952 --convert-thumbnails FORMAT Convert the thumbnails to another format
953 (currently supported: jpg|png|webp)
954 --split-chapters Split video into multiple files based on
955 internal chapters. The "chapter:" prefix
956 can be used with "--paths" and "--output"
957 to set the output filename for the split
958 files. See "OUTPUT TEMPLATE" for details
959 --no-split-chapters Do not split video based on chapters
961 --remove-chapters REGEX Remove chapters whose title matches the
962 given regular expression. Time ranges
963 prefixed by a "*" can also be used in place
964 of chapters to remove the specified range.
965 Eg: --remove-chapters "*
10:
15-
15:
00"
966 --remove-chapters "intro". This option can
967 be used multiple times
968 --no-remove-chapters Do not remove any chapters from the file
970 --force-keyframes-at-cuts Force keyframes around the chapters before
971 removing/splitting them. Requires a
972 re-encode and thus is very slow, but the
973 resulting video may have fewer artifacts
975 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
976 when cutting/splitting (default)
977 --use-postprocessor NAME[:ARGS] The (case sensitive) name of plugin
978 postprocessors to be enabled, and
979 (optionally) arguments to be passed to it,
980 separated by a colon ":". ARGS are a
981 semicolon ";" delimited list of NAME=VALUE.
982 The "when" argument determines when the
983 postprocessor is invoked. It can be one of
984 "pre_process" (after video extraction),
985 "after_filter" (after video passes filter),
986 "before_dl" (before each video download),
987 "post_process" (after each video download;
988 default), "after_move" (after moving video
989 file to it's final locations),
990 "after_video" (after downloading and
991 processing all formats of a video), or
992 "playlist" (at end of playlist). This
993 option can be used multiple times to add
994 different postprocessors
996 ## SponsorBlock Options:
997 Make chapter entries for, or remove various segments (sponsor,
998 introductions, etc.) from downloaded YouTube videos using the
999 [SponsorBlock API](https://sponsor.ajay.app)
1001 --sponsorblock-mark CATS SponsorBlock categories to create chapters
1002 for, separated by commas. Available
1003 categories are all, default(=all), sponsor,
1004 intro, outro, selfpromo, preview, filler,
1005 interaction, music_offtopic, poi_highlight.
1006 You can prefix the category with a "-" to
1007 exempt it. See [
1] for description of the
1008 categories. Eg: --sponsorblock-mark all,-preview
1009 [
1] https://wiki.sponsor.ajay.app/w/Segment_Categories
1010 --sponsorblock-remove CATS SponsorBlock categories to be removed from
1011 the video file, separated by commas. If a
1012 category is present in both mark and
1013 remove, remove takes precedence. The syntax
1014 and available categories are the same as
1015 for --sponsorblock-mark except that
1016 "default" refers to "all,-filler" and
1017 poi_highlight is not available
1018 --sponsorblock-chapter-title TEMPLATE
1019 The title template for SponsorBlock
1020 chapters created by --sponsorblock-mark.
1021 The same syntax as the output template is
1022 used, but the only available fields are
1023 start_time, end_time, category, categories,
1024 name, category_names. Defaults to
1025 "[SponsorBlock]: %(category_names)l"
1026 --no-sponsorblock Disable both --sponsorblock-mark and
1027 --sponsorblock-remove
1028 --sponsorblock-api URL SponsorBlock API location, defaults to
1029 https://sponsor.ajay.app
1031 ## Extractor Options:
1032 --extractor-retries RETRIES Number of retries for known extractor
1033 errors (default is
3), or "infinite"
1034 --allow-dynamic-mpd Process dynamic DASH manifests (default)
1035 (Alias: --no-ignore-dynamic-mpd)
1036 --ignore-dynamic-mpd Do not process dynamic DASH manifests
1037 (Alias: --no-allow-dynamic-mpd)
1038 --hls-split-discontinuity Split HLS playlists to different formats at
1039 discontinuities such as ad breaks
1040 --no-hls-split-discontinuity Do not split HLS playlists to different
1041 formats at discontinuities such as ad
1043 --extractor-args KEY:ARGS Pass these arguments to the extractor. See
1044 "EXTRACTOR ARGUMENTS" for details. You can
1045 use this option multiple times to give
1046 arguments for different extractors
1050 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
1052 1. **Main Configuration**: The file given by
`--config-location`
1053 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.
1054 1. **Home Configuration**:
`yt-dlp.conf` in the home path given by
`-P`, or in the current directory if no such path is given
1055 1. **User Configuration**:
1056 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
1057 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
1058 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
1059 * `%APPDATA%/yt-dlp/config.txt`
1061 * `~/yt-dlp.conf.txt`
1063 `%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%`
1064 1. **System Configuration**:
`/etc/yt-dlp.conf`
1066 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:
1068 # Lines starting with # are comments
1070 # Always extract audio
1073 # Do not copy the mtime
1077 --proxy 127.0.0.1:3128
1079 # Save all videos under YouTube directory in your home directory
1080 -o ~/YouTube/%(title)s.%(ext)s
1083 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`.
1085 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.
1087 ### Authentication with `.netrc` file
1089 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:
1092 chmod a-rwx,u+rw $HOME/.netrc
1094 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1096 machine <extractor> login <username> password <password>
1100 machine youtube login myaccount@gmail.com password my_youtube_password
1101 machine twitch login my_twitch_account_name password my_twitch_password
1103 To activate authentication with the
`.netrc` file you should pass
`--netrc` to yt-dlp or place it in the [configuration file](#configuration).
1105 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%`
1109 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.
1111 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1112 **tl;dr:** [navigate me to examples](#output-template-examples).
1113 <!-- MANPAGE: END EXCLUDED SECTION -->
1115 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).
1117 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.
1119 The field names themselves (the part inside the parenthesis) can also have some special formatting:
1120 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
1122 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`
1124 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`
1126 1. **Alternatives**: Alternate fields can be specified separated with a
`,`. Eg:
`%(release_date>%Y,upload_date>%Y|Unknown)s`
1128 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.
1130 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`
1132 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
1134 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
1136 To summarize, the general syntax for a field is:
1138 %(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
1141 Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon
`:`. The different file types supported are
`subtitle`,
`thumbnail`,
`description`,
`annotation` (deprecated),
`infojson`,
`link`,
`pl_thumbnail`,
`pl_description`,
`pl_infojson`,
`chapter`,
`pl_video`. For example,
`-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"` will put the thumbnails in a folder with the same name as the video. If any of the templates is empty, that type of file will not be written. Eg:
`--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
1143 The available fields are:
1145 - `id` (string): Video identifier
1146 - `title` (string): Video title
1147 - `fulltitle` (string): Video title ignoring live timestamp and generic title
1148 - `url` (string): Video URL
1149 - `ext` (string): Video filename extension
1150 - `alt_title` (string): A secondary title of the video
1151 - `description` (string): The description of the video
1152 - `display_id` (string): An alternative identifier for the video
1153 - `uploader` (string): Full name of the video uploader
1154 - `license` (string): License name the video is licensed under
1155 - `creator` (string): The creator of the video
1156 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
1157 - `upload_date` (string): Video upload date in UTC (YYYYMMDD)
1158 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
1159 - `release_date` (string): The date (YYYYMMDD) when the video was released in UTC
1160 - `modified_timestamp` (numeric): UNIX timestamp of the moment the video was last modified
1161 - `modified_date` (string): The date (YYYYMMDD) when the video was last modified in UTC
1162 - `uploader_id` (string): Nickname or id of the video uploader
1163 - `channel` (string): Full name of the channel the video is uploaded on
1164 - `channel_id` (string): Id of the channel
1165 - `channel_follower_count` (numeric): Number of followers of the channel
1166 - `location` (string): Physical location where the video was filmed
1167 - `duration` (numeric): Length of the video in seconds
1168 - `duration_string` (string): Length of the video (HH:mm:ss)
1169 - `view_count` (numeric): How many users have watched the video on the platform
1170 - `like_count` (numeric): Number of positive ratings of the video
1171 - `dislike_count` (numeric): Number of negative ratings of the video
1172 - `repost_count` (numeric): Number of reposts of the video
1173 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
1174 - `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)
1175 - `age_limit` (numeric): Age restriction for the video (years)
1176 - `live_status` (string): One of "is_live", "was_live", "is_upcoming", "not_live"
1177 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
1178 - `was_live` (boolean): Whether this video was originally a live stream
1179 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
1180 - `availability` (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
1181 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1182 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
1183 - `format` (string): A human-readable description of the format
1184 - `format_id` (string): Format code specified by
`--format`
1185 - `format_note` (string): Additional info about the format
1186 - `width` (numeric): Width of the video
1187 - `height` (numeric): Height of the video
1188 - `resolution` (string): Textual description of width and height
1189 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
1190 - `abr` (numeric): Average audio bitrate in KBit/s
1191 - `acodec` (string): Name of the audio codec in use
1192 - `asr` (numeric): Audio sampling rate in Hertz
1193 - `vbr` (numeric): Average video bitrate in KBit/s
1194 - `fps` (numeric): Frame rate
1195 - `dynamic_range` (string): The dynamic range of the video
1196 - `vcodec` (string): Name of the video codec in use
1197 - `container` (string): Name of the container format
1198 - `filesize` (numeric): The number of bytes, if known in advance
1199 - `filesize_approx` (numeric): An estimate for the number of bytes
1200 - `protocol` (string): The protocol that will be used for the actual download
1201 - `extractor` (string): Name of the extractor
1202 - `extractor_key` (string): Key name of the extractor
1203 - `epoch` (numeric): Unix epoch of when the information extraction was completed
1204 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
1205 - `video_autonumber` (numeric): Number that will be increased with each video
1206 - `n_entries` (numeric): Total number of extracted items in the playlist
1207 - `playlist_id` (string): Identifier of the playlist that contains the video
1208 - `playlist_title` (string): Name of the playlist that contains the video
1209 - `playlist` (string):
`playlist_id` or
`playlist_title`
1210 - `playlist_count` (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
1211 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1212 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
1213 - `playlist_uploader` (string): Full name of the playlist uploader
1214 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
1215 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
1216 - `webpage_url_basename` (string): The basename of the webpage URL
1217 - `webpage_url_domain` (string): The domain of the webpage URL
1218 - `original_url` (string): The URL given by the user (or same as
`webpage_url` for playlist entries)
1220 Available for the video that belongs to some logical chapter or section:
1222 - `chapter` (string): Name or title of the chapter the video belongs to
1223 - `chapter_number` (numeric): Number of the chapter the video belongs to
1224 - `chapter_id` (string): Id of the chapter the video belongs to
1226 Available for the video that is an episode of some series or programme:
1228 - `series` (string): Title of the series or programme the video episode belongs to
1229 - `season` (string): Title of the season the video episode belongs to
1230 - `season_number` (numeric): Number of the season the video episode belongs to
1231 - `season_id` (string): Id of the season the video episode belongs to
1232 - `episode` (string): Title of the video episode
1233 - `episode_number` (numeric): Number of the video episode within a season
1234 - `episode_id` (string): Id of the video episode
1236 Available for the media that is a track or a part of a music album:
1238 - `track` (string): Title of the track
1239 - `track_number` (numeric): Number of the track within an album or a disc
1240 - `track_id` (string): Id of the track
1241 - `artist` (string): Artist(s) of the track
1242 - `genre` (string): Genre(s) of the track
1243 - `album` (string): Title of the album the track belongs to
1244 - `album_type` (string): Type of the album
1245 - `album_artist` (string): List of all artists appeared on the album
1246 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1247 - `release_year` (numeric): Year (YYYY) when the album was released
1249 Available for
`chapter:` prefix when using
`--split-chapters` for videos with internal chapters:
1251 - `section_title` (string): Title of the chapter
1252 - `section_number` (numeric): Number of the chapter within the file
1253 - `section_start` (numeric): Start time of the chapter in seconds
1254 - `section_end` (numeric): End time of the chapter in seconds
1256 Available only when used in
`--print`:
1258 - `urls` (string): The URLs of all requested formats, one in each line
1259 - `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
1260 - `formats_table` (table): The video format table as printed by
`--list-formats`
1261 - `thumbnails_table` (table): The thumbnail format table as printed by
`--list-thumbnails`
1262 - `subtitles_table` (table): The subtitle format table as printed by
`--list-subs`
1263 - `automatic_captions_table` (table): The automatic subtitle format table as printed by
`--list-subs`
1266 Available only in
`--sponsorblock-chapter-title`:
1268 - `start_time` (numeric): Start time of the chapter in seconds
1269 - `end_time` (numeric): End time of the chapter in seconds
1270 - `categories` (list): The SponsorBlock categories the chapter belongs to
1271 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1272 - `category_names` (list): Friendly names of the categories
1273 - `name` (string): Friendly name of the smallest category
1275 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.
1277 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).
1279 **Tip**: Look at the
`-j` output to identify which fields are available for the particular URL
1281 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`.
1283 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.
1285 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
1287 The current default template is
`%(title)s [%(id)s].%(ext)s`.
1289 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.
1291 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1292 #### Output template and Windows batch files
1294 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"`.
1295 <!-- MANPAGE: END EXCLUDED SECTION -->
1297 #### Output template examples
1300 $ yt-dlp --get-filename -o "test video.%(ext)s" BaW_jenozKc
1301 test video.webm # Literal name with correct extension
1303 $ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
1304 youtube-dl test video ''_ä↭𝕐.webm # All kinds of weird characters
1306 $ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
1307 youtube-dl_test_video_.webm # Restricted file name
1309 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1310 $ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1312 # Download YouTube playlist videos in separate directories according to their uploaded year
1313 $ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1315 # Prefix playlist index with " - " separator, but only if it is available
1316 $ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1318 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1319 $ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"
1321 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1322 $ 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"
1324 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1325 $ 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"
1327 # Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
1328 # and put all temporary files in "C:\MyVideos\tmp"
1329 $ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs
1331 # Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
1332 $ 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
1334 # Stream the video being downloaded to stdout
1335 $ yt-dlp -o - BaW_jenozKc
1340 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1341 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`.
1343 **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.
1345 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.
1347 <!-- MANPAGE: BEGIN EXCLUDED SECTION -->
1348 **tl;dr:** [navigate me to examples](#format-selection-examples).
1349 <!-- MANPAGE: END EXCLUDED SECTION -->
1351 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.
1353 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.
1355 You can use
`-f -` to interactively provide the format selector *for each video*
1357 You can also use special names to select particular edge case formats:
1359 - `all`: Select **all formats** separately
1360 - `mergeall`: Select and **merge all formats** (Must be used with
`--audio-multistreams`,
`--video-multistreams` or both)
1361 - `b*`,
`best*`: Select the best quality format that **contains either** a video or an audio
1362 - `b`,
`best`: Select the best quality format that **contains both** video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
1363 - `bv`,
`bestvideo`: Select the best quality **video-only** format. Equivalent to
`best*[acodec=none]`
1364 - `bv*`,
`bestvideo*`: Select the best quality format that **contains video**. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
1365 - `ba`,
`bestaudio`: Select the best quality **audio-only** format. Equivalent to
`best*[vcodec=none]`
1366 - `ba*`,
`bestaudio*`: Select the best quality format that **contains audio**. It may also contain video. Equivalent to
`best*[acodec!=none]` ([Do not use!](https://github.com/yt-dlp/yt-dlp/issues/979#issuecomment-919629354))
1367 - `w*
`, `worst*
`: Select the worst quality format that contains either a video or an audio
1368 - `w
`, `worst
`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]
`
1369 - `wv
`, `worstvideo
`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]
`
1370 - `wv*
`, `worstvideo*
`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]
`
1371 - `wa
`, `worstaudio
`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]
`
1372 - `wa*
`, `worstaudio*
`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]
`
1374 For example, to download the worst quality video-only format you can use `-f worstvideo
`. It is however recommended not to use `worst
` and related options. When your format selector is `worst
`, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-S +size
` or more rigorously, `-S +size,+br,+res,+fps
` instead of `-f worst
`. See [sorting formats](#sorting-formats) for more details.
1376 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.
1378 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.
1380 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
`.
1382 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.
1384 **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
1386 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
`.
1388 ## Filtering Formats
1390 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=
720]"
` (or `-f "[filesize>
10M]"
`).
1392 The following numeric meta fields can be used with comparisons `<
`, `<=
`, `>
`, `>=
`, `=
` (equals), `!=
` (not equals):
1394 - `filesize
`: The number of bytes, if known in advance
1395 - `width
`: Width of the video, if known
1396 - `height
`: Height of the video, if known
1397 - `tbr
`: Average bitrate of audio and video in KBit/s
1398 - `abr
`: Average audio bitrate in KBit/s
1399 - `vbr
`: Average video bitrate in KBit/s
1400 - `asr
`: Audio sampling rate in Hertz
1403 Also filtering work for comparisons `=
` (equals), `^=
` (starts with), `$=
` (ends with), `*=
` (contains), `~=
` (matches regex) and following string meta fields:
1405 - `ext
`: File extension
1406 - `acodec
`: Name of the audio codec in use
1407 - `vcodec
`: Name of the video codec in use
1408 - `container
`: Name of the container format
1409 - `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
`)
1410 - `format_id
`: A short description of the format
1411 - `language
`: Language code
1413 Any string comparison may be prefixed with negation `!
` in order to produce an opposite comparison, e.g. `!*=
` (does not contain). The comparand of a string comparison needs to be quoted with either double or single quotes if it contains spaces or special characters other than `._-
`.
1415 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.
1417 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.
1419 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]"
`.
1423 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...
`.
1425 The available fields are:
1427 - `hasvid
`: Gives priority to formats that has a video stream
1428 - `hasaud
`: Gives priority to formats that has a audio stream
1429 - `ie_pref
`: The format preference
1430 - `lang
`: The language preference
1431 - `quality
`: The quality of the format
1432 - `source
`: The preference of the source
1433 - `proto
`: Protocol used for download (`https
`/`ftps
` > `http
`/`ftp
` > `m3u8_native
`/`m3u8
` > `http_dash_segments
`> `websocket_frag
` > `mms
`/`rtsp
` > `f4f
`/`f4m
`)
1434 - `vcodec
`: Video Codec (`av01
` > `vp9.2
` > `vp9
` > `h265
` > `h264
` > `vp8
` > `h263
` > `theora
` > other)
1435 - `acodec
`: Audio Codec (`flac
`/`alac
` > `wav
`/`aiff
` > `opus
` > `vorbis
` > `aac
` > `mp4a
` > `mp3
` > `eac3
` > `ac3
` > `dts
` > other)
1436 - `codec
`: Equivalent to `vcodec,acodec
`
1437 - `vext
`: Video Extension (`mp4
` > `webm
` > `flv
` > other). If `--prefer-free-formats
` is used, `webm
` is preferred.
1438 - `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
`.
1439 - `ext
`: Equivalent to `vext,aext
`
1440 - `filesize
`: Exact filesize, if known in advance
1441 - `fs_approx
`: Approximate filesize calculated from the manifests
1442 - `size
`: Exact filesize if available, otherwise approximate filesize
1443 - `height
`: Height of video
1444 - `width
`: Width of video
1445 - `res
`: Video resolution, calculated as the smallest dimension.
1446 - `fps
`: Framerate of video
1447 - `hdr
`: The dynamic range of the video (`DV
` > `HDR12
` > `HDR10+
` > `HDR10
` > `HLG
` > `SDR
`)
1448 - `tbr
`: Total average bitrate in KBit/s
1449 - `vbr
`: Average video bitrate in KBit/s
1450 - `abr
`: Average audio bitrate in KBit/s
1451 - `br
`: Equivalent to using `tbr,vbr,abr
`
1452 - `asr
`: Audio sample rate in Hz
1454 **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.
1456 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.
1458 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.
1460 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.
1462 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
`.
1464 **Tip**: You can use the `-v -F
` to see how the formats have been sorted (worst to best).
1466 ## Format Selection examples
1469 # Download and merge the best video-only format and the best audio-only format,
1470 # or download the best combined format if video-only format is not available
1471 $ yt-dlp -f "bv+ba/b"
1473 # Download best format that contains video,
1474 # and if it doesn't already have an audio stream, merge it with best audio-only format
1475 $ yt-dlp -f "bv*+ba/b"
1480 # Download the best video-only format and the best audio-only format without merging them
1481 # For this case, an output template should be used since
1482 # by default, bestvideo and bestaudio will have the same file name.
1483 $ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"
1485 # Download and merge the best format that has a video stream,
1486 # and all audio-only formats into one file
1487 $ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams
1489 # Download and merge the best format that has a video stream,
1490 # and the best 2 audio-only formats into one file
1491 $ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams
1494 # The following examples show the old method (without -S) of format selection
1495 # and how to use -S to achieve a similar but (generally) better result
1497 # Download the worst video available (old method)
1498 $ yt-dlp -f "wv*+wa/w"
1500 # Download the best video available but with the smallest resolution
1503 # Download the smallest video available
1504 $ yt-dlp -S "+size,+br"
1508 # Download the best mp4 video available, or the best video if no mp4 available
1509 $ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"
1511 # Download the best video with the best extension
1512 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1517 # Download the best video available but no better than 480p,
1518 # or the worst video if there is no video under 480p
1519 $ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"
1521 # Download the best video available with the largest height but no better than 480p,
1522 # or the best video with the smallest resolution if there is no video under 480p
1523 $ yt-dlp -S "height:480"
1525 # Download the best video available with the largest resolution but no better than 480p,
1526 # or the best video with the smallest resolution if there is no video under 480p
1527 # Resolution is determined by using the smallest dimension.
1528 # So this works correctly for vertical videos as well
1529 $ yt-dlp -S "res:480"
1533 # Download the best video (that also has audio) but no bigger than 50 MB,
1534 # or the worst video (that also has audio) if there is no video under 50 MB
1535 $ yt-dlp -f "b[filesize<50M] / w"
1537 # Download largest video (that also has audio) but no bigger than 50 MB,
1538 # or the smallest video (that also has audio) if there is no video under 50 MB
1539 $ yt-dlp -f "b" -S "filesize:50M"
1541 # Download best video (that also has audio) that is closest in size to 50 MB
1542 $ yt-dlp -f "b" -S "filesize~50M"
1546 # Download best video available via direct link over HTTP/HTTPS protocol,
1547 # or the best video available via any protocol if there is no such video
1548 $ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"
1550 # Download best video available via the best protocol
1551 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1556 # Download the best video with either h264 or h265 codec,
1557 # or the best video if there is no such video
1558 $ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"
1560 # Download the best video with best codec no better than h264,
1561 # or the best video with worst codec if there is no such video
1562 $ yt-dlp -S "codec:h264"
1564 # Download the best video with worst codec no worse than h264,
1565 # or the best video with best codec if there is no such video
1566 $ yt-dlp -S "+codec:h264"
1570 # More complex examples
1572 # Download the best video no better than 720p preferring framerate greater than 30,
1573 # or the worst video (still preferring framerate greater than 30) if there is no such video
1574 $ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"
1576 # Download the video with the largest resolution no better than 720p,
1577 # or the video with the smallest resolution available if there is no such video,
1578 # preferring larger framerate for formats with the same resolution
1579 $ yt-dlp -S "res:720,fps"
1583 # Download the video with smallest resolution no worse than 480p,
1584 # or the video with the largest resolution available if there is no such video,
1585 # preferring better codec and then larger total bitrate for the same resolution
1586 $ yt-dlp -S "+res:480,codec,br"
1589 # MODIFYING METADATA
1591 The metadata obtained by the extractors can be modified by using `--parse-metadata
` and `--replace-in-metadata
`
1593 `--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.
1595 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.
1597 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
`.
1599 This option also has a few special uses:
1600 * 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
1601 * 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.
1603 **Note**: Metadata modification happens before format selection, post-extraction and other post-processing operations. Some fields may be added or changed during these steps, overriding your changes.
1605 For reference, these are the fields yt-dlp adds by default to the file metadata:
1607 Metadata fields | From
1608 :--------------------------|:------------------------------------------------
1609 `title
` | `track
` or `title
`
1610 `date
` | `upload_date
`
1611 `description
`, `synopsis
` | `description
`
1612 `purl
`, `comment
` | `webpage_url
`
1613 `track
` | `track_number
`
1614 `artist
` | `artist
`, `creator
`, `uploader
` or `uploader_id
`
1617 `album_artist
` | `album_artist
`
1618 `disc
` | `disc_number
`
1620 `season_number
` | `season_number
`
1621 `episode_id
` | `episode
` or `episode_id
`
1622 `episode_sort
` | `episode_number
`
1623 `language
` of each stream | the format's `language
`
1625 **Note**: The file format may not support some of these fields
1628 ## Modifying metadata examples
1631 # Interpret the title as "Artist - Title"
1632 $ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"
1635 $ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"
1637 # Set title as "Series name S01E05"
1638 $ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"
1640 # Set "comment" field in video metadata using description instead of webpage_url
1641 $ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --add-metadata
1643 # Remove "formats" field from the infojson by setting it to an empty string
1644 $ yt-dlp --parse-metadata ":(?P<formats>)" -j
1646 # Replace all spaces and "_" in title and uploader with a `-`
1647 $ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"
1651 # EXTRACTOR ARGUMENTS
1653 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"
`
1655 The following extractors use this feature:
1658 * `skip
`: `hls
` or `dash
` (or both) to skip download of the respective manifests
1659 * `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.
1660 * `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
1661 * `include_live_dash
`: Include live dash formats even without `--live-from-start
` (These formats don't download properly)
1662 * `comment_sort
`: `top
` or `new
` (default) - choose comment sorting mode (on YouTube's side)
1663 * `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
`.
1664 * 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.
1665 * `max_comment_depth
` Maximum depth for nested comments. YouTube supports depths 1 or 2 (default)
1666 * **Deprecated**: Set `max-replies
` to `0` or `all
` in `max_comments
` instead (e.g. `max_comments=all,all,
0` to get no replies)
1668 #### youtubetab (YouTube playlists, channels, feeds, etc.)
1669 * `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)
1670 * `approximate_date
`: Extract approximate `upload_date
` in flat-playlist. This may cause date-based filters to be slightly off
1673 * `language
`: Languages to extract. Eg: `funimation:language=english,japanese
`
1674 * `version
`: The video version to extract - `uncut
` or `simulcast
`
1677 * `language
`: Languages to extract. Eg: `crunchyroll:language=jaJp
`
1678 * `hardsub
`: Which hard-sub versions to extract. Eg: `crunchyroll:hardsub=None,enUS
`
1680 #### crunchyrollbeta
1681 * `format
`: Which stream type(s) to extract. Default is `adaptive_hls
` Eg: `crunchyrollbeta:format=vo_adaptive_hls
`
1682 * Potentially useful values include `adaptive_hls
`, `adaptive_dash
`, `vo_adaptive_hls
`, `vo_adaptive_dash
`, `download_hls
`, `trailer_hls
`, `trailer_dash
`
1683 * `hardsub
`: Preference order for which hardsub versions to extract. Default is `None
` (no hardsubs). Eg: `crunchyrollbeta:hardsub=en-US,None
`
1686 * `video_types
`: Types of videos to download - one or more of `episodes
`, `movies
`, `clips
`, `trailers
`
1689 * `segment_duration
`: Segment duration in milliseconds for HLS-DMC formats. Use it at your own risk since this feature **may result in your account termination.**
1691 #### youtubewebarchive
1692 * `check_all
`: Try to check more at the cost of more requests. One or more of `thumbnails
`, `captures
`
1695 * `comment_sort
`: `hot
` (default), `you
` (cookies needed), `top
`, `new
` - choose comment sorting mode (on GameJolt's side)
1698 * `res
`: resolution to ignore - one or more of `sd
`, `hd
`, `fhd
`
1699 * `vcodec
`: vcodec to ignore - one or more of `h264
`, `h265
`, `dvh265
`
1700 * `dr
`: dynamic range to ignore - one or more of `sdr
`, `hdr10
`, `dv
`
1703 * `app_version
`: App version to call mobile APIs with - should be set along with `manifest_app_version
`. (e.g. `20.2.1`)
1704 * `manifest_app_version
`: Numeric app version to call mobile APIs with. (e.g. `221`)
1707 * `tab
`: Which tab to download. One of `new
`, `top
`, `videos
`, `podcasts
`, `streams
`, `stacks
`. (E.g. `rokfinchannel:tab=streams
`)
1710 NOTE: These options may be changed/removed in the future without concern for backward compatibility
1712 <!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
1717 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
1719 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
`.
1721 See [ytdlp_plugins](ytdlp_plugins) for example plugins.
1723 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
1725 If you are a plugin author, add [ytdlp-plugins](https://github.com/topics/ytdlp-plugins) as a topic to your repository for discoverability
1731 yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1733 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.
1735 From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1738 from yt_dlp import YoutubeDL
1740 ydl_opts = {'format': 'bestaudio'}
1741 with YoutubeDL(ydl_opts) as ydl:
1742 ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
1745 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#L191).
1747 Here's a more complete example demonstrating various functionality:
1755 def debug(self, msg):
1756 # For compatibility with youtube-dl, both debug and info are passed into debug
1757 # You can distinguish them by the prefix '[debug] '
1758 if msg.startswith('[debug] '):
1763 def info(self, msg):
1766 def warning(self, msg):
1769 def error(self, msg):
1773 # ℹ️ See the docstring of yt_dlp.postprocessor.common.PostProcessor
1774 class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
1775 # ℹ️ See docstring of yt_dlp.postprocessor.common.PostProcessor.run
1776 def run(self, info):
1777 self.to_screen('Doing stuff')
1781 # ℹ️ See "progress_hooks" in the docstring of yt_dlp.YoutubeDL
1783 if d['status'] == 'finished':
1784 print('Done downloading, now converting ...')
1787 def format_selector(ctx):
1788 """ Select the best video and the best audio that won't result in an mkv.
1789 This is just an example and does not handle all cases """
1791 # formats are already sorted worst to best
1792 formats = ctx.get('formats')[::-1]
1794 # acodec='none' means there is no audio
1795 best_video = next(f for f in formats
1796 if f['vcodec'] != 'none' and f['acodec'] == 'none')
1798 # find compatible audio extension
1799 audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
1800 # vcodec='none' means there is no video
1801 best_audio = next(f for f in formats if (
1802 f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))
1805 # These are the minimum required fields for a merged format
1806 'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
1807 'ext': best_video['ext'],
1808 'requested_formats': [best_video, best_audio],
1809 # Must be + separated list of protocols
1810 'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
1814 # ℹ️ See docstring of yt_dlp.YoutubeDL for a description of the options
1816 'format': format_selector,
1817 'postprocessors': [{
1818 # Embed metadata in video using ffmpeg.
1819 # ℹ️ See yt_dlp.postprocessor.FFmpegMetadataPP for the arguments it accepts
1820 'key': 'FFmpegMetadata',
1821 'add_chapters': True,
1822 'add_metadata': True,
1824 'logger': MyLogger(),
1825 'progress_hooks': [my_hook],
1826 # Add custom headers
1827 'http_headers': {'Referer': 'https://www.google.com'}
1831 # ℹ️ See the public functions in yt_dlp.YoutubeDL for for other available functions.
1832 # Eg: "ydl.download", "ydl.download_with_info_file"
1833 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1834 ydl.add_post_processor(MyCustomPP())
1835 info = ydl.extract_info('https://www.youtube.com/watch?v=BaW_jenozKc')
1837 # ℹ️ ydl.sanitize_info makes the info json-serializable
1838 print(json.dumps(ydl.sanitize_info(info)))
1841 **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
1844 <!-- MANPAGE: MOVE "NEW FEATURES" SECTION HERE -->
1846 # DEPRECATED OPTIONS
1848 These are all the deprecated options and the current alternative to achieve the same effect
1850 #### Almost redundant options
1851 While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant
1853 -j, --dump-json --print "%()j"
1854 -F, --list-formats --print formats_table
1855 --list-thumbnails --print thumbnails_table --print playlist:thumbnails_table
1856 --list-subs --print automatic_captions_table --print subtitles_table
1858 #### Redundant options
1859 While these options are redundant, they are still expected to be used due to their ease of use
1861 --get-description --print description
1862 --get-duration --print duration_string
1863 --get-filename --print filename
1864 --get-format --print format
1866 --get-thumbnail --print thumbnail
1867 -e, --get-title --print title
1868 -g, --get-url --print urls
1869 --match-title REGEX --match-filter "title ~= (?i)REGEX"
1870 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
1871 --min-views COUNT --match-filter "view_count >=? COUNT"
1872 --max-views COUNT --match-filter "view_count <=? COUNT"
1873 --user-agent UA --add-header "User-Agent:UA"
1874 --referer URL --add-header "Referer:URL"
1877 #### Not recommended
1878 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1880 --exec-before-download CMD --exec "before_dl:CMD"
1881 --no-exec-before-download --no-exec
1882 --all-formats -f all
1883 --all-subs --sub-langs all --write-subs
1884 --print-json -j --no-simulate
1885 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)03d
1886 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1887 --id -o "%(id)s.%(ext)s"
1888 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1889 --hls-prefer-native --downloader "m3u8:native"
1890 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1891 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1892 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1893 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
1894 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
1895 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
1896 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
1899 #### Developer options
1900 These options are not intended to be used by the end-user
1902 --test Download only part of video for testing extractors
1903 --youtube-print-sig-code For testing youtube signatures
1904 --allow-unplayable-formats List unplayable formats also
1905 --no-allow-unplayable-formats Default
1909 These are aliases that are no longer documented for various reasons
1911 --avconv-location --ffmpeg-location
1912 --clean-infojson --clean-info-json
1913 --cn-verification-proxy URL --geo-verification-proxy URL
1914 --dump-headers --print-traffic
1915 --dump-intermediate-pages --dump-pages
1916 --force-write-download-archive --force-write-archive
1917 --load-info --load-info-json
1918 --no-clean-infojson --no-clean-info-json
1919 --no-split-tracks --no-split-chapters
1920 --no-write-srt --no-write-subs
1921 --prefer-unsecure --prefer-insecure
1922 --rate-limit RATE --limit-rate RATE
1923 --split-tracks --split-chapters
1924 --srt-lang LANGS --sub-langs LANGS
1925 --trim-file-names LENGTH --trim-filenames LENGTH
1926 --write-srt --write-subs
1927 --yes-overwrites --force-overwrites
1929 #### Sponskrub Options
1930 Support for [SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of the `--sponsorblock
` options
1932 --sponskrub --sponsorblock-mark all
1933 --no-sponskrub --no-sponsorblock
1934 --sponskrub-cut --sponsorblock-remove all
1935 --no-sponskrub-cut --sponsorblock-remove -all
1936 --sponskrub-force Not applicable
1937 --no-sponskrub-force Not applicable
1938 --sponskrub-location Not applicable
1939 --sponskrub-args Not applicable
1941 #### No longer supported
1942 These options may no longer work as intended
1944 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
1945 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
1946 -C, --call-home Not implemented
1947 --no-call-home Default
1948 --include-ads No longer supported
1949 --no-include-ads Default
1950 --write-annotations No supported site has annotations now
1951 --no-write-annotations Default
1954 These options were deprecated since 2014 and have now been entirely removed
1956 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
1957 -t, --title -o "%(title)s-%(id)s.%(ext)s"
1958 -l, --literal -o accepts literal names
1961 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)
1964 For FAQ see the [youtube-dl README](https://github.com/ytdl-org/youtube-dl#faq)
projects / yt-dlp.git / blob