* [Sorting Formats](#sorting-formats)
* [Format Selection examples](#format-selection-examples)
* [PLUGINS](#plugins)
+* [DEPRECATED OPTIONS](#deprecated-options)
* [MORE](#more)
--no-warnings Ignore warnings
-s, --simulate Do not download the video and do not write
anything to disk
- --skip-download Do not download the video
+ --skip-download Do not download the video but write all
+ related files (Alias: --no-download)
-g, --get-url Simulate, quiet but print URL
-e, --get-title Simulate, quiet but print title
--get-id Simulate, quiet but print id
--encoding ENCODING Force the specified encoding (experimental)
--no-check-certificate Suppress HTTPS certificate validation
--prefer-insecure Use an unencrypted connection to retrieve
- information about the video. (Currently
+ information about the video (Currently
supported only for YouTube)
--user-agent UA Specify a custom user agent
--referer URL Specify a custom referer, use if the video
--sleep-requests SECONDS Number of seconds to sleep between requests
during data extraction
--sleep-interval SECONDS Number of seconds to sleep before each
- download when used alone or a lower bound
- of a range for randomized sleep before each
- download (minimum possible number of
- seconds to sleep) when used along with
- --max-sleep-interval
- --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
- before each download (maximum possible
- number of seconds to sleep). Must only be
- used along with --min-sleep-interval
+ download. This is the minimum time to sleep
+ when used along with --max-sleep-interval
+ (Alias: --min-sleep-interval)
+ --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
+ only be used along with --min-sleep-interval
--sleep-subtitles SECONDS Number of seconds to sleep before each
subtitle download
--write-subs Write subtitle file
--no-write-subs Do not write subtitle file (default)
--write-auto-subs Write automatically generated subtitle file
- (YouTube only)
- --no-write-auto-subs Do not write automatically generated
- subtitle file (default)
+ (Alias: --write-automatic-subs)
+ --no-write-auto-subs Do not write auto-generated subtitles
+ (default) (Alias: --no-write-automatic-subs)
--all-subs Download all the available subtitles of the
video
--list-subs List all available subtitles for the video
--sub-format FORMAT Subtitle format, accepts formats
preference, for example: "srt" or
"ass/srt/best"
- --sub-lang LANGS Languages of the subtitles to download
+ --sub-langs LANGS Languages of the subtitles to download
(optional) separated by commas, use --list-
subs for available language tags
downloading and post-processing, similar to
find's -exec syntax. Example: --exec 'adb
push {} /sdcard/Music/ && rm {}'
- --convert-subs FORMAT Convert the subtitles to other format
+ --convert-subs FORMAT Convert the subtitles to another format
(currently supported: srt|ass|vtt|lrc)
+ (Alias: --convert-subtitles)
--split-chapters Split video into multiple files based on
internal chapters. The "chapter:" prefix
can be used with "--paths" and "--output"
**Note**: `<root-dir>` is the directory of the binary (`<root-dir>/yt-dlp`), or the root directory of the module if you are running directly from source-code (`<root dir>/yt_dlp/__main__.py`)
+# DEPRECATED OPTIONS
+
+These are all the deprecated options and the current alternative to achieve the same effect
+
+ --cn-verification-proxy URL --geo-verification-proxy URL
+ --id -o "%(id)s.%(ext)s"
+ -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
+ -t, --title -o "%(title)s-%(id)s.%(ext)s"
+ -l, --literal -o accepts literal names
+ --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)03d
+ --metadata-from-title FORMAT --parse-metadata "title:FORMAT"
+ --prefer-avconv avconv is no longer officially supported (Alias: --no-prefer-ffmpeg)
+ --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
+ --avconv-location avconv is no longer officially supported
+ -C, --call-home Not implemented
+ --no-call-home Default
+ --write-srt --write-subs
+ --no-write-srt --no-write-subs
+ --srt-lang LANGS --sub-langs LANGS
+ --prefer-unsecure --prefer-insecure
+ --rate-limit RATE --limit-rate RATE
+ --force-write-download-archive --force-write-archive
+ --dump-intermediate-pages --dump-pages
+ --dump-headers --print-traffic
+ --youtube-print-sig-code No longer supported
+ --trim-file-names LENGTH --trim-filenames LENGTH
+ --yes-overwrites --force-overwrites
+ --load-info --load-info-json
+ --split-tracks --split-chapters
+ --no-split-tracks --no-split-chapters
+ --sponskrub-args ARGS --ppa "sponskrub:ARGS"
+ --test Only used for testing extractors
+
+
# MORE
For FAQ, Developer Instructions etc., see the [original README](https://github.com/ytdl-org/youtube-dl#faq)
* "data": The subtitles file contents
* "url": A URL pointing to the subtitles file
"ext" will be calculated from URL if missing
- automatic_captions: Like 'subtitles', used by the YoutubeIE for
- automatically generated captions
+ automatic_captions: Like 'subtitles'; contains automatically generated
+ captions instead of normal subtitles
duration: Length of the video in seconds, as an integer or float.
view_count: How many users have watched the video on the platform.
like_count: Number of positive ratings of the video
subtitles.add_option(
'--write-auto-subs', '--write-automatic-subs',
action='store_true', dest='writeautomaticsub', default=False,
- help='Write automatically generated subtitle file (YouTube only)')
+ help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
subtitles.add_option(
'--no-write-auto-subs', '--no-write-automatic-subs',
action='store_false', dest='writeautomaticsub', default=False,
- help='Do not write automatically generated subtitle file (default)')
+ help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
subtitles.add_option(
'--all-subs',
action='store_true', dest='allsubtitles', default=False,
action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
subtitles.add_option(
- '--sub-lang', '--sub-langs', '--srt-lang',
+ '--sub-langs', '--srt-langs',
action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
default=[], callback=_comma_separated_values_options_callback,
help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
workarounds.add_option(
'--prefer-insecure', '--prefer-unsecure',
action='store_true', dest='prefer_insecure',
- help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
+ help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
workarounds.add_option(
'--user-agent',
metavar='UA', dest='user_agent',
'--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
dest='sleep_interval', type=float,
help=(
- 'Number of seconds to sleep before each download when used alone '
- 'or a lower bound of a range for randomized sleep before each download '
- '(minimum possible number of seconds to sleep) when used along with '
- '--max-sleep-interval'))
+ 'Number of seconds to sleep before each download. '
+ 'This is the minimum time to sleep when used along with --max-sleep-interval '
+ '(Alias: --min-sleep-interval)'))
workarounds.add_option(
'--max-sleep-interval', metavar='SECONDS',
dest='max_sleep_interval', type=float,
- help=(
- 'Upper bound of a range for randomized sleep before each download '
- '(maximum possible number of seconds to sleep). Must only be used '
- 'along with --min-sleep-interval'))
+ help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
workarounds.add_option(
'--sleep-subtitles', metavar='SECONDS',
dest='sleep_interval_subtitles', default=0, type=int,
verbosity.add_option(
'--skip-download', '--no-download',
action='store_true', dest='skip_download', default=False,
- help='Do not download the video')
+ help='Do not download the video but write all related files (Alias: --no-download)')
verbosity.add_option(
'-g', '--get-url',
action='store_true', dest='geturl', default=False,
filesystem.add_option(
'--no-write-playlist-metafiles',
action='store_false', dest='allow_playlist_files',
- help=(
- 'Do not write playlist metadata when using '
- '--write-info-json, --write-description etc.'))
+ help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
filesystem.add_option(
'--clean-infojson',
action='store_true', dest='clean_infojson', default=True,
metavar='CMD', dest='exec_cmd',
help='Execute a command on the file after downloading and post-processing, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
postproc.add_option(
- '--convert-subs', '--convert-subtitles',
+ '--convert-subs', '--convert-sub', '--convert-subtitles',
metavar='FORMAT', dest='convertsubtitles', default=None,
- help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
+ help='Convert the subtitles to another format (currently supported: srt|ass|vtt|lrc) (Alias: --convert-subtitles)')
postproc.add_option(
'--split-chapters', '--split-tracks',
dest='split_chapters', action='store_true', default=False,