diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 38 insertions, 26 deletions
@@ -3,17 +3,17 @@ [](#readme) -[](https://github.com/yt-dlp/yt-dlp/releases/latest) -[](https://github.com/yt-dlp/yt-dlp/actions) -[](LICENSE) -[](Collaborators.md#collaborators) -[](supportedsites.md) -[](https://discord.gg/H5MNcFW63r) -[](https://yt-dlp.readthedocs.io) -[](https://github.com/yt-dlp/yt-dlp/commits) -[](https://github.com/yt-dlp/yt-dlp/commits) -[](https://github.com/yt-dlp/yt-dlp/releases/latest) -[](https://pypi.org/project/yt-dlp) +[](#release-files "Release") +[](LICENSE "License") +[](Collaborators.md#collaborators "Donate") +[](https://readthedocs.org/projects/yt-dlp/ "Docs") +[](supportedsites.md "Supported Sites") +[](https://pypi.org/project/yt-dlp "PyPi") +[](https://github.com/yt-dlp/yt-dlp/actions "CI Status") +[](https://discord.gg/H5MNcFW63r "Discord") +[](https://matrix.to/#/#yt-dlp:matrix.org "Matrix") +[](https://github.com/yt-dlp/yt-dlp/commits "Commit History") +[](https://github.com/yt-dlp/yt-dlp/commits "Commit History") </div> <!-- MANPAGE: END EXCLUDED SECTION --> @@ -157,8 +157,19 @@ You can install yt-dlp using one of the following methods: ### Using the release binary -You can simply download the [correct binary file](#release-files) for your OS: **[[Windows](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)] [[UNIX-like](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)]** +You can simply download the [correct binary file](#release-files) for your OS +<!-- MANPAGE: BEGIN EXCLUDED SECTION --> +[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe) +[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp) +[](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz) +[](#release-files) +[](https://github.com/yt-dlp/yt-dlp/releases) +<!-- MANPAGE: END EXCLUDED SECTION --> + +Note: The manpages, shell completion files etc. are available in the [source tarball](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz) + +<!-- TODO: Move to Wiki --> In UNIX-like OSes (MacOS, Linux, BSD), you can also install the same in one of the following ways: ``` @@ -176,7 +187,6 @@ sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp --d sudo chmod a+rx /usr/local/bin/yt-dlp ``` -PS: The manpages, shell completion files etc. are available in [yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz) ### With [PIP](https://pypi.org/project/pip) @@ -197,6 +207,7 @@ python3 -m pip install --force-reinstall https://github.com/yt-dlp/yt-dlp/archiv Note that on some systems, you may need to use `py` or `python` instead of `python3` +<!-- TODO: Add to Wiki, Remove Taps --> ### With [Homebrew](https://brew.sh) macOS or Linux users that are using Homebrew can also install it by: @@ -267,7 +278,7 @@ To use or redistribute the dependencies, you must agree to their respective lice The Windows and MacOS standalone release binaries are already built with the python interpreter, mutagen, pycryptodomex and websockets included. -**Note**: There are some regressions in newer ffmpeg versions that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependency, we provide [custom builds](https://github.com/yt-dlp/FFmpeg-Builds/wiki/Latest#latest-autobuilds) with patches for these issues at [yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds). See [the readme](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied) for details on the specific issues solved by these builds +**Note**: There are some regressions in newer ffmpeg versions that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependency, we provide [custom builds](https://github.com/yt-dlp/FFmpeg-Builds#ffmpeg-static-auto-builds) with patches for these issues at [yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds). See [the readme](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied) for details on the specific issues solved by these builds ## COMPILE @@ -331,7 +342,8 @@ You can also fork the project on github and run your fork's [build workflow](.gi except those given by --config-locations. For backward compatibility, if this option is found inside the system configuration - file, the user configuration is not loaded + file, the user configuration is not loaded. + (Alias: --no-config) --no-config-locations Do not load any custom configuration files (default). When given inside a configuration file, ignore all previous @@ -518,8 +530,8 @@ You can also fork the project on github and run your fork's [build workflow](.gi example, --downloader aria2c --downloader "dash,m3u8:native" will use aria2c for http/ftp downloads, and the native - downloader for dash/m3u8 downloads - (Alias: --external-downloader) + downloader for dash/m3u8 downloads (Alias: + --external-downloader) --downloader-args NAME:ARGS Give these arguments to the external downloader. Specify the downloader name and the arguments separated by a colon ":". For @@ -527,8 +539,8 @@ You can also fork the project on github and run your fork's [build workflow](.gi different positions using the same syntax as --postprocessor-args. You can use this option multiple times to give different - arguments to different downloaders - (Alias: --external-downloader-args) + arguments to different downloaders (Alias: + --external-downloader-args) ## Filesystem Options: -a, --batch-file FILE File containing URLs to download ("-" for @@ -602,8 +614,8 @@ You can also fork the project on github and run your fork's [build workflow](.gi without this option if the extraction is known to be quick (Alias: --get-comments) --no-write-comments Do not retrieve video comments unless the - extraction is known to be quick - (Alias: --no-get-comments) + extraction is known to be quick (Alias: + --no-get-comments) --load-info-json FILE JSON file containing the video information (created with the "--write-info-json" option) @@ -789,9 +801,9 @@ You can also fork the project on github and run your fork's [build workflow](.gi be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") You can prefix the language code with a "-" to exempt it - from the requested languages. (Eg: --sub- - langs all,-live_chat) Use --list-subs for a - list of available language tags + from the requested languages. (Eg: + --sub-langs all,-live_chat) Use --list-subs + for a list of available language tags ## Authentication Options: -u, --username USERNAME Login with this account ID @@ -894,8 +906,8 @@ You can also fork the project on github and run your fork's [build workflow](.gi --xattrs Write metadata to the video file's xattrs (using dublin core and xdg standards) --concat-playlist POLICY Concatenate videos in a playlist. One of - "never" (default), "always", or - "multi_video" (only when the videos form a + "never", "always", or "multi_video" + (default; only when the videos form a single show). All the video files must have same codecs and number of streams to be concatable. The "pl_video:" prefix can be |