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