4 A command-line program to download videos from YouTube and many other [video platforms](supportedsites.md)
6 <!-- GHA doesn't have for-the-badge style
7 []
(https://github.com/yt-dlp/yt-dlp/actions)
9 []
(https://github.com/yt-dlp/yt-dlp/releases/latest)
10 [](LICENSE)
11 []
(https://yt-dlp.readthedocs.io)
12 []
(https://discord.gg/H5MNcFW63r)
13 []
(https://github.com/yt-dlp/yt-dlp/commits)
14 []
(https://github.com/yt-dlp/yt-dlp/commits)
15 []
(https://github.com/yt-dlp/yt-dlp/releases/latest)
16 []
(https://pypi.org/project/yt-dlp)
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 * [NEW FEATURES](#new-features)
23 * [Differences in default behavior](#differences-in-default-behavior)
24 * [INSTALLATION](#installation)
26 * [Dependencies](#dependencies)
28 * [USAGE AND OPTIONS](#usage-and-options)
29 * [General Options](#general-options)
30 * [Network Options](#network-options)
31 * [Geo-restriction](#geo-restriction)
32 * [Video Selection](#video-selection)
33 * [Download Options](#download-options)
34 * [Filesystem Options](#filesystem-options)
35 * [Thumbnail Options](#thumbnail-options)
36 * [Internet Shortcut Options](#internet-shortcut-options)
37 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
38 * [Workarounds](#workarounds)
39 * [Video Format Options](#video-format-options)
40 * [Subtitle Options](#subtitle-options)
41 * [Authentication Options](#authentication-options)
42 * [Post-processing Options](#post-processing-options)
43 * [SponSkrub (SponsorBlock) Options](#sponskrub-sponsorblock-options)
44 * [Extractor Options](#extractor-options)
45 * [CONFIGURATION](#configuration)
46 * [Authentication with .netrc file](#authentication-with-netrc-file)
47 * [OUTPUT TEMPLATE](#output-template)
48 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
49 * [Output template examples](#output-template-examples)
50 * [FORMAT SELECTION](#format-selection)
51 * [Filtering Formats](#filtering-formats)
52 * [Sorting Formats](#sorting-formats)
53 * [Format Selection examples](#format-selection-examples)
54 * [MODIFYING METADATA](#modifying-metadata)
55 * [Modifying metadata examples](#modifying-metadata-examples)
57 * [DEPRECATED OPTIONS](#deprecated-options)
63 The major new features from the latest release of
[blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are:
65 * **
[SponSkrub Integration](#sponskrub-sponsorblock-options)**: You can use [SponSkrub](https://github.com/yt-dlp/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the
[SponsorBlock](https://sponsor.ajay.app) API
67 * **[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 that what is possible by simply using
`--format` ([examples](#format-selection-examples))
69 * **Merged with youtube-dl
[commit/c2350ca](https://github.com/ytdl-org/youtube-dl/commit/c2350cac243ba1ec1586fe85b0d62d1b700047a2)**: (v2021.06
.06) You get all the latest features and patches of
[youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of
[youtube-dlc](https://github.com/blackjack4494/yt-dlc)
71 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from
[animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including
`--write-comments`,
`BiliBiliSearch`,
`BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, playlist infojson etc. Note that the NicoNico improvements are not available. See
[#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details.
73 * **Youtube improvements**:
74 * All Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`) supports downloading multiple pages of content
75 * Search (
`ytsearch:`,
`ytsearchdate:`), search URLs and in-channel search works
76 * Mixes supports downloading multiple pages of content
77 * Redirect channel's home URL automatically to
`/video` to preserve the old behaviour
78 * `255kbps` audio is extracted from youtube music if premium cookies are given
79 * Youtube music Albums, channels etc can be downloaded
81 * **Split video by chapters**: Videos can be split into multiple files based on chapters using
`--split-chapters`
83 * **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
85 * **Aria2c with HLS/DASH**: You can use
`aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
87 * **New extractors**: AnimeLab, Philo MSO, Rcs, Gedi, bitwave.tv, mildom, audius, zee5, mtv.it, wimtv, pluto.tv, niconico users, discoveryplus.in, mediathek, NFHSNetwork, nebula, ukcolumn, whowatch, MxplayerShow, parlview (au), YoutubeWebArchive, fancode, Saitosan, ShemarooMe, telemundo, VootSeries, SonyLIVSeries, HotstarSeries, VidioPremier, VidioLive
89 * **Fixed extractors**: archive.org, roosterteeth.com, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, akamai, ina, rumble, tennistv, amcnetworks, la7 podcasts, linuxacadamy, nitter, twitcasting, viu, crackle, curiositystream, mediasite, rmcdecouverte, sonyliv, tubi, tenplay, patreon
91 * **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
93 * **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`)
95 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
97 * **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`
99 * **Other new options**:
`--sleep-requests`,
`--convert-thumbnails`,
`--write-link`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
101 * **Improvements**: Multiple
`--postprocessor-args` and
`--downloader-args`, faster archive checking, more [format selection options](#format-selection) etc
103 * **Plugin extractors**: Extractors can be loaded from an external file. See [plugins](#plugins) for details
105 * **Self-updater**: The releases can be updated using
`yt-dlp -U`
108 See
[changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
111 **PS**: Some of these changes are already in youtube-dlc, but are still unreleased. See [this](Changelog.md#unreleased-changes-in-blackjack4494yt-dlc) for details
113 If you are coming from
[youtube-dl](https://github.com/ytdl-org/youtube-dl), the amount of changes are very large. Compare
[options](#options) and [supported sites](supportedsites.md) with youtube-dl's to get an idea of the massive number of features/patches [youtube-dlc](https://github.com/blackjack4494/yt-dlc) has accumulated.
115 ### Differences in default behavior
117 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc.
119 * The options
`--id`,
`--auto-number` (
`-A`),
`--title` (
`-t`) and
`--literal` (
`-l`), no longer work. See [removed options](#Removed) for details
120 * `avconv` is not supported as as an alternative to
`ffmpeg`
121 * 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`
122 * 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
123 * The default format selector is
`bv*+ba/b`. This means that if a combined video + audio format that is better than the best video-only format is found, the former will be prefered. Use
`-f bv+ba/b` or
`--compat-options format-spec` to revert this
124 * 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
125 * `--ignore-errors` is enabled by default. Use
`--abort-on-error` or
`--compat-options abort-on-error` to abort on errors instead
126 * 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
127 * `--add-metadata` attaches the
`infojson` to
`mkv` files in addition to writing the metadata when used with
`--write-infojson`. Use
`--compat-options no-attach-info-json` to revert this
128 * `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
129 * The output of
`-F` is listed in a new format. Use
`--compat-options list-formats` to revert this
130 * 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
131 * Youtube channel URLs are automatically redirected to
`/video`. Append a
`/featured` to the URL to download only the videos in the home page. If the channel does not have a videos tab, we try to download the equivalent
`UU` playlist instead. Also,
`/live` URLs raise an error if there are no live videos instead of silently downloading the entire channel. You may use
`--compat-options no-youtube-channel-redirect` to revert all these redirections
132 * Unavailable videos are also listed for youtube playlists. Use
`--compat-options no-youtube-unavailable-videos` to remove this
133 * 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
134 * Thumbnail embedding in
`mp4` is done with mutagen if possible. Use
`--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
136 For ease of use, a few more compat options are available:
137 * `--compat-options all`: Use all compat options
138 * `--compat-options youtube-dl`: Same as
`--compat-options all,-multistreams`
139 * `--compat-options youtube-dlc`: Same as
`--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
143 yt-dlp is not platform specific. So it should work on your Unix box, on Windows or on macOS
145 You can install yt-dlp using one of the following methods:
146 * Download the binary from the
[latest release](https://github.com/yt-dlp/yt-dlp/releases/latest) (recommended method)
147 * Use
[PyPI package](https://pypi.org/project/yt-dlp):
`python3 -m pip install --upgrade yt-dlp`
148 * Use pip+git:
`python3 -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp.git@release`
149 * Install master branch:
`python3 -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp`
151 Note that on some systems, you may need to use
`py` or
`python` instead of
`python3`
153 UNIX users (Linux, macOS, BSD) can also install the
[latest release](https://github.com/yt-dlp/yt-dlp/releases/latest) one of the following ways:
156 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
157 sudo chmod a+rx /usr/local/bin/yt-dlp
161 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
162 sudo chmod a+rx /usr/local/bin/yt-dlp
166 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
167 sudo chmod a+rx /usr/local/bin/yt-dlp
171 You can use
`yt-dlp -U` to update if you are using the provided release.
172 If you are using
`pip`, simply re-run the same command that was used to install the program.
175 Python versions
3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
177 <!-- https://www.microsoft.com/en-us/download/details.aspx?id=
26999 -->
178 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.
180 While all the other dependancies are optional,
`ffmpeg` and
`ffprobe` are highly recommended
181 * [**ffmpeg** and **ffprobe**](https://www.ffmpeg.org) - Required for
[merging seperate video and audio files](#format-selection) as well as for various [post-processing](#post-processing-options) tasks. Licence [depends on the build](https://www.ffmpeg.org/legal.html)
182 * [**sponskrub**](https://github.com/faissaloo/SponSkrub) - For using the
[sponskrub options](#sponskrub-sponsorblock-options). Licenced under [GPLv3+](https://github.com/faissaloo/SponSkrub/blob/master/LICENCE.md)
183 * [**mutagen**](https://github.com/quodlibet/mutagen) - For embedding thumbnail in certain formats. Licenced under
[GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
184 * [**pycryptodome**](https://github.com/Legrandin/pycryptodome) - For decrypting various data. Licenced under
[BSD2](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
185 * [**websockets**](https://github.com/aaugustin/websockets) - For downloading over websocket. Licenced under
[BSD3](https://github.com/aaugustin/websockets/blob/main/LICENSE)
186 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For embedding thumbnail in mp4/m4a if mutagen is not present. Licenced under
[GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
187 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading
`rtmp` streams. ffmpeg will be used as a fallback. Licenced under
[GPLv2+](http://rtmpdump.mplayerhq.hu)
188 * [**mplayer**](http://mplayerhq.hu/design7/info.html) or
[**mpv**](https://mpv.io) - For downloading
`rstp` streams. ffmpeg will be used as a fallback. Licenced under
[GPLv2+](https://github.com/mpv-player/mpv/blob/master/Copyright)
189 * [**phantomjs**](https://github.com/ariya/phantomjs) - Used in extractors where javascript needs to be run. Licenced under
[BSD3](https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD)
190 * Any external downloader that you want to use with
`--downloader`
192 To use or redistribute the dependencies, you must agree to their respective licensing terms.
194 Note that the windows releases are already built with the python interpreter, mutagen, pycryptodome and websockets included.
199 To build the Windows executable, you must have pyinstaller (and optionally mutagen, pycryptodome, websockets)
201 python3 -m pip install --upgrade pyinstaller mutagen pycryptodome websockets
203 Once you have all the necessary dependencies installed, just run
`py pyinst.py`. The executable will be built for the same architecture (
32/
64 bit) as the python used to build it.
205 You can also build the executable without any version info or metadata by using:
207 pyinstaller.exe yt_dlp\__main__.py --onefile --name yt-dlp
209 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
212 You will need the required build tools:
`python`,
`make` (GNU),
`pandoc`,
`zip`,
`nosetests`
213 Then simply run
`make`. You can also run
`make yt-dlp` instead to compile only the binary without updating any of the additional files
215 **Note**: In either platform,
`devscripts\update-version.py` can be used to automatically update the version number
219 yt-dlp [OPTIONS] [--] URL [URL...]
221 `Ctrl+F` is your friend :D
222 <!-- Auto generated -->
225 -h, --help Print this help text and exit
226 --version Print program version and exit
227 -U, --update Update this program to latest version. Make
228 sure that you have sufficient permissions
229 (run with sudo if needed)
230 -i, --ignore-errors Continue on download errors, for example to
231 skip unavailable videos in a playlist
232 (default) (Alias: --no-abort-on-error)
233 --abort-on-error Abort downloading of further videos if an
234 error occurs (Alias: --no-ignore-errors)
235 --dump-user-agent Display the current browser identification
236 --list-extractors List all supported extractors
237 --extractor-descriptions Output descriptions of all supported
239 --force-generic-extractor Force extraction to use the generic
241 --default-search PREFIX Use this prefix for unqualified URLs. For
242 example "gvsearch2:" downloads two videos
243 from google videos for youtube-dl "large
244 apple". Use the value "auto" to let
245 youtube-dl guess ("auto_warning" to emit a
246 warning when guessing). "error" just throws
247 an error. The default value "fixup_error"
248 repairs broken URLs, but emits an error if
249 this is not possible instead of searching
250 --ignore-config, --no-config Disable loading any configuration files
251 except the one provided by --config-location.
252 When given inside a configuration
253 file, no further configuration files are
254 loaded. Additionally, (for backward
255 compatibility) if this option is found
256 inside the system configuration file, the
257 user configuration is not loaded
258 --config-location PATH Location of the main configuration file;
259 either the path to the config or its
261 --flat-playlist Do not extract the videos of a playlist,
263 --no-flat-playlist Extract the videos of a playlist
264 --mark-watched Mark videos watched (YouTube only)
265 --no-mark-watched Do not mark videos watched (default)
266 --no-colors Do not emit color codes in output
267 --compat-options OPTS Options that can help keep compatibility
268 with youtube-dl and youtube-dlc
269 configurations by reverting some of the
270 changes made in yt-dlp. See "Differences in
271 default behavior" for details
274 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
275 To enable SOCKS proxy, specify a proper
277 socks5://
127.0.0.1:
1080/. Pass in an empty
278 string (--proxy "") for direct connection
279 --socket-timeout SECONDS Time to wait before giving up, in seconds
280 --source-address IP Client-side IP address to bind to
281 -4, --force-ipv4 Make all connections via IPv4
282 -6, --force-ipv6 Make all connections via IPv6
285 --geo-verification-proxy URL Use this proxy to verify the IP address for
286 some geo-restricted sites. The default
287 proxy specified by --proxy (or none, if the
288 option is not present) is used for the
290 --geo-bypass Bypass geographic restriction via faking
291 X-Forwarded-For HTTP header
292 --no-geo-bypass Do not bypass geographic restriction via
293 faking X-Forwarded-For HTTP header
294 --geo-bypass-country CODE Force bypass geographic restriction with
295 explicitly provided two-letter ISO
3166-
2
297 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
298 explicitly provided IP block in CIDR
302 --playlist-start NUMBER Playlist video to start at (default is
1)
303 --playlist-end NUMBER Playlist video to end at (default is last)
304 --playlist-items ITEM_SPEC Playlist video items to download. Specify
305 indices of the videos in the playlist
306 separated by commas like: "--playlist-items
307 1,
2,
5,
8" if you want to download videos
308 indexed
1,
2,
5,
8 in the playlist. You can
309 specify range: "--playlist-items
310 1-
3,
7,
10-
13", it will download the videos
311 at index
1,
2,
3,
7,
10,
11,
12 and
13
312 --match-title REGEX Download only matching titles (regex or
314 --reject-title REGEX Skip download for matching titles (regex or
316 --max-downloads NUMBER Abort after downloading NUMBER files
317 --min-filesize SIZE Do not download any videos smaller than
318 SIZE (e.g.
50k or
44.6m)
319 --max-filesize SIZE Do not download any videos larger than SIZE
321 --date DATE Download only videos uploaded in this date.
322 The date can be "YYYYMMDD" or in the format
323 "(now|today)[+-][
0-
9](day|week|month|year)(s)?"
324 --datebefore DATE Download only videos uploaded on or before
325 this date. The date formats accepted is the
327 --dateafter DATE Download only videos uploaded on or after
328 this date. The date formats accepted is the
330 --min-views COUNT Do not download any videos with less than
332 --max-views COUNT Do not download any videos with more than
334 --match-filter FILTER Generic video filter. Specify any key (see
335 "OUTPUT TEMPLATE" for a list of available
336 keys) to match if the key is present, !key
337 to check if the key is not present,
338 key>NUMBER (like "view_count >
12", also
339 works with >=, <, <=, !=, =) to compare
340 against a number, key = 'LITERAL' (like
341 "uploader = 'Mike Smith'", also works with
342 !=) to match against a string literal and &
343 to require multiple matches. Values which
344 are not known are excluded unless you put a
345 question mark (?) after the operator. For
346 example, to only match videos that have
347 been liked more than
100 times and disliked
348 less than
50 times (or the dislike
349 functionality is not available at the given
350 service), but who also have a description,
351 use --match-filter "like_count >
100 &
352 dislike_count <?
50 & description"
353 --no-match-filter Do not use generic video filter (default)
354 --no-playlist Download only the video, if the URL refers
355 to a video and a playlist
356 --yes-playlist Download the playlist, if the URL refers to
357 a video and a playlist
358 --age-limit YEARS Download only videos suitable for the given
360 --download-archive FILE Download only videos not listed in the
361 archive file. Record the IDs of all
362 downloaded videos in it
363 --break-on-existing Stop the download process when encountering
364 a file that is in the archive
365 --break-on-reject Stop the download process when encountering
366 a file that has been filtered out
367 --skip-playlist-after-errors N Number of allowed failures until the rest
368 of the playlist is skipped
369 --no-download-archive Do not use archive file (default)
372 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
373 video that should be download concurrently
375 -r, --limit-rate RATE Maximum download rate in bytes per second
377 -R, --retries RETRIES Number of retries (default is
10), or
379 --fragment-retries RETRIES Number of retries for a fragment (default
380 is
10), or "infinite" (DASH, hlsnative and
382 --skip-unavailable-fragments Skip unavailable fragments for DASH,
383 hlsnative and ISM (default)
384 (Alias: --no-abort-on-unavailable-fragment)
385 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
386 (Alias: --no-skip-unavailable-fragments)
387 --keep-fragments Keep downloaded fragments on disk after
388 downloading is finished
389 --no-keep-fragments Delete downloaded fragments after
390 downloading is finished (default)
391 --buffer-size SIZE Size of download buffer (e.g.
1024 or
16K)
393 --resize-buffer The buffer size is automatically resized
394 from an initial value of --buffer-size
396 --no-resize-buffer Do not automatically adjust the buffer size
397 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
398 downloading (e.g.
10485760 or
10M) (default
399 is disabled). May be useful for bypassing
400 bandwidth throttling imposed by a webserver
402 --playlist-reverse Download playlist videos in reverse order
403 --no-playlist-reverse Download playlist videos in default order
405 --playlist-random Download playlist videos in random order
406 --xattr-set-filesize Set file xattribute ytdl.filesize with
408 --hls-use-mpegts Use the mpegts container for HLS videos;
409 allowing some players to play the video
410 while downloading, and reducing the chance
411 of file corruption if download is
412 interrupted. This is enabled by default for
414 --no-hls-use-mpegts Do not use the mpegts container for HLS
415 videos. This is default when not
416 downloading live streams
417 --downloader [PROTO:]NAME Name or path of the external downloader to
418 use (optionally) prefixed by the protocols
419 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
420 use it for. Currently supports native,
421 aria2c, avconv, axel, curl, ffmpeg, httpie,
422 wget (Recommended: aria2c). You can use
423 this option multiple times to set different
424 downloaders for different protocols. For
425 example, --downloader aria2c --downloader
426 "dash,m3u8:native" will use aria2c for
427 http/ftp downloads, and the native
428 downloader for dash/m3u8 downloads
429 (Alias: --external-downloader)
430 --downloader-args NAME:ARGS Give these arguments to the external
431 downloader. Specify the downloader name and
432 the arguments separated by a colon ":". You
433 can use this option multiple times
434 (Alias: --external-downloader-args)
436 ## Filesystem Options:
437 -a, --batch-file FILE File containing URLs to download ('-' for
438 stdin), one URL per line. Lines starting
439 with '#', ';' or ']' are considered as
441 -P, --paths TYPES:PATH The paths where the files should be
442 downloaded. Specify the type of file and
443 the path separated by a colon ":". All the
444 same types as --output are supported.
445 Additionally, you can also provide "home"
446 and "temp" paths. All intermediary files
447 are first downloaded to the temp path and
448 then the final files are moved over to the
449 home path after download is finished. This
450 option is ignored if --output is an
452 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
453 TEMPLATE" for details
454 --output-na-placeholder TEXT Placeholder value for unavailable meta
455 fields in output filename template
457 --restrict-filenames Restrict filenames to only ASCII
458 characters, and avoid "&" and spaces in
460 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
462 --windows-filenames Force filenames to be windows compatible
463 --no-windows-filenames Make filenames windows compatible only if
464 using windows (default)
465 --trim-filenames LENGTH Limit the filename length (excluding
466 extension) to the specified number of
468 -w, --no-overwrites Do not overwrite any files
469 --force-overwrites Overwrite all video and metadata files.
470 This option includes --no-continue
471 --no-force-overwrites Do not overwrite the video, but overwrite
472 related files (default)
473 -c, --continue Resume partially downloaded files/fragments
475 --no-continue Do not resume partially downloaded
476 fragments. If the file is not fragmented,
477 restart download of the entire file
478 --part Use .part files instead of writing directly
479 into output file (default)
480 --no-part Do not use .part files - write directly
482 --mtime Use the Last-modified header to set the
483 file modification time (default)
484 --no-mtime Do not use the Last-modified header to set
485 the file modification time
486 --write-description Write video description to a .description
488 --no-write-description Do not write video description (default)
489 --write-info-json Write video metadata to a .info.json file
490 (this may contain personal information)
491 --no-write-info-json Do not write video metadata (default)
492 --write-annotations Write video annotations to a
493 .annotations.xml file
494 --no-write-annotations Do not write video annotations (default)
495 --write-playlist-metafiles Write playlist metadata in addition to the
496 video metadata when using --write-info-json,
497 --write-description etc. (default)
498 --no-write-playlist-metafiles Do not write playlist metadata when using
499 --write-info-json, --write-description etc.
500 --clean-infojson Remove some private fields such as
501 filenames from the infojson. Note that it
502 could still contain some personal
503 information (default)
504 --no-clean-infojson Write all fields to the infojson
505 --write-comments Retrieve video comments to be placed in the
506 infojson. The comments are fetched even
507 without this option if the extraction is
508 known to be quick (Alias: --get-comments)
509 --no-write-comments Do not retrieve video comments unless the
510 extraction is known to be quick
511 (Alias: --no-get-comments)
512 --load-info-json FILE JSON file containing the video information
513 (created with the "--write-info-json"
515 --cookies FILE File to read cookies from and dump cookie
517 --no-cookies Do not read/dump cookies (default)
518 --cache-dir DIR Location in the filesystem where youtube-dl
519 can store some downloaded information (such
520 as client ids and signatures) permanently.
521 By default $XDG_CACHE_HOME/youtube-dl or
523 --no-cache-dir Disable filesystem caching
524 --rm-cache-dir Delete all filesystem cache files
526 ## Thumbnail Options:
527 --write-thumbnail Write thumbnail image to disk
528 --no-write-thumbnail Do not write thumbnail image to disk
530 --write-all-thumbnails Write all thumbnail image formats to disk
531 --list-thumbnails Simulate and list all available thumbnail
534 ## Internet Shortcut Options:
535 --write-link Write an internet shortcut file, depending
536 on the current platform (.url, .webloc or
537 .desktop). The URL may be cached by the OS
538 --write-url-link Write a .url Windows internet shortcut. The
539 OS caches the URL based on the file path
540 --write-webloc-link Write a .webloc macOS internet shortcut
541 --write-desktop-link Write a .desktop Linux internet shortcut
543 ## Verbosity and Simulation Options:
544 -q, --quiet Activate quiet mode
545 --no-warnings Ignore warnings
546 -s, --simulate Do not download the video and do not write
548 --ignore-no-formats-error Ignore "No video formats" error. Usefull
549 for extracting metadata even if the video
550 is not actually available for download
552 --no-ignore-no-formats-error Throw error when no downloadable video
553 formats are found (default)
554 --skip-download Do not download the video but write all
555 related files (Alias: --no-download)
556 -O, --print TEMPLATE Simulate, quiet but print the given fields.
557 Either a field name or similar formatting
558 as the output template can be used
559 -j, --dump-json Simulate, quiet but print JSON information.
560 See "OUTPUT TEMPLATE" for a description of
562 -J, --dump-single-json Simulate, quiet but print JSON information
563 for each command-line argument. If the URL
564 refers to a playlist, dump the whole
565 playlist information in a single line
566 --print-json Be quiet and print the video information as
567 JSON (video is still being downloaded)
568 --force-write-archive Force download archive entries to be
569 written as far as no errors occur, even if
570 -s or another simulation option is used
571 (Alias: --force-download-archive)
572 --newline Output progress bar as new lines
573 --no-progress Do not print progress bar
574 --console-title Display progress in console titlebar
575 -v, --verbose Print various debugging information
576 --dump-pages Print downloaded pages encoded using base64
577 to debug problems (very verbose)
578 --write-pages Write downloaded intermediary pages to
579 files in the current directory to debug
581 --print-traffic Display sent and read HTTP traffic
584 --encoding ENCODING Force the specified encoding (experimental)
585 --no-check-certificate Suppress HTTPS certificate validation
586 --prefer-insecure Use an unencrypted connection to retrieve
587 information about the video (Currently
588 supported only for YouTube)
589 --user-agent UA Specify a custom user agent
590 --referer URL Specify a custom referer, use if the video
591 access is restricted to one domain
592 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
593 separated by a colon ":". You can use this
594 option multiple times
595 --bidi-workaround Work around terminals that lack
596 bidirectional text support. Requires bidiv
597 or fribidi executable in PATH
598 --sleep-requests SECONDS Number of seconds to sleep between requests
599 during data extraction
600 --sleep-interval SECONDS Number of seconds to sleep before each
601 download. This is the minimum time to sleep
602 when used along with --max-sleep-interval
603 (Alias: --min-sleep-interval)
604 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
605 only be used along with --min-sleep-interval
606 --sleep-subtitles SECONDS Number of seconds to sleep before each
609 ## Video Format Options:
610 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
612 -S, --format-sort SORTORDER Sort the formats by the fields given, see
613 "Sorting Formats" for more details
614 --S-force, --format-sort-force Force user specified sort order to have
615 precedence over all fields, see "Sorting
616 Formats" for more details
617 --no-format-sort-force Some fields have precedence over the user
618 specified sort order (default), see
619 "Sorting Formats" for more details
620 --video-multistreams Allow multiple video streams to be merged
622 --no-video-multistreams Only one video stream is downloaded for
623 each output file (default)
624 --audio-multistreams Allow multiple audio streams to be merged
626 --no-audio-multistreams Only one audio stream is downloaded for
627 each output file (default)
628 --prefer-free-formats Prefer video formats with free containers
629 over non-free ones of same quality. Use
630 with "-S ext" to strictly prefer free
631 containers irrespective of quality
632 --no-prefer-free-formats Don't give any special preference to free
634 --check-formats Check that the formats selected are
635 actually downloadable (Experimental)
636 -F, --list-formats List all available formats of requested
638 --merge-output-format FORMAT If a merge is required (e.g.
639 bestvideo+bestaudio), output to given
640 container format. One of mkv, mp4, ogg,
641 webm, flv. Ignored if no merge is required
642 --allow-unplayable-formats Allow unplayable formats to be listed and
643 downloaded. All video post-processing will
645 --no-allow-unplayable-formats Do not allow unplayable formats to be
646 listed or downloaded (default)
649 --write-subs Write subtitle file
650 --no-write-subs Do not write subtitle file (default)
651 --write-auto-subs Write automatically generated subtitle file
652 (Alias: --write-automatic-subs)
653 --no-write-auto-subs Do not write auto-generated subtitles
654 (default) (Alias: --no-write-automatic-subs)
655 --list-subs List all available subtitles for the video
656 --sub-format FORMAT Subtitle format, accepts formats
657 preference, for example: "srt" or
659 --sub-langs LANGS Languages of the subtitles to download (can
660 be regex) or "all" separated by commas.
661 (Eg: --sub-langs en.*,ja) You can prefix
662 the language code with a "-" to exempt it
663 from the requested languages. (Eg: --sub-
664 langs all,-live_chat) Use --list-subs for a
665 list of available language tags
667 ## Authentication Options:
668 -u, --username USERNAME Login with this account ID
669 -p, --password PASSWORD Account password. If this option is left
670 out, yt-dlp will ask interactively
671 -2, --twofactor TWOFACTOR Two-factor authentication code
672 -n, --netrc Use .netrc authentication data
673 --video-password PASSWORD Video password (vimeo, youku)
674 --ap-mso MSO Adobe Pass multiple-system operator (TV
675 provider) identifier, use --ap-list-mso for
676 a list of available MSOs
677 --ap-username USERNAME Multiple-system operator account login
678 --ap-password PASSWORD Multiple-system operator account password.
679 If this option is left out, yt-dlp will ask
681 --ap-list-mso List all supported multiple-system
684 ## Post-Processing Options:
685 -x, --extract-audio Convert video files to audio-only files
686 (requires ffmpeg and ffprobe)
687 --audio-format FORMAT Specify audio format to convert the audio
688 to when -x is used. Currently supported
689 formats are: best (default) or one of
690 aac|flac|mp3|m4a|opus|vorbis|wav
691 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
692 value between
0 (better) and
9 (worse) for
693 VBR or a specific bitrate like
128K
695 --remux-video FORMAT Remux the video into another container if
696 necessary (currently supported: mp4|mkv|flv
697 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
698 target container does not support the
699 video/audio codec, remuxing will fail. You
700 can specify multiple rules; Eg.
701 "aac>m4a/mov>mp4/mkv" will remux aac to
702 m4a, mov to mp4 and anything else to mkv.
703 --recode-video FORMAT Re-encode the video into another format if
704 re-encoding is necessary. The syntax and
705 supported formats are the same as --remux-video
706 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
707 Specify the postprocessor/executable name
708 and the arguments separated by a colon ":"
709 to give the argument to the specified
710 postprocessor/executable. Supported PP are:
711 Merger, ExtractAudio, SplitChapters,
712 Metadata, EmbedSubtitle, EmbedThumbnail,
713 SubtitlesConvertor, ThumbnailsConvertor,
714 VideoRemuxer, VideoConvertor, SponSkrub,
715 FixupStretched, FixupM4a and FixupM3u8. The
716 supported executables are: AtomicParsley,
717 FFmpeg, FFprobe, and SponSkrub. You can
718 also specify "PP+EXE:ARGS" to give the
719 arguments to the specified executable only
720 when being used by the specified
721 postprocessor. Additionally, for
722 ffmpeg/ffprobe, "_i"/"_o" can be appended
723 to the prefix optionally followed by a
724 number to pass the argument before the
725 specified input/output file. Eg: --ppa
726 "Merger+ffmpeg_i1:-v quiet". You can use
727 this option multiple times to give
728 different arguments to different
729 postprocessors. (Alias: --ppa)
730 -k, --keep-video Keep the intermediate video file on disk
731 after post-processing
732 --no-keep-video Delete the intermediate video file after
733 post-processing (default)
734 --post-overwrites Overwrite post-processed files (default)
735 --no-post-overwrites Do not overwrite post-processed files
736 --embed-subs Embed subtitles in the video (only for mp4,
738 --no-embed-subs Do not embed subtitles (default)
739 --embed-thumbnail Embed thumbnail in the audio as cover art
740 --no-embed-thumbnail Do not embed thumbnail (default)
741 --add-metadata Write metadata to the video file
742 --no-add-metadata Do not write metadata (default)
743 --parse-metadata FROM:TO Parse additional metadata like title/artist
744 from other fields; see "MODIFYING METADATA"
746 --xattrs Write metadata to the video file's xattrs
747 (using dublin core and xdg standards)
748 --fixup POLICY Automatically correct known faults of the
749 file. One of never (do nothing), warn (only
750 emit a warning), detect_or_warn (the
751 default; fix file if we can, warn
753 --ffmpeg-location PATH Location of the ffmpeg binary; either the
754 path to the binary or its containing
756 --exec CMD Execute a command on the file after
757 downloading and post-processing. Similar
758 syntax to the output template can be used
759 to pass any field as arguments to the
760 command. An additional field "filepath"
761 that contains the final path of the
762 downloaded file is also available. If no
763 fields are passed, "%(filepath)s" is
764 appended to the end of the command
765 --convert-subs FORMAT Convert the subtitles to another format
766 (currently supported: srt|vtt|ass|lrc)
767 (Alias: --convert-subtitles)
768 --convert-thumbnails FORMAT Convert the thumbnails to another format
769 (currently supported: jpg|png)
770 --split-chapters Split video into multiple files based on
771 internal chapters. The "chapter:" prefix
772 can be used with "--paths" and "--output"
773 to set the output filename for the split
774 files. See "OUTPUT TEMPLATE" for details
775 --no-split-chapters Do not split video based on chapters
778 ## SponSkrub (SponsorBlock) Options:
779 [SponSkrub](https://github.com/yt-dlp/SponSkrub) is a utility to
780 mark/remove sponsor segments from downloaded YouTube videos using
781 [SponsorBlock API](https://sponsor.ajay.app)
783 --sponskrub Use sponskrub to mark sponsored sections.
784 This is enabled by default if the sponskrub
785 binary exists (Youtube only)
786 --no-sponskrub Do not use sponskrub
787 --sponskrub-cut Cut out the sponsor sections instead of
789 --no-sponskrub-cut Simply mark the sponsor sections, not cut
791 --sponskrub-force Run sponskrub even if the video was already
793 --no-sponskrub-force Do not cut out the sponsor sections if the
794 video was already downloaded (default)
795 --sponskrub-location PATH Location of the sponskrub binary; either
796 the path to the binary or its containing
799 ## Extractor Options:
800 --extractor-retries RETRIES Number of retries for known extractor
801 errors (default is
3), or "infinite"
802 --allow-dynamic-mpd Process dynamic DASH manifests (default)
803 (Alias: --no-ignore-dynamic-mpd)
804 --ignore-dynamic-mpd Do not process dynamic DASH manifests
805 (Alias: --no-allow-dynamic-mpd)
806 --hls-split-discontinuity Split HLS playlists to different formats at
807 discontinuities such as ad breaks
808 --no-hls-split-discontinuity Do not split HLS playlists to different
809 formats at discontinuities such as ad
811 --youtube-include-dash-manifest Download the DASH manifests and related
812 data on YouTube videos (default)
813 (Alias: --no-youtube-skip-dash-manifest)
814 --youtube-skip-dash-manifest Do not download the DASH manifests and
815 related data on YouTube videos
816 (Alias: --no-youtube-include-dash-manifest)
817 --youtube-include-hls-manifest Download the HLS manifests and related data
818 on YouTube videos (default)
819 (Alias: --no-youtube-skip-hls-manifest)
820 --youtube-skip-hls-manifest Do not download the HLS manifests and
821 related data on YouTube videos
822 (Alias: --no-youtube-include-hls-manifest)
826 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
828 1. **Main Configuration**: The file given by
`--config-location`
829 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.
830 1. **Home Configuration**:
`yt-dlp.conf` in the home path given by
`-P "home:<path>"`, or in the current directory if no such path is given
831 1. **User Configuration**:
832 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
833 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
834 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
835 * `%APPDATA%/yt-dlp/config.txt`
837 * `~/yt-dlp.conf.txt`
839 Note that
`~` points to
`C:\Users\<user name>` on windows. Also,
`%XDG_CONFIG_HOME%` defaults to
`~/.config` if undefined
840 1. **System Configuration**:
`/etc/yt-dlp.conf`
842 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:
844 # Lines starting with # are comments
846 # Always extract audio
849 # Do not copy the mtime
853 --proxy 127.0.0.1:3128
855 # Save all videos under YouTube directory in your home directory
856 -o ~/YouTube/%(title)s.%(ext)s
859 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`.
861 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 user and system configurations. Additionally, (for backward compatibility) if
`--ignore-config` is found inside the system configuration file, the user configuration is not loaded.
863 ### Authentication with `.netrc` file
865 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 your
`$HOME` and restrict permissions to read/write by only you:
868 chmod a-rwx,u+rw $HOME/.netrc
870 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
872 machine <extractor> login <login> password <password>
876 machine youtube login myaccount@gmail.com password my_youtube_password
877 machine twitch login my_twitch_account_name password my_twitch_password
879 To activate authentication with the
`.netrc` file you should pass
`--netrc` to yt-dlp or place it in the [configuration file](#configuration).
881 On Windows you may also need to setup the
`%HOME%` environment variable manually. For example:
883 set HOME=%USERPROFILE%
888 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.
890 **tl;dr:** [navigate me to examples](#output-template-examples).
892 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).
894 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/2/library/stdtypes.html#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.
896 The field names themselves (the part inside the parenthesis) can also have some special formatting:
897 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)`,
`%(id.3:7:-1)s`. Note that the fields that become available using this method are not listed below. Use
`-j` to see such fields
898 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`
899 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`
900 1. **Default**: A default value can be specified for when the field is empty using a
`|` seperator. This overrides
`--output-na-template`. Eg:
`%(uploader|Unknown)s`
902 To summarize, the general syntax for a field is:
904 %(name[.keys][addition][>strf][|default])[flags][width][.precision][length]type
907 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`,
`infojson`,
`pl_thumbnail`,
`pl_description`,
`pl_infojson`,
`chapter`. For example,
`-o '%(title)s.%(ext)s' -o 'thumbnail:%(title)s\%(title)s.%(ext)s'` will put the thumbnails in a folder with the same name as the video.
909 The available fields are:
911 - `id` (string): Video identifier
912 - `title` (string): Video title
913 - `url` (string): Video URL
914 - `ext` (string): Video filename extension
915 - `alt_title` (string): A secondary title of the video
916 - `description` (string): The description of the video
917 - `display_id` (string): An alternative identifier for the video
918 - `uploader` (string): Full name of the video uploader
919 - `license` (string): License name the video is licensed under
920 - `creator` (string): The creator of the video
921 - `release_date` (string): The date (YYYYMMDD) when the video was released
922 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
923 - `upload_date` (string): Video upload date (YYYYMMDD)
924 - `uploader_id` (string): Nickname or id of the video uploader
925 - `channel` (string): Full name of the channel the video is uploaded on
926 - `channel_id` (string): Id of the channel
927 - `location` (string): Physical location where the video was filmed
928 - `duration` (numeric): Length of the video in seconds
929 - `duration_string` (string): Length of the video (HH:mm:ss)
930 - `view_count` (numeric): How many users have watched the video on the platform
931 - `like_count` (numeric): Number of positive ratings of the video
932 - `dislike_count` (numeric): Number of negative ratings of the video
933 - `repost_count` (numeric): Number of reposts of the video
934 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
935 - `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)
936 - `age_limit` (numeric): Age restriction for the video (years)
937 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
938 - `was_live` (boolean): Whether this video was originally a live stream
939 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
940 - `availability` (string): Whether the video is 'private', 'premium_only', 'subscriber_only', 'needs_auth', 'unlisted' or 'public'
941 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
942 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
943 - `format` (string): A human-readable description of the format
944 - `format_id` (string): Format code specified by
`--format`
945 - `format_note` (string): Additional info about the format
946 - `width` (numeric): Width of the video
947 - `height` (numeric): Height of the video
948 - `resolution` (string): Textual description of width and height
949 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
950 - `abr` (numeric): Average audio bitrate in KBit/s
951 - `acodec` (string): Name of the audio codec in use
952 - `asr` (numeric): Audio sampling rate in Hertz
953 - `vbr` (numeric): Average video bitrate in KBit/s
954 - `fps` (numeric): Frame rate
955 - `vcodec` (string): Name of the video codec in use
956 - `container` (string): Name of the container format
957 - `filesize` (numeric): The number of bytes, if known in advance
958 - `filesize_approx` (numeric): An estimate for the number of bytes
959 - `protocol` (string): The protocol that will be used for the actual download
960 - `extractor` (string): Name of the extractor
961 - `extractor_key` (string): Key name of the extractor
962 - `epoch` (numeric): Unix epoch when creating the file
963 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
964 - `playlist` (string): Name or id of the playlist that contains the video
965 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
966 - `playlist_id` (string): Playlist identifier
967 - `playlist_title` (string): Playlist title
968 - `playlist_uploader` (string): Full name of the playlist uploader
969 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
970 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
971 - `original_url` (string): The URL given by the user (or same as
`webpage_url` for playlist entries)
973 Available for the video that belongs to some logical chapter or section:
975 - `chapter` (string): Name or title of the chapter the video belongs to
976 - `chapter_number` (numeric): Number of the chapter the video belongs to
977 - `chapter_id` (string): Id of the chapter the video belongs to
979 Available for the video that is an episode of some series or programme:
981 - `series` (string): Title of the series or programme the video episode belongs to
982 - `season` (string): Title of the season the video episode belongs to
983 - `season_number` (numeric): Number of the season the video episode belongs to
984 - `season_id` (string): Id of the season the video episode belongs to
985 - `episode` (string): Title of the video episode
986 - `episode_number` (numeric): Number of the video episode within a season
987 - `episode_id` (string): Id of the video episode
989 Available for the media that is a track or a part of a music album:
991 - `track` (string): Title of the track
992 - `track_number` (numeric): Number of the track within an album or a disc
993 - `track_id` (string): Id of the track
994 - `artist` (string): Artist(s) of the track
995 - `genre` (string): Genre(s) of the track
996 - `album` (string): Title of the album the track belongs to
997 - `album_type` (string): Type of the album
998 - `album_artist` (string): List of all artists appeared on the album
999 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1000 - `release_year` (numeric): Year (YYYY) when the album was released
1002 Available for
`chapter:` prefix when using
`--split-chapters` for videos with internal chapters:
1004 - `section_title` (string): Title of the chapter
1005 - `section_number` (numeric): Number of the chapter within the file
1006 - `section_start` (numeric): Start time of the chapter in seconds
1007 - `section_end` (numeric): End time of the chapter in seconds
1009 Available only when used in
`--print`:
1011 - `urls` (string): The URLs of all requested formats, one in each line
1012 - `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
1014 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. 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).
1016 For example for
`-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title
`yt-dlp test video` and id
`BaW_jenozKcj`, this will result in a
`yt-dlp test video-BaW_jenozKcj.mp4` file created in the current directory.
1018 For numeric sequences you can use numeric related formatting, for example,
`%(view_count)05d` will result in a string with view count padded with zeros up to
5 characters, like in
`00042`.
1020 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.
1022 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
1024 The current default template is
`%(title)s [%(id)s].%(ext)s`.
1026 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:
1028 #### Output template and Windows batch files
1030 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"`.
1032 #### Output template examples
1034 Note that on Windows you need to use double quotes instead of single.
1037 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
1038 youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
1040 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
1041 youtube-dl_test_video_.mp4 # A simple file name
1043 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1044 $ yt-dlp -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1046 # Download YouTube playlist videos in separate directories according to their uploaded year
1047 $ yt-dlp -o '%(upload_date>%Y)s/%(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1049 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1050 $ yt-dlp -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
1052 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1053 $ 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/
1055 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1056 $ 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
1058 # Stream the video being downloaded to stdout
1059 $ yt-dlp -o - BaW_jenozKc
1064 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1065 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`.
1067 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.
1069 **tl;dr:** [navigate me to examples](#format-selection-examples).
1071 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.
1073 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.
1075 You can also use special names to select particular edge case formats:
1077 - `all`: Select all formats
1078 - `mergeall`: Select and merge all formats (Must be used with
`--audio-multistreams`,
`--video-multistreams` or both)
1079 - `b*`,
`best*`: Select the best quality format irrespective of whether it contains video or audio
1080 - `w*`,
`worst*`: Select the worst quality format irrespective of whether it contains video or audio
1081 - `b`,
`best`: Select the best quality format that contains both video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
1082 - `w`,
`worst`: Select the worst quality format that contains both video and audio. Equivalent to
`worst*[vcodec!=none][acodec!=none]`
1083 - `bv`,
`bestvideo`: Select the best quality video-only format. Equivalent to
`best*[acodec=none]`
1084 - `wv`,
`worstvideo`: Select the worst quality video-only format. Equivalent to
`worst*[acodec=none]`
1085 - `bv*`,
`bestvideo*`: Select the best quality format that contains video. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
1086 - `wv*`,
`worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to
`worst*[vcodec!=none]`
1087 - `ba`,
`bestaudio`: Select the best quality audio-only format. Equivalent to
`best*[vcodec=none]`
1088 - `wa`,
`worstaudio`: Select the worst quality audio-only format. Equivalent to
`worst*[vcodec=none]`
1089 - `ba*`,
`bestaudio*`: Select the best quality format that contains audio. It may also contain video. Equivalent to
`best*[acodec!=none]`
1090 - `wa*`,
`worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to
`worst*[acodec!=none]`
1092 For example, to download the worst quality video-only format you can use
`-f worstvideo`. It is however recommended not to use
`worst` and related options. When your format selector is
`worst`, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use
`-f best -S +size,+br,+res,+fps` instead of
`-f worst`. See [sorting formats](#sorting-formats) for more details.
1094 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.
1096 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.
1098 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`.
1100 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. If
`--no-video-multistreams` is used, all formats with a video stream except the first one are ignored. Similarly, if
`--no-audio-multistreams` is used, all formats with an audio stream except the first one are ignored. For example,
`-f bestvideo+best+bestaudio` 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`.
1102 ## Filtering Formats
1104 You can also filter the video formats by putting a condition in brackets, as in
`-f "best[height=720]"` (or
`-f "[filesize>10M]"`).
1106 The following numeric meta fields can be used with comparisons
`<`,
`<=`,
`>`,
`>=`,
`=` (equals),
`!=` (not equals):
1108 - `filesize`: The number of bytes, if known in advance
1109 - `width`: Width of the video, if known
1110 - `height`: Height of the video, if known
1111 - `tbr`: Average bitrate of audio and video in KBit/s
1112 - `abr`: Average audio bitrate in KBit/s
1113 - `vbr`: Average video bitrate in KBit/s
1114 - `asr`: Audio sampling rate in Hertz
1117 Also filtering work for comparisons
`=` (equals),
`^=` (starts with),
`$=` (ends with),
`*=` (contains) and following string meta fields:
1119 - `ext`: File extension
1120 - `acodec`: Name of the audio codec in use
1121 - `vcodec`: Name of the video codec in use
1122 - `container`: Name of the container format
1123 - `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`)
1124 - `format_id`: A short description of the format
1125 - `language`: Language code
1127 Any string comparison may be prefixed with negation
`!` in order to produce an opposite comparison, e.g.
`!*=` (does not contain).
1129 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.
1131 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.
1133 Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than
480 you can use
`-f '(mp4,webm)[height<480]'`.
1137 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...`. The available fields are:
1139 - `hasvid`: Gives priority to formats that has a video stream
1140 - `hasaud`: Gives priority to formats that has a audio stream
1141 - `ie_pref`: The format preference as given by the extractor
1142 - `lang`: Language preference as given by the extractor
1143 - `quality`: The quality of the format as given by the extractor
1144 - `source`: Preference of the source as given by the extractor
1145 - `proto`: Protocol used for download (
`https`/
`ftps` >
`http`/
`ftp` >
`m3u8_native`/
`m3u8` >
`http_dash_segments`>
`websocket_frag` > other >
`mms`/
`rtsp` > unknown >
`f4f`/
`f4m`)
1146 - `vcodec`: Video Codec (
`av01` >
`vp9.2` >
`vp9` >
`h265` >
`h264` >
`vp8` >
`h263` >
`theora` > other > unknown)
1147 - `acodec`: Audio Codec (
`opus` >
`vorbis` >
`aac` >
`mp4a` >
`mp3` >
`ac3` >
`dts` > other > unknown)
1148 - `codec`: Equivalent to
`vcodec,acodec`
1149 - `vext`: Video Extension (
`mp4` >
`webm` >
`flv` > other > unknown). If
`--prefer-free-formats` is used,
`webm` is prefered.
1150 - `aext`: Audio Extension (
`m4a` >
`aac` >
`mp3` >
`ogg` >
`opus` >
`webm` > other > unknown). If
`--prefer-free-formats` is used, the order changes to
`opus` >
`ogg` >
`webm` >
`m4a` >
`mp3` >
`aac`.
1151 - `ext`: Equivalent to
`vext,aext`
1152 - `filesize`: Exact filesize, if know in advance. This will be unavailable for mu38 and DASH formats.
1153 - `fs_approx`: Approximate filesize calculated from the manifests
1154 - `size`: Exact filesize if available, otherwise approximate filesize
1155 - `height`: Height of video
1156 - `width`: Width of video
1157 - `res`: Video resolution, calculated as the smallest dimension.
1158 - `fps`: Framerate of video
1159 - `tbr`: Total average bitrate in KBit/s
1160 - `vbr`: Average video bitrate in KBit/s
1161 - `abr`: Average audio bitrate in KBit/s
1162 - `br`: Equivalent to using
`tbr,vbr,abr`
1163 - `asr`: Audio sample rate in Hz
1165 Note that any other **numerical** field made available by the extractor can also be used. 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.
1167 The fields
`hasvid`,
`ie_pref`,
`lang` are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using
`--force-format-sort`. Apart from these, the default order used is:
`quality,res,fps,codec:vp9.2,size,br,asr,proto,ext,hasaud,source,id`. Note that the extractors may override this default order, but they cannot override the user-provided order.
1169 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`.
1171 **Tip**: You can use the
`-v -F` to see how the formats have been sorted (worst to best).
1173 ## Format Selection examples
1175 Note that on Windows you may need to use double quotes instead of single.
1178 # Download and merge the best video-only format and the best audio-only format,
1179 # or download the best combined format if video-only format is not available
1180 $ yt-dlp -f 'bv+ba/b'
1182 # Download best format that contains video,
1183 # and if it doesn't already have an audio stream, merge it with best audio-only format
1184 $ yt-dlp -f 'bv*+ba/b'
1189 # Download the best video-only format and the best audio-only format without merging them
1190 # For this case, an output template should be used since
1191 # by default, bestvideo and bestaudio will have the same file name.
1192 $ yt-dlp -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s'
1194 # Download and merge the best format that has a video stream,
1195 # and all audio-only formats into one file
1196 $ yt-dlp -f 'bv*+mergeall[vcodec=none]' --audio-multistreams
1198 # Download and merge the best format that has a video stream,
1199 # and the best 2 audio-only formats into one file
1200 $ yt-dlp -f 'bv*+ba+ba.2' --audio-multistreams
1203 # The following examples show the old method (without -S) of format selection
1204 # and how to use -S to achieve a similar but (generally) better result
1206 # Download the worst video available (old method)
1207 $ yt-dlp -f 'wv*+wa/w'
1209 # Download the best video available but with the smallest resolution
1212 # Download the smallest video available
1213 $ yt-dlp -S '+size,+br'
1217 # Download the best mp4 video available, or the best video if no mp4 available
1218 $ yt-dlp -f 'bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b'
1220 # Download the best video with the best extension
1221 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1226 # Download the best video available but no better than 480p,
1227 # or the worst video if there is no video under 480p
1228 $ yt-dlp -f 'bv*[height<=480]+ba/b[height<=480] / wv*+ba/w'
1230 # Download the best video available with the largest height but no better than 480p,
1231 # or the best video with the smallest resolution if there is no video under 480p
1232 $ yt-dlp -S 'height:480'
1234 # Download the best video available with the largest resolution but no better than 480p,
1235 # or the best video with the smallest resolution if there is no video under 480p
1236 # Resolution is determined by using the smallest dimension.
1237 # So this works correctly for vertical videos as well
1238 $ yt-dlp -S 'res:480'
1242 # Download the best video (that also has audio) but no bigger than 50 MB,
1243 # or the worst video (that also has audio) if there is no video under 50 MB
1244 $ yt-dlp -f 'b[filesize<50M] / w'
1246 # Download largest video (that also has audio) but no bigger than 50 MB,
1247 # or the smallest video (that also has audio) if there is no video under 50 MB
1248 $ yt-dlp -f 'b' -S 'filesize:50M'
1250 # Download best video (that also has audio) that is closest in size to 50 MB
1251 $ yt-dlp -f 'b' -S 'filesize~50M'
1255 # Download best video available via direct link over HTTP/HTTPS protocol,
1256 # or the best video available via any protocol if there is no such video
1257 $ yt-dlp -f '(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)'
1259 # Download best video available via the best protocol
1260 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1265 # Download the best video with h264 codec, or the best video if there is no such video
1266 $ yt-dlp -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'
1268 # Download the best video with best codec no better than h264,
1269 # or the best video with worst codec if there is no such video
1270 $ yt-dlp -S 'codec:h264'
1272 # Download the best video with worst codec no worse than h264,
1273 # or the best video with best codec if there is no such video
1274 $ yt-dlp -S '+codec:h264'
1278 # More complex examples
1280 # Download the best video no better than 720p preferring framerate greater than 30,
1281 # or the worst video (still preferring framerate greater than 30) if there is no such video
1282 $ yt-dlp -f '((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)'
1284 # Download the video with the largest resolution no better than 720p,
1285 # or the video with the smallest resolution available if there is no such video,
1286 # preferring larger framerate for formats with the same resolution
1287 $ yt-dlp -S 'res:720,fps'
1291 # Download the video with smallest resolution no worse than 480p,
1292 # or the video with the largest resolution available if there is no such video,
1293 # preferring better codec and then larger total bitrate for the same resolution
1294 $ yt-dlp -S '+res:480,codec,br'
1297 # MODIFYING METADATA
1299 The metadata obtained the the extractors can be modified by using
`--parse-metadata FROM:TO`. The general syntax is to give the name of a field or a template (with similar syntax to
[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.
1301 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`.
1303 This option also has a few special uses:
1304 * You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a
`meta_` prefix. For example, any value you set to
`meta_description` field will be added to the
`description` field in the file. You can use this to set a different "description" and "synopsis", for example
1305 * 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
1307 ## Modifying metadata examples
1309 Note that on Windows you may need to use double quotes instead of single.
1312 # Interpret the title as "Artist - Title"
1313 $ yt-dlp --parse-metadata 'title:%(artist)s - %(title)s'
1316 $ yt-dlp --parse-metadata 'description:Artist - (?P<artist>.+)'
1318 # Set title as "Series name S01E05"
1319 $ yt-dlp --parse-metadata '%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s'
1321 # Set "comment" field in video metadata using description instead of webpage_url
1322 $ yt-dlp --parse-metadata 'description:(?s)(?P<meta_comment>.+)' --add-metadata
1328 Plugins are loaded from
`<root-dir>/ytdlp_plugins/<type>/__init__.py`. Currently only
`extractor` plugins are supported. Support for
`downloader` and
`postprocessor` plugins may be added in the future. See [ytdlp_plugins](ytdlp_plugins) for example.
1330 **Note**:
`<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`)
1332 # DEPRECATED OPTIONS
1334 These are all the deprecated options and the current alternative to achieve the same effect
1336 #### Not recommended
1337 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1339 --get-description --print description
1340 --get-duration --print duration_string
1341 --get-filename --print filename
1342 --get-format --print format
1344 --get-thumbnail --print thumbnail
1345 -e, --get-title --print title
1346 -g, --get-url --print urls
1347 --all-formats -f all
1348 --all-subs --sub-langs all --write-subs
1349 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)
03d
1350 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1351 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1352 --hls-prefer-native --downloader "m3u8:native"
1353 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1354 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1355 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1356 --sponskrub-args ARGS --ppa "sponskrub:ARGS"
1357 --test Used by developers for testing extractors. Not intended for the end user
1358 --youtube-print-sig-code Used for testing youtube signatures
1362 These are aliases that are no longer documented for various reasons
1364 --avconv-location --ffmpeg-location
1365 --cn-verification-proxy URL --geo-verification-proxy URL
1366 --dump-headers --print-traffic
1367 --dump-intermediate-pages --dump-pages
1368 --force-write-download-archive --force-write-archive
1369 --load-info --load-info-json
1370 --no-split-tracks --no-split-chapters
1371 --no-write-srt --no-write-subs
1372 --prefer-unsecure --prefer-insecure
1373 --rate-limit RATE --limit-rate RATE
1374 --split-tracks --split-chapters
1375 --srt-lang LANGS --sub-langs LANGS
1376 --trim-file-names LENGTH --trim-filenames LENGTH
1377 --write-srt --write-subs
1378 --yes-overwrites --force-overwrites
1380 #### No longer supported
1381 These options may no longer work as intended
1383 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
1384 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
1385 -C, --call-home Not implemented
1386 --no-call-home Default
1387 --include-ads No longer supported
1388 --no-include-ads Default
1391 These options were deprecated since
2014 and have now been entirely removed
1393 --id -o "%(id)s.%(ext)s"
1394 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
1395 -t, --title -o "%(title)s-%(id)s.%(ext)s"
1396 -l, --literal -o accepts literal names
1400 For FAQ, Developer Instructions etc., see the
[original README](https://github.com/ytdl-org/youtube-dl#faq)
projects / yt-dlp.git / blob