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)
56 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
58 * [DEPRECATED OPTIONS](#deprecated-options)
64 The major new features from the latest release of
[blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are:
66 * **
[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
68 * **[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))
70 * **Merged with youtube-dl
[commit/379f52a](https://github.com/ytdl-org/youtube-dl/commit/379f52a4954013767219d25099cce9e0f9401961)**: (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)
72 * **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.
74 * **Youtube improvements**:
75 * All Feeds (
`:ytfav`,
`:ytwatchlater`,
`:ytsubs`,
`:ythistory`,
`:ytrec`) supports downloading multiple pages of content
76 * Search (
`ytsearch:`,
`ytsearchdate:`), search URLs and in-channel search works
77 * Mixes supports downloading multiple pages of content
78 * Redirect channel's home URL automatically to
`/video` to preserve the old behaviour
79 * `255kbps` audio is extracted from youtube music if premium cookies are given
80 * Youtube music Albums, channels etc can be downloaded
82 * **Split video by chapters**: Videos can be split into multiple files based on chapters using
`--split-chapters`
84 * **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
86 * **Aria2c with HLS/DASH**: You can use
`aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
88 * **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
90 * **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
92 * **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
94 * **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`)
96 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
98 * **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`
100 * **Other new options**:
`--sleep-requests`,
`--convert-thumbnails`,
`--write-link`,
`--force-download-archive`,
`--force-overwrites`,
`--break-on-reject` etc
102 * **Improvements**: Multiple
`--postprocessor-args` and
`--downloader-args`, faster archive checking, more [format selection options](#format-selection) etc
104 * **Plugin extractors**: Extractors can be loaded from an external file. See [plugins](#plugins) for details
106 * **Self-updater**: The releases can be updated using
`yt-dlp -U`
109 See
[changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
112 **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
114 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.
116 ### Differences in default behavior
118 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc.
120 * The options
`--id`,
`--auto-number` (
`-A`),
`--title` (
`-t`) and
`--literal` (
`-l`), no longer work. See [removed options](#Removed) for details
121 * `avconv` is not supported as as an alternative to
`ffmpeg`
122 * 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`
123 * 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
124 * 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
125 * 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
126 * `--ignore-errors` is enabled by default. Use
`--abort-on-error` or
`--compat-options abort-on-error` to abort on errors instead
127 * 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
128 * `--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
129 * `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
130 * The output of
`-F` is listed in a new format. Use
`--compat-options list-formats` to revert this
131 * 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
132 * 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
133 * Unavailable videos are also listed for youtube playlists. Use
`--compat-options no-youtube-unavailable-videos` to remove this
134 * 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
135 * Thumbnail embedding in
`mp4` is done with mutagen if possible. Use
`--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
137 For ease of use, a few more compat options are available:
138 * `--compat-options all`: Use all compat options
139 * `--compat-options youtube-dl`: Same as
`--compat-options all,-multistreams`
140 * `--compat-options youtube-dlc`: Same as
`--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
144 yt-dlp is not platform specific. So it should work on your Unix box, on Windows or on macOS
146 You can install yt-dlp using one of the following methods:
147 * Download the binary from the
[latest release](https://github.com/yt-dlp/yt-dlp/releases/latest) (recommended method)
148 * Use
[PyPI package](https://pypi.org/project/yt-dlp):
`python3 -m pip install --upgrade yt-dlp`
149 * Use pip+git:
`python3 -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp.git@release`
150 * Install master branch:
`python3 -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp`
152 Note that on some systems, you may need to use
`py` or
`python` instead of
`python3`
154 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:
157 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
158 sudo chmod a+rx /usr/local/bin/yt-dlp
162 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
163 sudo chmod a+rx /usr/local/bin/yt-dlp
167 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
168 sudo chmod a+rx /usr/local/bin/yt-dlp
172 You can use
`yt-dlp -U` to update if you are using the provided release.
173 If you are using
`pip`, simply re-run the same command that was used to install the program.
176 Python versions
3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
178 <!-- https://www.microsoft.com/en-us/download/details.aspx?id=
26999 -->
179 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.
181 While all the other dependancies are optional,
`ffmpeg` and
`ffprobe` are highly recommended
182 * [**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)
183 * [**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)
184 * [**mutagen**](https://github.com/quodlibet/mutagen) - For embedding thumbnail in certain formats. Licenced under
[GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
185 * [**pycryptodome**](https://github.com/Legrandin/pycryptodome) - For decrypting various data. Licenced under
[BSD2](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
186 * [**websockets**](https://github.com/aaugustin/websockets) - For downloading over websocket. Licenced under
[BSD3](https://github.com/aaugustin/websockets/blob/main/LICENSE)
187 * [**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)
188 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading
`rtmp` streams. ffmpeg will be used as a fallback. Licenced under
[GPLv2+](http://rtmpdump.mplayerhq.hu)
189 * [**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)
190 * [**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)
191 * Any external downloader that you want to use with
`--downloader`
193 To use or redistribute the dependencies, you must agree to their respective licensing terms.
195 Note that the windows releases are already built with the python interpreter, mutagen, pycryptodome and websockets included.
200 To build the Windows executable, you must have pyinstaller (and optionally mutagen, pycryptodome, websockets)
202 python3 -m pip install --upgrade pyinstaller mutagen pycryptodome websockets
204 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.
206 You can also build the executable without any version info or metadata by using:
208 pyinstaller.exe yt_dlp\__main__.py --onefile --name yt-dlp
210 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
213 You will need the required build tools:
`python`,
`make` (GNU),
`pandoc`,
`zip`,
`nosetests`
214 Then simply run
`make`. You can also run
`make yt-dlp` instead to compile only the binary without updating any of the additional files
216 **Note**: In either platform,
`devscripts\update-version.py` can be used to automatically update the version number
220 yt-dlp [OPTIONS] [--] URL [URL...]
222 `Ctrl+F` is your friend :D
223 <!-- Auto generated -->
226 -h, --help Print this help text and exit
227 --version Print program version and exit
228 -U, --update Update this program to latest version. Make
229 sure that you have sufficient permissions
230 (run with sudo if needed)
231 -i, --ignore-errors Continue on download errors, for example to
232 skip unavailable videos in a playlist
233 (default) (Alias: --no-abort-on-error)
234 --abort-on-error Abort downloading of further videos if an
235 error occurs (Alias: --no-ignore-errors)
236 --dump-user-agent Display the current browser identification
237 --list-extractors List all supported extractors
238 --extractor-descriptions Output descriptions of all supported
240 --force-generic-extractor Force extraction to use the generic
242 --default-search PREFIX Use this prefix for unqualified URLs. For
243 example "gvsearch2:" downloads two videos
244 from google videos for youtube-dl "large
245 apple". Use the value "auto" to let
246 youtube-dl guess ("auto_warning" to emit a
247 warning when guessing). "error" just throws
248 an error. The default value "fixup_error"
249 repairs broken URLs, but emits an error if
250 this is not possible instead of searching
251 --ignore-config, --no-config Disable loading any configuration files
252 except the one provided by --config-location.
253 When given inside a configuration
254 file, no further configuration files are
255 loaded. Additionally, (for backward
256 compatibility) if this option is found
257 inside the system configuration file, the
258 user configuration is not loaded
259 --config-location PATH Location of the main configuration file;
260 either the path to the config or its
262 --flat-playlist Do not extract the videos of a playlist,
264 --no-flat-playlist Extract the videos of a playlist
265 --mark-watched Mark videos watched (YouTube only)
266 --no-mark-watched Do not mark videos watched (default)
267 --no-colors Do not emit color codes in output
268 --compat-options OPTS Options that can help keep compatibility
269 with youtube-dl and youtube-dlc
270 configurations by reverting some of the
271 changes made in yt-dlp. See "Differences in
272 default behavior" for details
275 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
276 To enable SOCKS proxy, specify a proper
278 socks5://
127.0.0.1:
1080/. Pass in an empty
279 string (--proxy "") for direct connection
280 --socket-timeout SECONDS Time to wait before giving up, in seconds
281 --source-address IP Client-side IP address to bind to
282 -4, --force-ipv4 Make all connections via IPv4
283 -6, --force-ipv6 Make all connections via IPv6
286 --geo-verification-proxy URL Use this proxy to verify the IP address for
287 some geo-restricted sites. The default
288 proxy specified by --proxy (or none, if the
289 option is not present) is used for the
291 --geo-bypass Bypass geographic restriction via faking
292 X-Forwarded-For HTTP header
293 --no-geo-bypass Do not bypass geographic restriction via
294 faking X-Forwarded-For HTTP header
295 --geo-bypass-country CODE Force bypass geographic restriction with
296 explicitly provided two-letter ISO
3166-
2
298 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
299 explicitly provided IP block in CIDR
303 --playlist-start NUMBER Playlist video to start at (default is
1)
304 --playlist-end NUMBER Playlist video to end at (default is last)
305 --playlist-items ITEM_SPEC Playlist video items to download. Specify
306 indices of the videos in the playlist
307 separated by commas like: "--playlist-items
308 1,
2,
5,
8" if you want to download videos
309 indexed
1,
2,
5,
8 in the playlist. You can
310 specify range: "--playlist-items
311 1-
3,
7,
10-
13", it will download the videos
312 at index
1,
2,
3,
7,
10,
11,
12 and
13
313 --match-title REGEX Download only matching titles (regex or
315 --reject-title REGEX Skip download for matching titles (regex or
317 --max-downloads NUMBER Abort after downloading NUMBER files
318 --min-filesize SIZE Do not download any videos smaller than
319 SIZE (e.g.
50k or
44.6m)
320 --max-filesize SIZE Do not download any videos larger than SIZE
322 --date DATE Download only videos uploaded in this date.
323 The date can be "YYYYMMDD" or in the format
324 "(now|today)[+-][
0-
9](day|week|month|year)(s)?"
325 --datebefore DATE Download only videos uploaded on or before
326 this date. The date formats accepted is the
328 --dateafter DATE Download only videos uploaded on or after
329 this date. The date formats accepted is the
331 --min-views COUNT Do not download any videos with less than
333 --max-views COUNT Do not download any videos with more than
335 --match-filter FILTER Generic video filter. Specify any key (see
336 "OUTPUT TEMPLATE" for a list of available
337 keys) to match if the key is present, !key
338 to check if the key is not present,
339 key>NUMBER (like "view_count >
12", also
340 works with >=, <, <=, !=, =) to compare
341 against a number, key = 'LITERAL' (like
342 "uploader = 'Mike Smith'", also works with
343 !=) to match against a string literal and &
344 to require multiple matches. Values which
345 are not known are excluded unless you put a
346 question mark (?) after the operator. For
347 example, to only match videos that have
348 been liked more than
100 times and disliked
349 less than
50 times (or the dislike
350 functionality is not available at the given
351 service), but who also have a description,
352 use --match-filter "like_count >
100 &
353 dislike_count <?
50 & description"
354 --no-match-filter Do not use generic video filter (default)
355 --no-playlist Download only the video, if the URL refers
356 to a video and a playlist
357 --yes-playlist Download the playlist, if the URL refers to
358 a video and a playlist
359 --age-limit YEARS Download only videos suitable for the given
361 --download-archive FILE Download only videos not listed in the
362 archive file. Record the IDs of all
363 downloaded videos in it
364 --break-on-existing Stop the download process when encountering
365 a file that is in the archive
366 --break-on-reject Stop the download process when encountering
367 a file that has been filtered out
368 --skip-playlist-after-errors N Number of allowed failures until the rest
369 of the playlist is skipped
370 --no-download-archive Do not use archive file (default)
373 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
374 video that should be download concurrently
376 -r, --limit-rate RATE Maximum download rate in bytes per second
378 --throttled-rate RATE Minimum download rate in bytes per second
379 below which throttling is assumed and the
380 video data is re-extracted (e.g.
100K)
381 -R, --retries RETRIES Number of retries (default is
10), or
383 --fragment-retries RETRIES Number of retries for a fragment (default
384 is
10), or "infinite" (DASH, hlsnative and
386 --skip-unavailable-fragments Skip unavailable fragments for DASH,
387 hlsnative and ISM (default)
388 (Alias: --no-abort-on-unavailable-fragment)
389 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
390 (Alias: --no-skip-unavailable-fragments)
391 --keep-fragments Keep downloaded fragments on disk after
392 downloading is finished
393 --no-keep-fragments Delete downloaded fragments after
394 downloading is finished (default)
395 --buffer-size SIZE Size of download buffer (e.g.
1024 or
16K)
397 --resize-buffer The buffer size is automatically resized
398 from an initial value of --buffer-size
400 --no-resize-buffer Do not automatically adjust the buffer size
401 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
402 downloading (e.g.
10485760 or
10M) (default
403 is disabled). May be useful for bypassing
404 bandwidth throttling imposed by a webserver
406 --playlist-reverse Download playlist videos in reverse order
407 --no-playlist-reverse Download playlist videos in default order
409 --playlist-random Download playlist videos in random order
410 --xattr-set-filesize Set file xattribute ytdl.filesize with
412 --hls-use-mpegts Use the mpegts container for HLS videos;
413 allowing some players to play the video
414 while downloading, and reducing the chance
415 of file corruption if download is
416 interrupted. This is enabled by default for
418 --no-hls-use-mpegts Do not use the mpegts container for HLS
419 videos. This is default when not
420 downloading live streams
421 --downloader [PROTO:]NAME Name or path of the external downloader to
422 use (optionally) prefixed by the protocols
423 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
424 use it for. Currently supports native,
425 aria2c, avconv, axel, curl, ffmpeg, httpie,
426 wget (Recommended: aria2c). You can use
427 this option multiple times to set different
428 downloaders for different protocols. For
429 example, --downloader aria2c --downloader
430 "dash,m3u8:native" will use aria2c for
431 http/ftp downloads, and the native
432 downloader for dash/m3u8 downloads
433 (Alias: --external-downloader)
434 --downloader-args NAME:ARGS Give these arguments to the external
435 downloader. Specify the downloader name and
436 the arguments separated by a colon ":". You
437 can use this option multiple times to give
438 different arguments to different downloaders
439 (Alias: --external-downloader-args)
441 ## Filesystem Options:
442 -a, --batch-file FILE File containing URLs to download ('-' for
443 stdin), one URL per line. Lines starting
444 with '#', ';' or ']' are considered as
446 -P, --paths TYPES:PATH The paths where the files should be
447 downloaded. Specify the type of file and
448 the path separated by a colon ":". All the
449 same types as --output are supported.
450 Additionally, you can also provide "home"
451 and "temp" paths. All intermediary files
452 are first downloaded to the temp path and
453 then the final files are moved over to the
454 home path after download is finished. This
455 option is ignored if --output is an
457 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
458 TEMPLATE" for details
459 --output-na-placeholder TEXT Placeholder value for unavailable meta
460 fields in output filename template
462 --restrict-filenames Restrict filenames to only ASCII
463 characters, and avoid "&" and spaces in
465 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
467 --windows-filenames Force filenames to be windows compatible
468 --no-windows-filenames Make filenames windows compatible only if
469 using windows (default)
470 --trim-filenames LENGTH Limit the filename length (excluding
471 extension) to the specified number of
473 -w, --no-overwrites Do not overwrite any files
474 --force-overwrites Overwrite all video and metadata files.
475 This option includes --no-continue
476 --no-force-overwrites Do not overwrite the video, but overwrite
477 related files (default)
478 -c, --continue Resume partially downloaded files/fragments
480 --no-continue Do not resume partially downloaded
481 fragments. If the file is not fragmented,
482 restart download of the entire file
483 --part Use .part files instead of writing directly
484 into output file (default)
485 --no-part Do not use .part files - write directly
487 --mtime Use the Last-modified header to set the
488 file modification time (default)
489 --no-mtime Do not use the Last-modified header to set
490 the file modification time
491 --write-description Write video description to a .description
493 --no-write-description Do not write video description (default)
494 --write-info-json Write video metadata to a .info.json file
495 (this may contain personal information)
496 --no-write-info-json Do not write video metadata (default)
497 --write-annotations Write video annotations to a
498 .annotations.xml file
499 --no-write-annotations Do not write video annotations (default)
500 --write-playlist-metafiles Write playlist metadata in addition to the
501 video metadata when using --write-info-json,
502 --write-description etc. (default)
503 --no-write-playlist-metafiles Do not write playlist metadata when using
504 --write-info-json, --write-description etc.
505 --clean-infojson Remove some private fields such as
506 filenames from the infojson. Note that it
507 could still contain some personal
508 information (default)
509 --no-clean-infojson Write all fields to the infojson
510 --write-comments Retrieve video comments to be placed in the
511 infojson. The comments are fetched even
512 without this option if the extraction is
513 known to be quick (Alias: --get-comments)
514 --no-write-comments Do not retrieve video comments unless the
515 extraction is known to be quick
516 (Alias: --no-get-comments)
517 --load-info-json FILE JSON file containing the video information
518 (created with the "--write-info-json"
520 --cookies FILE File to read cookies from and dump cookie
522 --no-cookies Do not read/dump cookies (default)
523 --cache-dir DIR Location in the filesystem where youtube-dl
524 can store some downloaded information (such
525 as client ids and signatures) permanently.
526 By default $XDG_CACHE_HOME/youtube-dl or
528 --no-cache-dir Disable filesystem caching
529 --rm-cache-dir Delete all filesystem cache files
531 ## Thumbnail Options:
532 --write-thumbnail Write thumbnail image to disk
533 --no-write-thumbnail Do not write thumbnail image to disk
535 --write-all-thumbnails Write all thumbnail image formats to disk
536 --list-thumbnails Simulate and list all available thumbnail
539 ## Internet Shortcut Options:
540 --write-link Write an internet shortcut file, depending
541 on the current platform (.url, .webloc or
542 .desktop). The URL may be cached by the OS
543 --write-url-link Write a .url Windows internet shortcut. The
544 OS caches the URL based on the file path
545 --write-webloc-link Write a .webloc macOS internet shortcut
546 --write-desktop-link Write a .desktop Linux internet shortcut
548 ## Verbosity and Simulation Options:
549 -q, --quiet Activate quiet mode
550 --no-warnings Ignore warnings
551 -s, --simulate Do not download the video and do not write
553 --ignore-no-formats-error Ignore "No video formats" error. Usefull
554 for extracting metadata even if the video
555 is not actually available for download
557 --no-ignore-no-formats-error Throw error when no downloadable video
558 formats are found (default)
559 --skip-download Do not download the video but write all
560 related files (Alias: --no-download)
561 -O, --print TEMPLATE Simulate, quiet but print the given fields.
562 Either a field name or similar formatting
563 as the output template can be used
564 -j, --dump-json Simulate, quiet but print JSON information.
565 See "OUTPUT TEMPLATE" for a description of
567 -J, --dump-single-json Simulate, quiet but print JSON information
568 for each command-line argument. If the URL
569 refers to a playlist, dump the whole
570 playlist information in a single line
571 --print-json Be quiet and print the video information as
572 JSON (video is still being downloaded)
573 --force-write-archive Force download archive entries to be
574 written as far as no errors occur, even if
575 -s or another simulation option is used
576 (Alias: --force-download-archive)
577 --newline Output progress bar as new lines
578 --no-progress Do not print progress bar
579 --console-title Display progress in console titlebar
580 -v, --verbose Print various debugging information
581 --dump-pages Print downloaded pages encoded using base64
582 to debug problems (very verbose)
583 --write-pages Write downloaded intermediary pages to
584 files in the current directory to debug
586 --print-traffic Display sent and read HTTP traffic
589 --encoding ENCODING Force the specified encoding (experimental)
590 --no-check-certificate Suppress HTTPS certificate validation
591 --prefer-insecure Use an unencrypted connection to retrieve
592 information about the video (Currently
593 supported only for YouTube)
594 --user-agent UA Specify a custom user agent
595 --referer URL Specify a custom referer, use if the video
596 access is restricted to one domain
597 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
598 separated by a colon ":". You can use this
599 option multiple times
600 --bidi-workaround Work around terminals that lack
601 bidirectional text support. Requires bidiv
602 or fribidi executable in PATH
603 --sleep-requests SECONDS Number of seconds to sleep between requests
604 during data extraction
605 --sleep-interval SECONDS Number of seconds to sleep before each
606 download. This is the minimum time to sleep
607 when used along with --max-sleep-interval
608 (Alias: --min-sleep-interval)
609 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
610 only be used along with --min-sleep-interval
611 --sleep-subtitles SECONDS Number of seconds to sleep before each
614 ## Video Format Options:
615 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
617 -S, --format-sort SORTORDER Sort the formats by the fields given, see
618 "Sorting Formats" for more details
619 --S-force, --format-sort-force Force user specified sort order to have
620 precedence over all fields, see "Sorting
621 Formats" for more details
622 --no-format-sort-force Some fields have precedence over the user
623 specified sort order (default), see
624 "Sorting Formats" for more details
625 --video-multistreams Allow multiple video streams to be merged
627 --no-video-multistreams Only one video stream is downloaded for
628 each output file (default)
629 --audio-multistreams Allow multiple audio streams to be merged
631 --no-audio-multistreams Only one audio stream is downloaded for
632 each output file (default)
633 --prefer-free-formats Prefer video formats with free containers
634 over non-free ones of same quality. Use
635 with "-S ext" to strictly prefer free
636 containers irrespective of quality
637 --no-prefer-free-formats Don't give any special preference to free
639 --check-formats Check that the formats selected are
640 actually downloadable (Experimental)
641 -F, --list-formats List all available formats of requested
643 --merge-output-format FORMAT If a merge is required (e.g.
644 bestvideo+bestaudio), output to given
645 container format. One of mkv, mp4, ogg,
646 webm, flv. Ignored if no merge is required
647 --allow-unplayable-formats Allow unplayable formats to be listed and
648 downloaded. All video post-processing will
650 --no-allow-unplayable-formats Do not allow unplayable formats to be
651 listed or downloaded (default)
654 --write-subs Write subtitle file
655 --no-write-subs Do not write subtitle file (default)
656 --write-auto-subs Write automatically generated subtitle file
657 (Alias: --write-automatic-subs)
658 --no-write-auto-subs Do not write auto-generated subtitles
659 (default) (Alias: --no-write-automatic-subs)
660 --list-subs List all available subtitles for the video
661 --sub-format FORMAT Subtitle format, accepts formats
662 preference, for example: "srt" or
664 --sub-langs LANGS Languages of the subtitles to download (can
665 be regex) or "all" separated by commas.
666 (Eg: --sub-langs en.*,ja) You can prefix
667 the language code with a "-" to exempt it
668 from the requested languages. (Eg: --sub-
669 langs all,-live_chat) Use --list-subs for a
670 list of available language tags
672 ## Authentication Options:
673 -u, --username USERNAME Login with this account ID
674 -p, --password PASSWORD Account password. If this option is left
675 out, yt-dlp will ask interactively
676 -2, --twofactor TWOFACTOR Two-factor authentication code
677 -n, --netrc Use .netrc authentication data
678 --video-password PASSWORD Video password (vimeo, youku)
679 --ap-mso MSO Adobe Pass multiple-system operator (TV
680 provider) identifier, use --ap-list-mso for
681 a list of available MSOs
682 --ap-username USERNAME Multiple-system operator account login
683 --ap-password PASSWORD Multiple-system operator account password.
684 If this option is left out, yt-dlp will ask
686 --ap-list-mso List all supported multiple-system
689 ## Post-Processing Options:
690 -x, --extract-audio Convert video files to audio-only files
691 (requires ffmpeg and ffprobe)
692 --audio-format FORMAT Specify audio format to convert the audio
693 to when -x is used. Currently supported
694 formats are: best (default) or one of
695 aac|flac|mp3|m4a|opus|vorbis|wav
696 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
697 value between
0 (better) and
9 (worse) for
698 VBR or a specific bitrate like
128K
700 --remux-video FORMAT Remux the video into another container if
701 necessary (currently supported: mp4|mkv|flv
702 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
703 target container does not support the
704 video/audio codec, remuxing will fail. You
705 can specify multiple rules; Eg.
706 "aac>m4a/mov>mp4/mkv" will remux aac to
707 m4a, mov to mp4 and anything else to mkv.
708 --recode-video FORMAT Re-encode the video into another format if
709 re-encoding is necessary. The syntax and
710 supported formats are the same as --remux-video
711 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
712 Specify the postprocessor/executable name
713 and the arguments separated by a colon ":"
714 to give the argument to the specified
715 postprocessor/executable. Supported PP are:
716 Merger, ExtractAudio, SplitChapters,
717 Metadata, EmbedSubtitle, EmbedThumbnail,
718 SubtitlesConvertor, ThumbnailsConvertor,
719 VideoRemuxer, VideoConvertor, SponSkrub,
720 FixupStretched, FixupM4a, FixupM3u8,
721 FixupTimestamp and FixupDuration. The
722 supported executables are: AtomicParsley,
723 FFmpeg, FFprobe, and SponSkrub. You can
724 also specify "PP+EXE:ARGS" to give the
725 arguments to the specified executable only
726 when being used by the specified
727 postprocessor. Additionally, for
728 ffmpeg/ffprobe, "_i"/"_o" can be appended
729 to the prefix optionally followed by a
730 number to pass the argument before the
731 specified input/output file. Eg: --ppa
732 "Merger+ffmpeg_i1:-v quiet". You can use
733 this option multiple times to give
734 different arguments to different
735 postprocessors. (Alias: --ppa)
736 -k, --keep-video Keep the intermediate video file on disk
737 after post-processing
738 --no-keep-video Delete the intermediate video file after
739 post-processing (default)
740 --post-overwrites Overwrite post-processed files (default)
741 --no-post-overwrites Do not overwrite post-processed files
742 --embed-subs Embed subtitles in the video (only for mp4,
744 --no-embed-subs Do not embed subtitles (default)
745 --embed-thumbnail Embed thumbnail in the video as cover art
746 --no-embed-thumbnail Do not embed thumbnail (default)
747 --embed-metadata Embed metadata including chapter markers
748 (if supported by the format) to the video
749 file (Alias: --add-metadata)
750 --no-embed-metadata Do not write metadata (default)
751 (Alias: --no-add-metadata)
752 --parse-metadata FROM:TO Parse additional metadata like title/artist
753 from other fields; see "MODIFYING METADATA"
755 --xattrs Write metadata to the video file's xattrs
756 (using dublin core and xdg standards)
757 --fixup POLICY Automatically correct known faults of the
758 file. One of never (do nothing), warn (only
759 emit a warning), detect_or_warn (the
760 default; fix file if we can, warn
761 otherwise), force (try fixing even if file
763 --ffmpeg-location PATH Location of the ffmpeg binary; either the
764 path to the binary or its containing
766 --exec CMD Execute a command on the file after
767 downloading and post-processing. Similar
768 syntax to the output template can be used
769 to pass any field as arguments to the
770 command. An additional field "filepath"
771 that contains the final path of the
772 downloaded file is also available. If no
773 fields are passed, "%(filepath)s" is
774 appended to the end of the command
775 --convert-subs FORMAT Convert the subtitles to another format
776 (currently supported: srt|vtt|ass|lrc)
777 (Alias: --convert-subtitles)
778 --convert-thumbnails FORMAT Convert the thumbnails to another format
779 (currently supported: jpg|png)
780 --split-chapters Split video into multiple files based on
781 internal chapters. The "chapter:" prefix
782 can be used with "--paths" and "--output"
783 to set the output filename for the split
784 files. See "OUTPUT TEMPLATE" for details
785 --no-split-chapters Do not split video based on chapters
788 ## SponSkrub (SponsorBlock) Options:
789 [SponSkrub](https://github.com/yt-dlp/SponSkrub) is a utility to
790 mark/remove sponsor segments from downloaded YouTube videos using
791 [SponsorBlock API](https://sponsor.ajay.app)
793 --sponskrub Use sponskrub to mark sponsored sections.
794 This is enabled by default if the sponskrub
795 binary exists (Youtube only)
796 --no-sponskrub Do not use sponskrub
797 --sponskrub-cut Cut out the sponsor sections instead of
799 --no-sponskrub-cut Simply mark the sponsor sections, not cut
801 --sponskrub-force Run sponskrub even if the video was already
803 --no-sponskrub-force Do not cut out the sponsor sections if the
804 video was already downloaded (default)
805 --sponskrub-location PATH Location of the sponskrub binary; either
806 the path to the binary or its containing
809 ## Extractor Options:
810 --extractor-retries RETRIES Number of retries for known extractor
811 errors (default is
3), or "infinite"
812 --allow-dynamic-mpd Process dynamic DASH manifests (default)
813 (Alias: --no-ignore-dynamic-mpd)
814 --ignore-dynamic-mpd Do not process dynamic DASH manifests
815 (Alias: --no-allow-dynamic-mpd)
816 --hls-split-discontinuity Split HLS playlists to different formats at
817 discontinuities such as ad breaks
818 --no-hls-split-discontinuity Do not split HLS playlists to different
819 formats at discontinuities such as ad
821 --extractor-args KEY:ARGS Pass these arguments to the extractor. See
822 "EXTRACTOR ARGUMENTS" for details. You can
823 use this option multiple times to give
824 different arguments to different extractors
828 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
830 1. **Main Configuration**: The file given by
`--config-location`
831 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.
832 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
833 1. **User Configuration**:
834 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
835 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
836 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
837 * `%APPDATA%/yt-dlp/config.txt`
839 * `~/yt-dlp.conf.txt`
841 Note that
`~` points to
`C:\Users\<user name>` on windows. Also,
`%XDG_CONFIG_HOME%` defaults to
`~/.config` if undefined
842 1. **System Configuration**:
`/etc/yt-dlp.conf`
844 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:
846 # Lines starting with # are comments
848 # Always extract audio
851 # Do not copy the mtime
855 --proxy 127.0.0.1:3128
857 # Save all videos under YouTube directory in your home directory
858 -o ~/YouTube/%(title)s.%(ext)s
861 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`.
863 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.
865 ### Authentication with `.netrc` file
867 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:
870 chmod a-rwx,u+rw $HOME/.netrc
872 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
874 machine <extractor> login <login> password <password>
878 machine youtube login myaccount@gmail.com password my_youtube_password
879 machine twitch login my_twitch_account_name password my_twitch_password
881 To activate authentication with the
`.netrc` file you should pass
`--netrc` to yt-dlp or place it in the [configuration file](#configuration).
883 On Windows you may also need to setup the
`%HOME%` environment variable manually. For example:
885 set HOME=%USERPROFILE%
890 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.
892 **tl;dr:** [navigate me to examples](#output-template-examples).
894 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).
896 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.
898 The field names themselves (the part inside the parenthesis) can also have some special formatting:
899 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
900 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`
901 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`
902 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`
904 To summarize, the general syntax for a field is:
906 %(name[.keys][addition][>strf][|default])[flags][width][.precision][length]type
909 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.
911 The available fields are:
913 - `id` (string): Video identifier
914 - `title` (string): Video title
915 - `url` (string): Video URL
916 - `ext` (string): Video filename extension
917 - `alt_title` (string): A secondary title of the video
918 - `description` (string): The description of the video
919 - `display_id` (string): An alternative identifier for the video
920 - `uploader` (string): Full name of the video uploader
921 - `license` (string): License name the video is licensed under
922 - `creator` (string): The creator of the video
923 - `release_date` (string): The date (YYYYMMDD) when the video was released
924 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
925 - `upload_date` (string): Video upload date (YYYYMMDD)
926 - `uploader_id` (string): Nickname or id of the video uploader
927 - `channel` (string): Full name of the channel the video is uploaded on
928 - `channel_id` (string): Id of the channel
929 - `location` (string): Physical location where the video was filmed
930 - `duration` (numeric): Length of the video in seconds
931 - `duration_string` (string): Length of the video (HH:mm:ss)
932 - `view_count` (numeric): How many users have watched the video on the platform
933 - `like_count` (numeric): Number of positive ratings of the video
934 - `dislike_count` (numeric): Number of negative ratings of the video
935 - `repost_count` (numeric): Number of reposts of the video
936 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
937 - `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)
938 - `age_limit` (numeric): Age restriction for the video (years)
939 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
940 - `was_live` (boolean): Whether this video was originally a live stream
941 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
942 - `availability` (string): Whether the video is 'private', 'premium_only', 'subscriber_only', 'needs_auth', 'unlisted' or 'public'
943 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
944 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
945 - `format` (string): A human-readable description of the format
946 - `format_id` (string): Format code specified by
`--format`
947 - `format_note` (string): Additional info about the format
948 - `width` (numeric): Width of the video
949 - `height` (numeric): Height of the video
950 - `resolution` (string): Textual description of width and height
951 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
952 - `abr` (numeric): Average audio bitrate in KBit/s
953 - `acodec` (string): Name of the audio codec in use
954 - `asr` (numeric): Audio sampling rate in Hertz
955 - `vbr` (numeric): Average video bitrate in KBit/s
956 - `fps` (numeric): Frame rate
957 - `vcodec` (string): Name of the video codec in use
958 - `container` (string): Name of the container format
959 - `filesize` (numeric): The number of bytes, if known in advance
960 - `filesize_approx` (numeric): An estimate for the number of bytes
961 - `protocol` (string): The protocol that will be used for the actual download
962 - `extractor` (string): Name of the extractor
963 - `extractor_key` (string): Key name of the extractor
964 - `epoch` (numeric): Unix epoch when creating the file
965 - `autonumber` (numeric): Number that will be increased with each download, starting at
`--autonumber-start`
966 - `playlist` (string): Name or id of the playlist that contains the video
967 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
968 - `playlist_id` (string): Playlist identifier
969 - `playlist_title` (string): Playlist title
970 - `playlist_uploader` (string): Full name of the playlist uploader
971 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
972 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
973 - `original_url` (string): The URL given by the user (or same as
`webpage_url` for playlist entries)
975 Available for the video that belongs to some logical chapter or section:
977 - `chapter` (string): Name or title of the chapter the video belongs to
978 - `chapter_number` (numeric): Number of the chapter the video belongs to
979 - `chapter_id` (string): Id of the chapter the video belongs to
981 Available for the video that is an episode of some series or programme:
983 - `series` (string): Title of the series or programme the video episode belongs to
984 - `season` (string): Title of the season the video episode belongs to
985 - `season_number` (numeric): Number of the season the video episode belongs to
986 - `season_id` (string): Id of the season the video episode belongs to
987 - `episode` (string): Title of the video episode
988 - `episode_number` (numeric): Number of the video episode within a season
989 - `episode_id` (string): Id of the video episode
991 Available for the media that is a track or a part of a music album:
993 - `track` (string): Title of the track
994 - `track_number` (numeric): Number of the track within an album or a disc
995 - `track_id` (string): Id of the track
996 - `artist` (string): Artist(s) of the track
997 - `genre` (string): Genre(s) of the track
998 - `album` (string): Title of the album the track belongs to
999 - `album_type` (string): Type of the album
1000 - `album_artist` (string): List of all artists appeared on the album
1001 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1002 - `release_year` (numeric): Year (YYYY) when the album was released
1004 Available for
`chapter:` prefix when using
`--split-chapters` for videos with internal chapters:
1006 - `section_title` (string): Title of the chapter
1007 - `section_number` (numeric): Number of the chapter within the file
1008 - `section_start` (numeric): Start time of the chapter in seconds
1009 - `section_end` (numeric): End time of the chapter in seconds
1011 Available only when used in
`--print`:
1013 - `urls` (string): The URLs of all requested formats, one in each line
1014 - `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
1016 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).
1018 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.
1020 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`.
1022 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.
1024 To use percent literals in an output template use
`%%`. To output to stdout use
`-o -`.
1026 The current default template is
`%(title)s [%(id)s].%(ext)s`.
1028 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:
1030 #### Output template and Windows batch files
1032 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"`.
1034 #### Output template examples
1036 Note that on Windows you need to use double quotes instead of single.
1039 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
1040 youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
1042 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
1043 youtube-dl_test_video_.mp4 # A simple file name
1045 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1046 $ yt-dlp -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1048 # Download YouTube playlist videos in separate directories according to their uploaded year
1049 $ yt-dlp -o '%(upload_date>%Y)s/%(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1051 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1052 $ yt-dlp -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
1054 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1055 $ 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/
1057 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1058 $ 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
1060 # Stream the video being downloaded to stdout
1061 $ yt-dlp -o - BaW_jenozKc
1066 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1067 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`.
1069 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.
1071 **tl;dr:** [navigate me to examples](#format-selection-examples).
1073 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.
1075 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.
1077 You can also use special names to select particular edge case formats:
1079 - `all`: Select all formats
1080 - `mergeall`: Select and merge all formats (Must be used with
`--audio-multistreams`,
`--video-multistreams` or both)
1081 - `b*`,
`best*`: Select the best quality format irrespective of whether it contains video or audio
1082 - `w*`,
`worst*`: Select the worst quality format irrespective of whether it contains video or audio
1083 - `b`,
`best`: Select the best quality format that contains both video and audio. Equivalent to
`best*[vcodec!=none][acodec!=none]`
1084 - `w`,
`worst`: Select the worst quality format that contains both video and audio. Equivalent to
`worst*[vcodec!=none][acodec!=none]`
1085 - `bv`,
`bestvideo`: Select the best quality video-only format. Equivalent to
`best*[acodec=none]`
1086 - `wv`,
`worstvideo`: Select the worst quality video-only format. Equivalent to
`worst*[acodec=none]`
1087 - `bv*`,
`bestvideo*`: Select the best quality format that contains video. It may also contain audio. Equivalent to
`best*[vcodec!=none]`
1088 - `wv*`,
`worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to
`worst*[vcodec!=none]`
1089 - `ba`,
`bestaudio`: Select the best quality audio-only format. Equivalent to
`best*[vcodec=none]`
1090 - `wa`,
`worstaudio`: Select the worst quality audio-only format. Equivalent to
`worst*[vcodec=none]`
1091 - `ba*`,
`bestaudio*`: Select the best quality format that contains audio. It may also contain video. Equivalent to
`best*[acodec!=none]`
1092 - `wa*`,
`worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to
`worst*[acodec!=none]`
1094 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.
1096 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.
1098 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.
1100 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`.
1102 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`.
1104 ## Filtering Formats
1106 You can also filter the video formats by putting a condition in brackets, as in
`-f "best[height=720]"` (or
`-f "[filesize>10M]"`).
1108 The following numeric meta fields can be used with comparisons
`<`,
`<=`,
`>`,
`>=`,
`=` (equals),
`!=` (not equals):
1110 - `filesize`: The number of bytes, if known in advance
1111 - `width`: Width of the video, if known
1112 - `height`: Height of the video, if known
1113 - `tbr`: Average bitrate of audio and video in KBit/s
1114 - `abr`: Average audio bitrate in KBit/s
1115 - `vbr`: Average video bitrate in KBit/s
1116 - `asr`: Audio sampling rate in Hertz
1119 Also filtering work for comparisons
`=` (equals),
`^=` (starts with),
`$=` (ends with),
`*=` (contains) and following string meta fields:
1121 - `ext`: File extension
1122 - `acodec`: Name of the audio codec in use
1123 - `vcodec`: Name of the video codec in use
1124 - `container`: Name of the container format
1125 - `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`)
1126 - `format_id`: A short description of the format
1127 - `language`: Language code
1129 Any string comparison may be prefixed with negation
`!` in order to produce an opposite comparison, e.g.
`!*=` (does not contain).
1131 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.
1133 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.
1135 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]'`.
1139 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:
1141 - `hasvid`: Gives priority to formats that has a video stream
1142 - `hasaud`: Gives priority to formats that has a audio stream
1143 - `ie_pref`: The format preference as given by the extractor
1144 - `lang`: Language preference as given by the extractor
1145 - `quality`: The quality of the format as given by the extractor
1146 - `source`: Preference of the source as given by the extractor
1147 - `proto`: Protocol used for download (
`https`/
`ftps` >
`http`/
`ftp` >
`m3u8_native`/
`m3u8` >
`http_dash_segments`>
`websocket_frag` > other >
`mms`/
`rtsp` > unknown >
`f4f`/
`f4m`)
1148 - `vcodec`: Video Codec (
`av01` >
`vp9.2` >
`vp9` >
`h265` >
`h264` >
`vp8` >
`h263` >
`theora` > other > unknown)
1149 - `acodec`: Audio Codec (
`opus` >
`vorbis` >
`aac` >
`mp4a` >
`mp3` >
`ac3` >
`dts` > other > unknown)
1150 - `codec`: Equivalent to
`vcodec,acodec`
1151 - `vext`: Video Extension (
`mp4` >
`webm` >
`flv` > other > unknown). If
`--prefer-free-formats` is used,
`webm` is prefered.
1152 - `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`.
1153 - `ext`: Equivalent to
`vext,aext`
1154 - `filesize`: Exact filesize, if know in advance. This will be unavailable for mu38 and DASH formats.
1155 - `fs_approx`: Approximate filesize calculated from the manifests
1156 - `size`: Exact filesize if available, otherwise approximate filesize
1157 - `height`: Height of video
1158 - `width`: Width of video
1159 - `res`: Video resolution, calculated as the smallest dimension.
1160 - `fps`: Framerate of video
1161 - `tbr`: Total average bitrate in KBit/s
1162 - `vbr`: Average video bitrate in KBit/s
1163 - `abr`: Average audio bitrate in KBit/s
1164 - `br`: Equivalent to using
`tbr,vbr,abr`
1165 - `asr`: Audio sample rate in Hz
1167 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.
1169 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.
1171 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`.
1173 **Tip**: You can use the
`-v -F` to see how the formats have been sorted (worst to best).
1175 ## Format Selection examples
1177 Note that on Windows you may need to use double quotes instead of single.
1180 # Download and merge the best video-only format and the best audio-only format,
1181 # or download the best combined format if video-only format is not available
1182 $ yt-dlp -f 'bv+ba/b'
1184 # Download best format that contains video,
1185 # and if it doesn't already have an audio stream, merge it with best audio-only format
1186 $ yt-dlp -f 'bv*+ba/b'
1191 # Download the best video-only format and the best audio-only format without merging them
1192 # For this case, an output template should be used since
1193 # by default, bestvideo and bestaudio will have the same file name.
1194 $ yt-dlp -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s'
1196 # Download and merge the best format that has a video stream,
1197 # and all audio-only formats into one file
1198 $ yt-dlp -f 'bv*+mergeall[vcodec=none]' --audio-multistreams
1200 # Download and merge the best format that has a video stream,
1201 # and the best 2 audio-only formats into one file
1202 $ yt-dlp -f 'bv*+ba+ba.2' --audio-multistreams
1205 # The following examples show the old method (without -S) of format selection
1206 # and how to use -S to achieve a similar but (generally) better result
1208 # Download the worst video available (old method)
1209 $ yt-dlp -f 'wv*+wa/w'
1211 # Download the best video available but with the smallest resolution
1214 # Download the smallest video available
1215 $ yt-dlp -S '+size,+br'
1219 # Download the best mp4 video available, or the best video if no mp4 available
1220 $ yt-dlp -f 'bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b'
1222 # Download the best video with the best extension
1223 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1228 # Download the best video available but no better than 480p,
1229 # or the worst video if there is no video under 480p
1230 $ yt-dlp -f 'bv*[height<=480]+ba/b[height<=480] / wv*+ba/w'
1232 # Download the best video available with the largest height but no better than 480p,
1233 # or the best video with the smallest resolution if there is no video under 480p
1234 $ yt-dlp -S 'height:480'
1236 # Download the best video available with the largest resolution but no better than 480p,
1237 # or the best video with the smallest resolution if there is no video under 480p
1238 # Resolution is determined by using the smallest dimension.
1239 # So this works correctly for vertical videos as well
1240 $ yt-dlp -S 'res:480'
1244 # Download the best video (that also has audio) but no bigger than 50 MB,
1245 # or the worst video (that also has audio) if there is no video under 50 MB
1246 $ yt-dlp -f 'b[filesize<50M] / w'
1248 # Download largest video (that also has audio) but no bigger than 50 MB,
1249 # or the smallest video (that also has audio) if there is no video under 50 MB
1250 $ yt-dlp -f 'b' -S 'filesize:50M'
1252 # Download best video (that also has audio) that is closest in size to 50 MB
1253 $ yt-dlp -f 'b' -S 'filesize~50M'
1257 # Download best video available via direct link over HTTP/HTTPS protocol,
1258 # or the best video available via any protocol if there is no such video
1259 $ yt-dlp -f '(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)'
1261 # Download best video available via the best protocol
1262 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1267 # Download the best video with h264 codec, or the best video if there is no such video
1268 $ yt-dlp -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'
1270 # Download the best video with best codec no better than h264,
1271 # or the best video with worst codec if there is no such video
1272 $ yt-dlp -S 'codec:h264'
1274 # Download the best video with worst codec no worse than h264,
1275 # or the best video with best codec if there is no such video
1276 $ yt-dlp -S '+codec:h264'
1280 # More complex examples
1282 # Download the best video no better than 720p preferring framerate greater than 30,
1283 # or the worst video (still preferring framerate greater than 30) if there is no such video
1284 $ yt-dlp -f '((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)'
1286 # Download the video with the largest resolution no better than 720p,
1287 # or the video with the smallest resolution available if there is no such video,
1288 # preferring larger framerate for formats with the same resolution
1289 $ yt-dlp -S 'res:720,fps'
1293 # Download the video with smallest resolution no worse than 480p,
1294 # or the video with the largest resolution available if there is no such video,
1295 # preferring better codec and then larger total bitrate for the same resolution
1296 $ yt-dlp -S '+res:480,codec,br'
1299 # MODIFYING METADATA
1301 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.
1303 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`.
1305 This option also has a few special uses:
1306 * 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
1307 * 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
1309 ## Modifying metadata examples
1311 Note that on Windows you may need to use double quotes instead of single.
1314 # Interpret the title as "Artist - Title"
1315 $ yt-dlp --parse-metadata 'title:%(artist)s - %(title)s'
1318 $ yt-dlp --parse-metadata 'description:Artist - (?P<artist>.+)'
1320 # Set title as "Series name S01E05"
1321 $ yt-dlp --parse-metadata '%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s'
1323 # Set "comment" field in video metadata using description instead of webpage_url
1324 $ yt-dlp --parse-metadata 'description:(?s)(?P<meta_comment>.+)' --add-metadata
1328 # EXTRACTOR ARGUMENTS
1330 Some extractors accept additional arguments which can be passed using
`--extractor-args KEY:ARGS`.
`ARGS` is a
`;` (colon) seperated string of
`ARG=VAL1,VAL2`. Eg:
`--extractor-args youtube:skip=dash,hls`
1332 The following extractors use this feature:
1334 * `skip`:
`hls` or
`dash` (or both) to skip download of the respective manifests
1335 * `player_client`:
`web`(default) or
`android` (force use the android client fallbacks for video extraction)
1336 * `player_skip`:
`configs`- skip requests if applicable for client configs and use defaults
1340 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.
1342 **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`)
1344 # DEPRECATED OPTIONS
1346 These are all the deprecated options and the current alternative to achieve the same effect
1348 #### Not recommended
1349 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1351 --get-description --print description
1352 --get-duration --print duration_string
1353 --get-filename --print filename
1354 --get-format --print format
1356 --get-thumbnail --print thumbnail
1357 -e, --get-title --print title
1358 -g, --get-url --print urls
1359 --all-formats -f all
1360 --all-subs --sub-langs all --write-subs
1361 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)
03d
1362 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1363 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1364 --hls-prefer-native --downloader "m3u8:native"
1365 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1366 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1367 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1368 --sponskrub-args ARGS --ppa "sponskrub:ARGS"
1369 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
1370 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
1371 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
1372 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
1373 --test Used by developers for testing extractors. Not intended for the end user
1374 --youtube-print-sig-code Used for testing youtube signatures
1378 These are aliases that are no longer documented for various reasons
1380 --avconv-location --ffmpeg-location
1381 --cn-verification-proxy URL --geo-verification-proxy URL
1382 --dump-headers --print-traffic
1383 --dump-intermediate-pages --dump-pages
1384 --force-write-download-archive --force-write-archive
1385 --load-info --load-info-json
1386 --no-split-tracks --no-split-chapters
1387 --no-write-srt --no-write-subs
1388 --prefer-unsecure --prefer-insecure
1389 --rate-limit RATE --limit-rate RATE
1390 --split-tracks --split-chapters
1391 --srt-lang LANGS --sub-langs LANGS
1392 --trim-file-names LENGTH --trim-filenames LENGTH
1393 --write-srt --write-subs
1394 --yes-overwrites --force-overwrites
1396 #### No longer supported
1397 These options may no longer work as intended
1399 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
1400 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
1401 -C, --call-home Not implemented
1402 --no-call-home Default
1403 --include-ads No longer supported
1404 --no-include-ads Default
1407 These options were deprecated since
2014 and have now been entirely removed
1409 --id -o "%(id)s.%(ext)s"
1410 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
1411 -t, --title -o "%(title)s-%(id)s.%(ext)s"
1412 -l, --literal -o accepts literal names
1416 For FAQ, Developer Instructions etc., see the
[original README](https://github.com/ytdl-org/youtube-dl#faq)
projects / yt-dlp.git / blob