]> jfr.im git - yt-dlp.git/blame - yt_dlp/options.py
Add `--compat-options 2021,2022`
[yt-dlp.git] / yt_dlp / options.py
CommitLineData
9e491463 1import collections
2import contextlib
34a741a8 3import optparse
f8271158 4import os.path
3aa9a735 5import re
f9934b96 6import shlex
ac668111 7import shutil
9e491463 8import string
34a741a8
PH
9import sys
10
ac668111 11from .compat import compat_expanduser
f59f5ef8 12from .cookies import SUPPORTED_BROWSERS, SUPPORTED_KEYRINGS
81a23040 13from .downloader.external import list_external_downloaders
ad3dc496 14from .postprocessor import (
81a23040 15 FFmpegExtractAudioPP,
4f04be6a 16 FFmpegMergerPP,
81a23040 17 FFmpegSubtitlesConvertorPP,
18 FFmpegThumbnailsConvertorPP,
19 FFmpegVideoRemuxerPP,
7a340e0d 20 SponsorBlockPP,
81a23040 21)
7a340e0d 22from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
70b23409 23from .update import detect_variant, is_non_updateable
f8271158 24from .utils import (
25 OUTTMPL_TYPES,
26 POSTPROCESS_WHEN,
27 Config,
da4db748 28 deprecation_warning,
f8271158 29 expand_path,
70b23409 30 format_field,
f8271158 31 get_executable_path,
8e40b9d1
M
32 get_system_config_dirs,
33 get_user_config_dirs,
19a03940 34 join_nonempty,
5314b521 35 orderedSet_from_options,
f8271158 36 remove_end,
37 write_string,
38)
39from .version import __version__
81a23040 40
34a741a8 41
06e57990 42def parseOpts(overrideArguments=None, ignore_config_files='if_override'):
9e491463 43 root = Config(create_parser())
06e57990 44 if ignore_config_files == 'if_override':
45 ignore_config_files = overrideArguments is not None
34a741a8 46
8e40b9d1
M
47 def _load_from_config_dirs(config_dirs):
48 for config_dir in config_dirs:
49 conf_file_path = os.path.join(config_dir, 'config')
50 conf = Config.read_file(conf_file_path, default=None)
51 if conf is None:
52 conf_file_path += '.txt'
53 conf = Config.read_file(conf_file_path, default=None)
54 if conf is not None:
55 return conf, conf_file_path
56 return None, None
57
58 def _read_user_conf(package_name, default=None):
59 # .config/package_name.conf
ac668111 60 xdg_config_home = os.getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
8e40b9d1
M
61 user_conf_file = os.path.join(xdg_config_home, '%s.conf' % package_name)
62 user_conf = Config.read_file(user_conf_file, default=None)
63 if user_conf is not None:
64 return user_conf, user_conf_file
34a741a8 65
8e40b9d1
M
66 # home (~/package_name.conf or ~/package_name.conf.txt)
67 user_conf_file = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
68 user_conf = Config.read_file(user_conf_file, default=None)
69 if user_conf is None:
70 user_conf_file += '.txt'
71 user_conf = Config.read_file(user_conf_file, default=None)
72 if user_conf is not None:
73 return user_conf, user_conf_file
34a741a8 74
8e40b9d1
M
75 # Package config directories (e.g. ~/.config/package_name/package_name.txt)
76 user_conf, user_conf_file = _load_from_config_dirs(get_user_config_dirs(package_name))
77 if user_conf is not None:
78 return user_conf, user_conf_file
79 return default if default is not None else [], None
34a741a8 80
8e40b9d1
M
81 def _read_system_conf(package_name, default=None):
82 system_conf, system_conf_file = _load_from_config_dirs(get_system_config_dirs(package_name))
83 if system_conf is not None:
84 return system_conf, system_conf_file
85 return default if default is not None else [], None
34a741a8 86
8e40b9d1 87 def add_config(label, path=None, func=None):
06e57990 88 """ Adds config and returns whether to continue """
9e491463 89 if root.parse_known_args()[0].ignoreconfig:
06e57990 90 return False
8e40b9d1
M
91 elif func:
92 assert path is None
93 args, current_path = func('yt-dlp')
94 else:
95 current_path = os.path.join(path, 'yt-dlp.conf')
96 args = Config.read_file(current_path, default=None)
97 if args is not None:
98 root.append_config(args, current_path, label=label)
99 return True
06e57990 100 return True
101
102 def load_configs():
103 yield not ignore_config_files
104 yield add_config('Portable', get_executable_path())
9e491463 105 yield add_config('Home', expand_path(root.parse_known_args()[0].paths.get('home', '')).strip())
8e40b9d1
M
106 yield add_config('User', func=_read_user_conf)
107 yield add_config('System', func=_read_system_conf)
06e57990 108
9e491463 109 opts = optparse.Values({'verbose': True, 'print_help': False})
110 try:
44a6fcff 111 try:
112 if overrideArguments:
113 root.append_config(overrideArguments, label='Override')
114 else:
115 root.append_config(sys.argv[1:], label='Command-line')
116 loaded_all_configs = all(load_configs())
117 except ValueError as err:
118 raise root.parser.error(err)
9e491463 119
44a6fcff 120 if loaded_all_configs:
9e491463 121 # If ignoreconfig is found inside the system configuration file,
122 # the user configuration is removed
123 if root.parse_known_args()[0].ignoreconfig:
124 user_conf = next((i for i, conf in enumerate(root.configs) if conf.label == 'User'), None)
125 if user_conf is not None:
126 root.configs.pop(user_conf)
06e57990 127
284a60c5 128 try:
129 root.configs[0].load_configs() # Resolve any aliases using --config-location
130 except ValueError as err:
131 raise root.parser.error(err)
132
9e491463 133 opts, args = root.parse_args()
134 except optparse.OptParseError:
135 with contextlib.suppress(optparse.OptParseError):
136 opts, _ = root.parse_known_args(strict=False)
137 raise
138 except (SystemExit, KeyboardInterrupt):
139 opts.verbose = False
140 raise
141 finally:
142 verbose = opts.verbose and f'\n{root}'.replace('\n| ', '\n[debug] ')[1:]
143 if verbose:
144 write_string(f'{verbose}\n')
145 if opts.print_help:
146 if verbose:
147 write_string('\n')
148 root.parser.print_help()
149 if opts.print_help:
150 sys.exit()
151 return root.parser, opts, args
06e57990 152
153
19a03940 154class _YoutubeDLHelpFormatter(optparse.IndentedHelpFormatter):
155 def __init__(self):
156 # No need to wrap help messages if we're on a wide console
ac668111 157 max_width = shutil.get_terminal_size().columns or 80
2dd5a2e3 158 # The % is chosen to get a pretty output in README.md
159 super().__init__(width=max_width, max_help_position=int(0.45 * max_width))
19a03940 160
161 @staticmethod
162 def format_option_strings(option):
163 """ ('-o', '--option') -> -o, --format METAVAR """
164 opts = join_nonempty(
165 option._short_opts and option._short_opts[0],
166 option._long_opts and option._long_opts[0],
167 delim=', ')
168 if option.takes_value():
169 opts += f' {option.metavar}'
170 return opts
171
172
db2e129c 173class _YoutubeDLOptionParser(optparse.OptionParser):
174 # optparse is deprecated since python 3.2. So assume a stable interface even for private methods
ca7f8b8f 175 ALIAS_DEST = '_triggered_aliases'
9e491463 176 ALIAS_TRIGGER_LIMIT = 100
db2e129c 177
19a03940 178 def __init__(self):
179 super().__init__(
9e491463 180 prog='yt-dlp' if detect_variant() == 'source' else None,
19a03940 181 version=__version__,
182 usage='%prog [OPTIONS] URL [URL...]',
183 epilog='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
184 formatter=_YoutubeDLHelpFormatter(),
185 conflict_handler='resolve',
186 )
ca7f8b8f 187 self.set_default(self.ALIAS_DEST, collections.defaultdict(int))
19a03940 188
9e491463 189 _UNKNOWN_OPTION = (optparse.BadOptionError, optparse.AmbiguousOptionError)
190 _BAD_OPTION = optparse.OptionValueError
191
192 def parse_known_args(self, args=None, values=None, strict=True):
193 """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args"""
194 self.rargs, self.largs = self._get_args(args), []
195 self.values = values or self.get_default_values()
196 while self.rargs:
c800598c 197 arg = self.rargs[0]
9e491463 198 try:
c800598c 199 if arg == '--':
200 del self.rargs[0]
201 break
202 elif arg.startswith('--'):
203 self._process_long_opt(self.rargs, self.values)
204 elif arg.startswith('-') and arg != '-':
205 self._process_short_opts(self.rargs, self.values)
206 elif self.allow_interspersed_args:
207 self.largs.append(self.rargs.pop(0))
208 else:
209 break
9e491463 210 except optparse.OptParseError as err:
211 if isinstance(err, self._UNKNOWN_OPTION):
212 self.largs.append(err.opt_str)
213 elif strict:
214 if isinstance(err, self._BAD_OPTION):
215 self.error(str(err))
216 raise
217 return self.check_values(self.values, self.largs)
218
219 def error(self, msg):
44a6fcff 220 msg = f'{self.get_prog_name()}: error: {str(msg).strip()}\n'
9e491463 221 raise optparse.OptParseError(f'{self.get_usage()}\n{msg}' if self.usage else msg)
222
19a03940 223 def _get_args(self, args):
224 return sys.argv[1:] if args is None else list(args)
225
db2e129c 226 def _match_long_opt(self, opt):
962ffcf8 227 """Improve ambiguous argument resolution by comparing option objects instead of argument strings"""
db2e129c 228 try:
229 return super()._match_long_opt(opt)
230 except optparse.AmbiguousOptionError as e:
86e5f3ed 231 if len({self._long_opt[p] for p in e.possibilities}) == 1:
db2e129c 232 return e.possibilities[0]
233 raise
234
235
06e57990 236def create_parser():
d21bba78 237 def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=',', process=str.strip):
e632bce2 238 # append can be True, False or -1 (prepend)
9e907ebd 239 current = list(getattr(parser.values, option.dest)) if append else []
1f8471e2 240 value = list(filter(None, [process(value)] if delim is None else map(process, value.split(delim))))
d818eb74 241 setattr(
242 parser.values, option.dest,
e632bce2 243 current + value if append is True else value + current)
34a741a8 244
31654882 245 def _set_from_options_callback(
5314b521 246 option, opt_str, value, parser, allowed_values, delim=',', aliases={},
d21bba78 247 process=lambda x: x.lower().strip()):
5314b521 248 values = [process(value)] if delim is None else map(process, value.split(delim))
249 try:
250 requested = orderedSet_from_options(values, collections.ChainMap(aliases, {'all': allowed_values}),
251 start=getattr(parser.values, option.dest))
252 except ValueError as e:
253 raise optparse.OptionValueError(f'wrong {option.metavar} for {opt_str}: {e.args[0]}')
31654882 254
5314b521 255 setattr(parser.values, option.dest, set(requested))
31654882 256
e632bce2 257 def _dict_from_options_callback(
d818eb74 258 option, opt_str, value, parser,
44bcb8d1 259 allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True,
ca30f449 260 process_key=str.lower, append=False):
45016689 261
ca30f449 262 out_dict = dict(getattr(parser.values, option.dest))
bb66c247 263 multiple_args = not isinstance(value, str)
d818eb74 264 if multiple_keys:
86e5f3ed 265 allowed_keys = fr'({allowed_keys})(,({allowed_keys}))*'
bb66c247 266 mobj = re.match(
86e5f3ed 267 fr'(?i)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
bb66c247 268 value[0] if multiple_args else value)
45016689 269 if mobj is not None:
44bcb8d1 270 keys, val = mobj.group('keys').split(','), mobj.group('val')
bb66c247 271 if multiple_args:
272 val = [val, *value[1:]]
45016689 273 elif default_key is not None:
d818eb74 274 keys, val = [default_key], value
45016689 275 else:
276 raise optparse.OptionValueError(
86e5f3ed 277 f'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
4bb6b02f 278 try:
44bcb8d1 279 keys = map(process_key, keys) if process_key else keys
4bb6b02f 280 val = process(val) if process else val
281 except Exception as err:
44bcb8d1 282 raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}')
d818eb74 283 for key in keys:
ca30f449 284 out_dict[key] = out_dict.get(key, []) + [val] if append else val
285 setattr(parser.values, option.dest, out_dict)
45016689 286
119e40ef 287 def when_prefix(default):
288 return {
289 'default': {},
290 'type': 'str',
291 'action': 'callback',
292 'callback': _dict_from_options_callback,
293 'callback_kwargs': {
294 'allowed_keys': '|'.join(map(re.escape, POSTPROCESS_WHEN)),
295 'default_key': default,
296 'multiple_keys': False,
297 'append': True,
298 },
299 }
300
19a03940 301 parser = _YoutubeDLOptionParser()
9e491463 302 alias_group = optparse.OptionGroup(parser, 'Aliases')
303 Formatter = string.Formatter()
304
305 def _create_alias(option, opt_str, value, parser):
306 aliases, opts = value
307 try:
308 nargs = len({i if f == '' else f
309 for i, (_, f, _, _) in enumerate(Formatter.parse(opts)) if f is not None})
310 opts.format(*map(str, range(nargs))) # validate
311 except Exception as err:
312 raise optparse.OptionValueError(f'wrong {opt_str} OPTIONS formatting; {err}')
313 if alias_group not in parser.option_groups:
314 parser.add_option_group(alias_group)
315
316 aliases = (x if x.startswith('-') else f'--{x}' for x in map(str.strip, aliases.split(',')))
317 try:
46d09f87 318 args = [f'ARG{i}' for i in range(nargs)]
9e491463 319 alias_group.add_option(
46d09f87 320 *aliases, nargs=nargs, dest=parser.ALIAS_DEST, type='str' if nargs else None,
321 metavar=' '.join(args), help=opts.format(*args), action='callback',
9e491463 322 callback=_alias_callback, callback_kwargs={'opts': opts, 'nargs': nargs})
323 except Exception as err:
324 raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}')
325
326 def _alias_callback(option, opt_str, value, parser, opts, nargs):
327 counter = getattr(parser.values, option.dest)
328 counter[opt_str] += 1
329 if counter[opt_str] > parser.ALIAS_TRIGGER_LIMIT:
330 raise optparse.OptionValueError(f'Alias {opt_str} exceeded invocation limit')
331 if nargs == 1:
332 value = [value]
333 assert (nargs == 0 and value is None) or len(value) == nargs
334 parser.rargs[:0] = shlex.split(
335 opts if value is None else opts.format(*map(shlex.quote, value)))
34a741a8 336
8450c15c
PH
337 general = optparse.OptionGroup(parser, 'General Options')
338 general.add_option(
9e491463 339 '-h', '--help', dest='print_help', action='store_true',
17941321 340 help='Print this help text and exit')
8450c15c 341 general.add_option(
b76f0e58 342 '--version',
8450c15c 343 action='version',
17941321 344 help='Print program version and exit')
8450c15c
PH
345 general.add_option(
346 '-U', '--update',
347 action='store_true', dest='update_self',
70b23409 348 help=format_field(
349 is_non_updateable(), None, 'Check if updates are available. %s',
350 default='Update this program to the latest version'))
d32f30ac 351 general.add_option(
352 '--no-update',
353 action='store_false', dest='update_self',
70b23409 354 help='Do not check for updates (default)')
8450c15c 355 general.add_option(
b1940459 356 '-i', '--ignore-errors',
357 action='store_true', dest='ignoreerrors',
0930b11f 358 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
b1940459 359 general.add_option(
360 '--no-abort-on-error',
361 action='store_const', dest='ignoreerrors', const='only_download',
362 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
8450c15c 363 general.add_option(
6623ac34 364 '--abort-on-error', '--no-ignore-errors',
8450c15c 365 action='store_false', dest='ignoreerrors',
8a51f564 366 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
8450c15c
PH
367 general.add_option(
368 '--dump-user-agent',
369 action='store_true', dest='dump_user_agent', default=False,
34488702 370 help='Display the current user-agent and exit')
34a741a8 371 general.add_option(
8450c15c
PH
372 '--list-extractors',
373 action='store_true', dest='list_extractors', default=False,
b7b04c78 374 help='List all supported extractors and exit')
8450c15c
PH
375 general.add_option(
376 '--extractor-descriptions',
377 action='store_true', dest='list_extractor_descriptions', default=False,
b7b04c78 378 help='Output descriptions of all supported extractors and exit')
fe7866d0 379 general.add_option(
380 '--use-extractors', '--ies',
381 action='callback', dest='allowed_extractors', metavar='NAMES', type='str',
382 default=[], callback=_list_from_options_callback,
383 help=(
384 'Extractor names to use separated by commas. '
385 'You can also use regexes, "all", "default" and "end" (end URL matching); '
386 'e.g. --ies "holodex.*,end,youtube". '
387 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. '
2516cafb 388 'Use --list-extractors for a list of extractor names. (Alias: --ies)'))
d22dec74
S
389 general.add_option(
390 '--force-generic-extractor',
391 action='store_true', dest='force_generic_extractor', default=False,
fe7866d0 392 help=optparse.SUPPRESS_HELP)
34a741a8
PH
393 general.add_option(
394 '--default-search',
395 dest='default_search', metavar='PREFIX',
2dd5a2e3 396 help=(
397 'Use this prefix for unqualified URLs. '
62b58c09 398 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". '
2dd5a2e3 399 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
400 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
401 'but emits an error if this is not possible instead of searching'))
34a741a8 402 general.add_option(
6623ac34 403 '--ignore-config', '--no-config',
7303f84a 404 action='store_true', dest='ignoreconfig',
6623ac34 405 help=(
9e907ebd 406 'Don\'t load any more configuration files except those given by --config-locations. '
ed8d87f9 407 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
fc5fa964 408 '(Alias: --no-config)'))
e66dca5e 409 general.add_option(
06e57990 410 '--no-config-locations',
411 action='store_const', dest='config_locations', const=[],
412 help=(
413 'Do not load any custom configuration files (default). When given inside a '
414 'configuration file, ignore all previous --config-locations defined in the current file'))
415 general.add_option(
416 '--config-locations',
417 dest='config_locations', metavar='PATH', action='append',
418 help=(
6b9e832d 419 'Location of the main configuration file; either the path to the config or its containing directory '
420 '("-" for stdin). Can be used multiple times and inside other configuration files'))
057a5206
PH
421 general.add_option(
422 '--flat-playlist',
6623ac34 423 action='store_const', dest='extract_flat', const='in_playlist', default=False,
8a51f564 424 help='Do not extract the videos of a playlist, only list them')
6623ac34 425 general.add_option(
426 '--no-flat-playlist',
427 action='store_false', dest='extract_flat',
428 help='Extract the videos of a playlist')
adbc4ec4
THD
429 general.add_option(
430 '--live-from-start',
431 action='store_true', dest='live_from_start',
9e907ebd 432 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
adbc4ec4
THD
433 general.add_option(
434 '--no-live-from-start',
435 action='store_false', dest='live_from_start',
436 help='Download livestreams from the current time (default)')
f2ebc5c7 437 general.add_option(
438 '--wait-for-video',
439 dest='wait_for_video', metavar='MIN[-MAX]', default=None,
440 help=(
441 'Wait for scheduled streams to become available. '
442 'Pass the minimum number of seconds (or range) to wait between retries'))
443 general.add_option(
444 '--no-wait-for-video',
445 dest='wait_for_video', action='store_const', const=None,
446 help='Do not wait for scheduled streams (default)')
d77ab8e2
S
447 general.add_option(
448 '--mark-watched',
449 action='store_true', dest='mark_watched', default=False,
e248be33 450 help='Mark videos watched (even with --simulate)')
90f794c6
S
451 general.add_option(
452 '--no-mark-watched',
597c1866 453 action='store_false', dest='mark_watched',
454 help='Do not mark videos watched (default)')
7e5db8c9 455 general.add_option(
f2df4071 456 '--no-colors', '--no-colours',
597c1866 457 action='store_true', dest='no_color', default=False,
f2df4071 458 help='Do not emit color codes in output (Alias: --no-colours)')
53ed7066 459 general.add_option(
460 '--compat-options',
31654882 461 metavar='OPTS', dest='compat_opts', default=set(), type='str',
462 action='callback', callback=_set_from_options_callback,
463 callback_kwargs={
464 'allowed_values': {
5c3895ff 465 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
31654882 466 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
d2c8aadf 467 'no-attach-info-json', 'embed-metadata', 'embed-thumbnail-atomicparsley',
468 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
469 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
d21bba78 470 }, 'aliases': {
5314b521 471 'youtube-dl': ['all', '-multistreams'],
472 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat'],
2a06bb4e 473 '2021': ['2022', 'no-certifi', 'filename-sanitization', 'no-youtube-prefer-utc-upload-date'],
474 '2022': [],
31654882 475 }
476 }, help=(
477 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
53ed7066 478 'configurations by reverting some of the changes made in yt-dlp. '
479 'See "Differences in default behavior" for details'))
9e491463 480 general.add_option(
481 '--alias', metavar='ALIASES OPTIONS', dest='_', type='str', nargs=2,
482 action='callback', callback=_create_alias,
483 help=(
484 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
485 'Arguments are parsed according to the Python string formatting mini-language. '
62b58c09 486 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
9e491463 487 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
488 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
962ffcf8 489 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
9e491463 490 f'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
491 'This option can be used multiple times'))
34a741a8 492
be4a824d
PH
493 network = optparse.OptionGroup(parser, 'Network Options')
494 network.add_option(
495 '--proxy', dest='proxy',
496 default=None, metavar='URL',
6623ac34 497 help=(
62b58c09
L
498 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
499 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
be4a824d
PH
500 network.add_option(
501 '--socket-timeout',
502 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
503 help='Time to wait before giving up, in seconds')
504 network.add_option(
505 '--source-address',
506 metavar='IP', dest='source_address', default=None,
24ee6b97 507 help='Client-side IP address to bind to',
be4a824d 508 )
500b8b41
PH
509 network.add_option(
510 '-4', '--force-ipv4',
511 action='store_const', const='0.0.0.0', dest='source_address',
24ee6b97 512 help='Make all connections via IPv4',
500b8b41
PH
513 )
514 network.add_option(
515 '-6', '--force-ipv6',
516 action='store_const', const='::', dest='source_address',
24ee6b97 517 help='Make all connections via IPv6',
500b8b41 518 )
0aa10994 519
b31fdeed 520 geo = optparse.OptionGroup(parser, 'Geo-restriction')
0aa10994 521 geo.add_option(
38cce791
YCH
522 '--geo-verification-proxy',
523 dest='geo_verification_proxy', default=None, metavar='URL',
6623ac34 524 help=(
525 'Use this proxy to verify the IP address for some geo-restricted sites. '
8a51f564 526 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
0aa10994 527 geo.add_option(
91410c9b
PH
528 '--cn-verification-proxy',
529 dest='cn_verification_proxy', default=None, metavar='URL',
0aa10994
S
530 help=optparse.SUPPRESS_HELP)
531 geo.add_option(
532 '--geo-bypass',
533 action='store_true', dest='geo_bypass', default=True,
455a15e2 534 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header (default)')
0aa10994
S
535 geo.add_option(
536 '--no-geo-bypass',
455a15e2 537 action='store_false', dest='geo_bypass',
504f20dd 538 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
0aa10994
S
539 geo.add_option(
540 '--geo-bypass-country', metavar='CODE',
541 dest='geo_bypass_country', default=None,
504f20dd 542 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
5f95927a
S
543 geo.add_option(
544 '--geo-bypass-ip-block', metavar='IP_BLOCK',
545 dest='geo_bypass_ip_block', default=None,
504f20dd 546 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
be4a824d 547
8450c15c 548 selection = optparse.OptionGroup(parser, 'Video Selection')
34a741a8
PH
549 selection.add_option(
550 '--playlist-start',
551 dest='playliststart', metavar='NUMBER', default=1, type=int,
7e88d7d7 552 help=optparse.SUPPRESS_HELP)
34a741a8
PH
553 selection.add_option(
554 '--playlist-end',
555 dest='playlistend', metavar='NUMBER', default=None, type=int,
7e88d7d7 556 help=optparse.SUPPRESS_HELP)
c14e88f0 557 selection.add_option(
7e88d7d7 558 '-I', '--playlist-items',
c14e88f0 559 dest='playlist_items', metavar='ITEM_SPEC', default=None,
7e88d7d7 560 help=(
71df9b7f 561 'Comma separated playlist_index of the items to download. '
7e88d7d7 562 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
563 'Use negative indices to count from the right and negative STEP to download in reverse order. '
71df9b7f 564 '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'))
34a741a8 565 selection.add_option(
8450c15c
PH
566 '--match-title',
567 dest='matchtitle', metavar='REGEX',
8f18aca8 568 help=optparse.SUPPRESS_HELP)
8450c15c
PH
569 selection.add_option(
570 '--reject-title',
571 dest='rejecttitle', metavar='REGEX',
8f18aca8 572 help=optparse.SUPPRESS_HELP)
8450c15c
PH
573 selection.add_option(
574 '--min-filesize',
575 metavar='SIZE', dest='min_filesize', default=None,
46d09f87 576 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
8450c15c
PH
577 selection.add_option(
578 '--max-filesize',
579 metavar='SIZE', dest='max_filesize', default=None,
71df9b7f 580 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
8450c15c
PH
581 selection.add_option(
582 '--date',
583 metavar='DATE', dest='date', default=None,
c76eb41b 584 help=(
3d38b2d6 585 'Download only videos uploaded on this date. The date can be "YYYYMMDD" or in the format '
62b58c09 586 '[now|today|yesterday][-N[day|week|month|year]]. E.g. --date today-2weeks'))
8450c15c
PH
587 selection.add_option(
588 '--datebefore',
589 metavar='DATE', dest='datebefore', default=None,
c76eb41b 590 help=(
591 'Download only videos uploaded on or before this date. '
592 'The date formats accepted is the same as --date'))
34a741a8 593 selection.add_option(
8450c15c
PH
594 '--dateafter',
595 metavar='DATE', dest='dateafter', default=None,
c76eb41b 596 help=(
597 'Download only videos uploaded on or after this date. '
598 'The date formats accepted is the same as --date'))
34a741a8 599 selection.add_option(
8450c15c
PH
600 '--min-views',
601 metavar='COUNT', dest='min_views', default=None, type=int,
8f18aca8 602 help=optparse.SUPPRESS_HELP)
34a741a8 603 selection.add_option(
8450c15c
PH
604 '--max-views',
605 metavar='COUNT', dest='max_views', default=None, type=int,
8f18aca8 606 help=optparse.SUPPRESS_HELP)
347de493 607 selection.add_option(
b1a7cd05 608 '--match-filters',
609 metavar='FILTER', dest='match_filter', action='append',
347de493 610 help=(
2dd5a2e3 611 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
d4ada357 612 'number or a string using the operators defined in "Filtering Formats". '
b1a7cd05 613 'You can also simply specify a field to match if the field is present, '
614 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
615 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
62b58c09 616 'the filter matches if atleast one of the conditions are met. E.g. --match-filter '
b1a7cd05 617 '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
618 'matches only videos that are not live OR those that have a like count more than 100 '
619 '(or the like field is not available) and also has a description '
2dd5a2e3 620 'that contains the phrase "cats & dogs" (caseless). '
492272fe 621 'Use "--match-filter -" to interactively ask whether to download each video'))
6623ac34 622 selection.add_option(
623 '--no-match-filter',
624 metavar='FILTER', dest='match_filter', action='store_const', const=None,
625 help='Do not use generic video filter (default)')
34a741a8 626 selection.add_option(
8450c15c
PH
627 '--no-playlist',
628 action='store_true', dest='noplaylist', default=False,
8a51f564 629 help='Download only the video, if the URL refers to a video and a playlist')
df4bd0d5
PH
630 selection.add_option(
631 '--yes-playlist',
f0884c8b 632 action='store_false', dest='noplaylist',
8a51f564 633 help='Download the playlist, if the URL refers to a video and a playlist')
8450c15c
PH
634 selection.add_option(
635 '--age-limit',
636 metavar='YEARS', dest='age_limit', default=None, type=int,
17941321 637 help='Download only videos suitable for the given age')
8450c15c
PH
638 selection.add_option(
639 '--download-archive', metavar='FILE',
640 dest='download_archive',
8a51f564 641 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
f304da8a 642 selection.add_option(
643 '--no-download-archive',
644 dest='download_archive', action="store_const", const=None,
645 help='Do not use archive file (default)')
646 selection.add_option(
647 '--max-downloads',
648 dest='max_downloads', metavar='NUMBER', type=int, default=None,
649 help='Abort after downloading NUMBER files')
ea6e0c2b 650 selection.add_option(
651 '--break-on-existing',
652 action='store_true', dest='break_on_existing', default=False,
8a51f564 653 help='Stop the download process when encountering a file that is in the archive')
8b0d7497 654 selection.add_option(
655 '--break-on-reject',
656 action='store_true', dest='break_on_reject', default=False,
8a51f564 657 help='Stop the download process when encountering a file that has been filtered out')
b222c271 658 selection.add_option(
659 '--break-per-input',
660 action='store_true', dest='break_per_url', default=False,
71df9b7f 661 help='Alters --max-downloads, --break-on-existing, --break-on-reject, and autonumber to reset per input URL')
b222c271 662 selection.add_option(
663 '--no-break-per-input',
664 action='store_false', dest='break_per_url',
490110c5 665 help='--break-on-existing and similar options terminates the entire download queue')
26e2805c 666 selection.add_option(
667 '--skip-playlist-after-errors', metavar='N',
668 dest='skip_playlist_after_errors', default=None, type=int,
669 help='Number of allowed failures until the rest of the playlist is skipped')
8450c15c
PH
670 selection.add_option(
671 '--include-ads',
672 dest='include_ads', action='store_true',
d9aa2332 673 help=optparse.SUPPRESS_HELP)
6623ac34 674 selection.add_option(
675 '--no-include-ads',
676 dest='include_ads', action='store_false',
d9aa2332 677 help=optparse.SUPPRESS_HELP)
34a741a8 678
8450c15c
PH
679 authentication = optparse.OptionGroup(parser, 'Authentication Options')
680 authentication.add_option(
681 '-u', '--username',
682 dest='username', metavar='USERNAME',
17941321 683 help='Login with this account ID')
8450c15c
PH
684 authentication.add_option(
685 '-p', '--password',
686 dest='password', metavar='PASSWORD',
7a5c1cfe 687 help='Account password. If this option is left out, yt-dlp will ask interactively')
8450c15c
PH
688 authentication.add_option(
689 '-2', '--twofactor',
690 dest='twofactor', metavar='TWOFACTOR',
3540fe26 691 help='Two-factor authentication code')
8450c15c
PH
692 authentication.add_option(
693 '-n', '--netrc',
694 action='store_true', dest='usenetrc', default=False,
17941321 695 help='Use .netrc authentication data')
0001fcb5 696 authentication.add_option(
697 '--netrc-location',
698 dest='netrc_location', metavar='PATH',
699 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
8450c15c
PH
700 authentication.add_option(
701 '--video-password',
702 dest='videopassword', metavar='PASSWORD',
29f7c58a 703 help='Video password (vimeo, youku)')
b31fdeed 704 authentication.add_option(
797c636b
RA
705 '--ap-mso',
706 dest='ap_mso', metavar='MSO',
537f7533 707 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
b31fdeed 708 authentication.add_option(
1b6712ab 709 '--ap-username',
797c636b 710 dest='ap_username', metavar='USERNAME',
537f7533 711 help='Multiple-system operator account login')
b31fdeed 712 authentication.add_option(
1b6712ab 713 '--ap-password',
797c636b 714 dest='ap_password', metavar='PASSWORD',
7a5c1cfe 715 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
b31fdeed 716 authentication.add_option(
87148bb7
RA
717 '--ap-list-mso',
718 action='store_true', dest='ap_list_mso', default=False,
537f7533 719 help='List all supported multiple-system operators')
bb58c9ed 720 authentication.add_option(
721 '--client-certificate',
722 dest='client_certificate', metavar='CERTFILE',
723 help='Path to client certificate file in PEM format. May include the private key')
724 authentication.add_option(
725 '--client-certificate-key',
726 dest='client_certificate_key', metavar='KEYFILE',
727 help='Path to private key file for client certificate')
728 authentication.add_option(
729 '--client-certificate-password',
730 dest='client_certificate_password', metavar='PASSWORD',
731 help='Password for client certificate private key, if encrypted. '
2dd5a2e3 732 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
8450c15c
PH
733
734 video_format = optparse.OptionGroup(parser, 'Video Format Options')
735 video_format.add_option(
736 '-f', '--format',
737 action='store', dest='format', metavar='FORMAT', default=None,
eb8a4433 738 help='Video format code, see "FORMAT SELECTION" for more details')
739 video_format.add_option(
c76eb41b 740 '-S', '--format-sort', metavar='SORTORDER',
e632bce2 741 dest='format_sort', default=[], type='str', action='callback',
742 callback=_list_from_options_callback, callback_kwargs={'append': -1},
eb8a4433 743 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
744 video_format.add_option(
745 '--format-sort-force', '--S-force',
746 action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
747 help=(
748 'Force user specified sort order to have precedence over all fields, '
2dd5a2e3 749 'see "Sorting Formats" for more details (Alias: --S-force)'))
eb8a4433 750 video_format.add_option(
751 '--no-format-sort-force',
752 action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
2dd5a2e3 753 help='Some fields have precedence over the user specified sort order (default)')
909d24dd 754 video_format.add_option(
755 '--video-multistreams',
53ed7066 756 action='store_true', dest='allow_multiple_video_streams', default=None,
91ebc640 757 help='Allow multiple video streams to be merged into a single file')
909d24dd 758 video_format.add_option(
759 '--no-video-multistreams',
760 action='store_false', dest='allow_multiple_video_streams',
91ebc640 761 help='Only one video stream is downloaded for each output file (default)')
909d24dd 762 video_format.add_option(
763 '--audio-multistreams',
53ed7066 764 action='store_true', dest='allow_multiple_audio_streams', default=None,
91ebc640 765 help='Allow multiple audio streams to be merged into a single file')
909d24dd 766 video_format.add_option(
767 '--no-audio-multistreams',
768 action='store_false', dest='allow_multiple_audio_streams',
91ebc640 769 help='Only one audio stream is downloaded for each output file (default)')
8450c15c
PH
770 video_format.add_option(
771 '--all-formats',
772 action='store_const', dest='format', const='all',
d9aa2332 773 help=optparse.SUPPRESS_HELP)
8450c15c
PH
774 video_format.add_option(
775 '--prefer-free-formats',
776 action='store_true', dest='prefer_free_formats', default=False,
da9be05e 777 help=(
778 'Prefer video formats with free containers over non-free ones of same quality. '
779 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
780 video_format.add_option(
781 '--no-prefer-free-formats',
1c36c1f3 782 action='store_false', dest='prefer_free_formats', default=False,
da9be05e 783 help="Don't give any special preference to free containers (default)")
e8e73840 784 video_format.add_option(
785 '--check-formats',
9f1a1c36 786 action='store_const', const='selected', dest='check_formats', default=None,
ebc7d3ff 787 help='Make sure formats are selected only from those that are actually downloadable')
9f1a1c36 788 video_format.add_option(
789 '--check-all-formats',
790 action='store_true', dest='check_formats',
791 help='Check all formats for whether they are actually downloadable')
0ba692ac 792 video_format.add_option(
793 '--no-check-formats',
794 action='store_false', dest='check_formats',
9f1a1c36 795 help='Do not check that the formats are actually downloadable')
8450c15c
PH
796 video_format.add_option(
797 '-F', '--list-formats',
798 action='store_true', dest='listformats',
b7b04c78 799 help='List available formats of each video. Simulate unless --no-simulate is used')
76d321f6 800 video_format.add_option(
801 '--list-formats-as-table',
91ebc640 802 action='store_true', dest='listformats_table', default=True,
53ed7066 803 help=optparse.SUPPRESS_HELP)
76d321f6 804 video_format.add_option(
6623ac34 805 '--list-formats-old', '--no-list-formats-as-table',
76d321f6 806 action='store_false', dest='listformats_table',
53ed7066 807 help=optparse.SUPPRESS_HELP)
d120e901 808 video_format.add_option(
bd1a281e
PH
809 '--merge-output-format',
810 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
d120e901 811 help=(
62b58c09 812 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
fc61aff4 813 'Ignored if no merge is required. '
4f04be6a 814 f'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
63ad4d43 815 video_format.add_option(
816 '--allow-unplayable-formats',
817 action='store_true', dest='allow_unplayable_formats', default=False,
88acdbc2 818 help=optparse.SUPPRESS_HELP)
63ad4d43 819 video_format.add_option(
820 '--no-allow-unplayable-formats',
821 action='store_false', dest='allow_unplayable_formats',
88acdbc2 822 help=optparse.SUPPRESS_HELP)
8450c15c
PH
823
824 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
825 subtitles.add_option(
6623ac34 826 '--write-subs', '--write-srt',
8450c15c 827 action='store_true', dest='writesubtitles', default=False,
17941321 828 help='Write subtitle file')
8450c15c 829 subtitles.add_option(
6623ac34 830 '--no-write-subs', '--no-write-srt',
831 action='store_false', dest='writesubtitles',
832 help='Do not write subtitle file (default)')
833 subtitles.add_option(
834 '--write-auto-subs', '--write-automatic-subs',
8450c15c 835 action='store_true', dest='writeautomaticsub', default=False,
e167860c 836 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
6623ac34 837 subtitles.add_option(
838 '--no-write-auto-subs', '--no-write-automatic-subs',
839 action='store_false', dest='writeautomaticsub', default=False,
e167860c 840 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
8450c15c
PH
841 subtitles.add_option(
842 '--all-subs',
843 action='store_true', dest='allsubtitles', default=False,
c32b0aab 844 help=optparse.SUPPRESS_HELP)
8450c15c
PH
845 subtitles.add_option(
846 '--list-subs',
847 action='store_true', dest='listsubtitles', default=False,
b7b04c78 848 help='List available subtitles of each video. Simulate unless --no-simulate is used')
8450c15c
PH
849 subtitles.add_option(
850 '--sub-format',
a504ced0 851 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
62b58c09 852 help='Subtitle format; accepts formats preference, e.g. "srt" or "ass/srt/best"')
8450c15c 853 subtitles.add_option(
e167860c 854 '--sub-langs', '--srt-langs',
8450c15c 855 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
e632bce2 856 default=[], callback=_list_from_options_callback,
c32b0aab 857 help=(
62b58c09
L
858 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja". '
859 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
c32b0aab 860 'Use --list-subs for a list of available language tags'))
8450c15c
PH
861
862 downloader = optparse.OptionGroup(parser, 'Download Options')
4cf1e5d2 863 downloader.add_option(
864 '-N', '--concurrent-fragments',
865 dest='concurrent_fragment_downloads', metavar='N', default=1, type=int,
b69fd25c 866 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
8450c15c 867 downloader.add_option(
8ec2b2c4
S
868 '-r', '--limit-rate', '--rate-limit',
869 dest='ratelimit', metavar='RATE',
62b58c09 870 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
51d9739f 871 downloader.add_option(
872 '--throttled-rate',
873 dest='throttledratelimit', metavar='RATE',
62b58c09 874 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
8450c15c
PH
875 downloader.add_option(
876 '-R', '--retries',
877 dest='retries', metavar='RETRIES', default=10,
8a51f564 878 help='Number of retries (default is %default), or "infinite"')
205a0654
EH
879 downloader.add_option(
880 '--file-access-retries',
45806d44 881 dest='file_access_retries', metavar='RETRIES', default=3,
205a0654 882 help='Number of times to retry on file access error (default is %default), or "infinite"')
52bb437e
S
883 downloader.add_option(
884 '--fragment-retries',
885 dest='fragment_retries', metavar='RETRIES', default=10,
12ee65ea 886 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
23326151 887 downloader.add_option(
888 '--retry-sleep',
889 dest='retry_sleep', metavar='[TYPE:]EXPR', default={}, type='str',
890 action='callback', callback=_dict_from_options_callback,
891 callback_kwargs={
be5c1ae8 892 'allowed_keys': 'http|fragment|file_access|extractor',
23326151 893 'default_key': 'http',
894 }, help=(
be5c1ae8 895 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
896 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
2dd5a2e3 897 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
62b58c09
L
898 'This option can be used multiple times to set the sleep for the different retry types, '
899 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
9603b660 900 downloader.add_option(
c76eb41b 901 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
9603b660 902 action='store_true', dest='skip_unavailable_fragments', default=True,
2dd5a2e3 903 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragment)')
732fb3f8 904 downloader.add_option(
6623ac34 905 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
9603b660 906 action='store_false', dest='skip_unavailable_fragments',
2dd5a2e3 907 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
0eee52f3
S
908 downloader.add_option(
909 '--keep-fragments',
910 action='store_true', dest='keep_fragments', default=False,
6623ac34 911 help='Keep downloaded fragments on disk after downloading is finished')
912 downloader.add_option(
913 '--no-keep-fragments',
914 action='store_false', dest='keep_fragments',
915 help='Delete downloaded fragments after downloading is finished (default)')
8450c15c
PH
916 downloader.add_option(
917 '--buffer-size',
918 dest='buffersize', metavar='SIZE', default='1024',
62b58c09 919 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
6623ac34 920 downloader.add_option(
921 '--resize-buffer',
922 action='store_false', dest='noresizebuffer',
923 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
8450c15c
PH
924 downloader.add_option(
925 '--no-resize-buffer',
926 action='store_true', dest='noresizebuffer', default=False,
6623ac34 927 help='Do not automatically adjust the buffer size')
ba515388
S
928 downloader.add_option(
929 '--http-chunk-size',
930 dest='http_chunk_size', metavar='SIZE', default=None,
6623ac34 931 help=(
62b58c09 932 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
6623ac34 933 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
8450c15c
PH
934 downloader.add_option(
935 '--test',
936 action='store_true', dest='test', default=False,
937 help=optparse.SUPPRESS_HELP)
ff815fe6
MS
938 downloader.add_option(
939 '--playlist-reverse',
7e9a6125 940 action='store_true', dest='playlist_reverse',
7e88d7d7 941 help=optparse.SUPPRESS_HELP)
6623ac34 942 downloader.add_option(
943 '--no-playlist-reverse',
c76eb41b 944 action='store_false', dest='playlist_reverse',
7e88d7d7 945 help=optparse.SUPPRESS_HELP)
75822ca7
TC
946 downloader.add_option(
947 '--playlist-random',
7e9a6125 948 action='store_true', dest='playlist_random',
75822ca7 949 help='Download playlist videos in random order')
7e9a6125 950 downloader.add_option(
951 '--lazy-playlist',
952 action='store_true', dest='lazy_playlist',
953 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
954 downloader.add_option(
955 '--no-lazy-playlist',
956 action='store_false', dest='lazy_playlist',
957 help='Process videos in the playlist only after the entire playlist is parsed (default)')
881e6a1f
PH
958 downloader.add_option(
959 '--xattr-set-filesize',
960 dest='xattr_set_filesize', action='store_true',
504f20dd 961 help='Set file xattribute ytdl.filesize with expected file size')
85729c51
PH
962 downloader.add_option(
963 '--hls-prefer-native',
bf09af3a 964 dest='hls_prefer_native', action='store_true', default=None,
52a8a1e1 965 help=optparse.SUPPRESS_HELP)
bf09af3a
S
966 downloader.add_option(
967 '--hls-prefer-ffmpeg',
968 dest='hls_prefer_native', action='store_false', default=None,
52a8a1e1 969 help=optparse.SUPPRESS_HELP)
7d106a65
JMF
970 downloader.add_option(
971 '--hls-use-mpegts',
9bd20204 972 dest='hls_use_mpegts', action='store_true', default=None,
6623ac34 973 help=(
9bd20204 974 'Use the mpegts container for HLS videos; '
975 'allowing some players to play the video while downloading, '
976 'and reducing the chance of file corruption if download is interrupted. '
977 'This is enabled by default for live streams'))
978 downloader.add_option(
979 '--no-hls-use-mpegts',
980 dest='hls_use_mpegts', action='store_false',
981 help=(
982 'Do not use the mpegts container for HLS videos. '
983 'This is default when not downloading live streams'))
5ec1b6b7 984 downloader.add_option(
985 '--download-sections',
986 metavar='REGEX', dest='download_ranges', action='append',
987 help=(
988 'Download only chapters whose title matches the given regular expression. '
989 'Time ranges prefixed by a "*" can also be used in place of chapters to download the specified range. '
62b58c09 990 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
fc2ba496 991 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
222516d9 992 downloader.add_option(
52a8a1e1 993 '--downloader', '--external-downloader',
994 dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str',
e632bce2 995 action='callback', callback=_dict_from_options_callback,
52a8a1e1 996 callback_kwargs={
997 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
cc0ec3e1 998 'default_key': 'default',
dbf5416a 999 'process': str.strip
1000 }, help=(
52a8a1e1 1001 'Name or path of the external downloader to use (optionally) prefixed by '
1002 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
8dc59305 1003 f'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
52a8a1e1 1004 'You can use this option multiple times to set different downloaders for different protocols. '
62b58c09 1005 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
52a8a1e1 1006 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
0a41f331 1007 '(Alias: --external-downloader)'))
c75f0b36 1008 downloader.add_option(
46ee996e 1009 '--downloader-args', '--external-downloader-args',
1010 metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
e632bce2 1011 action='callback', callback=_dict_from_options_callback,
b8f6bbe6 1012 callback_kwargs={
9e907ebd 1013 'allowed_keys': r'ffmpeg_[io]\d*|%s' % '|'.join(map(re.escape, list_external_downloaders())),
cc0ec3e1 1014 'default_key': 'default',
f9934b96 1015 'process': shlex.split
dbf5416a 1016 }, help=(
46ee996e 1017 'Give these arguments to the external downloader. '
1018 'Specify the downloader name and the arguments separated by a colon ":". '
330690a2 1019 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
5d3a0e79 1020 'You can use this option multiple times to give different arguments to different downloaders '
1021 '(Alias: --external-downloader-args)'))
8450c15c
PH
1022
1023 workarounds = optparse.OptionGroup(parser, 'Workarounds')
34a741a8 1024 workarounds.add_option(
8450c15c
PH
1025 '--encoding',
1026 dest='encoding', metavar='ENCODING',
34a741a8 1027 help='Force the specified encoding (experimental)')
f81c62a6 1028 workarounds.add_option(
1029 '--legacy-server-connect',
1030 action='store_true', dest='legacy_server_connect', default=False,
1031 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
34a741a8 1032 workarounds.add_option(
e6f21b3d 1033 '--no-check-certificates',
8450c15c 1034 action='store_true', dest='no_check_certificate', default=False,
17941321 1035 help='Suppress HTTPS certificate validation')
34a741a8 1036 workarounds.add_option(
6623ac34 1037 '--prefer-insecure', '--prefer-unsecure',
1038 action='store_true', dest='prefer_insecure',
e167860c 1039 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
34a741a8 1040 workarounds.add_option(
8450c15c
PH
1041 '--user-agent',
1042 metavar='UA', dest='user_agent',
8b7539d2 1043 help=optparse.SUPPRESS_HELP)
34a741a8 1044 workarounds.add_option(
8450c15c
PH
1045 '--referer',
1046 metavar='URL', dest='referer', default=None,
8b7539d2 1047 help=optparse.SUPPRESS_HELP)
34a741a8 1048 workarounds.add_option(
8450c15c 1049 '--add-header',
45016689 1050 metavar='FIELD:VALUE', dest='headers', default={}, type='str',
e632bce2 1051 action='callback', callback=_dict_from_options_callback,
8b7539d2 1052 callback_kwargs={'multiple_keys': False},
45016689 1053 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
34a741a8
PH
1054 )
1055 workarounds.add_option(
8450c15c
PH
1056 '--bidi-workaround',
1057 dest='bidi_workaround', action='store_true',
1058 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1cf376f5 1059 workarounds.add_option(
1060 '--sleep-requests', metavar='SECONDS',
1061 dest='sleep_interval_requests', type=float,
1062 help='Number of seconds to sleep between requests during data extraction')
5f0d813d 1063 workarounds.add_option(
065bc354 1064 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
649f7966 1065 dest='sleep_interval', type=float,
7aa589a5 1066 help=(
e167860c 1067 'Number of seconds to sleep before each download. '
1068 'This is the minimum time to sleep when used along with --max-sleep-interval '
1069 '(Alias: --min-sleep-interval)'))
065bc354 1070 workarounds.add_option(
1071 '--max-sleep-interval', metavar='SECONDS',
1072 dest='max_sleep_interval', type=float,
e167860c 1073 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
0c9df79e 1074 workarounds.add_option(
c76eb41b 1075 '--sleep-subtitles', metavar='SECONDS',
31108ce9 1076 dest='sleep_interval_subtitles', default=0, type=int,
1cf376f5 1077 help='Number of seconds to sleep before each subtitle download')
34a741a8 1078
0744a815 1079 verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
8450c15c
PH
1080 verbosity.add_option(
1081 '-q', '--quiet',
1082 action='store_true', dest='quiet', default=False,
34488702 1083 help='Activate quiet mode. If used with --verbose, print the log to stderr')
34a741a8
PH
1084 verbosity.add_option(
1085 '--no-warnings',
1086 dest='no_warnings', action='store_true', default=False,
1087 help='Ignore warnings')
8450c15c
PH
1088 verbosity.add_option(
1089 '-s', '--simulate',
b7b04c78 1090 action='store_true', dest='simulate', default=None,
17941321 1091 help='Do not download the video and do not write anything to disk')
b7b04c78 1092 verbosity.add_option(
1093 '--no-simulate',
1094 action='store_false', dest='simulate',
1095 help='Download the video even if printing/listing options are used')
b7da73eb 1096 verbosity.add_option(
1097 '--ignore-no-formats-error',
1098 action='store_true', dest='ignore_no_formats_error', default=False,
1099 help=(
0930b11f 1100 'Ignore "No video formats" error. Useful for extracting metadata '
34488702 1101 'even if the videos are not actually available for download (experimental)'))
b7da73eb 1102 verbosity.add_option(
1103 '--no-ignore-no-formats-error',
1104 action='store_false', dest='ignore_no_formats_error',
1105 help='Throw error when no downloadable video formats are found (default)')
8450c15c 1106 verbosity.add_option(
6623ac34 1107 '--skip-download', '--no-download',
8450c15c 1108 action='store_true', dest='skip_download', default=False,
e167860c 1109 help='Do not download the video but write all related files (Alias: --no-download)')
53c18592 1110 verbosity.add_option(
ad3dc496 1111 '-O', '--print',
119e40ef 1112 metavar='[WHEN:]TEMPLATE', dest='forceprint', **when_prefix('video'),
1113 help=(
ed5835b4 1114 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
119e40ef 1115 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
62f6f1cb 1116 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1117 'This option can be used multiple times'))
bb66c247 1118 verbosity.add_option(
1119 '--print-to-file',
119e40ef 1120 metavar='[WHEN:]TEMPLATE FILE', dest='print_to_file', nargs=2, **when_prefix('video'),
1121 help=(
bb66c247 1122 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
1123 'FILE uses the same syntax as the output template. This option can be used multiple times'))
8450c15c
PH
1124 verbosity.add_option(
1125 '-g', '--get-url',
1126 action='store_true', dest='geturl', default=False,
53c18592 1127 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1128 verbosity.add_option(
1129 '-e', '--get-title',
1130 action='store_true', dest='gettitle', default=False,
53c18592 1131 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1132 verbosity.add_option(
1133 '--get-id',
1134 action='store_true', dest='getid', default=False,
53c18592 1135 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1136 verbosity.add_option(
1137 '--get-thumbnail',
1138 action='store_true', dest='getthumbnail', default=False,
53c18592 1139 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1140 verbosity.add_option(
1141 '--get-description',
1142 action='store_true', dest='getdescription', default=False,
53c18592 1143 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1144 verbosity.add_option(
1145 '--get-duration',
1146 action='store_true', dest='getduration', default=False,
53c18592 1147 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1148 verbosity.add_option(
1149 '--get-filename',
1150 action='store_true', dest='getfilename', default=False,
53c18592 1151 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1152 verbosity.add_option(
1153 '--get-format',
1154 action='store_true', dest='getformat', default=False,
53c18592 1155 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1156 verbosity.add_option(
1157 '-j', '--dump-json',
1158 action='store_true', dest='dumpjson', default=False,
b7b04c78 1159 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
63e0be34
PH
1160 verbosity.add_option(
1161 '-J', '--dump-single-json',
1162 action='store_true', dest='dump_single_json', default=False,
6623ac34 1163 help=(
b7b04c78 1164 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1165 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
c0bdf32a
PH
1166 verbosity.add_option(
1167 '--print-json',
1168 action='store_true', dest='print_json', default=False,
b7b04c78 1169 help=optparse.SUPPRESS_HELP)
2d30509f 1170 verbosity.add_option(
c76eb41b 1171 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
2d30509f 1172 action='store_true', dest='force_write_download_archive', default=False,
1173 help=(
e58c22a0 1174 'Force download archive entries to be written as far as no errors occur, '
1175 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
8450c15c
PH
1176 verbosity.add_option(
1177 '--newline',
1178 action='store_true', dest='progress_with_newline', default=False,
17941321 1179 help='Output progress bar as new lines')
8450c15c
PH
1180 verbosity.add_option(
1181 '--no-progress',
819e0531 1182 action='store_true', dest='noprogress', default=None,
17941321 1183 help='Do not print progress bar')
819e0531 1184 verbosity.add_option(
1185 '--progress',
1186 action='store_false', dest='noprogress',
1187 help='Show progress bar, even if in quiet mode')
8450c15c
PH
1188 verbosity.add_option(
1189 '--console-title',
1190 action='store_true', dest='consoletitle', default=False,
17941321 1191 help='Display progress in console titlebar')
819e0531 1192 verbosity.add_option(
1193 '--progress-template',
1194 metavar='[TYPES:]TEMPLATE', dest='progress_template', default={}, type='str',
1195 action='callback', callback=_dict_from_options_callback,
1196 callback_kwargs={
1197 'allowed_keys': '(download|postprocess)(-title)?',
1198 'default_key': 'download'
1199 }, help=(
1200 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1201 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1202 'The video\'s fields are accessible under the "info" key and '
62b58c09 1203 'the progress attributes are accessible under "progress" key. E.g. '
819e0531 1204 # TODO: Document the fields inside "progress"
1205 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
8450c15c
PH
1206 verbosity.add_option(
1207 '-v', '--verbose',
1208 action='store_true', dest='verbose', default=False,
17941321 1209 help='Print various debugging information')
8450c15c 1210 verbosity.add_option(
8bba753c 1211 '--dump-pages', '--dump-intermediate-pages',
8450c15c 1212 action='store_true', dest='dump_intermediate_pages', default=False,
79979c68 1213 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
8450c15c
PH
1214 verbosity.add_option(
1215 '--write-pages',
1216 action='store_true', dest='write_pages', default=False,
1217 help='Write downloaded intermediary pages to files in the current directory to debug problems')
f95b9dee 1218 verbosity.add_option(
1219 '--load-pages',
1220 action='store_true', dest='load_pages', default=False,
1221 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1222 verbosity.add_option(
1223 '--youtube-print-sig-code',
1224 action='store_true', dest='youtube_print_sig_code', default=False,
1225 help=optparse.SUPPRESS_HELP)
1226 verbosity.add_option(
2f543a21 1227 '--print-traffic', '--dump-headers',
8450c15c
PH
1228 dest='debug_printtraffic', action='store_true', default=False,
1229 help='Display sent and read HTTP traffic')
58b1f00d
PH
1230 verbosity.add_option(
1231 '-C', '--call-home',
1232 dest='call_home', action='store_true', default=False,
19a03940 1233 # help='Contact the yt-dlp server for debugging')
8d801631 1234 help=optparse.SUPPRESS_HELP)
8bfa7545
PH
1235 verbosity.add_option(
1236 '--no-call-home',
6623ac34 1237 dest='call_home', action='store_false',
7a5c1cfe 1238 # help='Do not contact the yt-dlp server for debugging (default)')
8d801631 1239 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1240
1241 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
1242 filesystem.add_option(
1243 '-a', '--batch-file',
1244 dest='batchfile', metavar='FILE',
940a67a3 1245 help=(
1246 'File containing URLs to download ("-" for stdin), one URL per line. '
1247 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1e520b55
Z
1248 filesystem.add_option(
1249 '--no-batch-file',
1250 dest='batchfile', action='store_const', const=None,
1251 help='Do not read URLs from batch file (default)')
19b824f6 1252 filesystem.add_option(
1253 '--id', default=False,
1254 action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
0202b52a 1255 filesystem.add_option(
1256 '-P', '--paths',
d74a58a1 1257 metavar='[TYPES:]PATH', dest='paths', default={}, type='str',
e632bce2 1258 action='callback', callback=_dict_from_options_callback,
d74a58a1 1259 callback_kwargs={
9e907ebd 1260 'allowed_keys': 'home|temp|%s' % '|'.join(map(re.escape, OUTTMPL_TYPES.keys())),
d74a58a1 1261 'default_key': 'home'
1262 }, help=(
0202b52a 1263 'The paths where the files should be downloaded. '
de6000d9 1264 'Specify the type of file and the path separated by a colon ":". '
6a34813a 1265 'All the same TYPES as --output are supported. '
d74a58a1 1266 'Additionally, you can also provide "home" (default) and "temp" paths. '
0202b52a 1267 'All intermediary files are first downloaded to the temp path and '
1268 'then the final files are moved over to the home path after download is finished. '
de6000d9 1269 'This option is ignored if --output is an absolute path'))
8450c15c
PH
1270 filesystem.add_option(
1271 '-o', '--output',
d818eb74 1272 metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str',
e632bce2 1273 action='callback', callback=_dict_from_options_callback,
de6000d9 1274 callback_kwargs={
9e907ebd 1275 'allowed_keys': '|'.join(map(re.escape, OUTTMPL_TYPES.keys())),
cc0ec3e1 1276 'default_key': 'default'
dbf5416a 1277 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
a820dc72
RA
1278 filesystem.add_option(
1279 '--output-na-placeholder',
0bc0a322 1280 dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
2dd5a2e3 1281 help=('Placeholder for unavailable fields in "OUTPUT TEMPLATE" (default: "%default")'))
8450c15c
PH
1282 filesystem.add_option(
1283 '--autonumber-size',
be5df5ee
S
1284 dest='autonumber_size', metavar='NUMBER', type=int,
1285 help=optparse.SUPPRESS_HELP)
acbb2374
CP
1286 filesystem.add_option(
1287 '--autonumber-start',
1a241a2d 1288 dest='autonumber_start', metavar='NUMBER', default=1, type=int,
a439a3a4 1289 help=optparse.SUPPRESS_HELP)
8450c15c
PH
1290 filesystem.add_option(
1291 '--restrict-filenames',
1292 action='store_true', dest='restrictfilenames', default=False,
1293 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
6623ac34 1294 filesystem.add_option(
1295 '--no-restrict-filenames',
c2934512 1296 action='store_false', dest='restrictfilenames',
6623ac34 1297 help='Allow Unicode characters, "&" and spaces in filenames (default)')
c2934512 1298 filesystem.add_option(
1299 '--windows-filenames',
1300 action='store_true', dest='windowsfilenames', default=False,
0930b11f 1301 help='Force filenames to be Windows-compatible')
c2934512 1302 filesystem.add_option(
1303 '--no-windows-filenames',
1304 action='store_false', dest='windowsfilenames',
0930b11f 1305 help='Make filenames Windows-compatible only if using Windows (default)')
c2934512 1306 filesystem.add_option(
1307 '--trim-filenames', '--trim-file-names', metavar='LENGTH',
1308 dest='trim_file_name', default=0, type=int,
1309 help='Limit the filename length (excluding extension) to the specified number of characters')
8450c15c
PH
1310 filesystem.add_option(
1311 '-w', '--no-overwrites',
0c3d0f51 1312 action='store_false', dest='overwrites', default=None,
1313 help='Do not overwrite any files')
1314 filesystem.add_option(
1315 '--force-overwrites', '--yes-overwrites',
1316 action='store_true', dest='overwrites',
1317 help='Overwrite all video and metadata files. This option includes --no-continue')
1318 filesystem.add_option(
1319 '--no-force-overwrites',
1320 action='store_const', dest='overwrites', const=None,
1321 help='Do not overwrite the video, but overwrite related files (default)')
8450c15c
PH
1322 filesystem.add_option(
1323 '-c', '--continue',
1324 action='store_true', dest='continue_dl', default=True,
c25228e5 1325 help='Resume partially downloaded files/fragments (default)')
8450c15c
PH
1326 filesystem.add_option(
1327 '--no-continue',
1328 action='store_false', dest='continue_dl',
c25228e5 1329 help=(
1330 'Do not resume partially downloaded fragments. '
e58c22a0 1331 'If the file is not fragmented, restart download of the entire file'))
6623ac34 1332 filesystem.add_option(
1333 '--part',
1334 action='store_false', dest='nopart', default=False,
1335 help='Use .part files instead of writing directly into output file (default)')
8450c15c
PH
1336 filesystem.add_option(
1337 '--no-part',
6623ac34 1338 action='store_true', dest='nopart',
17941321 1339 help='Do not use .part files - write directly into output file')
6623ac34 1340 filesystem.add_option(
1341 '--mtime',
1342 action='store_true', dest='updatetime', default=True,
1343 help='Use the Last-modified header to set the file modification time (default)')
8450c15c
PH
1344 filesystem.add_option(
1345 '--no-mtime',
6623ac34 1346 action='store_false', dest='updatetime',
17941321 1347 help='Do not use the Last-modified header to set the file modification time')
8450c15c
PH
1348 filesystem.add_option(
1349 '--write-description',
1350 action='store_true', dest='writedescription', default=False,
17941321 1351 help='Write video description to a .description file')
6623ac34 1352 filesystem.add_option(
1353 '--no-write-description',
1354 action='store_false', dest='writedescription',
1355 help='Do not write video description (default)')
8450c15c
PH
1356 filesystem.add_option(
1357 '--write-info-json',
d1b5f70b 1358 action='store_true', dest='writeinfojson', default=None,
c25228e5 1359 help='Write video metadata to a .info.json file (this may contain personal information)')
6623ac34 1360 filesystem.add_option(
1361 '--no-write-info-json',
1362 action='store_false', dest='writeinfojson',
1363 help='Do not write video metadata (default)')
8450c15c
PH
1364 filesystem.add_option(
1365 '--write-annotations',
1366 action='store_true', dest='writeannotations', default=False,
0bb1bc1b 1367 help=optparse.SUPPRESS_HELP)
6623ac34 1368 filesystem.add_option(
1369 '--no-write-annotations',
1370 action='store_false', dest='writeannotations',
0bb1bc1b 1371 help=optparse.SUPPRESS_HELP)
cac96421 1372 filesystem.add_option(
1373 '--write-playlist-metafiles',
53ed7066 1374 action='store_true', dest='allow_playlist_files', default=None,
cac96421 1375 help=(
1376 'Write playlist metadata in addition to the video metadata '
1377 'when using --write-info-json, --write-description etc. (default)'))
1378 filesystem.add_option(
1379 '--no-write-playlist-metafiles',
1380 action='store_false', dest='allow_playlist_files',
e167860c 1381 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
75d43ca0 1382 filesystem.add_option(
3856407a 1383 '--clean-info-json', '--clean-infojson',
e4f02757 1384 action='store_true', dest='clean_infojson', default=None,
75d43ca0 1385 help=(
1386 'Remove some private fields such as filenames from the infojson. '
1387 'Note that it could still contain some personal information (default)'))
1388 filesystem.add_option(
3856407a 1389 '--no-clean-info-json', '--no-clean-infojson',
75d43ca0 1390 action='store_false', dest='clean_infojson',
1391 help='Write all fields to the infojson')
06167fbb 1392 filesystem.add_option(
2305e2e5 1393 '--write-comments', '--get-comments',
06167fbb 1394 action='store_true', dest='getcomments', default=False,
277d6ff5 1395 help=(
2305e2e5 1396 'Retrieve video comments to be placed in the infojson. '
1397 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1398 filesystem.add_option(
1399 '--no-write-comments', '--no-get-comments',
dd594deb 1400 action='store_false', dest='getcomments',
2305e2e5 1401 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
8450c15c 1402 filesystem.add_option(
244fe977 1403 '--load-info-json', '--load-info',
8450c15c 1404 dest='load_info_filename', metavar='FILE',
1a48181a 1405 help='JSON file containing the video information (created with the "--write-info-json" option)')
8450c15c
PH
1406 filesystem.add_option(
1407 '--cookies',
1408 dest='cookiefile', metavar='FILE',
f304da8a 1409 help='Netscape formatted file to read cookies from and dump cookie jar in')
6623ac34 1410 filesystem.add_option(
1411 '--no-cookies',
1412 action='store_const', const=None, dest='cookiefile', metavar='FILE',
982ee69a
MB
1413 help='Do not read/dump cookies from/to file (default)')
1414 filesystem.add_option(
1415 '--cookies-from-browser',
825d3ce3 1416 dest='cookiesfrombrowser', metavar='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
982ee69a 1417 help=(
825d3ce3 1418 'The name of the browser to load cookies from. '
f59f5ef8 1419 f'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
825d3ce3 1420 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1421 'the name/path of the PROFILE to load cookies from, '
1422 'and the CONTAINER name (if Firefox) ("none" for no container) '
1423 'can be given with their respective seperators. '
1424 'By default, all containers of the most recently accessed profile are used. '
f59f5ef8 1425 f'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
982ee69a
MB
1426 filesystem.add_option(
1427 '--no-cookies-from-browser',
1428 action='store_const', const=None, dest='cookiesfrombrowser',
1429 help='Do not load cookies from browser (default)')
34a741a8
PH
1430 filesystem.add_option(
1431 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
304ad45a 1432 help=(
1433 'Location in the filesystem where yt-dlp can store some downloaded information '
1434 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
34a741a8 1435 filesystem.add_option(
6623ac34 1436 '--no-cache-dir', action='store_false', dest='cachedir',
34a741a8
PH
1437 help='Disable filesystem caching')
1438 filesystem.add_option(
8450c15c
PH
1439 '--rm-cache-dir',
1440 action='store_true', dest='rm_cachedir',
34a741a8
PH
1441 help='Delete all filesystem cache files')
1442
b31fdeed 1443 thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options')
cfb56d1a
PH
1444 thumbnail.add_option(
1445 '--write-thumbnail',
acc0d6a4 1446 action='callback', dest='writethumbnail', default=False,
1447 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1448 callback=lambda option, _, __, parser: setattr(
1449 parser.values, option.dest, getattr(parser.values, option.dest) or True),
17941321 1450 help='Write thumbnail image to disk')
6623ac34 1451 thumbnail.add_option(
1452 '--no-write-thumbnail',
1453 action='store_false', dest='writethumbnail',
1454 help='Do not write thumbnail image to disk (default)')
ec82d85a
PH
1455 thumbnail.add_option(
1456 '--write-all-thumbnails',
acc0d6a4 1457 action='store_const', dest='writethumbnail', const='all',
17941321 1458 help='Write all thumbnail image formats to disk')
cfb56d1a
PH
1459 thumbnail.add_option(
1460 '--list-thumbnails',
1461 action='store_true', dest='list_thumbnails', default=False,
b7b04c78 1462 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
cfb56d1a 1463
732044af 1464 link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
1465 link.add_option(
1466 '--write-link',
1467 action='store_true', dest='writelink', default=False,
8a51f564 1468 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
732044af 1469 link.add_option(
1470 '--write-url-link',
1471 action='store_true', dest='writeurllink', default=False,
8a51f564 1472 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
732044af 1473 link.add_option(
1474 '--write-webloc-link',
1475 action='store_true', dest='writewebloclink', default=False,
8a51f564 1476 help='Write a .webloc macOS internet shortcut')
732044af 1477 link.add_option(
1478 '--write-desktop-link',
1479 action='store_true', dest='writedesktoplink', default=False,
8a51f564 1480 help='Write a .desktop Linux internet shortcut')
732044af 1481
1482 postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
8450c15c
PH
1483 postproc.add_option(
1484 '-x', '--extract-audio',
1485 action='store_true', dest='extractaudio', default=False,
e4172ac9 1486 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
8450c15c
PH
1487 postproc.add_option(
1488 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
81a23040 1489 help=(
35faefee 1490 'Format to convert the audio to when -x is used. '
8dc59305 1491 f'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
e0ab9854 1492 'You can specify multiple rules using similar syntax as --remux-video'))
8450c15c
PH
1493 postproc.add_option(
1494 '--audio-quality', metavar='QUALITY',
1495 dest='audioquality', default='5',
35faefee 1496 help=(
1497 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1498 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
efe87a10
FS
1499 postproc.add_option(
1500 '--remux-video',
1501 metavar='FORMAT', dest='remuxvideo', default=None,
6623ac34 1502 help=(
35faefee 1503 'Remux the video into another container if necessary '
1504 f'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1505 'If target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
62b58c09 1506 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
8450c15c
PH
1507 postproc.add_option(
1508 '--recode-video',
1509 metavar='FORMAT', dest='recodevideo', default=None,
2dd5a2e3 1510 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
d84f1d14 1511 postproc.add_option(
45016689 1512 '--postprocessor-args', '--ppa',
1513 metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
e632bce2 1514 action='callback', callback=_dict_from_options_callback,
d818eb74 1515 callback_kwargs={
9e907ebd 1516 'allowed_keys': r'\w+(?:\+\w+)?',
1517 'default_key': 'default-compat',
f9934b96 1518 'process': shlex.split,
cc0ec3e1 1519 'multiple_keys': False
dbf5416a 1520 }, help=(
1b77b347 1521 'Give these arguments to the postprocessors. '
43820c03 1522 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
8fa43c73 1523 'to give the argument to the specified postprocessor/executable. Supported PP are: '
7a340e0d
NA
1524 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1525 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1526 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1527 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
43820c03 1528 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
5b1ecbb3 1529 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
597c1866 1530 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
62b58c09 1531 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
5b1ecbb3 1532 'You can use this option multiple times to give different arguments to different '
1533 'postprocessors. (Alias: --ppa)'))
8450c15c
PH
1534 postproc.add_option(
1535 '-k', '--keep-video',
1536 action='store_true', dest='keepvideo', default=False,
6623ac34 1537 help='Keep the intermediate video file on disk after post-processing')
1538 postproc.add_option(
1539 '--no-keep-video',
1540 action='store_false', dest='keepvideo',
1541 help='Delete the intermediate video file after post-processing (default)')
1542 postproc.add_option(
1543 '--post-overwrites',
1544 action='store_false', dest='nopostoverwrites',
1545 help='Overwrite post-processed files (default)')
8450c15c
PH
1546 postproc.add_option(
1547 '--no-post-overwrites',
1548 action='store_true', dest='nopostoverwrites', default=False,
6623ac34 1549 help='Do not overwrite post-processed files')
8450c15c
PH
1550 postproc.add_option(
1551 '--embed-subs',
1552 action='store_true', dest='embedsubtitles', default=False,
40025ee2 1553 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
6623ac34 1554 postproc.add_option(
1555 '--no-embed-subs',
1556 action='store_false', dest='embedsubtitles',
1557 help='Do not embed subtitles (default)')
8450c15c
PH
1558 postproc.add_option(
1559 '--embed-thumbnail',
1560 action='store_true', dest='embedthumbnail', default=False,
6aecd871 1561 help='Embed thumbnail in the video as cover art')
6623ac34 1562 postproc.add_option(
1563 '--no-embed-thumbnail',
1564 action='store_false', dest='embedthumbnail',
1565 help='Do not embed thumbnail (default)')
8450c15c 1566 postproc.add_option(
7e067091 1567 '--embed-metadata', '--add-metadata',
8450c15c 1568 action='store_true', dest='addmetadata', default=False,
dac5df5a 1569 help=(
1570 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1571 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
6623ac34 1572 postproc.add_option(
7e067091 1573 '--no-embed-metadata', '--no-add-metadata',
6623ac34 1574 action='store_false', dest='addmetadata',
7a340e0d
NA
1575 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1576 postproc.add_option(
1577 '--embed-chapters', '--add-chapters',
1578 action='store_true', dest='addchapters', default=None,
1579 help='Add chapter markers to the video file (Alias: --add-chapters)')
1580 postproc.add_option(
1581 '--no-embed-chapters', '--no-add-chapters',
1582 action='store_false', dest='addchapters',
1583 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
dac5df5a 1584 postproc.add_option(
1585 '--embed-info-json',
1586 action='store_true', dest='embed_infojson', default=None,
1587 help='Embed the infojson as an attachment to mkv/mka video files')
1588 postproc.add_option(
1589 '--no-embed-info-json',
1590 action='store_false', dest='embed_infojson',
1591 help='Do not embed the infojson as an attachment to the video file')
e7db87f7 1592 postproc.add_option(
1593 '--metadata-from-title',
1594 metavar='FORMAT', dest='metafromtitle',
5bfa4862 1595 help=optparse.SUPPRESS_HELP)
1596 postproc.add_option(
1597 '--parse-metadata',
fe74d5b5 1598 metavar='[WHEN:]FROM:TO', dest='parse_metadata', **when_prefix('pre_process'),
6623ac34 1599 help=(
fe74d5b5 1600 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1601 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
e9f4ccd1 1602 postproc.add_option(
1603 '--replace-in-metadata',
fe74d5b5 1604 dest='parse_metadata', metavar='[WHEN:]FIELDS REGEX REPLACE', nargs=3, **when_prefix('pre_process'),
1605 help=(
1606 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1607 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
8450c15c 1608 postproc.add_option(
6f7563be 1609 '--xattrs', '--xattr',
8450c15c 1610 action='store_true', dest='xattrs', default=False,
17941321 1611 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
3b603dbd 1612 postproc.add_option(
1613 '--concat-playlist',
1614 metavar='POLICY', dest='concat_playlist', default='multi_video',
1615 choices=('never', 'always', 'multi_video'),
1616 help=(
fc5fa964 1617 'Concatenate videos in a playlist. One of "never", "always", or '
1618 '"multi_video" (default; only when the videos form a single show). '
3b603dbd 1619 'All the video files must have same codecs and number of streams to be concatable. '
1620 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
a44ca5a4 1621 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
6271f1ca
PH
1622 postproc.add_option(
1623 '--fixup',
99594a11 1624 metavar='POLICY', dest='fixup', default=None,
f89b3e2d 1625 choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
6623ac34 1626 help=(
1627 'Automatically correct known faults of the file. '
1628 'One of never (do nothing), warn (only emit a warning), '
f89b3e2d 1629 'detect_or_warn (the default; fix file if we can, warn otherwise), '
f304da8a 1630 'force (try fixing even if file already exists)'))
8450c15c 1631 postproc.add_option(
6623ac34 1632 '--prefer-avconv', '--no-prefer-ffmpeg',
8450c15c 1633 action='store_false', dest='prefer_ffmpeg',
e4172ac9 1634 help=optparse.SUPPRESS_HELP)
8450c15c 1635 postproc.add_option(
6623ac34 1636 '--prefer-ffmpeg', '--no-prefer-avconv',
e4172ac9 1637 action='store_true', dest='prefer_ffmpeg', default=True,
1638 help=optparse.SUPPRESS_HELP)
73fac4e9
PH
1639 postproc.add_option(
1640 '--ffmpeg-location', '--avconv-location', metavar='PATH',
1641 dest='ffmpeg_location',
e4172ac9 1642 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
34a741a8 1643 postproc.add_option(
1e43a6f7 1644 '--exec',
119e40ef 1645 metavar='[WHEN:]CMD', dest='exec_cmd', **when_prefix('after_move'),
1646 help=(
1647 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1648 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
34488702 1649 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1e43a6f7 1650 'After download, an additional field "filepath" that contains the final path of the downloaded file '
1651 'is also available, and if no fields are passed, %(filepath)q is appended to the end of the command. '
c681cb5d 1652 'This option can be used multiple times'))
1653 postproc.add_option(
1654 '--no-exec',
1e43a6f7 1655 action='store_const', dest='exec_cmd', const={},
c681cb5d 1656 help='Remove any previously defined --exec')
1657 postproc.add_option(
1658 '--exec-before-download', metavar='CMD',
ad3dc496 1659 action='append', dest='exec_before_dl_cmd',
1e43a6f7 1660 help=optparse.SUPPRESS_HELP)
5520aa2d 1661 postproc.add_option(
c681cb5d 1662 '--no-exec-before-download',
a44ca5a4 1663 action='store_const', dest='exec_before_dl_cmd', const=None,
1e43a6f7 1664 help=optparse.SUPPRESS_HELP)
e9fade72 1665 postproc.add_option(
e167860c 1666 '--convert-subs', '--convert-sub', '--convert-subtitles',
e9fade72 1667 metavar='FORMAT', dest='convertsubtitles', default=None,
81a23040 1668 help=(
1669 'Convert the subtitles to another format (currently supported: %s) '
8dc59305 1670 '(Alias: --convert-subtitles)' % ', '.join(sorted(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS))))
8fa43c73 1671 postproc.add_option(
1672 '--convert-thumbnails',
1673 metavar='FORMAT', dest='convertthumbnails', default=None,
81a23040 1674 help=(
1675 'Convert the thumbnails to another format '
8dc59305 1676 f'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
00bbc5f1 1677 'You can specify multiple rules using similar syntax as --remux-video'))
72755351 1678 postproc.add_option(
1679 '--split-chapters', '--split-tracks',
1680 dest='split_chapters', action='store_true', default=False,
1681 help=(
1682 'Split video into multiple files based on internal chapters. '
1683 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1684 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1685 postproc.add_option(
1686 '--no-split-chapters', '--no-split-tracks',
1687 dest='split_chapters', action='store_false',
1688 help='Do not split video based on chapters (default)')
7a340e0d
NA
1689 postproc.add_option(
1690 '--remove-chapters',
1691 metavar='REGEX', dest='remove_chapters', action='append',
2d9ec704 1692 help=(
1693 'Remove chapters whose title matches the given regular expression. '
5ec1b6b7 1694 'The syntax is the same as --download-sections. This option can be used multiple times'))
7a340e0d
NA
1695 postproc.add_option(
1696 '--no-remove-chapters', dest='remove_chapters', action='store_const', const=None,
1697 help='Do not remove any chapters from the file (default)')
1698 postproc.add_option(
1699 '--force-keyframes-at-cuts',
1700 action='store_true', dest='force_keyframes_at_cuts', default=False,
1701 help=(
5ec1b6b7 1702 'Force keyframes at cuts when downloading/splitting/removing sections. '
1703 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
7a340e0d
NA
1704 postproc.add_option(
1705 '--no-force-keyframes-at-cuts',
1706 action='store_false', dest='force_keyframes_at_cuts',
1707 help='Do not force keyframes around the chapters when cutting/splitting (default)')
3ae5e797 1708 _postprocessor_opts_parser = lambda key, val='': (
1709 *(item.split('=', 1) for item in (val.split(';') if val else [])),
1710 ('key', remove_end(key, 'PP')))
1711 postproc.add_option(
1712 '--use-postprocessor',
1713 metavar='NAME[:ARGS]', dest='add_postprocessors', default=[], type='str',
1714 action='callback', callback=_list_from_options_callback,
1715 callback_kwargs={
1716 'delim': None,
1717 'process': lambda val: dict(_postprocessor_opts_parser(*val.split(':', 1)))
1718 }, help=(
1719 'The (case sensitive) name of plugin postprocessors to be enabled, '
e75bb0d6 1720 'and (optionally) arguments to be passed to it, separated by a colon ":". '
3ae5e797 1721 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1722 'The "when" argument determines when the postprocessor is invoked. '
09b49e1f 1723 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
119e40ef 1724 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1725 '"post_process" (after each video download; default), '
09b49e1f 1726 '"after_move" (after moving video file to it\'s final locations), '
ebed8b37 1727 '"after_video" (after downloading and processing all formats of a video), '
09b49e1f 1728 'or "playlist" (at end of playlist). '
3ae5e797 1729 'This option can be used multiple times to add different postprocessors'))
34a741a8 1730
7a340e0d
NA
1731 sponsorblock = optparse.OptionGroup(parser, 'SponsorBlock Options', description=(
1732 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1733 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1734 sponsorblock.add_option(
1735 '--sponsorblock-mark', metavar='CATS',
1736 dest='sponsorblock_mark', default=set(), action='callback', type='str',
8157a09d
NA
1737 callback=_set_from_options_callback, callback_kwargs={
1738 'allowed_values': SponsorBlockPP.CATEGORIES.keys(),
1739 'aliases': {'default': ['all']}
1740 }, help=(
7a340e0d 1741 'SponsorBlock categories to create chapters for, separated by commas. '
2dd5a2e3 1742 f'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1743 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
62b58c09 1744 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
7a340e0d
NA
1745 sponsorblock.add_option(
1746 '--sponsorblock-remove', metavar='CATS',
1747 dest='sponsorblock_remove', default=set(), action='callback', type='str',
8157a09d 1748 callback=_set_from_options_callback, callback_kwargs={
63c547d7 1749 'allowed_values': set(SponsorBlockPP.CATEGORIES.keys()) - set(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys()),
8157a09d
NA
1750 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1751 # The filler category is very aggressive.
1752 # It is strongly recommended to not use this in a client by default.
1753 'aliases': {'default': ['all', '-filler']}
1754 }, help=(
7a340e0d
NA
1755 'SponsorBlock categories to be removed from the video file, separated by commas. '
1756 'If a category is present in both mark and remove, remove takes precedence. '
8157a09d
NA
1757 'The syntax and available categories are the same as for --sponsorblock-mark '
1758 'except that "default" refers to "all,-filler" '
63c547d7 1759 f'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
7a340e0d
NA
1760 sponsorblock.add_option(
1761 '--sponsorblock-chapter-title', metavar='TEMPLATE',
1762 default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title',
1763 help=(
2dd5a2e3 1764 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1765 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1766 'Defaults to "%default"'))
7a340e0d
NA
1767 sponsorblock.add_option(
1768 '--no-sponsorblock', default=False,
1769 action='store_true', dest='no_sponsorblock',
1770 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1771 sponsorblock.add_option(
1772 '--sponsorblock-api', metavar='URL',
1773 default='https://sponsor.ajay.app', dest='sponsorblock_api',
1774 help='SponsorBlock API location, defaults to %default')
1775
1776 sponsorblock.add_option(
a9e7f546 1777 '--sponskrub',
165efb82 1778 action='store_true', dest='sponskrub', default=False,
7a340e0d
NA
1779 help=optparse.SUPPRESS_HELP)
1780 sponsorblock.add_option(
a9e7f546 1781 '--no-sponskrub',
1782 action='store_false', dest='sponskrub',
7a340e0d
NA
1783 help=optparse.SUPPRESS_HELP)
1784 sponsorblock.add_option(
a9e7f546 1785 '--sponskrub-cut', default=False,
1786 action='store_true', dest='sponskrub_cut',
7a340e0d
NA
1787 help=optparse.SUPPRESS_HELP)
1788 sponsorblock.add_option(
6623ac34 1789 '--no-sponskrub-cut',
1790 action='store_false', dest='sponskrub_cut',
7a340e0d
NA
1791 help=optparse.SUPPRESS_HELP)
1792 sponsorblock.add_option(
a9e7f546 1793 '--sponskrub-force', default=False,
1794 action='store_true', dest='sponskrub_force',
7a340e0d
NA
1795 help=optparse.SUPPRESS_HELP)
1796 sponsorblock.add_option(
6623ac34 1797 '--no-sponskrub-force',
1798 action='store_true', dest='sponskrub_force',
7a340e0d
NA
1799 help=optparse.SUPPRESS_HELP)
1800 sponsorblock.add_option(
a9e7f546 1801 '--sponskrub-location', metavar='PATH',
1802 dest='sponskrub_path', default='',
7a340e0d
NA
1803 help=optparse.SUPPRESS_HELP)
1804 sponsorblock.add_option(
c76eb41b 1805 '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
1b77b347 1806 help=optparse.SUPPRESS_HELP)
a9e7f546 1807
78895bd3 1808 extractor = optparse.OptionGroup(parser, 'Extractor Options')
62bff2c1 1809 extractor.add_option(
1810 '--extractor-retries',
d6e51845 1811 dest='extractor_retries', metavar='RETRIES', default=3,
62bff2c1 1812 help='Number of retries for known extractor errors (default is %default), or "infinite"')
78895bd3 1813 extractor.add_option(
6623ac34 1814 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
78895bd3 1815 action='store_true', dest='dynamic_mpd', default=True,
8a51f564 1816 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
78895bd3 1817 extractor.add_option(
6623ac34 1818 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
78895bd3 1819 action='store_false', dest='dynamic_mpd',
8a51f564 1820 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
310c2ed2 1821 extractor.add_option(
1822 '--hls-split-discontinuity',
1823 dest='hls_split_discontinuity', action='store_true', default=False,
1824 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1825 )
1826 extractor.add_option(
1827 '--no-hls-split-discontinuity',
1828 dest='hls_split_discontinuity', action='store_false',
1829 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
042931a5 1830 _extractor_arg_parser = lambda key, vals='': (key.strip().lower().replace('-', '_'), [
1831 val.replace(r'\,', ',').strip() for val in re.split(r'(?<!\\),', vals)])
5d3a0e79 1832 extractor.add_option(
1833 '--extractor-args',
2fa669f7 1834 metavar='IE_KEY:ARGS', dest='extractor_args', default={}, type='str',
5d3a0e79 1835 action='callback', callback=_dict_from_options_callback,
1836 callback_kwargs={
1837 'multiple_keys': False,
1838 'process': lambda val: dict(
4bb6b02f 1839 _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';'))
dbf5416a 1840 }, help=(
2fa669f7 1841 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
4bb6b02f 1842 'You can use this option multiple times to give arguments for different extractors'))
e409895f 1843 extractor.add_option(
1844 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1845 action='store_true', dest='youtube_include_dash_manifest', default=True,
5d3a0e79 1846 help=optparse.SUPPRESS_HELP)
e409895f 1847 extractor.add_option(
1848 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1849 action='store_false', dest='youtube_include_dash_manifest',
5d3a0e79 1850 help=optparse.SUPPRESS_HELP)
e409895f 1851 extractor.add_option(
1852 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1853 action='store_true', dest='youtube_include_hls_manifest', default=True,
5d3a0e79 1854 help=optparse.SUPPRESS_HELP)
e409895f 1855 extractor.add_option(
1856 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1857 action='store_false', dest='youtube_include_hls_manifest',
5d3a0e79 1858 help=optparse.SUPPRESS_HELP)
78895bd3 1859
34a741a8 1860 parser.add_option_group(general)
be4a824d 1861 parser.add_option_group(network)
0aa10994 1862 parser.add_option_group(geo)
34a741a8
PH
1863 parser.add_option_group(selection)
1864 parser.add_option_group(downloader)
1865 parser.add_option_group(filesystem)
cfb56d1a 1866 parser.add_option_group(thumbnail)
732044af 1867 parser.add_option_group(link)
34a741a8
PH
1868 parser.add_option_group(verbosity)
1869 parser.add_option_group(workarounds)
1870 parser.add_option_group(video_format)
1871 parser.add_option_group(subtitles)
1872 parser.add_option_group(authentication)
1873 parser.add_option_group(postproc)
7a340e0d 1874 parser.add_option_group(sponsorblock)
78895bd3 1875 parser.add_option_group(extractor)
34a741a8 1876
06e57990 1877 return parser
7303f84a 1878
e66dca5e 1879
06e57990 1880def _hide_login_info(opts):
da4db748 1881 deprecation_warning(f'"{__name__}._hide_login_info" is deprecated and may be removed '
1882 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
06e57990 1883 return Config.hide_login_info(opts)