11 from .compat
import compat_expanduser
12 from .cookies
import SUPPORTED_BROWSERS
, SUPPORTED_KEYRINGS
13 from .downloader
.external
import list_external_downloaders
14 from .postprocessor
import (
17 FFmpegSubtitlesConvertorPP
,
18 FFmpegThumbnailsConvertorPP
,
22 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
23 from .update
import UPDATE_SOURCES
, detect_variant
, is_non_updateable
32 get_system_config_dirs
,
35 orderedSet_from_options
,
40 from .version
import CHANNEL
, __version__
43 def parseOpts(overrideArguments
=None, ignore_config_files
='if_override'): # noqa: N803
44 PACKAGE_NAME
= 'yt-dlp'
46 root
= Config(create_parser())
47 if ignore_config_files
== 'if_override':
48 ignore_config_files
= overrideArguments
is not None
50 def read_config(*paths
):
51 path
= os
.path
.join(*paths
)
52 conf
= Config
.read_file(path
, default
=None)
56 def _load_from_config_dirs(config_dirs
):
57 for config_dir
in config_dirs
:
58 head
, tail
= os
.path
.split(config_dir
)
59 assert tail
== PACKAGE_NAME
or config_dir
== os
.path
.join(compat_expanduser('~'), f
'.{PACKAGE_NAME}')
61 yield read_config(head
, f
'{PACKAGE_NAME}.conf')
62 if tail
.startswith('.'): # ~/.PACKAGE_NAME
63 yield read_config(head
, f
'{PACKAGE_NAME}.conf.txt')
64 yield read_config(config_dir
, 'config')
65 yield read_config(config_dir
, 'config.txt')
67 def add_config(label
, path
=None, func
=None):
68 """ Adds config and returns whether to continue """
69 if root
.parse_known_args()[0].ignoreconfig
:
73 args
, current_path
= next(
74 filter(None, _load_from_config_dirs(func(PACKAGE_NAME
))), (None, None))
76 current_path
= os
.path
.join(path
, 'yt-dlp.conf')
77 args
= Config
.read_file(current_path
, default
=None)
79 root
.append_config(args
, current_path
, label
=label
)
83 yield not ignore_config_files
84 yield add_config('Portable', get_executable_path())
85 yield add_config('Home', expand_path(root
.parse_known_args()[0].paths
.get('home', '')).strip())
86 yield add_config('User', func
=get_user_config_dirs
)
87 yield add_config('System', func
=get_system_config_dirs
)
89 opts
= optparse
.Values({'verbose': True, 'print_help': False})
92 if overrideArguments
is not None:
93 root
.append_config(overrideArguments
, label
='Override')
95 root
.append_config(sys
.argv
[1:], label
='Command-line')
96 loaded_all_configs
= all(load_configs())
97 except ValueError as err
:
98 raise root
.parser
.error(err
)
100 if loaded_all_configs
:
101 # If ignoreconfig is found inside the system configuration file,
102 # the user configuration is removed
103 if root
.parse_known_args()[0].ignoreconfig
:
104 user_conf
= next((i
for i
, conf
in enumerate(root
.configs
) if conf
.label
== 'User'), None)
105 if user_conf
is not None:
106 root
.configs
.pop(user_conf
)
109 root
.configs
[0].load_configs() # Resolve any aliases using --config-location
110 except ValueError as err
:
111 raise root
.parser
.error(err
)
113 opts
, args
= root
.parse_args()
114 except optparse
.OptParseError
:
115 with contextlib
.suppress(optparse
.OptParseError
):
116 opts
, _
= root
.parse_known_args(strict
=False)
118 except (SystemExit, KeyboardInterrupt):
122 verbose
= opts
.verbose
and f
'\n{root}'.replace('\n| ', '\n[debug] ')[1:]
124 write_string(f
'{verbose}\n')
128 root
.parser
.print_help()
131 return root
.parser
, opts
, args
134 class _YoutubeDLHelpFormatter(optparse
.IndentedHelpFormatter
):
136 # No need to wrap help messages if we're on a wide console
137 max_width
= shutil
.get_terminal_size().columns
or 80
138 # The % is chosen to get a pretty output in README.md
139 super().__init
__(width
=max_width
, max_help_position
=int(0.45 * max_width
))
142 def format_option_strings(option
):
143 """ ('-o', '--option') -> -o, --format METAVAR """
144 opts
= join_nonempty(
145 option
._short
_opts
and option
._short
_opts
[0],
146 option
._long
_opts
and option
._long
_opts
[0],
148 if option
.takes_value():
149 opts
+= f
' {option.metavar}'
153 class _YoutubeDLOptionParser(optparse
.OptionParser
):
154 # optparse is deprecated since Python 3.2. So assume a stable interface even for private methods
155 ALIAS_DEST
= '_triggered_aliases'
156 ALIAS_TRIGGER_LIMIT
= 100
160 prog
='yt-dlp' if detect_variant() == 'source' else None,
162 usage
='%prog [OPTIONS] URL [URL...]',
163 epilog
='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
164 formatter
=_YoutubeDLHelpFormatter(),
165 conflict_handler
='resolve',
167 self
.set_default(self
.ALIAS_DEST
, collections
.defaultdict(int))
169 _UNKNOWN_OPTION
= (optparse
.BadOptionError
, optparse
.AmbiguousOptionError
)
170 _BAD_OPTION
= optparse
.OptionValueError
172 def parse_known_args(self
, args
=None, values
=None, strict
=True):
173 """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args"""
174 self
.rargs
, self
.largs
= self
._get
_args
(args
), []
175 self
.values
= values
or self
.get_default_values()
182 elif arg
.startswith('--'):
183 self
._process
_long
_opt
(self
.rargs
, self
.values
)
184 elif arg
.startswith('-') and arg
!= '-':
185 self
._process
_short
_opts
(self
.rargs
, self
.values
)
186 elif self
.allow_interspersed_args
:
187 self
.largs
.append(self
.rargs
.pop(0))
190 except optparse
.OptParseError
as err
:
191 if isinstance(err
, self
._UNKNOWN
_OPTION
):
192 self
.largs
.append(err
.opt_str
)
194 if isinstance(err
, self
._BAD
_OPTION
):
197 return self
.check_values(self
.values
, self
.largs
)
199 def _generate_error_message(self
, msg
):
200 msg
= f
'{self.get_prog_name()}: error: {str(msg).strip()}\n'
201 return f
'{self.get_usage()}\n{msg}' if self
.usage
else msg
203 def error(self
, msg
):
204 raise optparse
.OptParseError(self
._generate
_error
_message
(msg
))
206 def _get_args(self
, args
):
207 return sys
.argv
[1:] if args
is None else list(args
)
209 def _match_long_opt(self
, opt
):
210 """Improve ambiguous argument resolution by comparing option objects instead of argument strings"""
212 return super()._match
_long
_opt
(opt
)
213 except optparse
.AmbiguousOptionError
as e
:
214 if len({self
._long
_opt
[p
] for p
in e
.possibilities
}) == 1:
215 return e
.possibilities
[0]
220 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
221 # append can be True, False or -1 (prepend)
222 current
= list(getattr(parser
.values
, option
.dest
)) if append
else []
223 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
225 parser
.values
, option
.dest
,
226 current
+ value
if append
is True else value
+ current
)
228 def _set_from_options_callback(
229 option
, opt_str
, value
, parser
, allowed_values
, delim
=',', aliases
={},
230 process
=lambda x
: x
.lower().strip()):
231 values
= [process(value
)] if delim
is None else map(process
, value
.split(delim
))
233 requested
= orderedSet_from_options(values
, collections
.ChainMap(aliases
, {'all': allowed_values
}),
234 start
=getattr(parser
.values
, option
.dest
))
235 except ValueError as e
:
236 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {e.args[0]}')
238 setattr(parser
.values
, option
.dest
, set(requested
))
240 def _dict_from_options_callback(
241 option
, opt_str
, value
, parser
,
242 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True,
243 process_key
=str.lower
, append
=False):
245 out_dict
= dict(getattr(parser
.values
, option
.dest
))
246 multiple_args
= not isinstance(value
, str)
248 allowed_keys
= fr
'({allowed_keys})(,({allowed_keys}))*'
250 fr
'(?is)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
251 value
[0] if multiple_args
else value
)
253 keys
, val
= mobj
.group('keys').split(','), mobj
.group('val')
255 val
= [val
, *value
[1:]]
256 elif default_key
is not None:
257 keys
, val
= variadic(default_key
), value
259 raise optparse
.OptionValueError(
260 f
'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
262 keys
= map(process_key
, keys
) if process_key
else keys
263 val
= process(val
) if process
else val
264 except Exception as err
:
265 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
267 out_dict
[key
] = [*out_dict
.get(key
, []), val
] if append
else val
268 setattr(parser
.values
, option
.dest
, out_dict
)
270 def when_prefix(default
):
274 'action': 'callback',
275 'callback': _dict_from_options_callback
,
277 'allowed_keys': '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
278 'default_key': default
,
279 'multiple_keys': False,
284 parser
= _YoutubeDLOptionParser()
285 alias_group
= optparse
.OptionGroup(parser
, 'Aliases')
286 Formatter
= string
.Formatter()
288 def _create_alias(option
, opt_str
, value
, parser
):
289 aliases
, opts
= value
291 nargs
= len({i
if f
== '' else f
292 for i
, (_
, f
, _
, _
) in enumerate(Formatter
.parse(opts
)) if f
is not None})
293 opts
.format(*map(str, range(nargs
))) # validate
294 except Exception as err
:
295 raise optparse
.OptionValueError(f
'wrong {opt_str} OPTIONS formatting; {err}')
296 if alias_group
not in parser
.option_groups
:
297 parser
.add_option_group(alias_group
)
299 aliases
= (x
if x
.startswith('-') else f
'--{x}' for x
in map(str.strip
, aliases
.split(',')))
301 args
= [f
'ARG{i}' for i
in range(nargs
)]
302 alias_group
.add_option(
303 *aliases
, nargs
=nargs
, dest
=parser
.ALIAS_DEST
, type='str' if nargs
else None,
304 metavar
=' '.join(args
), help=opts
.format(*args
), action
='callback',
305 callback
=_alias_callback
, callback_kwargs
={'opts': opts
, 'nargs': nargs
})
306 except Exception as err
:
307 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
309 def _alias_callback(option
, opt_str
, value
, parser
, opts
, nargs
):
310 counter
= getattr(parser
.values
, option
.dest
)
311 counter
[opt_str
] += 1
312 if counter
[opt_str
] > parser
.ALIAS_TRIGGER_LIMIT
:
313 raise optparse
.OptionValueError(f
'Alias {opt_str} exceeded invocation limit')
316 assert (nargs
== 0 and value
is None) or len(value
) == nargs
317 parser
.rargs
[:0] = shlex
.split(
318 opts
if value
is None else opts
.format(*map(shlex
.quote
, value
)))
320 general
= optparse
.OptionGroup(parser
, 'General Options')
322 '-h', '--help', dest
='print_help', action
='store_true',
323 help='Print this help text and exit')
327 help='Print program version and exit')
330 action
='store_const', dest
='update_self', const
=CHANNEL
,
332 is_non_updateable(), None, 'Check if updates are available. %s',
333 default
=f
'Update this program to the latest {CHANNEL} version'))
336 action
='store_false', dest
='update_self',
337 help='Do not check for updates (default)')
340 action
='store', dest
='update_self', metavar
='[CHANNEL]@[TAG]',
342 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. '
343 f
'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; '
344 f
'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}'))
346 '-i', '--ignore-errors',
347 action
='store_true', dest
='ignoreerrors',
348 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
350 '--no-abort-on-error',
351 action
='store_const', dest
='ignoreerrors', const
='only_download',
352 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
354 '--abort-on-error', '--no-ignore-errors',
355 action
='store_false', dest
='ignoreerrors',
356 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
359 action
='store_true', dest
='dump_user_agent', default
=False,
360 help='Display the current user-agent and exit')
363 action
='store_true', dest
='list_extractors', default
=False,
364 help='List all supported extractors and exit')
366 '--extractor-descriptions',
367 action
='store_true', dest
='list_extractor_descriptions', default
=False,
368 help='Output descriptions of all supported extractors and exit')
370 '--use-extractors', '--ies',
371 action
='callback', dest
='allowed_extractors', metavar
='NAMES', type='str',
372 default
=[], callback
=_list_from_options_callback
,
374 'Extractor names to use separated by commas. '
375 'You can also use regexes, "all", "default" and "end" (end URL matching); '
376 'e.g. --ies "holodex.*,end,youtube". '
377 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. '
378 'Use --list-extractors for a list of extractor names. (Alias: --ies)'))
380 '--force-generic-extractor',
381 action
='store_true', dest
='force_generic_extractor', default
=False,
382 help=optparse
.SUPPRESS_HELP
)
385 dest
='default_search', metavar
='PREFIX',
387 'Use this prefix for unqualified URLs. '
388 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". '
389 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
390 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
391 'but emits an error if this is not possible instead of searching'))
393 '--ignore-config', '--no-config',
394 action
='store_true', dest
='ignoreconfig',
396 'Don\'t load any more configuration files except those given to --config-locations. '
397 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
398 '(Alias: --no-config)'))
400 '--no-config-locations',
401 action
='store_const', dest
='config_locations', const
=[],
403 'Do not load any custom configuration files (default). When given inside a '
404 'configuration file, ignore all previous --config-locations defined in the current file'))
406 '--config-locations',
407 dest
='config_locations', metavar
='PATH', action
='append',
409 'Location of the main configuration file; either the path to the config or its containing directory '
410 '("-" for stdin). Can be used multiple times and inside other configuration files'))
413 dest
='plugin_dirs', metavar
='PATH', action
='append',
415 'Path to an additional directory to search for plugins. '
416 'This option can be used multiple times to add multiple directories. '
417 'Note that this currently only works for extractor plugins; '
418 'postprocessor plugins can only be loaded from the default plugin directories'))
421 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
422 help='Do not extract the videos of a playlist, only list them')
424 '--no-flat-playlist',
425 action
='store_false', dest
='extract_flat',
426 help='Fully extract the videos of a playlist (default)')
429 action
='store_true', dest
='live_from_start',
430 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
432 '--no-live-from-start',
433 action
='store_false', dest
='live_from_start',
434 help='Download livestreams from the current time (default)')
437 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
439 'Wait for scheduled streams to become available. '
440 'Pass the minimum number of seconds (or range) to wait between retries'))
442 '--no-wait-for-video',
443 dest
='wait_for_video', action
='store_const', const
=None,
444 help='Do not wait for scheduled streams (default)')
447 action
='store_true', dest
='mark_watched', default
=False,
448 help='Mark videos watched (even with --simulate)')
451 action
='store_false', dest
='mark_watched',
452 help='Do not mark videos watched (default)')
454 '--no-colors', '--no-colours',
455 action
='store_const', dest
='color', const
={
456 'stdout': 'no_color',
457 'stderr': 'no_color',
459 help=optparse
.SUPPRESS_HELP
)
462 dest
='color', metavar
='[STREAM:]POLICY', default
={}, type='str',
463 action
='callback', callback
=_dict_from_options_callback
,
465 'allowed_keys': 'stdout|stderr',
466 'default_key': ['stdout', 'stderr'],
467 'process': str.strip
,
469 'Whether to emit color codes in output, optionally prefixed by '
470 'the STREAM (stdout or stderr) to apply the setting to. '
471 'Can be one of "always", "auto" (default), "never", or '
472 '"no_color" (use non color terminal sequences). '
473 'Use "auto-tty" or "no_color-tty" to decide based on terminal support only. '
474 'Can be used multiple times'))
477 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
478 action
='callback', callback
=_set_from_options_callback
,
481 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
482 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', 'playlist-match-filter',
483 'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress',
484 'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
485 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
486 'prefer-legacy-http-handler', 'manifest-filesize-approx', 'allow-unsafe-ext', 'prefer-vp9-sort',
488 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext', '-prefer-vp9-sort'],
489 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext', '-prefer-vp9-sort'],
490 '2021': ['2022', 'no-certifi', 'filename-sanitization'],
491 '2022': ['2023', 'no-external-downloader-progress', 'playlist-match-filter', 'prefer-legacy-http-handler', 'manifest-filesize-approx'],
492 '2023': ['prefer-vp9-sort'],
495 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
496 'configurations by reverting some of the changes made in yt-dlp. '
497 'See "Differences in default behavior" for details'))
499 '--alias', metavar
='ALIASES OPTIONS', dest
='_', type='str', nargs
=2,
500 action
='callback', callback
=_create_alias
,
502 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
503 'Arguments are parsed according to the Python string formatting mini-language. '
504 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
505 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
506 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
507 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
508 f
'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
509 'This option can be used multiple times'))
511 network
= optparse
.OptionGroup(parser
, 'Network Options')
513 '--proxy', dest
='proxy',
514 default
=None, metavar
='URL',
516 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
517 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
520 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
521 help='Time to wait before giving up, in seconds')
524 metavar
='IP', dest
='source_address', default
=None,
525 help='Client-side IP address to bind to',
529 metavar
='CLIENT[:OS]', dest
='impersonate', default
=None,
531 'Client to impersonate for requests. E.g. chrome, chrome-110, chrome:windows-10. '
532 'Pass --impersonate="" to impersonate any client. Note that forcing impersonation '
533 'for all requests may have a detrimental impact on download speed and stability'),
536 '--list-impersonate-targets',
537 dest
='list_impersonate_targets', default
=False, action
='store_true',
538 help='List available clients to impersonate.',
541 '-4', '--force-ipv4',
542 action
='store_const', const
='0.0.0.0', dest
='source_address',
543 help='Make all connections via IPv4',
546 '-6', '--force-ipv6',
547 action
='store_const', const
='::', dest
='source_address',
548 help='Make all connections via IPv6',
551 '--enable-file-urls', action
='store_true',
552 dest
='enable_file_urls', default
=False,
553 help='Enable file:// URLs. This is disabled by default for security reasons.',
556 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
558 '--geo-verification-proxy',
559 dest
='geo_verification_proxy', default
=None, metavar
='URL',
561 'Use this proxy to verify the IP address for some geo-restricted sites. '
562 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
564 '--cn-verification-proxy',
565 dest
='cn_verification_proxy', default
=None, metavar
='URL',
566 help=optparse
.SUPPRESS_HELP
)
568 '--xff', metavar
='VALUE',
569 dest
='geo_bypass', default
='default',
571 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
572 'One of "default" (only when known to be useful), "never", '
573 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
576 action
='store_const', dest
='geo_bypass', const
='default',
577 help=optparse
.SUPPRESS_HELP
)
580 action
='store_const', dest
='geo_bypass', const
='never',
581 help=optparse
.SUPPRESS_HELP
)
583 '--geo-bypass-country', metavar
='CODE', dest
='geo_bypass',
584 help=optparse
.SUPPRESS_HELP
)
586 '--geo-bypass-ip-block', metavar
='IP_BLOCK', dest
='geo_bypass',
587 help=optparse
.SUPPRESS_HELP
)
589 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
590 selection
.add_option(
592 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
593 help=optparse
.SUPPRESS_HELP
)
594 selection
.add_option(
596 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
597 help=optparse
.SUPPRESS_HELP
)
598 selection
.add_option(
599 '-I', '--playlist-items',
600 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
602 'Comma separated playlist_index of the items to download. '
603 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
604 'Use negative indices to count from the right and negative STEP to download in reverse order. '
605 'E.g. "-I 1:3,7,-5::2" used on a playlist of size 15 will download the items at index 1,2,3,7,11,13,15'))
606 selection
.add_option(
608 dest
='matchtitle', metavar
='REGEX',
609 help=optparse
.SUPPRESS_HELP
)
610 selection
.add_option(
612 dest
='rejecttitle', metavar
='REGEX',
613 help=optparse
.SUPPRESS_HELP
)
614 selection
.add_option(
616 metavar
='SIZE', dest
='min_filesize', default
=None,
617 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
618 selection
.add_option(
620 metavar
='SIZE', dest
='max_filesize', default
=None,
621 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
622 selection
.add_option(
624 metavar
='DATE', dest
='date', default
=None,
626 'Download only videos uploaded on this date. '
627 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
628 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
629 selection
.add_option(
631 metavar
='DATE', dest
='datebefore', default
=None,
633 'Download only videos uploaded on or before this date. '
634 'The date formats accepted are the same as --date'))
635 selection
.add_option(
637 metavar
='DATE', dest
='dateafter', default
=None,
639 'Download only videos uploaded on or after this date. '
640 'The date formats accepted are the same as --date'))
641 selection
.add_option(
643 metavar
='COUNT', dest
='min_views', default
=None, type=int,
644 help=optparse
.SUPPRESS_HELP
)
645 selection
.add_option(
647 metavar
='COUNT', dest
='max_views', default
=None, type=int,
648 help=optparse
.SUPPRESS_HELP
)
649 selection
.add_option(
651 metavar
='FILTER', dest
='match_filter', action
='append',
653 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
654 'number or a string using the operators defined in "Filtering Formats". '
655 'You can also simply specify a field to match if the field is present, '
656 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
657 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
658 'the filter matches if at least one of the conditions is met. E.g. --match-filters '
659 '!is_live --match-filters "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
660 'matches only videos that are not live OR those that have a like count more than 100 '
661 '(or the like field is not available) and also has a description '
662 'that contains the phrase "cats & dogs" (caseless). '
663 'Use "--match-filters -" to interactively ask whether to download each video'))
664 selection
.add_option(
665 '--no-match-filters',
666 dest
='match_filter', action
='store_const', const
=None,
667 help='Do not use any --match-filters (default)')
668 selection
.add_option(
669 '--break-match-filters',
670 metavar
='FILTER', dest
='breaking_match_filter', action
='append',
671 help='Same as "--match-filters" but stops the download process when a video is rejected')
672 selection
.add_option(
673 '--no-break-match-filters',
674 dest
='breaking_match_filter', action
='store_const', const
=None,
675 help='Do not use any --break-match-filters (default)')
676 selection
.add_option(
678 action
='store_true', dest
='noplaylist', default
=False,
679 help='Download only the video, if the URL refers to a video and a playlist')
680 selection
.add_option(
682 action
='store_false', dest
='noplaylist',
683 help='Download the playlist, if the URL refers to a video and a playlist')
684 selection
.add_option(
686 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
687 help='Download only videos suitable for the given age')
688 selection
.add_option(
689 '--download-archive', metavar
='FILE',
690 dest
='download_archive',
691 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
692 selection
.add_option(
693 '--no-download-archive',
694 dest
='download_archive', action
='store_const', const
=None,
695 help='Do not use archive file (default)')
696 selection
.add_option(
698 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
699 help='Abort after downloading NUMBER files')
700 selection
.add_option(
701 '--break-on-existing',
702 action
='store_true', dest
='break_on_existing', default
=False,
703 help='Stop the download process when encountering a file that is in the archive '
704 'supplied with the --download-archive option')
705 selection
.add_option(
706 '--no-break-on-existing',
707 action
='store_false', dest
='break_on_existing',
708 help='Do not stop the download process when encountering a file that is in the archive (default)')
709 selection
.add_option(
711 action
='store_true', dest
='break_on_reject', default
=False,
712 help=optparse
.SUPPRESS_HELP
)
713 selection
.add_option(
715 action
='store_true', dest
='break_per_url', default
=False,
716 help='Alters --max-downloads, --break-on-existing, --break-match-filters, and autonumber to reset per input URL')
717 selection
.add_option(
718 '--no-break-per-input',
719 action
='store_false', dest
='break_per_url',
720 help='--break-on-existing and similar options terminates the entire download queue')
721 selection
.add_option(
722 '--skip-playlist-after-errors', metavar
='N',
723 dest
='skip_playlist_after_errors', default
=None, type=int,
724 help='Number of allowed failures until the rest of the playlist is skipped')
725 selection
.add_option(
727 dest
='include_ads', action
='store_true',
728 help=optparse
.SUPPRESS_HELP
)
729 selection
.add_option(
731 dest
='include_ads', action
='store_false',
732 help=optparse
.SUPPRESS_HELP
)
734 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
735 authentication
.add_option(
737 dest
='username', metavar
='USERNAME',
738 help='Login with this account ID')
739 authentication
.add_option(
741 dest
='password', metavar
='PASSWORD',
742 help='Account password. If this option is left out, yt-dlp will ask interactively')
743 authentication
.add_option(
745 dest
='twofactor', metavar
='TWOFACTOR',
746 help='Two-factor authentication code')
747 authentication
.add_option(
749 action
='store_true', dest
='usenetrc', default
=False,
750 help='Use .netrc authentication data')
751 authentication
.add_option(
753 dest
='netrc_location', metavar
='PATH',
754 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
755 authentication
.add_option(
757 dest
='netrc_cmd', metavar
='NETRC_CMD',
758 help='Command to execute to get the credentials for an extractor.')
759 authentication
.add_option(
761 dest
='videopassword', metavar
='PASSWORD',
762 help='Video-specific password')
763 authentication
.add_option(
765 dest
='ap_mso', metavar
='MSO',
766 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
767 authentication
.add_option(
769 dest
='ap_username', metavar
='USERNAME',
770 help='Multiple-system operator account login')
771 authentication
.add_option(
773 dest
='ap_password', metavar
='PASSWORD',
774 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
775 authentication
.add_option(
777 action
='store_true', dest
='ap_list_mso', default
=False,
778 help='List all supported multiple-system operators')
779 authentication
.add_option(
780 '--client-certificate',
781 dest
='client_certificate', metavar
='CERTFILE',
782 help='Path to client certificate file in PEM format. May include the private key')
783 authentication
.add_option(
784 '--client-certificate-key',
785 dest
='client_certificate_key', metavar
='KEYFILE',
786 help='Path to private key file for client certificate')
787 authentication
.add_option(
788 '--client-certificate-password',
789 dest
='client_certificate_password', metavar
='PASSWORD',
790 help='Password for client certificate private key, if encrypted. '
791 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
793 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
794 video_format
.add_option(
796 action
='store', dest
='format', metavar
='FORMAT', default
=None,
797 help='Video format code, see "FORMAT SELECTION" for more details')
798 video_format
.add_option(
799 '-S', '--format-sort', metavar
='SORTORDER',
800 dest
='format_sort', default
=[], type='str', action
='callback',
801 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1},
802 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
803 video_format
.add_option(
804 '--format-sort-force', '--S-force',
805 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
807 'Force user specified sort order to have precedence over all fields, '
808 'see "Sorting Formats" for more details (Alias: --S-force)'))
809 video_format
.add_option(
810 '--no-format-sort-force',
811 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
812 help='Some fields have precedence over the user specified sort order (default)')
813 video_format
.add_option(
814 '--video-multistreams',
815 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
816 help='Allow multiple video streams to be merged into a single file')
817 video_format
.add_option(
818 '--no-video-multistreams',
819 action
='store_false', dest
='allow_multiple_video_streams',
820 help='Only one video stream is downloaded for each output file (default)')
821 video_format
.add_option(
822 '--audio-multistreams',
823 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
824 help='Allow multiple audio streams to be merged into a single file')
825 video_format
.add_option(
826 '--no-audio-multistreams',
827 action
='store_false', dest
='allow_multiple_audio_streams',
828 help='Only one audio stream is downloaded for each output file (default)')
829 video_format
.add_option(
831 action
='store_const', dest
='format', const
='all',
832 help=optparse
.SUPPRESS_HELP
)
833 video_format
.add_option(
834 '--prefer-free-formats',
835 action
='store_true', dest
='prefer_free_formats', default
=False,
837 'Prefer video formats with free containers over non-free ones of the same quality. '
838 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
839 video_format
.add_option(
840 '--no-prefer-free-formats',
841 action
='store_false', dest
='prefer_free_formats', default
=False,
842 help="Don't give any special preference to free containers (default)")
843 video_format
.add_option(
845 action
='store_const', const
='selected', dest
='check_formats', default
=None,
846 help='Make sure formats are selected only from those that are actually downloadable')
847 video_format
.add_option(
848 '--check-all-formats',
849 action
='store_true', dest
='check_formats',
850 help='Check all formats for whether they are actually downloadable')
851 video_format
.add_option(
852 '--no-check-formats',
853 action
='store_false', dest
='check_formats',
854 help='Do not check that the formats are actually downloadable')
855 video_format
.add_option(
856 '-F', '--list-formats',
857 action
='store_true', dest
='listformats',
858 help='List available formats of each video. Simulate unless --no-simulate is used')
859 video_format
.add_option(
860 '--list-formats-as-table',
861 action
='store_true', dest
='listformats_table', default
=True,
862 help=optparse
.SUPPRESS_HELP
)
863 video_format
.add_option(
864 '--list-formats-old', '--no-list-formats-as-table',
865 action
='store_false', dest
='listformats_table',
866 help=optparse
.SUPPRESS_HELP
)
867 video_format
.add_option(
868 '--merge-output-format',
869 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
871 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
872 'Ignored if no merge is required. '
873 f
'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
874 video_format
.add_option(
875 '--allow-unplayable-formats',
876 action
='store_true', dest
='allow_unplayable_formats', default
=False,
877 help=optparse
.SUPPRESS_HELP
)
878 video_format
.add_option(
879 '--no-allow-unplayable-formats',
880 action
='store_false', dest
='allow_unplayable_formats',
881 help=optparse
.SUPPRESS_HELP
)
883 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
884 subtitles
.add_option(
885 '--write-subs', '--write-srt',
886 action
='store_true', dest
='writesubtitles', default
=False,
887 help='Write subtitle file')
888 subtitles
.add_option(
889 '--no-write-subs', '--no-write-srt',
890 action
='store_false', dest
='writesubtitles',
891 help='Do not write subtitle file (default)')
892 subtitles
.add_option(
893 '--write-auto-subs', '--write-automatic-subs',
894 action
='store_true', dest
='writeautomaticsub', default
=False,
895 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
896 subtitles
.add_option(
897 '--no-write-auto-subs', '--no-write-automatic-subs',
898 action
='store_false', dest
='writeautomaticsub', default
=False,
899 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
900 subtitles
.add_option(
902 action
='store_true', dest
='allsubtitles', default
=False,
903 help=optparse
.SUPPRESS_HELP
)
904 subtitles
.add_option(
906 action
='store_true', dest
='listsubtitles', default
=False,
907 help='List available subtitles of each video. Simulate unless --no-simulate is used')
908 subtitles
.add_option(
910 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
911 help='Subtitle format; accepts formats preference separated by "/", e.g. "srt" or "ass/srt/best"')
912 subtitles
.add_option(
913 '--sub-langs', '--srt-langs',
914 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
915 default
=[], callback
=_list_from_options_callback
,
917 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja" '
918 '(where "en.*" is a regex pattern that matches "en" followed by 0 or more of any character). '
919 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
920 'Use --list-subs for a list of available language tags'))
922 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
923 downloader
.add_option(
924 '-N', '--concurrent-fragments',
925 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
926 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
927 downloader
.add_option(
928 '-r', '--limit-rate', '--rate-limit',
929 dest
='ratelimit', metavar
='RATE',
930 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
931 downloader
.add_option(
933 dest
='throttledratelimit', metavar
='RATE',
934 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
935 downloader
.add_option(
937 dest
='retries', metavar
='RETRIES', default
=10,
938 help='Number of retries (default is %default), or "infinite"')
939 downloader
.add_option(
940 '--file-access-retries',
941 dest
='file_access_retries', metavar
='RETRIES', default
=3,
942 help='Number of times to retry on file access error (default is %default), or "infinite"')
943 downloader
.add_option(
944 '--fragment-retries',
945 dest
='fragment_retries', metavar
='RETRIES', default
=10,
946 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
947 downloader
.add_option(
949 dest
='retry_sleep', metavar
='[TYPE:]EXPR', default
={}, type='str',
950 action
='callback', callback
=_dict_from_options_callback
,
952 'allowed_keys': 'http|fragment|file_access|extractor',
953 'default_key': 'http',
955 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
956 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
957 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
958 'This option can be used multiple times to set the sleep for the different retry types, '
959 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
960 downloader
.add_option(
961 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
962 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
963 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
964 downloader
.add_option(
965 '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
966 action
='store_false', dest
='skip_unavailable_fragments',
967 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
968 downloader
.add_option(
970 action
='store_true', dest
='keep_fragments', default
=False,
971 help='Keep downloaded fragments on disk after downloading is finished')
972 downloader
.add_option(
973 '--no-keep-fragments',
974 action
='store_false', dest
='keep_fragments',
975 help='Delete downloaded fragments after downloading is finished (default)')
976 downloader
.add_option(
978 dest
='buffersize', metavar
='SIZE', default
='1024',
979 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
980 downloader
.add_option(
982 action
='store_false', dest
='noresizebuffer',
983 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
984 downloader
.add_option(
985 '--no-resize-buffer',
986 action
='store_true', dest
='noresizebuffer', default
=False,
987 help='Do not automatically adjust the buffer size')
988 downloader
.add_option(
990 dest
='http_chunk_size', metavar
='SIZE', default
=None,
992 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
993 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
994 downloader
.add_option(
996 action
='store_true', dest
='test', default
=False,
997 help=optparse
.SUPPRESS_HELP
)
998 downloader
.add_option(
999 '--playlist-reverse',
1000 action
='store_true', dest
='playlist_reverse',
1001 help=optparse
.SUPPRESS_HELP
)
1002 downloader
.add_option(
1003 '--no-playlist-reverse',
1004 action
='store_false', dest
='playlist_reverse',
1005 help=optparse
.SUPPRESS_HELP
)
1006 downloader
.add_option(
1007 '--playlist-random',
1008 action
='store_true', dest
='playlist_random',
1009 help='Download playlist videos in random order')
1010 downloader
.add_option(
1012 action
='store_true', dest
='lazy_playlist',
1013 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
1014 downloader
.add_option(
1015 '--no-lazy-playlist',
1016 action
='store_false', dest
='lazy_playlist',
1017 help='Process videos in the playlist only after the entire playlist is parsed (default)')
1018 downloader
.add_option(
1019 '--xattr-set-filesize',
1020 dest
='xattr_set_filesize', action
='store_true',
1021 help='Set file xattribute ytdl.filesize with expected file size')
1022 downloader
.add_option(
1023 '--hls-prefer-native',
1024 dest
='hls_prefer_native', action
='store_true', default
=None,
1025 help=optparse
.SUPPRESS_HELP
)
1026 downloader
.add_option(
1027 '--hls-prefer-ffmpeg',
1028 dest
='hls_prefer_native', action
='store_false', default
=None,
1029 help=optparse
.SUPPRESS_HELP
)
1030 downloader
.add_option(
1032 dest
='hls_use_mpegts', action
='store_true', default
=None,
1034 'Use the mpegts container for HLS videos; '
1035 'allowing some players to play the video while downloading, '
1036 'and reducing the chance of file corruption if download is interrupted. '
1037 'This is enabled by default for live streams'))
1038 downloader
.add_option(
1039 '--no-hls-use-mpegts',
1040 dest
='hls_use_mpegts', action
='store_false',
1042 'Do not use the mpegts container for HLS videos. '
1043 'This is default when not downloading live streams'))
1044 downloader
.add_option(
1045 '--download-sections',
1046 metavar
='REGEX', dest
='download_ranges', action
='append',
1048 'Download only chapters that match the regular expression. '
1049 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. '
1050 '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. '
1051 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
1052 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
1053 downloader
.add_option(
1054 '--downloader', '--external-downloader',
1055 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
1056 action
='callback', callback
=_dict_from_options_callback
,
1058 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
1059 'default_key': 'default',
1060 'process': str.strip
,
1062 'Name or path of the external downloader to use (optionally) prefixed by '
1063 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
1064 f
'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
1065 'You can use this option multiple times to set different downloaders for different protocols. '
1066 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
1067 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
1068 '(Alias: --external-downloader)'))
1069 downloader
.add_option(
1070 '--downloader-args', '--external-downloader-args',
1071 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
1072 action
='callback', callback
=_dict_from_options_callback
,
1074 'allowed_keys': r
'ffmpeg_[io]\d*|{}'.format('|'.join(map(re
.escape
, list_external_downloaders()))),
1075 'default_key': 'default',
1076 'process': shlex
.split
,
1078 'Give these arguments to the external downloader. '
1079 'Specify the downloader name and the arguments separated by a colon ":". '
1080 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
1081 'You can use this option multiple times to give different arguments to different downloaders '
1082 '(Alias: --external-downloader-args)'))
1084 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
1085 workarounds
.add_option(
1087 dest
='encoding', metavar
='ENCODING',
1088 help='Force the specified encoding (experimental)')
1089 workarounds
.add_option(
1090 '--legacy-server-connect',
1091 action
='store_true', dest
='legacy_server_connect', default
=False,
1092 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
1093 workarounds
.add_option(
1094 '--no-check-certificates',
1095 action
='store_true', dest
='no_check_certificate', default
=False,
1096 help='Suppress HTTPS certificate validation')
1097 workarounds
.add_option(
1098 '--prefer-insecure', '--prefer-unsecure',
1099 action
='store_true', dest
='prefer_insecure',
1100 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
1101 workarounds
.add_option(
1103 metavar
='UA', dest
='user_agent',
1104 help=optparse
.SUPPRESS_HELP
)
1105 workarounds
.add_option(
1107 metavar
='URL', dest
='referer', default
=None,
1108 help=optparse
.SUPPRESS_HELP
)
1109 workarounds
.add_option(
1111 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
1112 action
='callback', callback
=_dict_from_options_callback
,
1113 callback_kwargs
={'multiple_keys': False},
1114 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
1116 workarounds
.add_option(
1117 '--bidi-workaround',
1118 dest
='bidi_workaround', action
='store_true',
1119 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1120 workarounds
.add_option(
1121 '--sleep-requests', metavar
='SECONDS',
1122 dest
='sleep_interval_requests', type=float,
1123 help='Number of seconds to sleep between requests during data extraction')
1124 workarounds
.add_option(
1125 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
1126 dest
='sleep_interval', type=float,
1128 'Number of seconds to sleep before each download. '
1129 'This is the minimum time to sleep when used along with --max-sleep-interval '
1130 '(Alias: --min-sleep-interval)'))
1131 workarounds
.add_option(
1132 '--max-sleep-interval', metavar
='SECONDS',
1133 dest
='max_sleep_interval', type=float,
1134 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1135 workarounds
.add_option(
1136 '--sleep-subtitles', metavar
='SECONDS',
1137 dest
='sleep_interval_subtitles', default
=0, type=int,
1138 help='Number of seconds to sleep before each subtitle download')
1140 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
1141 verbosity
.add_option(
1143 action
='store_true', dest
='quiet', default
=None,
1144 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1145 verbosity
.add_option(
1147 action
='store_false', dest
='quiet',
1148 help='Deactivate quiet mode. (Default)')
1149 verbosity
.add_option(
1151 dest
='no_warnings', action
='store_true', default
=False,
1152 help='Ignore warnings')
1153 verbosity
.add_option(
1155 action
='store_true', dest
='simulate', default
=None,
1156 help='Do not download the video and do not write anything to disk')
1157 verbosity
.add_option(
1159 action
='store_false', dest
='simulate',
1160 help='Download the video even if printing/listing options are used')
1161 verbosity
.add_option(
1162 '--ignore-no-formats-error',
1163 action
='store_true', dest
='ignore_no_formats_error', default
=False,
1165 'Ignore "No video formats" error. Useful for extracting metadata '
1166 'even if the videos are not actually available for download (experimental)'))
1167 verbosity
.add_option(
1168 '--no-ignore-no-formats-error',
1169 action
='store_false', dest
='ignore_no_formats_error',
1170 help='Throw error when no downloadable video formats are found (default)')
1171 verbosity
.add_option(
1172 '--skip-download', '--no-download',
1173 action
='store_true', dest
='skip_download', default
=False,
1174 help='Do not download the video but write all related files (Alias: --no-download)')
1175 verbosity
.add_option(
1177 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', **when_prefix('video'),
1179 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1180 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
1181 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1182 'This option can be used multiple times'))
1183 verbosity
.add_option(
1185 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', nargs
=2, **when_prefix('video'),
1187 'Append given template to the file. The values of WHEN and TEMPLATE are the same as that of --print. '
1188 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1189 verbosity
.add_option(
1191 action
='store_true', dest
='geturl', default
=False,
1192 help=optparse
.SUPPRESS_HELP
)
1193 verbosity
.add_option(
1194 '-e', '--get-title',
1195 action
='store_true', dest
='gettitle', default
=False,
1196 help=optparse
.SUPPRESS_HELP
)
1197 verbosity
.add_option(
1199 action
='store_true', dest
='getid', default
=False,
1200 help=optparse
.SUPPRESS_HELP
)
1201 verbosity
.add_option(
1203 action
='store_true', dest
='getthumbnail', default
=False,
1204 help=optparse
.SUPPRESS_HELP
)
1205 verbosity
.add_option(
1206 '--get-description',
1207 action
='store_true', dest
='getdescription', default
=False,
1208 help=optparse
.SUPPRESS_HELP
)
1209 verbosity
.add_option(
1211 action
='store_true', dest
='getduration', default
=False,
1212 help=optparse
.SUPPRESS_HELP
)
1213 verbosity
.add_option(
1215 action
='store_true', dest
='getfilename', default
=False,
1216 help=optparse
.SUPPRESS_HELP
)
1217 verbosity
.add_option(
1219 action
='store_true', dest
='getformat', default
=False,
1220 help=optparse
.SUPPRESS_HELP
)
1221 verbosity
.add_option(
1222 '-j', '--dump-json',
1223 action
='store_true', dest
='dumpjson', default
=False,
1225 'Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. '
1226 'See "OUTPUT TEMPLATE" for a description of available keys'))
1227 verbosity
.add_option(
1228 '-J', '--dump-single-json',
1229 action
='store_true', dest
='dump_single_json', default
=False,
1231 'Quiet, but print JSON information for each URL or infojson passed. Simulate unless --no-simulate is used. '
1232 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1233 verbosity
.add_option(
1235 action
='store_true', dest
='print_json', default
=False,
1236 help=optparse
.SUPPRESS_HELP
)
1237 verbosity
.add_option(
1238 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1239 action
='store_true', dest
='force_write_download_archive', default
=False,
1241 'Force download archive entries to be written as far as no errors occur, '
1242 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1243 verbosity
.add_option(
1245 action
='store_true', dest
='progress_with_newline', default
=False,
1246 help='Output progress bar as new lines')
1247 verbosity
.add_option(
1249 action
='store_true', dest
='noprogress', default
=None,
1250 help='Do not print progress bar')
1251 verbosity
.add_option(
1253 action
='store_false', dest
='noprogress',
1254 help='Show progress bar, even if in quiet mode')
1255 verbosity
.add_option(
1257 action
='store_true', dest
='consoletitle', default
=False,
1258 help='Display progress in console titlebar')
1259 verbosity
.add_option(
1260 '--progress-template',
1261 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1262 action
='callback', callback
=_dict_from_options_callback
,
1264 'allowed_keys': '(download|postprocess)(-title)?',
1265 'default_key': 'download',
1267 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1268 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1269 'The video\'s fields are accessible under the "info" key and '
1270 'the progress attributes are accessible under "progress" key. E.g. '
1271 # TODO: Document the fields inside "progress"
1272 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1273 verbosity
.add_option(
1275 metavar
='SECONDS', action
='store', dest
='progress_delta', type=float, default
=0,
1276 help='Time between progress output (default: 0)')
1277 verbosity
.add_option(
1279 action
='store_true', dest
='verbose', default
=False,
1280 help='Print various debugging information')
1281 verbosity
.add_option(
1282 '--dump-pages', '--dump-intermediate-pages',
1283 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1284 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1285 verbosity
.add_option(
1287 action
='store_true', dest
='write_pages', default
=False,
1288 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1289 verbosity
.add_option(
1291 action
='store_true', dest
='load_pages', default
=False,
1292 help=optparse
.SUPPRESS_HELP
)
1293 verbosity
.add_option(
1294 '--youtube-print-sig-code',
1295 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1296 help=optparse
.SUPPRESS_HELP
)
1297 verbosity
.add_option(
1298 '--print-traffic', '--dump-headers',
1299 dest
='debug_printtraffic', action
='store_true', default
=False,
1300 help='Display sent and read HTTP traffic')
1301 verbosity
.add_option(
1302 '-C', '--call-home',
1303 dest
='call_home', action
='store_true', default
=False,
1304 # help='Contact the yt-dlp server for debugging')
1305 help=optparse
.SUPPRESS_HELP
)
1306 verbosity
.add_option(
1308 dest
='call_home', action
='store_false',
1309 # help='Do not contact the yt-dlp server for debugging (default)')
1310 help=optparse
.SUPPRESS_HELP
)
1312 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1313 filesystem
.add_option(
1314 '-a', '--batch-file',
1315 dest
='batchfile', metavar
='FILE',
1317 'File containing URLs to download ("-" for stdin), one URL per line. '
1318 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1319 filesystem
.add_option(
1321 dest
='batchfile', action
='store_const', const
=None,
1322 help='Do not read URLs from batch file (default)')
1323 filesystem
.add_option(
1324 '--id', default
=False,
1325 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1326 filesystem
.add_option(
1328 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1329 action
='callback', callback
=_dict_from_options_callback
,
1331 'allowed_keys': 'home|temp|{}'.format('|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys()))),
1332 'default_key': 'home',
1334 'The paths where the files should be downloaded. '
1335 'Specify the type of file and the path separated by a colon ":". '
1336 'All the same TYPES as --output are supported. '
1337 'Additionally, you can also provide "home" (default) and "temp" paths. '
1338 'All intermediary files are first downloaded to the temp path and '
1339 'then the final files are moved over to the home path after download is finished. '
1340 'This option is ignored if --output is an absolute path'))
1341 filesystem
.add_option(
1343 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1344 action
='callback', callback
=_dict_from_options_callback
,
1346 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1347 'default_key': 'default',
1348 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1349 filesystem
.add_option(
1350 '--output-na-placeholder',
1351 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1352 help=('Placeholder for unavailable fields in --output (default: "%default")'))
1353 filesystem
.add_option(
1354 '--autonumber-size',
1355 dest
='autonumber_size', metavar
='NUMBER', type=int,
1356 help=optparse
.SUPPRESS_HELP
)
1357 filesystem
.add_option(
1358 '--autonumber-start',
1359 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1360 help=optparse
.SUPPRESS_HELP
)
1361 filesystem
.add_option(
1362 '--restrict-filenames',
1363 action
='store_true', dest
='restrictfilenames', default
=False,
1364 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1365 filesystem
.add_option(
1366 '--no-restrict-filenames',
1367 action
='store_false', dest
='restrictfilenames',
1368 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1369 filesystem
.add_option(
1370 '--windows-filenames',
1371 action
='store_true', dest
='windowsfilenames', default
=False,
1372 help='Force filenames to be Windows-compatible')
1373 filesystem
.add_option(
1374 '--no-windows-filenames',
1375 action
='store_false', dest
='windowsfilenames',
1376 help='Make filenames Windows-compatible only if using Windows (default)')
1377 filesystem
.add_option(
1378 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1379 dest
='trim_file_name', default
=0, type=int,
1380 help='Limit the filename length (excluding extension) to the specified number of characters')
1381 filesystem
.add_option(
1382 '-w', '--no-overwrites',
1383 action
='store_false', dest
='overwrites', default
=None,
1384 help='Do not overwrite any files')
1385 filesystem
.add_option(
1386 '--force-overwrites', '--yes-overwrites',
1387 action
='store_true', dest
='overwrites',
1388 help='Overwrite all video and metadata files. This option includes --no-continue')
1389 filesystem
.add_option(
1390 '--no-force-overwrites',
1391 action
='store_const', dest
='overwrites', const
=None,
1392 help='Do not overwrite the video, but overwrite related files (default)')
1393 filesystem
.add_option(
1395 action
='store_true', dest
='continue_dl', default
=True,
1396 help='Resume partially downloaded files/fragments (default)')
1397 filesystem
.add_option(
1399 action
='store_false', dest
='continue_dl',
1401 'Do not resume partially downloaded fragments. '
1402 'If the file is not fragmented, restart download of the entire file'))
1403 filesystem
.add_option(
1405 action
='store_false', dest
='nopart', default
=False,
1406 help='Use .part files instead of writing directly into output file (default)')
1407 filesystem
.add_option(
1409 action
='store_true', dest
='nopart',
1410 help='Do not use .part files - write directly into output file')
1411 filesystem
.add_option(
1413 action
='store_true', dest
='updatetime', default
=True,
1414 help='Use the Last-modified header to set the file modification time (default)')
1415 filesystem
.add_option(
1417 action
='store_false', dest
='updatetime',
1418 help='Do not use the Last-modified header to set the file modification time')
1419 filesystem
.add_option(
1420 '--write-description',
1421 action
='store_true', dest
='writedescription', default
=False,
1422 help='Write video description to a .description file')
1423 filesystem
.add_option(
1424 '--no-write-description',
1425 action
='store_false', dest
='writedescription',
1426 help='Do not write video description (default)')
1427 filesystem
.add_option(
1428 '--write-info-json',
1429 action
='store_true', dest
='writeinfojson', default
=None,
1430 help='Write video metadata to a .info.json file (this may contain personal information)')
1431 filesystem
.add_option(
1432 '--no-write-info-json',
1433 action
='store_false', dest
='writeinfojson',
1434 help='Do not write video metadata (default)')
1435 filesystem
.add_option(
1436 '--write-annotations',
1437 action
='store_true', dest
='writeannotations', default
=False,
1438 help=optparse
.SUPPRESS_HELP
)
1439 filesystem
.add_option(
1440 '--no-write-annotations',
1441 action
='store_false', dest
='writeannotations',
1442 help=optparse
.SUPPRESS_HELP
)
1443 filesystem
.add_option(
1444 '--write-playlist-metafiles',
1445 action
='store_true', dest
='allow_playlist_files', default
=None,
1447 'Write playlist metadata in addition to the video metadata '
1448 'when using --write-info-json, --write-description etc. (default)'))
1449 filesystem
.add_option(
1450 '--no-write-playlist-metafiles',
1451 action
='store_false', dest
='allow_playlist_files',
1452 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1453 filesystem
.add_option(
1454 '--clean-info-json', '--clean-infojson',
1455 action
='store_true', dest
='clean_infojson', default
=None,
1457 'Remove some internal metadata such as filenames from the infojson (default)'))
1458 filesystem
.add_option(
1459 '--no-clean-info-json', '--no-clean-infojson',
1460 action
='store_false', dest
='clean_infojson',
1461 help='Write all fields to the infojson')
1462 filesystem
.add_option(
1463 '--write-comments', '--get-comments',
1464 action
='store_true', dest
='getcomments', default
=False,
1466 'Retrieve video comments to be placed in the infojson. '
1467 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1468 filesystem
.add_option(
1469 '--no-write-comments', '--no-get-comments',
1470 action
='store_false', dest
='getcomments',
1471 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1472 filesystem
.add_option(
1473 '--load-info-json', '--load-info',
1474 dest
='load_info_filename', metavar
='FILE',
1475 help='JSON file containing the video information (created with the "--write-info-json" option)')
1476 filesystem
.add_option(
1478 dest
='cookiefile', metavar
='FILE',
1479 help='Netscape formatted file to read cookies from and dump cookie jar in')
1480 filesystem
.add_option(
1482 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1483 help='Do not read/dump cookies from/to file (default)')
1484 filesystem
.add_option(
1485 '--cookies-from-browser',
1486 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
1488 'The name of the browser to load cookies from. '
1489 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1490 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1491 'the name/path of the PROFILE to load cookies from, '
1492 'and the CONTAINER name (if Firefox) ("none" for no container) '
1493 'can be given with their respective separators. '
1494 'By default, all containers of the most recently accessed profile are used. '
1495 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1496 filesystem
.add_option(
1497 '--no-cookies-from-browser',
1498 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1499 help='Do not load cookies from browser (default)')
1500 filesystem
.add_option(
1501 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1503 'Location in the filesystem where yt-dlp can store some downloaded information '
1504 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
1505 filesystem
.add_option(
1506 '--no-cache-dir', action
='store_false', dest
='cachedir',
1507 help='Disable filesystem caching')
1508 filesystem
.add_option(
1510 action
='store_true', dest
='rm_cachedir',
1511 help='Delete all filesystem cache files')
1513 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1514 thumbnail
.add_option(
1515 '--write-thumbnail',
1516 action
='callback', dest
='writethumbnail', default
=False,
1517 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1518 callback
=lambda option
, _
, __
, parser
: setattr(
1519 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1520 help='Write thumbnail image to disk')
1521 thumbnail
.add_option(
1522 '--no-write-thumbnail',
1523 action
='store_false', dest
='writethumbnail',
1524 help='Do not write thumbnail image to disk (default)')
1525 thumbnail
.add_option(
1526 '--write-all-thumbnails',
1527 action
='store_const', dest
='writethumbnail', const
='all',
1528 help='Write all thumbnail image formats to disk')
1529 thumbnail
.add_option(
1530 '--list-thumbnails',
1531 action
='store_true', dest
='list_thumbnails', default
=False,
1532 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1534 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1537 action
='store_true', dest
='writelink', default
=False,
1538 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1541 action
='store_true', dest
='writeurllink', default
=False,
1542 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1544 '--write-webloc-link',
1545 action
='store_true', dest
='writewebloclink', default
=False,
1546 help='Write a .webloc macOS internet shortcut')
1548 '--write-desktop-link',
1549 action
='store_true', dest
='writedesktoplink', default
=False,
1550 help='Write a .desktop Linux internet shortcut')
1552 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1553 postproc
.add_option(
1554 '-x', '--extract-audio',
1555 action
='store_true', dest
='extractaudio', default
=False,
1556 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1557 postproc
.add_option(
1558 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1560 'Format to convert the audio to when -x is used. '
1561 f
'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
1562 'You can specify multiple rules using similar syntax as --remux-video'))
1563 postproc
.add_option(
1564 '--audio-quality', metavar
='QUALITY',
1565 dest
='audioquality', default
='5',
1567 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1568 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
1569 postproc
.add_option(
1571 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1573 'Remux the video into another container if necessary '
1574 f
'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1575 'If the target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
1576 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
1577 postproc
.add_option(
1579 metavar
='FORMAT', dest
='recodevideo', default
=None,
1580 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1581 postproc
.add_option(
1582 '--postprocessor-args', '--ppa',
1583 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1584 action
='callback', callback
=_dict_from_options_callback
,
1586 'allowed_keys': r
'\w+(?:\+\w+)?',
1587 'default_key': 'default-compat',
1588 'process': shlex
.split
,
1589 'multiple_keys': False,
1591 'Give these arguments to the postprocessors. '
1592 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1593 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1594 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1595 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1596 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1597 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1598 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1599 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1600 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1601 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
1602 'You can use this option multiple times to give different arguments to different '
1603 'postprocessors. (Alias: --ppa)'))
1604 postproc
.add_option(
1605 '-k', '--keep-video',
1606 action
='store_true', dest
='keepvideo', default
=False,
1607 help='Keep the intermediate video file on disk after post-processing')
1608 postproc
.add_option(
1610 action
='store_false', dest
='keepvideo',
1611 help='Delete the intermediate video file after post-processing (default)')
1612 postproc
.add_option(
1613 '--post-overwrites',
1614 action
='store_false', dest
='nopostoverwrites',
1615 help='Overwrite post-processed files (default)')
1616 postproc
.add_option(
1617 '--no-post-overwrites',
1618 action
='store_true', dest
='nopostoverwrites', default
=False,
1619 help='Do not overwrite post-processed files')
1620 postproc
.add_option(
1622 action
='store_true', dest
='embedsubtitles', default
=False,
1623 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1624 postproc
.add_option(
1626 action
='store_false', dest
='embedsubtitles',
1627 help='Do not embed subtitles (default)')
1628 postproc
.add_option(
1629 '--embed-thumbnail',
1630 action
='store_true', dest
='embedthumbnail', default
=False,
1631 help='Embed thumbnail in the video as cover art')
1632 postproc
.add_option(
1633 '--no-embed-thumbnail',
1634 action
='store_false', dest
='embedthumbnail',
1635 help='Do not embed thumbnail (default)')
1636 postproc
.add_option(
1637 '--embed-metadata', '--add-metadata',
1638 action
='store_true', dest
='addmetadata', default
=False,
1640 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1641 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1642 postproc
.add_option(
1643 '--no-embed-metadata', '--no-add-metadata',
1644 action
='store_false', dest
='addmetadata',
1645 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1646 postproc
.add_option(
1647 '--embed-chapters', '--add-chapters',
1648 action
='store_true', dest
='addchapters', default
=None,
1649 help='Add chapter markers to the video file (Alias: --add-chapters)')
1650 postproc
.add_option(
1651 '--no-embed-chapters', '--no-add-chapters',
1652 action
='store_false', dest
='addchapters',
1653 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1654 postproc
.add_option(
1655 '--embed-info-json',
1656 action
='store_true', dest
='embed_infojson', default
=None,
1657 help='Embed the infojson as an attachment to mkv/mka video files')
1658 postproc
.add_option(
1659 '--no-embed-info-json',
1660 action
='store_false', dest
='embed_infojson',
1661 help='Do not embed the infojson as an attachment to the video file')
1662 postproc
.add_option(
1663 '--metadata-from-title',
1664 metavar
='FORMAT', dest
='metafromtitle',
1665 help=optparse
.SUPPRESS_HELP
)
1666 postproc
.add_option(
1668 metavar
='[WHEN:]FROM:TO', dest
='parse_metadata', **when_prefix('pre_process'),
1670 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1671 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1672 postproc
.add_option(
1673 '--replace-in-metadata',
1674 dest
='parse_metadata', metavar
='[WHEN:]FIELDS REGEX REPLACE', nargs
=3, **when_prefix('pre_process'),
1676 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1677 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1678 postproc
.add_option(
1679 '--xattrs', '--xattr',
1680 action
='store_true', dest
='xattrs', default
=False,
1681 help='Write metadata to the video file\'s xattrs (using Dublin Core and XDG standards)')
1682 postproc
.add_option(
1683 '--concat-playlist',
1684 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1685 choices
=('never', 'always', 'multi_video'),
1687 'Concatenate videos in a playlist. One of "never", "always", or '
1688 '"multi_video" (default; only when the videos form a single show). '
1689 'All the video files must have the same codecs and number of streams to be concatenable. '
1690 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1691 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1692 postproc
.add_option(
1694 metavar
='POLICY', dest
='fixup', default
=None,
1695 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1697 'Automatically correct known faults of the file. '
1698 'One of never (do nothing), warn (only emit a warning), '
1699 'detect_or_warn (the default; fix the file if we can, warn otherwise), '
1700 'force (try fixing even if the file already exists)'))
1701 postproc
.add_option(
1702 '--prefer-avconv', '--no-prefer-ffmpeg',
1703 action
='store_false', dest
='prefer_ffmpeg',
1704 help=optparse
.SUPPRESS_HELP
)
1705 postproc
.add_option(
1706 '--prefer-ffmpeg', '--no-prefer-avconv',
1707 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1708 help=optparse
.SUPPRESS_HELP
)
1709 postproc
.add_option(
1710 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1711 dest
='ffmpeg_location',
1712 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1713 postproc
.add_option(
1715 metavar
='[WHEN:]CMD', dest
='exec_cmd', **when_prefix('after_move'),
1717 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1718 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
1719 'The same syntax as the output template can be used to pass any field as arguments to the command. '
1720 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
1721 'This option can be used multiple times'))
1722 postproc
.add_option(
1724 action
='store_const', dest
='exec_cmd', const
={},
1725 help='Remove any previously defined --exec')
1726 postproc
.add_option(
1727 '--exec-before-download', metavar
='CMD',
1728 action
='append', dest
='exec_before_dl_cmd',
1729 help=optparse
.SUPPRESS_HELP
)
1730 postproc
.add_option(
1731 '--no-exec-before-download',
1732 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1733 help=optparse
.SUPPRESS_HELP
)
1734 postproc
.add_option(
1735 '--convert-subs', '--convert-sub', '--convert-subtitles',
1736 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1738 'Convert the subtitles to another format '
1739 f
'(currently supported: {", ".join(sorted(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS))}). '
1740 'Use "--convert-subs none" to disable conversion (default) (Alias: --convert-subtitles)'))
1741 postproc
.add_option(
1742 '--convert-thumbnails',
1743 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1745 'Convert the thumbnails to another format '
1746 f
'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
1747 'You can specify multiple rules using similar syntax as "--remux-video". '
1748 'Use "--convert-thumbnails none" to disable conversion (default)'))
1749 postproc
.add_option(
1750 '--split-chapters', '--split-tracks',
1751 dest
='split_chapters', action
='store_true', default
=False,
1753 'Split video into multiple files based on internal chapters. '
1754 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1755 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1756 postproc
.add_option(
1757 '--no-split-chapters', '--no-split-tracks',
1758 dest
='split_chapters', action
='store_false',
1759 help='Do not split video based on chapters (default)')
1760 postproc
.add_option(
1761 '--remove-chapters',
1762 metavar
='REGEX', dest
='remove_chapters', action
='append',
1764 'Remove chapters whose title matches the given regular expression. '
1765 'The syntax is the same as --download-sections. This option can be used multiple times'))
1766 postproc
.add_option(
1767 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1768 help='Do not remove any chapters from the file (default)')
1769 postproc
.add_option(
1770 '--force-keyframes-at-cuts',
1771 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1773 'Force keyframes at cuts when downloading/splitting/removing sections. '
1774 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
1775 postproc
.add_option(
1776 '--no-force-keyframes-at-cuts',
1777 action
='store_false', dest
='force_keyframes_at_cuts',
1778 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1779 _postprocessor_opts_parser
= lambda key
, val
='': (
1780 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1781 ('key', remove_end(key
, 'PP')))
1782 postproc
.add_option(
1783 '--use-postprocessor',
1784 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1785 action
='callback', callback
=_list_from_options_callback
,
1788 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1))),
1790 'The (case-sensitive) name of plugin postprocessors to be enabled, '
1791 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1792 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1793 'The "when" argument determines when the postprocessor is invoked. '
1794 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1795 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1796 '"post_process" (after each video download; default), '
1797 '"after_move" (after moving the video file to its final location), '
1798 '"after_video" (after downloading and processing all formats of a video), '
1799 'or "playlist" (at end of playlist). '
1800 'This option can be used multiple times to add different postprocessors'))
1802 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1803 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1804 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1805 sponsorblock
.add_option(
1806 '--sponsorblock-mark', metavar
='CATS',
1807 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1808 callback
=_set_from_options_callback
, callback_kwargs
={
1809 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1810 'aliases': {'default': ['all']},
1812 'SponsorBlock categories to create chapters for, separated by commas. '
1813 f
'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1814 'You can prefix the category with a "-" to exclude it. See [1] for descriptions of the categories. '
1815 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1816 sponsorblock
.add_option(
1817 '--sponsorblock-remove', metavar
='CATS',
1818 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1819 callback
=_set_from_options_callback
, callback_kwargs
={
1820 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.NON_SKIPPABLE_CATEGORIES
.keys()),
1821 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1822 # The filler category is very aggressive.
1823 # It is strongly recommended to not use this in a client by default.
1824 'aliases': {'default': ['all', '-filler']},
1826 'SponsorBlock categories to be removed from the video file, separated by commas. '
1827 'If a category is present in both mark and remove, remove takes precedence. '
1828 'The syntax and available categories are the same as for --sponsorblock-mark '
1829 'except that "default" refers to "all,-filler" '
1830 f
'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
1831 sponsorblock
.add_option(
1832 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1833 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1835 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1836 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1837 'Defaults to "%default"'))
1838 sponsorblock
.add_option(
1839 '--no-sponsorblock', default
=False,
1840 action
='store_true', dest
='no_sponsorblock',
1841 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1842 sponsorblock
.add_option(
1843 '--sponsorblock-api', metavar
='URL',
1844 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1845 help='SponsorBlock API location, defaults to %default')
1847 sponsorblock
.add_option(
1849 action
='store_true', dest
='sponskrub', default
=False,
1850 help=optparse
.SUPPRESS_HELP
)
1851 sponsorblock
.add_option(
1853 action
='store_false', dest
='sponskrub',
1854 help=optparse
.SUPPRESS_HELP
)
1855 sponsorblock
.add_option(
1856 '--sponskrub-cut', default
=False,
1857 action
='store_true', dest
='sponskrub_cut',
1858 help=optparse
.SUPPRESS_HELP
)
1859 sponsorblock
.add_option(
1860 '--no-sponskrub-cut',
1861 action
='store_false', dest
='sponskrub_cut',
1862 help=optparse
.SUPPRESS_HELP
)
1863 sponsorblock
.add_option(
1864 '--sponskrub-force', default
=False,
1865 action
='store_true', dest
='sponskrub_force',
1866 help=optparse
.SUPPRESS_HELP
)
1867 sponsorblock
.add_option(
1868 '--no-sponskrub-force',
1869 action
='store_true', dest
='sponskrub_force',
1870 help=optparse
.SUPPRESS_HELP
)
1871 sponsorblock
.add_option(
1872 '--sponskrub-location', metavar
='PATH',
1873 dest
='sponskrub_path', default
='',
1874 help=optparse
.SUPPRESS_HELP
)
1875 sponsorblock
.add_option(
1876 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1877 help=optparse
.SUPPRESS_HELP
)
1879 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1880 extractor
.add_option(
1881 '--extractor-retries',
1882 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1883 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1884 extractor
.add_option(
1885 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1886 action
='store_true', dest
='dynamic_mpd', default
=True,
1887 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1888 extractor
.add_option(
1889 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1890 action
='store_false', dest
='dynamic_mpd',
1891 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1892 extractor
.add_option(
1893 '--hls-split-discontinuity',
1894 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1895 help='Split HLS playlists to different formats at discontinuities such as ad breaks',
1897 extractor
.add_option(
1898 '--no-hls-split-discontinuity',
1899 dest
='hls_split_discontinuity', action
='store_false',
1900 help='Do not split HLS playlists into different formats at discontinuities such as ad breaks (default)')
1901 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1902 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1903 extractor
.add_option(
1905 metavar
='IE_KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1906 action
='callback', callback
=_dict_from_options_callback
,
1908 'multiple_keys': False,
1909 'process': lambda val
: dict(
1910 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';')),
1912 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
1913 'You can use this option multiple times to give arguments for different extractors'))
1914 extractor
.add_option(
1915 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1916 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1917 help=optparse
.SUPPRESS_HELP
)
1918 extractor
.add_option(
1919 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1920 action
='store_false', dest
='youtube_include_dash_manifest',
1921 help=optparse
.SUPPRESS_HELP
)
1922 extractor
.add_option(
1923 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1924 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1925 help=optparse
.SUPPRESS_HELP
)
1926 extractor
.add_option(
1927 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1928 action
='store_false', dest
='youtube_include_hls_manifest',
1929 help=optparse
.SUPPRESS_HELP
)
1931 parser
.add_option_group(general
)
1932 parser
.add_option_group(network
)
1933 parser
.add_option_group(geo
)
1934 parser
.add_option_group(selection
)
1935 parser
.add_option_group(downloader
)
1936 parser
.add_option_group(filesystem
)
1937 parser
.add_option_group(thumbnail
)
1938 parser
.add_option_group(link
)
1939 parser
.add_option_group(verbosity
)
1940 parser
.add_option_group(workarounds
)
1941 parser
.add_option_group(video_format
)
1942 parser
.add_option_group(subtitles
)
1943 parser
.add_option_group(authentication
)
1944 parser
.add_option_group(postproc
)
1945 parser
.add_option_group(sponsorblock
)
1946 parser
.add_option_group(extractor
)
1951 def _hide_login_info(opts
):
1952 deprecation_warning(f
'"{__name__}._hide_login_info" is deprecated and may be removed '
1953 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
1954 return Config
.hide_login_info(opts
)