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