YT-DLP Commands Reference
Complete reference of all available commands and options for YT-DLP. Use these commands to customize your video downloads.
Official DocumentationPrint help text (-h)--help
Print this help text and exit
Type:boolean
Print program version--version
Print program version and exit
Type:boolean
Update to latest stable version (-U)--update
Update this program to the latest stable version
Type:boolean
Do not check for updates--no-update
Do not check for updates (default)
Type:boolean
Upgrade/downgrade to specific version--update-to
Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. CHANNEL and TAG default to "stable" and "latest" respectively if omitted. Supported channels: stable, nightly, master. See "UPDATE" for details.
Type:string
Example:
--update-to nightly@2023.03.02
Ignore errors (-i)--ignore-errors
Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails.
Type:boolean
Continue on error (default)--no-abort-on-error
Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)
Type:boolean
Abort on error (Alias: --no-ignore-errors)--abort-on-error
Abort downloading of further videos if an error occurs
Type:boolean
Display user agent--dump-user-agent
Display the current user-agent and exit
Type:boolean
List all extractors--list-extractors
List all supported extractors and exit
Type:boolean
Output extractor descriptions--extractor-descriptions
Output descriptions of all supported extractors and exit
Type:boolean
Extractor names to use (Alias: --ies)--use-extractors
Extractor names to use separated by commas. You can also use regexes, "all", "default" and "end" (end URL matching); e.g. --ies "holodex.*,end,youtube". Prefix the name with a "-" to exclude it. Use --list-extractors for a list of extractor names.
Type:string
Example:
--use-extractors holodex.*,end,youtube
Default search prefix--default-search
Use this prefix for unqualified URLs. E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". Use "auto", "auto_warning", "error", or "fixup_error" (default).
Type:string
Example:
--default-search ytsearch
Ignore configuration files (Alias: --no-config)--ignore-config
Don't load any more configuration files except those given to --config-locations. For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded.
Type:boolean
No custom config locations--no-config-locations
Do not load any custom configuration files (default). When given inside a configuration file, ignore all previous --config-locations defined in the current file.
Type:boolean
Configuration file locations--config-locations
Location of the main configuration file; either the path to the config or its containing directory ("-" for stdin). Can be used multiple times and inside other configuration files.
Type:string
Example:
--config-locations ~/.config/yt-dlp/config
Plugin directories--plugin-dirs
Path to an additional directory to search for plugins. This option can be used multiple times to add multiple directories. Use "default" to search the default plugin directories (default).
Type:string
Example:
--plugin-dirs ./my_plugins
Clear plugin directories--no-plugin-dirs
Clear plugin directories to search, including defaults and those provided by previous --plugin-dirs.
Type:boolean
Do not extract playlist videos (metadata only)--flat-playlist
Do not extract a playlist's URL result entries; some entry metadata may be missing and downloading may be bypassed.
Type:boolean
Extract playlist videos (default)--no-flat-playlist
Fully extract the videos of a playlist (default).
Type:boolean
Download livestreams from start--live-from-start
Download livestreams from the start. Currently experimental and only supported for YouTube and Twitch.
Type:boolean
Download livestreams from current time (default)--no-live-from-start
Download livestreams from the current time (default).
Type:boolean
Wait for scheduled streams--wait-for-video
Wait for scheduled streams to become available. Pass the minimum number of seconds (or range) to wait between retries.
Type:string
Example:
--wait-for-video 60-300
Do not wait for scheduled streams (default)--no-wait-for-video
Do not wait for scheduled streams (default).
Type:boolean
Mark videos as watched--mark-watched
Mark videos watched (even with --simulate).
Type:boolean
Do not mark as watched (default)--no-mark-watched
Do not mark videos watched (default).
Type:boolean
Disable colored output (Use --color never)--no-colors
Do not emit color codes in output. Better to use --color never.
Type:boolean
Color output policy--color
Whether to emit color codes in output, optionally prefixed by the STREAM (stdout or stderr). Can be "always", "auto" (default), "never", or "no_color". Use "auto-tty" or "no_color-tty" for TTY-only decision. Can be used multiple times.
Type:string
Example:
--color stderr:always
Compatibility options--compat-options
Options that can help keep compatibility with youtube-dl or youtube-dlc configurations by reverting some of the changes made in yt-dlp. See "Differences in default behavior" for details.
Type:string
Example:
--compat-options youtube-dl
Create option aliases--alias
Create aliases for an option string. Arguments are parsed according to Python string formatting. E.g. --alias get-audio,-X "-S aext:{0},abr -x --audio-format {0}". This option can be used multiple times.
Type:string
Example:
--alias get-audio,-X "-S aext:{0},abr -x --audio-format {0}"
Preset Alias (-t)--preset-alias
Applies a predefined set of options. E.g. --preset-alias mp3. Available presets: mp3, aac, mp4, mkv, sleep. This option can be used multiple times.
Type:select
Force generic extractor--force-generic-extractor
Force extraction to use the generic extractor
Type:boolean