yt-dlp - 追加機能と修正を加えたyoutube-dlフォーク

(A youtube-dl fork with additional features and fixes)

Created at: 2020-10-26 12:22:55
Language: Python
License: Unlicense

YT-DLP

リリースバージョン PyPi 寄付 マトリックス 不和 サポートされているサイト ライセンス:ライセンス解除 CIステータス コミット 最後のコミット

yt-dlpは、現在非アクティブになっているyoutube-dlcに基づくyoutube-dlフォークです。このプロジェクトの主な焦点は、元のプロジェクトを最新の状態に保ちながら、新しい機能とパッチを追加することです。

新機能

  • youtube-dl 2021.12.17 commit/8a158a9およびyoutube-dlc2020.11.11-3commit / f9401f2に基づく:最新のyoutube-dlに加えて、youtube-dlcのすべての機能とパッチを入手できます。

  • スポンサーブロックの統合:スポンサーブロックAPIを利用して、YouTube動画のスポンサーセクションにマークを付けたり削除したりでき

  • フォーマットの並べ替え:デフォルトのフォーマットの並べ替えオプションが変更され、より大きなビットレートを使用するのではなく、より高い解像度とより優れたコーデックが優先されるようになりました。さらに、を使用してソート順を指定できるようになり

    -S
    --format
    これにより、 ()を使用するだけで可能な形式よりもはるかに簡単な形式の選択が可能になります。

  • Animelover1984 / youtube-dlとの統合:、、、、 mp4 / ogg / opusへのサムネイルの埋め込み、プレイリストinfojsonなど、animelover1984/youtube-dlのほとんどの機能と改善点を利用できます。NicoNicoライブストリームは利用できないことに注意してください。詳細については、 #31を参照してください。

    --write-comments
    BiliBiliSearch
    BilibiliChannel

  • Youtubeの改善

    • すべてのフィード(、、、、、、)およびプライベートプレイリストは、コンテンツの複数のページのダウンロードを
      :ytfav
      サポート
      :ytwatchlater
      します
      :ytsubs
      :ythistory
      :ytrec
      :ytnotif
    • 検索(
      ytsearch:
      ytsearchdate:
      )、検索URL、チャネル内検索は機能します
    • Mixesは、複数ページのコンテンツのダウンロードをサポートしています
    • 一部の(すべてではない)年齢制限のあるコンテンツは、Cookieなしでダウンロードできます
    • n-sigベースのスロットリングの修正
    • /video
      以前の動作を維持するために、チャネルのホームURLを自動的にリダイレクトします
    • 255kbps
      プレミアムCookieが提供されると、YouTube Musicからオーディオが抽出されます(利用可能な場合)
    • Youtube musicアルバム、チャンネルなどをダウンロードできます(自己アップロードされた音楽を除く
    • --live-from-start
      (実験的)を使用して最初からライブストリームをダウンロードする
    • ストーリーのダウンロードのサポート(
      ytstories:<channel UCID>
    • クリップのダウンロードのサポート
  • ブラウザからのCookie:Cookieは、を使用してすべての主要なWebブラウザから自動的に抽出できます。

    --cookies-from-browser BROWSER[+KEYRING][:PROFILE]

  • ダウンロード時間範囲:ビデオは、タイムスタンプまたはチャプターに基づいて部分的にダウンロードできます。

    --download-sections

  • チャプターによるビデオの分割:ビデオは、を使用してチャプターに基づいて複数のファイルに分割できます

    --split-chapters

  • マルチスレッドフラグメントのダウンロード:m3u8/mpdビデオの複数のフラグメントを並行してダウンロードします。

    --concurrent-fragments
    ( )オプションを使用して、使用
    -N
    するスレッドの数を設定します

  • HLS / DASH

    aria2c
    を使用したAria2c: DASH(mpd)およびHLS(m3u8)形式の外部ダウンローダーとして使用できます

  • 新規および修正されたエクストラクタ:多くの新しいエクストラクタが追加され、多くの既存のエクストラクタが修正されました。変更ログまたはサポートされているサイトのリストを参照してください

  • 新しいMSO:Philo、Spectrum、SlingTV、Cablevision、RCNなど。

  • マニフェストからの字幕抽出:字幕はストリーミングメディアマニフェストから抽出できます。詳細については、 commit/be6202fを参照してください

  • 複数のパスと出力テンプレート:さまざまな種類のファイルに対して、さまざまな出力テンプレートとダウンロードパスを指定できます。

    --paths
    -P
    )を使用して、中間ファイルがダウンロードされる一時パスを設定することもできます。

  • ポータブル構成:構成ファイルは、ホームディレクトリとルートディレクトリから自動的にロードされます。詳細については、構成を参照してください

  • 出力テンプレートの改善:出力テンプレートに、日時の書式設定、数値オフセット、オブジェクトトラバーサルなどを含めることができるようになりました。詳細については、出力テンプレートを参照してください。

    --parse-metadata
    との助けを借りて、さらに高度な操作を行うこともできます
    --replace-in-metadata

  • その他の新しいオプション:、、、、、、、、、、など

    --alias
    の多く
    --print
    の新しいオプションが追加されました
    --concat-playlist
    --wait-for-video
    --retry-sleep
    --sleep-requests
    --convert-thumbnails
    --force-download-archive
    --force-overwrites
    --break-on-reject

  • 改善

    --format
    点: /
    --match-filter
    、複数
    --postprocessor-args
    および
    --downloader-args
    、より高速なアーカイブチェック、より多くのフォーマット選択オプション、マルチビデオ/オーディオのマージ、複数
    --config-locations
    --exec
    さまざまな段階での正規表現およびその他の演算子

  • プラグイン:ExtractorsとPostProcessorsは外部ファイルからロードできます。詳細についてはプラグインを参照してください

  • セルフアップデーター:リリースは、を使用して更新できます

    yt-dlp -U

変更の完全なリストについては、変更ログまたはコミットを参照してください

デフォルトの動作の違い

yt-dlpのデフォルトオプションの一部は、youtube-dlおよびyoutube-dlcのオプションとは異なります。

  • オプション
    --auto-number
    -A
    )、
    --title
    -t
    )、および
    --literal
    -l
    )は機能しなくなりました。詳細については、削除されたオプションを参照してください
  • avconv
    の代替としてサポートされていません
    ffmpeg
  • yt-dlpは、設定ファイルをyoutube-dlとは少し異なる場所に保存します。正しい場所のリストについては、構成を参照してください
  • デフォルトの出力テンプレート
    %(title)s [%(id)s].%(ext)s
    です。この変更の本当の理由はありません。これは、yt-dlpが公開される前に変更されており、現在はに戻す予定はありません
    %(title)s-%(id)s.%(ext)s
    。代わりに、
    --compat-options filename
  • デフォルトのフォーマットソートはyoutube-dlとは異なり、より高いビットレートよりもより高い解像度とより優れたコーデックを優先します。
    --format-sort
    このオプションを使用して、これを任意の順序に変更したり、
    --compat-options format-sort
    youtube-dlの並べ替え順序を使用したりできます。
  • デフォルトのフォーマットセレクターはです
    bv*+ba/b
    。これは、最良のビデオのみのフォーマットよりも優れたビデオとオーディオの組み合わせフォーマットが見つかった場合、前者が優先されることを意味します。
    -f bv+ba/b
    またはを使用
    --compat-options format-spec
    してこれを元に戻します
  • youtube-dlcとは異なり、yt-dlpでは、デフォルトで複数のオーディオ/ビデオストリームを1つのファイルにマージすることはできません(これはの使用と競合するため
    -f bv*+ba
    )。必要に応じて、とを使用してこの機能を有効にする必要があり
    --audio-multistreams
    ます
    --video-multistreams
    --compat-options multistreams
    両方を有効にするために使用することもできます
  • --no-abort-on-error
    デフォルトで有効になっています。
    --abort-on-error
    代わりにまたはを使用
    --compat-options abort-on-error
    してエラーで中止する
  • サムネイル、説明、infojsonなどのメタデータファイルを書き込む場合、同じ情報(利用可能な場合)がプレイリストにも書き込まれます。これらのファイルを使用する
    --no-write-playlist-metafiles
    かどうか
    --compat-options no-playlist-metafiles
  • --add-metadata
    と一緒に使用すると、メタデータの書き込みに加えて、
    infojson
    をファイルに添付します。またはを使用してこれを元に戻します
    mkv
    --write-info-json
    --no-embed-info-json
    --compat-options no-attach-info-json
  • --add-metadata
    一部のメタデータは、youtube-dlと比較して、使用時に異なるフィールドに埋め込まれます。最も注目すべきは、
    comment
    フィールドに
    webpage_url
    synopsis
    が含まれていること
    description
    です。これを好みに合わせて変更したり、元に戻したりするために使用
    --parse-metadata
    できます
    --compat-options embed-metadata
  • playlist_index
    --playlist-reverse
    やなどのオプションを使用すると、動作が異なります
    --playlist-items
    。詳細については、 #302を参照してください。
    --compat-options playlist-index
    以前の動作を維持したい場合に使用できます
  • の出力は
    -F
    新しい形式で一覧表示されます。
    --compat-options list-formats
    これを元に戻すために使用します
  • ファニメーションエピソードのすべての体験は、単一のビデオと見なされます。この動作により、既存のアーカイブが破損します。
    --compat-options seperate-video-versions
    デフォルトのプレーヤーのみから情報を抽出するために使用します
  • Youtubeライブチャット(利用可能な場合)は字幕と見なされます。
    --sub-langs all,-live_chat
    ライブチャットを除くすべての字幕をダウンロードするために使用します。
    --compat-options no-live-chat
    ライブチャットがダウンロードされないようにするためにも使用できます
  • YouTubeチャンネルのURLは自動的ににリダイレクトされ
    /video
    ます。URLにを追加
    /featured
    して、ホームページのビデオのみをダウンロードします。チャンネルに[動画]タブがない場合は、
    UU
    代わりに同等の再生リストをダウンロードしようとします。他のすべてのタブでは、チャネルに要求されたタブが表示されない場合、エラーが発生します。また、
    /live
    チャンネル全体をサイレントにダウンロードするのではなく、ライブビデオがない場合、URLはエラーを発生させます。
    --compat-options no-youtube-channel-redirect
    これらすべてのリダイレクトを元に戻すために使用できます
  • 利用できない動画は、YouTubeの再生リストにも表示されます。
    --compat-options no-youtube-unavailable-videos
    これを削除するために使用します
  • がダウンローダーとして使用されている場合
    ffmpeg
    、フォーマットのダウンロードとマージは、可能な場合は1つのステップで実行されます。
    --compat-options no-direct-merge
    これを元に戻すために使用します
  • サムネイルの埋め込みは
    mp4
    、可能であれば変異原で行われます。
    --compat-options embed-thumbnail-atomicparsley
    代わりにAtomicParsleyの使用を強制するために使用します
  • ファイル名などの一部のプライベートフィールドは、デフォルトでinfojsonから削除されます。
    --no-clean-infojson
    またはを使用
    --compat-options no-clean-infojson
    してこれを元に戻します
  • --embed-subs
    --write-subs
    一緒に使用すると、字幕はディスクに書き込まれ、メディアファイルにも埋め込まれます。
    --embed-subs
    潜水艦を埋め込んで、別のファイルを自動的に削除するためだけに使用できます。詳細については、 #630(コメント)を参照してください。
    --compat-options no-keep-subs
    これを元に戻すために使用できます
  • certifi
    インストールされている場合、SSLルート証明書に使用されます。システム証明書のみを使用する場合は、
    --compat-options no-certifi
  • youtube-dlは、ファイル名から余分な句読点を削除しようとします。これは役立つ場合もありますが、望ましくない場合もあります。そのため、yt-dlpは、ファイル名のフィールドを可能な限り元の値に近づけようとします。
    --compat-options filename-sanitization
    youtube-dlの動作に戻すために使用できます

使いやすさのために、さらにいくつかの互換オプションが利用可能です。

  • --compat-options all
    :すべての互換オプションを使用してください(使用しないでください)
  • --compat-options youtube-dl
    : と同じ
    --compat-options all,-multistreams
  • --compat-options youtube-dlc
    : と同じ
    --compat-options all,-no-live-chat,-no-youtube-channel-redirect

インストール

次のいずれかの方法を使用してyt-dlpをインストールできます。

リリースバイナリの使用

OSに適したバイナリファイルをダウンロードするだけです

ウィンドウズ Linux マックOS ソースTarball その他のバリエーション すべてのバージョン

注:マンページ、シェル補完ファイルなどは、ソースtarballで入手できます。

UNIXライクなOS(MacOS、Linux、BSD)では、次のいずれかの方法で同じものをインストールすることもできます。

sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
sudo chmod a+rx /usr/local/bin/yt-dlp
sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
sudo chmod a+rx /usr/local/bin/yt-dlp
sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp --dir /usr/local/bin -o yt-dlp
sudo chmod a+rx /usr/local/bin/yt-dlp

PIPを使用

PyPIパッケージは次のコマンドでインストールできます。

python3 -m pip install -U yt-dlp

次を使用して、オプションの依存関係なしでインストールできます。

python3 -m pip install --no-deps -U yt-dlp

最先端になりたい場合は、次のコマンドを使用してマスターブランチをインストールすることもできます。

python3 -m pip install --force-reinstall https://github.com/yt-dlp/yt-dlp/archive/master.tar.gz

一部のシステムでは、

py
または
python
の代わりにを使用する必要がある場合があります
python3

自作

Homebrewを使用しているmacOSまたはLinuxユーザーは、次の方法でインストールすることもできます。

brew install yt-dlp/taps/yt-dlp

アップデート

提供されているリリースを使用している場合は、を使用

yt-dlp -U
して更新できます

pipを使用してインストールした場合は、プログラムのインストールに使用したのと同じコマンドを再実行するだけです。

Homebrewを使用してインストールした場合は、

brew upgrade yt-dlp/taps/yt-dlp

リリースファイル

おすすめされた

ファイル 説明
yt-dlp プラットフォームに依存しないzipimportバイナリ。Pythonが必要(Linux / BSDに推奨)
yt-dlp.exe Windows(Win7 SP1 +)スタンドアロンx64バイナリ(Windowsに推奨)
yt-dlp_macos MacOS(10.15+)スタンドアロン実行可能ファイル(MacOSに推奨)

代替案

ファイル 説明
yt-dlp_x86.exe Windows(Vista SP2 +)スタンドアロンx86(32ビット)バイナリ
yt-dlp_min.exe Windows(Win7 SP1 +)で構築されたスタンドアロンのx64バイナリ
py2exe

非推奨
yt-dlp_linux UNIXスタンドアロンx64バイナリ
yt-dlp_linux.zip パッケージ化されていないUnix実行可能ファイル(自動更新なし)
yt-dlp_win.zip パッケージ化されていないWindows実行可能ファイル(自動更新なし)
yt-dlp_macos.zip パッケージ化されていないMacOS(10.15+)実行可能ファイル(自動更新なし)

その他

ファイル 説明
yt-dlp.tar.gz ソースtarball。マンページ、補完なども含まれています
SHA2-512SUMS GNUスタイルのSHA512の合計
SHA2-256SUMS GNUスタイルのSHA256の合計

依存関係

Pythonバージョン3.7以降(CPythonおよびPyPy)がサポートされています。他のバージョンおよび実装は、正しく機能する場合と機能しない場合があります。

他のすべての依存関係はオプションで

ffmpeg
あり
ffprobe
、強くお勧めします

強く推奨する

ネットワーキング

  • certifi *-Mozillaのルート証明書バンドルを提供します。MPLv2でライセンス供与
  • brotli *またはbrotlicffi - Brotliコンテンツエンコーディングのサポート。両方ともMIT12の下でライセンスされてます
  • websockets *-websocket経由でダウンロードします。BSD-3-Clauseの下でライセンス供与

メタデータ

その他

  • pycryptodomex *-AES-128HLSストリームおよびその他のさまざまなデータを復号化するため。BSD-2-Clauseの下でライセンス供与
  • phantomjs -javascriptを実行する必要があるエクストラクターで使用されます。BSD-3-Clauseの下でライセンス供与
  • secretstorage - LinuxでChromiumベースのブラウザのCookieを復号化するときにGnome
    --cookies-from-browser
    キーリングにアクセスするため。BSD-3-Clauseの下でライセンス供与
  • 一緒に使用したい外部ダウンローダー
    --downloader

非推奨

依存関係を使用または再配布するには、それぞれのライセンス条項に同意する必要があります。

WindowsおよびMacOSスタンドアロンリリースバイナリは、Pythonインタープリターを使用して構築され、*でマークされたパッケージが含まれています。

試行しているタスクに必要な依存関係がない場合、yt-dlpは警告を表示します。現在利用可能なすべての依存関係が

--verbose
出力の上部に表示されます

コンパイル

スタンドアロンのPyInstallerビルド

Windows / MacOS実行可能ファイルをビルドするには、Pythonと

pyinstaller
(および必要に応じてyt-dlpのオプションの依存関係のいずれか)が必要です。必要な依存関係をすべてインストールしたら、を実行するだけ
pyinst.py
です。実行可能ファイルは、使用されているPythonと同じアーキテクチャ(32/64ビット)用にビルドされます。

python3 -m pip install -U pyinstaller -r requirements.txt
python3 devscripts/make_lazy_extractors.py
python3 pyinst.py

一部のシステムでは、

py
または
python
の代わりにを使用する必要がある場合があります
python3

pyinstallerは、仮想環境を使用せずにWindowsストアからインストールされたPythonをサポートしていないことに注意してください。

重要:使用せず

pyinstaller
に直接実行することは、公式にはサポートされていません。これは正しく機能する場合と機能しない場合があります。
pyinst.py

プラットフォームに依存しないバイナリ(UNIX)

ビルドツール

python
(3.6+)、、
zip
make
GNU)、
pandoc
*、および
pytest
*が必要になります。

これらをインストールした後、単にを実行し

make
ます。

代わりに実行

make yt-dlp
して、追加ファイルを更新せずにバイナリのみをコンパイルすることもできます。( *でマークされた依存関係はこれには必要ありません)

スタンドアロンPy2Exeビルド(Windows)

py2exeでビルドするオプションを提供していますが、py2exeビルドには/を含めることができず、ターゲットコンピューターでVC ++ 14を実行する必要があるため、代わりにPyInstallerを使用してビルドすることをお勧めします。

pycryptodomex
certifi

とにかくビルドしたい場合は、Pythonとpy2exeをインストールしてから、

setup.py py2exe

py -m pip install -U py2exe -r requirements.txt
py devscripts/make_lazy_extractors.py
py setup.py py2exe

関連するスクリプト

  • devscripts/update-version.py
    -現在のタイムスタンプに基づいてバージョン番号を更新します
  • devscripts/make_lazy_extractors.py
    -怠惰な抽出機能を作成します。バイナリ(任意のバリアント)をビルドする前にこれを実行すると、起動パフォーマンスが向上します。
    YTDLP_NO_LAZY_EXTRACTORS=1
    レイジーエクストラクタのロードを強制的に無効にする場合は、環境変数を設定します。

githubでプロジェクトをフォークし、フォークのビルドワークフローを実行して、完全なリリースを自動的にビルドすることもできます

使用法とオプション

yt-dlp [OPTIONS] [--] URL [URL...]

Ctrl+F
あなたの友達です:D

一般的なオプション:

-h, --help                      Print this help text and exit
--version                       Print program version and exit
-U, --update                    Update this program to latest version
--no-update                     Do not update (default)
-i, --ignore-errors             Ignore download and postprocessing errors.
                                The download will be considered successful
                                even if the postprocessing fails
--no-abort-on-error             Continue with next video on download errors;
                                e.g. to skip unavailable videos in a
                                playlist (default)
--abort-on-error                Abort downloading of further videos if an
                                error occurs (Alias: --no-ignore-errors)
--dump-user-agent               Display the current user-agent and exit
--list-extractors               List all supported extractors and exit
--extractor-descriptions        Output descriptions of all supported
                                extractors and exit
--force-generic-extractor       Force extraction to use the generic extractor
--default-search PREFIX         Use this prefix for unqualified URLs. Eg:
                                "gvsearch2:python" downloads two videos from
                                google videos for the search term "python".
                                Use the value "auto" to let yt-dlp guess
                                ("auto_warning" to emit a warning when
                                guessing). "error" just throws an error. The
                                default value "fixup_error" repairs broken
                                URLs, but emits an error if this is not
                                possible instead of searching
--ignore-config                 Don't load any more configuration files
                                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.
                                (Alias: --no-config)
--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
--config-locations PATH         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
--flat-playlist                 Do not extract the videos of a playlist,
                                only list them
--no-flat-playlist              Extract the videos of a playlist
--live-from-start               Download livestreams from the start.
                                Currently only supported for YouTube
                                (Experimental)
--no-live-from-start            Download livestreams from the current time
                                (default)
--wait-for-video MIN[-MAX]      Wait for scheduled streams to become
                                available. Pass the minimum number of
                                seconds (or range) to wait between retries
--no-wait-for-video             Do not wait for scheduled streams (default)
--mark-watched                  Mark videos watched (even with --simulate)
--no-mark-watched               Do not mark videos watched (default)
--no-colors                     Do not emit color codes in output
--compat-options OPTS           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
--alias ALIASES OPTIONS         Create aliases for an option string. Unless
                                an alias starts with a dash "-", it is
                                prefixed with "--". Arguments are parsed
                                according to the Python string formatting
                                mini-language. Eg: --alias get-audio,-X
                                "-S=aext:{0},abr -x --audio-format {0}"
                                creates options "--get-audio" and "-X" that
                                takes an argument (ARG0) and expands to
                                "-S=aext:ARG0,abr -x --audio-format ARG0".
                                All defined aliases are listed in the --help
                                output. Alias options can trigger more
                                aliases; so be carefull to avoid defining
                                recursive options. As a safety measure, each
                                alias may be triggered a maximum of 100
                                times. This option can be used multiple times

ネットワークオプション:

--proxy URL                     Use the specified HTTP/HTTPS/SOCKS proxy. To
                                enable SOCKS proxy, specify a proper scheme.
                                Eg: socks5://user:[email protected]:1080/. Pass
                                in an empty string (--proxy "") for direct
                                connection
--socket-timeout SECONDS        Time to wait before giving up, in seconds
--source-address IP             Client-side IP address to bind to
-4, --force-ipv4                Make all connections via IPv4
-6, --force-ipv6                Make all connections via IPv6

地理的制限:

--geo-verification-proxy URL    Use this proxy to verify the IP address for
                                some geo-restricted sites. The default proxy
                                specified by --proxy (or none, if the option
                                is not present) is used for the actual
                                downloading
--geo-bypass                    Bypass geographic restriction via faking
                                X-Forwarded-For HTTP header (default)
--no-geo-bypass                 Do not bypass geographic restriction via
                                faking X-Forwarded-For HTTP header
--geo-bypass-country CODE       Force bypass geographic restriction with
                                explicitly provided two-letter ISO 3166-2
                                country code
--geo-bypass-ip-block IP_BLOCK  Force bypass geographic restriction with
                                explicitly provided IP block in CIDR notation

ビデオの選択:

-I, --playlist-items ITEM_SPEC  Comma seperated playlist_index of the videos
                                to download. You can specify a range using
                                "[START]:[STOP][:STEP]". For backward
                                compatibility, START-STOP is also supported.
                                Use negative indices to count from the right
                                and negative STEP to download in reverse
                                order. Eg: "-I 1:3,7,-5::2" used on a
                                playlist of size 15 will download the videos
                                at index 1,2,3,7,11,13,15
--min-filesize SIZE             Do not download any videos smaller than SIZE
                                (e.g. 50k or 44.6m)
--max-filesize SIZE             Do not download any videos larger than SIZE
                                (e.g. 50k or 44.6m)
--date DATE                     Download only videos uploaded on this date.
                                The date can be "YYYYMMDD" or in the format 
                                [now|today|yesterday][-N[day|week|month|year]].
                                Eg: --date today-2weeks
--datebefore DATE               Download only videos uploaded on or before
                                this date. The date formats accepted is the
                                same as --date
--dateafter DATE                Download only videos uploaded on or after
                                this date. The date formats accepted is the
                                same as --date
--match-filters FILTER          Generic video filter. Any "OUTPUT TEMPLATE"
                                field can be compared with a number or a
                                string using the operators defined in
                                "Filtering formats". You can also simply
                                specify a field to match if the field is
                                present, use "!field" to check if the field
                                is not present, and "&" to check multiple
                                conditions. Use a "\" to escape "&" or
                                quotes if needed. If used multiple times,
                                the filter matches if atleast one of the
                                conditions are met. Eg: --match-filter
                                !is_live --match-filter "like_count>?100 &
                                description~='(?i)\bcats \& dogs\b'" matches
                                only videos that are not live OR those that
                                have a like count more than 100 (or the like
                                field is not available) and also has a
                                description that contains the phrase "cats &
                                dogs" (caseless). Use "--match-filter -" to
                                interactively ask whether to download each
                                video
--no-match-filter               Do not use generic video filter (default)
--no-playlist                   Download only the video, if the URL refers
                                to a video and a playlist
--yes-playlist                  Download the playlist, if the URL refers to
                                a video and a playlist
--age-limit YEARS               Download only videos suitable for the given
                                age
--download-archive FILE         Download only videos not listed in the
                                archive file. Record the IDs of all
                                downloaded videos in it
--no-download-archive           Do not use archive file (default)
--max-downloads NUMBER          Abort after downloading NUMBER files
--break-on-existing             Stop the download process when encountering
                                a file that is in the archive
--break-on-reject               Stop the download process when encountering
                                a file that has been filtered out
--break-per-input               Make --break-on-existing, --break-on-reject
                                and --max-downloads act only on the current
                                input URL
--no-break-per-input            --break-on-existing and similar options
                                terminates the entire download queue
--skip-playlist-after-errors N  Number of allowed failures until the rest of
                                the playlist is skipped

ダウンロードオプション:

-N, --concurrent-fragments N    Number of fragments of a dash/hlsnative
                                video that should be downloaded concurrently
                                (default is 1)
-r, --limit-rate RATE           Maximum download rate in bytes per second
                                (e.g. 50K or 4.2M)
--throttled-rate RATE           Minimum download rate in bytes per second
                                below which throttling is assumed and the
                                video data is re-extracted (e.g. 100K)
-R, --retries RETRIES           Number of retries (default is 10), or
                                "infinite"
--file-access-retries RETRIES   Number of times to retry on file access
                                error (default is 3), or "infinite"
--fragment-retries RETRIES      Number of retries for a fragment (default is
                                10), or "infinite" (DASH, hlsnative and ISM)
--retry-sleep [TYPE:]EXPR       An expression for the time to sleep between
                                retries in seconds (optionally) prefixed by
                                the type of retry (file_access, fragment,
                                http (default)) to apply the sleep to. EXPR
                                can be a number, linear=START[:END[:STEP=1]]
                                or exp=START[:END[:BASE=2]]. This option can
                                be used multiple times to set the sleep for
                                the different retry types. Eg: --retry-sleep
                                linear=1::2 --retry-sleep fragment:exp=1:20
--skip-unavailable-fragments    Skip unavailable fragments for DASH,
                                hlsnative and ISM downloads (default)
                                (Alias: --no-abort-on-unavailable-fragment)
--abort-on-unavailable-fragment
                                Abort download if a fragment is unavailable
                                (Alias: --no-skip-unavailable-fragments)
--keep-fragments                Keep downloaded fragments on disk after
                                downloading is finished
--no-keep-fragments             Delete downloaded fragments after
                                downloading is finished (default)
--buffer-size SIZE              Size of download buffer (e.g. 1024 or 16K)
                                (default is 1024)
--resize-buffer                 The buffer size is automatically resized
                                from an initial value of --buffer-size
                                (default)
--no-resize-buffer              Do not automatically adjust the buffer size
--http-chunk-size SIZE          Size of a chunk for chunk-based HTTP
                                downloading (e.g. 10485760 or 10M) (default
                                is disabled). May be useful for bypassing
                                bandwidth throttling imposed by a webserver
                                (experimental)
--playlist-random               Download playlist videos in random order
--lazy-playlist                 Process entries in the playlist as they are
                                received. This disables n_entries,
                                --playlist-random and --playlist-reverse
--no-lazy-playlist              Process videos in the playlist only after
                                the entire playlist is parsed (default)
--xattr-set-filesize            Set file xattribute ytdl.filesize with
                                expected file size
--hls-use-mpegts                Use the mpegts container for HLS videos;
                                allowing some players to play the video
                                while downloading, and reducing the chance
                                of file corruption if download is
                                interrupted. This is enabled by default for
                                live streams
--no-hls-use-mpegts             Do not use the mpegts container for HLS
                                videos. This is default when not downloading
                                live streams
--download-sections REGEX       Download only chapters whose title matches
                                the given regular expression. Time ranges
                                prefixed by a "*" can also be used in place
                                of chapters to download the specified range.
                                Eg: --download-sections "*10:15-15:00"
                                --download-sections "intro". Needs ffmpeg.
                                This option can be used multiple times to
                                download multiple sections
--downloader [PROTO:]NAME       Name or path of the external downloader to
                                use (optionally) prefixed by the protocols
                                (http, ftp, m3u8, dash, rstp, rtmp, mms) to
                                use it for. Currently supports native,
                                aria2c, avconv, axel, curl, ffmpeg, httpie,
                                wget. You can use this option multiple times
                                to set different downloaders for different
                                protocols. For 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-args NAME:ARGS     Give these arguments to the external
                                downloader. Specify the downloader name and
                                the arguments separated by a colon ":". For
                                ffmpeg, arguments can be passed to 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)

ファイルシステムオプション:

-a, --batch-file FILE           File containing URLs to download ("-" for
                                stdin), one URL per line. Lines starting
                                with "#", ";" or "]" are considered as
                                comments and ignored
--no-batch-file                 Do not read URLs from batch file (default)
-P, --paths [TYPES:]PATH        The paths where the files should be
                                downloaded. Specify the type of file and the
                                path separated by a colon ":". All the same
                                TYPES as --output are supported.
                                Additionally, you can also provide "home"
                                (default) and "temp" paths. All intermediary
                                files are first downloaded to the temp path
                                and then the final files are moved over to
                                the home path after download is finished.
                                This option is ignored if --output is an
                                absolute path
-o, --output [TYPES:]TEMPLATE   Output filename template; see "OUTPUT
                                TEMPLATE" for details
--output-na-placeholder TEXT    Placeholder for unavailable fields in
                                "OUTPUT TEMPLATE" (default: "NA")
--restrict-filenames            Restrict filenames to only ASCII characters,
                                and avoid "&" and spaces in filenames
--no-restrict-filenames         Allow Unicode characters, "&" and spaces in
                                filenames (default)
--windows-filenames             Force filenames to be Windows-compatible
--no-windows-filenames          Make filenames Windows-compatible only if
                                using Windows (default)
--trim-filenames LENGTH         Limit the filename length (excluding
                                extension) to the specified number of
                                characters
-w, --no-overwrites             Do not overwrite any files
--force-overwrites              Overwrite all video and metadata files. This
                                option includes --no-continue
--no-force-overwrites           Do not overwrite the video, but overwrite
                                related files (default)
-c, --continue                  Resume partially downloaded files/fragments
                                (default)
--no-continue                   Do not resume partially downloaded
                                fragments. If the file is not fragmented,
                                restart download of the entire file
--part                          Use .part files instead of writing directly
                                into output file (default)
--no-part                       Do not use .part files - write directly into
                                output file
--mtime                         Use the Last-modified header to set the file
                                modification time (default)
--no-mtime                      Do not use the Last-modified header to set
                                the file modification time
--write-description             Write video description to a .description file
--no-write-description          Do not write video description (default)
--write-info-json               Write video metadata to a .info.json file
                                (this may contain personal information)
--no-write-info-json            Do not write video metadata (default)
--write-playlist-metafiles      Write playlist metadata in addition to the
                                video metadata when using --write-info-json,
                                --write-description etc. (default)
--no-write-playlist-metafiles   Do not write playlist metadata when using
                                --write-info-json, --write-description etc.
--clean-info-json               Remove some private fields such as filenames
                                from the infojson. Note that it could still
                                contain some personal information (default)
--no-clean-info-json            Write all fields to the infojson
--write-comments                Retrieve video comments to be placed in the
                                infojson. The comments are fetched even
                                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)
--load-info-json FILE           JSON file containing the video information
                                (created with the "--write-info-json" option)
--cookies FILE                  Netscape formatted file to read cookies from
                                and dump cookie jar in
--no-cookies                    Do not read/dump cookies from/to file
                                (default)
--cookies-from-browser BROWSER[+KEYRING][:PROFILE]
                                The name of the browser and (optionally) the
                                name/path of the profile to load cookies
                                from, separated by a ":". Currently
                                supported browsers are: brave, chrome,
                                chromium, edge, firefox, opera, safari,
                                vivaldi. By default, the most recently
                                accessed profile is used. The keyring used
                                for decrypting Chromium cookies on Linux can
                                be (optionally) specified after the browser
                                name separated by a "+". Currently supported
                                keyrings are: basictext, gnomekeyring, kwallet
--no-cookies-from-browser       Do not load cookies from browser (default)
--cache-dir DIR                 Location in the filesystem where youtube-dl
                                can store some downloaded information (such
                                as client ids and signatures) permanently.
                                By default $XDG_CACHE_HOME/yt-dlp or
                                ~/.cache/yt-dlp
--no-cache-dir                  Disable filesystem caching
--rm-cache-dir                  Delete all filesystem cache files

サムネイルオプション:

--write-thumbnail               Write thumbnail image to disk
--no-write-thumbnail            Do not write thumbnail image to disk (default)
--write-all-thumbnails          Write all thumbnail image formats to disk
--list-thumbnails               List available thumbnails of each video.
                                Simulate unless --no-simulate is used

インターネットショートカットオプション:

--write-link                    Write an internet shortcut file, depending
                                on the current platform (.url, .webloc or
                                .desktop). The URL may be cached by the OS
--write-url-link                Write a .url Windows internet shortcut. The
                                OS caches the URL based on the file path
--write-webloc-link             Write a .webloc macOS internet shortcut
--write-desktop-link            Write a .desktop Linux internet shortcut

詳細およびシミュレーションオプション:

-q, --quiet                     Activate quiet mode. If used with --verbose,
                                print the log to stderr
--no-warnings                   Ignore warnings
-s, --simulate                  Do not download the video and do not write
                                anything to disk
--no-simulate                   Download the video even if printing/listing
                                options are used
--ignore-no-formats-error       Ignore "No video formats" error. Useful for
                                extracting metadata even if the videos are
                                not actually available for download
                                (experimental)
--no-ignore-no-formats-error    Throw error when no downloadable video
                                formats are found (default)
--skip-download                 Do not download the video but write all
                                related files (Alias: --no-download)
-O, --print [WHEN:]TEMPLATE     Field name or output template to print to
                                screen, optionally prefixed with when to
                                print it, separated by a ":". Supported
                                values of "WHEN" are the same as that of
                                --use-postprocessor, and "video" (default).
                                Implies --quiet. Implies --simulate unless
                                --no-simulate or later stages of WHEN are
                                used. This option can be used multiple times
--print-to-file [WHEN:]TEMPLATE FILE
                                Append given template to the file. The
                                values of WHEN and TEMPLATE are same as that
                                of --print. FILE uses the same syntax as the
                                output template. This option can be used
                                multiple times
-j, --dump-json                 Quiet, but print JSON information for each
                                video. Simulate unless --no-simulate is
                                used. See "OUTPUT TEMPLATE" for a
                                description of available keys
-J, --dump-single-json          Quiet, but print JSON information for each
                                url or infojson passed. Simulate unless
                                --no-simulate is used. If the URL refers to
                                a playlist, the whole playlist information
                                is dumped in a single line
--force-write-archive           Force download archive entries to be written
                                as far as no errors occur, even if -s or
                                another simulation option is used (Alias:
                                --force-download-archive)
--newline                       Output progress bar as new lines
--no-progress                   Do not print progress bar
--progress                      Show progress bar, even if in quiet mode
--console-title                 Display progress in console titlebar
--progress-template [TYPES:]TEMPLATE
                                Template for progress outputs, optionally
                                prefixed with one of "download:" (default),
                                "download-title:" (the console title),
                                "postprocess:",  or "postprocess-title:".
                                The video's fields are accessible under the
                                "info" key and the progress attributes are
                                accessible under "progress" key. E.g.:
                                --console-title --progress-template
                                "download-title:%(info.id)s-%(progress.eta)s"
-v, --verbose                   Print various debugging information
--dump-pages                    Print downloaded pages encoded using base64
                                to debug problems (very verbose)
--write-pages                   Write downloaded intermediary pages to files
                                in the current directory to debug problems
--print-traffic                 Display sent and read HTTP traffic

回避策:

--encoding ENCODING             Force the specified encoding (experimental)
--legacy-server-connect         Explicitly allow HTTPS connection to servers
                                that do not support RFC 5746 secure
                                renegotiation
--no-check-certificates         Suppress HTTPS certificate validation
--prefer-insecure               Use an unencrypted connection to retrieve
                                information about the video (Currently
                                supported only for YouTube)
--add-header FIELD:VALUE        Specify a custom HTTP header and its value,
                                separated by a colon ":". You can use this
                                option multiple times
--bidi-workaround               Work around terminals that lack
                                bidirectional text support. Requires bidiv
                                or fribidi executable in PATH
--sleep-requests SECONDS        Number of seconds to sleep between requests
                                during data extraction
--sleep-interval SECONDS        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)
--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

ビデオフォーマットオプション:

-f, --format FORMAT             Video format code, see "FORMAT SELECTION"
                                for more details
-S, --format-sort SORTORDER     Sort the formats by the fields given, see
                                "Sorting Formats" for more details
--format-sort-force             Force user specified sort order to have
                                precedence over all fields, see "Sorting
                                Formats" for more details (Alias: --S-force)
--no-format-sort-force          Some fields have precedence over the user
                                specified sort order (default)
--video-multistreams            Allow multiple video streams to be merged
                                into a single file
--no-video-multistreams         Only one video stream is downloaded for each
                                output file (default)
--audio-multistreams            Allow multiple audio streams to be merged
                                into a single file
--no-audio-multistreams         Only one audio stream is downloaded for each
                                output file (default)
--prefer-free-formats           Prefer video formats with free containers
                                over non-free ones of same quality. Use with
                                "-S ext" to strictly prefer free containers
                                irrespective of quality
--no-prefer-free-formats        Don't give any special preference to free
                                containers (default)
--check-formats                 Make sure formats are selected only from
                                those that are actually downloadable
--check-all-formats             Check all formats for whether they are
                                actually downloadable
--no-check-formats              Do not check that the formats are actually
                                downloadable
-F, --list-formats              List available formats of each video.
                                Simulate unless --no-simulate is used
--merge-output-format FORMAT    If a merge is required (e.g.
                                bestvideo+bestaudio), output to given
                                container format. One of mkv, mp4, ogg,
                                webm, flv. Ignored if no merge is required

字幕オプション:

--write-subs                    Write subtitle file
--no-write-subs                 Do not write subtitle file (default)
--write-auto-subs               Write automatically generated subtitle file
                                (Alias: --write-automatic-subs)
--no-write-auto-subs            Do not write auto-generated subtitles
                                (default) (Alias: --no-write-automatic-subs)
--list-subs                     List available subtitles of each video.
                                Simulate unless --no-simulate is used
--sub-format FORMAT             Subtitle format; accepts formats preference,
                                Eg: "srt" or "ass/srt/best"
--sub-langs LANGS               Languages of the subtitles to download (can
                                be regex) or "all" separated by commas. (Eg:
                                --sub-langs "en.*,ja") You can prefix the
                                language code with a "-" to exclude it from
                                the requested languages. (Eg: --sub-langs
                                all,-live_chat) Use --list-subs for a list
                                of available language tags

認証オプション:

-u, --username USERNAME         Login with this account ID
-p, --password PASSWORD         Account password. If this option is left
                                out, yt-dlp will ask interactively
-2, --twofactor TWOFACTOR       Two-factor authentication code
-n, --netrc                     Use .netrc authentication data
--netrc-location PATH           Location of .netrc authentication data;
                                either the path or its containing directory.
                                Defaults to ~/.netrc
--video-password PASSWORD       Video password (vimeo, youku)
--ap-mso MSO                    Adobe Pass multiple-system operator (TV
                                provider) identifier, use --ap-list-mso for
                                a list of available MSOs
--ap-username USERNAME          Multiple-system operator account login
--ap-password PASSWORD          Multiple-system operator account password.
                                If this option is left out, yt-dlp will ask
                                interactively
--ap-list-mso                   List all supported multiple-system operators
--client-certificate CERTFILE   Path to client certificate file in PEM
                                format. May include the private key
--client-certificate-key KEYFILE
                                Path to private key file for client
                                certificate
--client-certificate-password PASSWORD
                                Password for client certificate private key,
                                if encrypted. If not provided, and the key
                                is encrypted, yt-dlp will ask interactively

後処理オプション:

-x, --extract-audio             Convert video files to audio-only files
                                (requires ffmpeg and ffprobe)
--audio-format FORMAT           Format to convert the audio to when -x is
                                used. (currently supported: best (default),
                                mp3, aac, m4a, opus, vorbis, flac, alac,
                                wav). You can specify multiple rules using
                                similar syntax as --remux-video
--audio-quality QUALITY         Specify ffmpeg audio quality to use when
                                converting the audio with -x. Insert a value
                                between 0 (best) and 10 (worst) for VBR or a
                                specific bitrate like 128K (default 5)
--remux-video FORMAT            Remux the video into another container if
                                necessary (currently supported: mp4, mkv,
                                flv, webm, mov, avi, mka, ogg, mp3, aac,
                                m4a, opus, vorbis, flac, alac, wav). If
                                target container does not support the
                                video/audio codec, remuxing will fail. You
                                can specify multiple rules; Eg.
                                "aac>m4a/mov>mp4/mkv" will remux aac to m4a,
                                mov to mp4 and anything else to mkv
--recode-video FORMAT           Re-encode the video into another format if
                                necessary. The syntax and supported formats
                                are the same as --remux-video
--postprocessor-args NAME:ARGS  Give these arguments to the postprocessors.
                                Specify the postprocessor/executable name
                                and the arguments separated by a colon ":"
                                to give the argument to the specified
                                postprocessor/executable. Supported PP are:
                                Merger, ModifyChapters, SplitChapters,
                                ExtractAudio, VideoRemuxer, VideoConvertor,
                                Metadata, EmbedSubtitle, EmbedThumbnail,
                                SubtitlesConvertor, ThumbnailsConvertor,
                                FixupStretched, FixupM4a, FixupM3u8,
                                FixupTimestamp and FixupDuration. The
                                supported executables are: AtomicParsley,
                                FFmpeg and FFprobe. You can also specify
                                "PP+EXE:ARGS" to give the arguments to the
                                specified executable only when being used by
                                the specified postprocessor. Additionally,
                                for ffmpeg/ffprobe, "_i"/"_o" can be
                                appended to the prefix optionally followed
                                by a number to pass the argument before the
                                specified input/output file. Eg: --ppa
                                "Merger+ffmpeg_i1:-v quiet". You can use
                                this option multiple times to give different
                                arguments to different postprocessors.
                                (Alias: --ppa)
-k, --keep-video                Keep the intermediate video file on disk
                                after post-processing
--no-keep-video                 Delete the intermediate video file after
                                post-processing (default)
--post-overwrites               Overwrite post-processed files (default)
--no-post-overwrites            Do not overwrite post-processed files
--embed-subs                    Embed subtitles in the video (only for mp4,
                                webm and mkv videos)
--no-embed-subs                 Do not embed subtitles (default)
--embed-thumbnail               Embed thumbnail in the video as cover art
--no-embed-thumbnail            Do not embed thumbnail (default)
--embed-metadata                Embed metadata to the video file. Also
                                embeds chapters/infojson if present unless
                                --no-embed-chapters/--no-embed-info-json are
                                used (Alias: --add-metadata)
--no-embed-metadata             Do not add metadata to file (default)
                                (Alias: --no-add-metadata)
--embed-chapters                Add chapter markers to the video file
                                (Alias: --add-chapters)
--no-embed-chapters             Do not add chapter markers (default) (Alias:
                                --no-add-chapters)
--embed-info-json               Embed the infojson as an attachment to
                                mkv/mka video files
--no-embed-info-json            Do not embed the infojson as an attachment
                                to the video file
--parse-metadata FROM:TO        Parse additional metadata like title/artist
                                from other fields; see "MODIFYING METADATA"
                                for details
--replace-in-metadata FIELDS REGEX REPLACE
                                Replace text in a metadata field using the
                                given regex. This option can be used
                                multiple times
--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", "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
                                used with "--paths" and "--output" to set
                                the output filename for the concatenated
                                files. See "OUTPUT TEMPLATE" for details
--fixup POLICY                  Automatically correct known faults of the
                                file. One of never (do nothing), warn (only
                                emit a warning), detect_or_warn (the
                                default; fix file if we can, warn
                                otherwise), force (try fixing even if file
                                already exists)
--ffmpeg-location PATH          Location of the ffmpeg binary; either the
                                path to the binary or its containing directory
--exec [WHEN:]CMD               Execute a command, optionally prefixed with
                                when to execute it (after_move if
                                unspecified), separated by a ":". Supported
                                values of "WHEN" are the same as that of
                                --use-postprocessor. Same syntax as the
                                output template can be used to pass any
                                field as arguments to the command. After
                                download, an additional field "filepath"
                                that contains the final path of the
                                downloaded file is also available, and if no
                                fields are passed, %(filepath)q is appended
                                to the end of the command. This option can
                                be used multiple times
--no-exec                       Remove any previously defined --exec
--convert-subs FORMAT           Convert the subtitles to another format
                                (currently supported: srt, vtt, ass, lrc)
                                (Alias: --convert-subtitles)
--convert-thumbnails FORMAT     Convert the thumbnails to another format
                                (currently supported: jpg, png, webp). You
                                can specify multiple rules using similar
                                syntax as --remux-video
--split-chapters                Split video into multiple files based on
                                internal chapters. The "chapter:" prefix can
                                be used with "--paths" and "--output" to set
                                the output filename for the split files. See
                                "OUTPUT TEMPLATE" for details
--no-split-chapters             Do not split video based on chapters (default)
--remove-chapters REGEX         Remove chapters whose title matches the
                                given regular expression. The syntax is the
                                same as --download-sections. This option can
                                be used multiple times
--no-remove-chapters            Do not remove any chapters from the file
                                (default)
--force-keyframes-at-cuts       Force keyframes at cuts when
                                downloading/splitting/removing sections.
                                This is slow due to needing a re-encode, but
                                the resulting video may have fewer artifacts
                                around the cuts
--no-force-keyframes-at-cuts    Do not force keyframes around the chapters
                                when cutting/splitting (default)
--use-postprocessor NAME[:ARGS]
                                The (case sensitive) name of plugin
                                postprocessors to be enabled, and
                                (optionally) arguments to be passed to it,
                                separated by a colon ":". ARGS are a
                                semicolon ";" delimited list of NAME=VALUE.
                                The "when" argument determines when the
                                postprocessor is invoked. It can be one of
                                "pre_process" (after video extraction),
                                "after_filter" (after video passes filter),
                                "before_dl" (before each video download),
                                "post_process" (after each video download;
                                default), "after_move" (after moving video
                                file to it's final locations), "after_video"
                                (after downloading and processing all
                                formats of a video), or "playlist" (at end
                                of playlist). This option can be used
                                multiple times to add different postprocessors

スポンサーブロックオプション:

スポンサーブロックAPIを使用して、ダウンロードしたYouTube動画のチャプターエントリを作成するか、さまざまなセグメント(スポンサー、紹介など)を 削除します。

--sponsorblock-mark CATS        SponsorBlock categories to create chapters
                                for, separated by commas. Available
                                categories are sponsor, intro, outro,
                                selfpromo, preview, filler, interaction,
                                music_offtopic, poi_highlight, all and
                                default (=all). You can prefix the category
                                with a "-" to exclude it. See [1] for
                                description of the categories. Eg:
                                --sponsorblock-mark all,-preview
                                [1] https://wiki.sponsor.ajay.app/w/Segment_Categories
--sponsorblock-remove CATS      SponsorBlock categories to be removed from
                                the video file, separated by commas. If a
                                category is present in both mark and remove,
                                remove takes precedence. The syntax and
                                available categories are the same as for
                                --sponsorblock-mark except that "default"
                                refers to "all,-filler" and poi_highlight is
                                not available
--sponsorblock-chapter-title TEMPLATE
                                An output template for the title of the
                                SponsorBlock chapters created by
                                --sponsorblock-mark. The only available
                                fields are start_time, end_time, category,
                                categories, name, category_names. Defaults
                                to "[SponsorBlock]: %(category_names)l"
--no-sponsorblock               Disable both --sponsorblock-mark and
                                --sponsorblock-remove
--sponsorblock-api URL          SponsorBlock API location, defaults to
                                https://sponsor.ajay.app

抽出オプション:

--extractor-retries RETRIES     Number of retries for known extractor errors
                                (default is 3), or "infinite"
--allow-dynamic-mpd             Process dynamic DASH manifests (default)
                                (Alias: --no-ignore-dynamic-mpd)
--ignore-dynamic-mpd            Do not process dynamic DASH manifests
                                (Alias: --no-allow-dynamic-mpd)
--hls-split-discontinuity       Split HLS playlists to different formats at
                                discontinuities such as ad breaks
--no-hls-split-discontinuity    Do not split HLS playlists to different
                                formats at discontinuities such as ad breaks
                                (default)
--extractor-args KEY:ARGS       Pass these arguments to the extractor. See
                                "EXTRACTOR ARGUMENTS" for details. You can
                                use this option multiple times to give
                                arguments for different extractors

構成

サポートされているコマンドラインオプションを構成ファイルに配置することで、yt-dlpを構成できます。構成は、次の場所からロードされます。

  1. 主な構成:によって与えられたファイル

    --config-location

  2. ポータブル構成

    yt-dlp.conf
    バンドルされたバイナリと同じディレクトリにあります。ソースコード()から実行している場合は
    <root dir>/yt_dlp/__main__.py
    、代わりにルートディレクトリが使用されます。

  3. ホーム構成

    yt-dlp.conf
    によって指定されたホームパス
    -P
    内、またはそのようなパスが指定されていない場合は現在のディレクトリ内

  4. ユーザー構成

    • %XDG_CONFIG_HOME%/yt-dlp/config
      (Linux / macOSで推奨)
    • %XDG_CONFIG_HOME%/yt-dlp.conf
    • %APPDATA%/yt-dlp/config
      (Windowsで推奨)
    • %APPDATA%/yt-dlp/config.txt
    • ~/yt-dlp.conf
    • ~/yt-dlp.conf.txt

    %XDG_CONFIG_HOME%
    ~/.config
    未定義の場合のデフォルト。ウィンドウでは、
    %APPDATA%
    通常、を指し、存在する場合は
    C:\Users\<user name>\AppData\Roaming
    を指します(通常)、または
    ~
    %HOME%
    %USERPROFILE%
    C:\Users\<user name>
    %HOMEDRIVE%%HOMEPATH%

  5. システム構成

    /etc/yt-dlp.conf

たとえば、次の構成ファイルを使用すると、yt-dlpは常にオーディオを抽出し、mtimeをコピーせず、プロキシを使用して、すべてのビデオを

YouTube
ホームディレクトリのディレクトリに保存します。

# Lines starting with # are comments

# Always extract audio
-x

# Do not copy the mtime
--no-mtime

# Use this proxy
--proxy 127.0.0.1:3128

# Save all videos under YouTube directory in your home directory
-o ~/YouTube/%(title)s.%(ext)s

構成ファイルのオプションは、通常のコマンドライン呼び出しで使用されるスイッチとも呼ばれるオプションとまったく同じであることに注意してください。したがって、orの後に空白があってはなりません。たとえば、orではなくorです。

-
--
-o
--proxy
- o
-- proxy

--ignore-config
特定のyt-dlp実行のすべての構成ファイルを無効にする場合に使用できます。
--ignore-config
構成ファイル内でが見つかった場合、それ以上の構成はロードされません。たとえば、ポータブル構成ファイルにオプションがあると、ホーム、ユーザー、およびシステム構成のロードが防止されます。さらに、(下位互換性のために)
--ignore-config
システム構成ファイル内にが見つかった場合、ユーザー構成はロードされません。

.netrc
ファイルによる認証

yt-dlpの実行ごとにコマンドライン引数としてクレデンシャルを渡さず、シェルコマンド履歴でプレーンテキストのパスワードを追跡しないようにするために、認証をサポートするエクストラクタの自動クレデンシャルストレージを構成することもできます(とでログインとパスワードを提供する

--username
) 。
--password
。これは、エクストラクタごとに
.netrc
ファイル
を使用して実現できます。そのためには、
.netrc
ファイルを作成し、
--netrc-location
自分だけが読み取り/書き込みするためのアクセス許可を制限する必要があります。

touch $HOME/.netrc
chmod a-rwx,u+rw $HOME/.netrc

その後、次の形式でエクストラクタのクレデンシャルを追加できます。エクストラクタは小文字のエクストラクタの名前です。

machine <extractor> login <username> password <password>

例えば:

machine youtube login [email protected] password my_youtube_password
machine twitch login my_twitch_account_name password my_twitch_password

ファイルで認証をアクティブにするには、yt-dlpに

.netrc
渡すか、構成ファイルに配置する必要があります。
--netrc

UNIXでは、.netrcファイルのデフォルトの場所は

$HOME
~
)です。Windowsでは、
%HOME%
存在する場合は
%USERPROFILE%
(通常
C:\Users\<user name>
)または
%HOMEDRIVE%%HOMEPATH%

出力テンプレート

この

-o
オプションは、出力ファイル名のテンプレートを示すために使用され、
-P
オプションは、各タイプのファイルを保存するパスを指定するために使用されます。

tl; dr: 例に移動します

の最も簡単な使用法は

-o
、のように単一のファイルをダウンロードするときにテンプレート引数を設定しないことです
yt-dlp -o funny_video.flv "https://some/video"
(このようなファイル拡張子のハードコーディングは推奨されておらず、後処理が中断される可能性があります)。

ただし、各ビデオをダウンロードするときに置き換えられる特別なシーケンスが含まれている場合もあります。特別なシーケンスは、 Python文字列フォーマット操作に従ってフォーマットできます。たとえば、

%(NAME)s
または
%(NAME)05d
。明確にするために、これはパーセント記号の後に括弧で囲まれた名前が続き、その後に書式設定操作が続きます。

フィールド名自体(括弧内の部分)にも、特別な形式を設定できます。

  1. オブジェクトトラバーサル:メタデータで使用可能な辞書とリストは、

    .
    (ドット)セパレーターを使用してトラバースできます。を使用してPythonスライスを実行することもできます
    :
    。例:
    %(tags.0)s
    、、、、。
    %(subtitles.en.-1.ext)s
    _ infodict全体を指します。この方法を使用して使用可能になるすべてのフィールドが以下にリストされていないことに注意してください。そのようなフィールドを表示するために使用します
    %(id.3:7:-1)s
    %(formats.:.format_id)s
    %()s
    -j

  2. 加算

    +
    :数値フィールドの加算と減算は、それぞれとを使用して実行できます
    -
    。例:
    %(playlist_index+10)03d
    %(n_entries+1-playlist_index)d

  3. 日付/時刻のフォーマット:日付/時刻フィールドは、フィールド名とは別に指定することにより、 strftimeフォーマットに従ってフォーマットできます

    >
    。例:
    %(duration>%H-%M-%S)s
    、、
    %(upload_date>%Y-%m-%d)s
    %(epoch-3600>%H-%M-%S)s

  4. 代替:代替フィールドは、で区切って指定できます

    ,
    。例えば:
    %(release_date>%Y,upload_date>%Y|Unknown)s

  5. 置換:置換値は、

    &
    セパレーターを使用して指定できます。フィールドが空でない場合、実際のフィールドの内容の代わりにこの置換値が使用されます。これは、代替フィールドが考慮された後に行われます。したがって、代替フィールドのいずれかが空でない場合は、置換が使用されます。

  6. デフォルト:文字通りのデフォルト値は、

    |
    区切り文字を使用してフィールドが空の場合に指定できます。これはをオーバーライドします
    --output-na-template
    。例えば:
    %(uploader|Unknown)s

  7. その他の変換:通常の形式タイプ

    diouxXeEfFgGcrs
    に加えて、、、、、、、、を使用して、B ytes
    B
    j son
    j
    きれいに印刷するためのフラグ)、コンマ区切りのl ist(改行で区切られたフラグ)、文字列に変換できます。 q端末(リストを異なる引数に分割するフラグ)、D ecimalサフィックス(例:10M)(1024を係数として使用するフラグ)、およびファイル名としてS anitize(制限付きフラグ)をそれぞれ追加します。
    l
    q
    D
    S
    #
    #
    \n
    #
    #
    #

  8. Unicode正規化:フォーマットタイプは、NFCユニコード正規化

    U
    に使用できます。代替形式フラグ()は正規化をNFDに変更し、変換フラグはNFKC/NFKD互換性等価正規化に使用できます。例:NFKCです
    #
    +
    %(title)+.100U

要約すると、フィールドの一般的な構文は次のとおりです。

%(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type

さらに、ファイルのタイプの後にコロンで区切ったテンプレートを指定することにより、一般的な出力テンプレートとは別に、さまざまなメタデータファイルに異なる出力テンプレートを設定できます

:
。サポートされているさまざまなファイルタイプは、、、、
subtitle
(非推奨)、、、、、、、、、です。たとえば 、サムネイルをビデオと同じ名前のフォルダに配置します。テンプレートのいずれかが空の場合、そのタイプのファイルは書き込まれません。例:動画ではなく、再生リストにのみサムネイルを書き込みます。
thumbnail
description
annotation
infojson
link
pl_thumbnail
pl_description
pl_infojson
chapter
pl_video
-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"
--write-thumbnail -o "thumbnail:"

使用可能なフィールドは次のとおりです。

  • id
    (文字列):ビデオ識別子
  • title
    (文字列):ビデオタイトル
  • fulltitle
    (文字列):ライブタイムスタンプと一般的なタイトルを無視するビデオタイトル
  • url
    (文字列):ビデオURL
  • ext
    (文字列):ビデオファイル名拡張子
  • alt_title
    (文字列):動画の2番目のタイトル
  • description
    (文字列):動画の説明
  • display_id
    (文字列):動画の代替識別子
  • uploader
    (文字列):動画アップローダーのフルネーム
  • license
    (文字列):ビデオがライセンスされているライセンス名
  • creator
    (文字列):動画の作成者
  • timestamp
    (数値):ビデオが利用可能になった瞬間のUNIXタイムスタンプ
  • upload_date
    (文字列):UTCでのビデオアップロード日(YYYYMMDD)
  • release_timestamp
    (数値):ビデオがリリースされた瞬間のUNIXタイムスタンプ
  • release_date
    (文字列):ビデオがUTCでリリースされた日付(YYYYMMDD)
  • modified_timestamp
    (数値):ビデオが最後に変更された瞬間のUNIXタイムスタンプ
  • modified_date
    (文字列):ビデオがUTCで最後に変更された日付(YYYYMMDD)
  • uploader_id
    (文字列):動画アップローダーのニックネームまたはID
  • channel
    (文字列):動画がアップロードされているチャンネルのフルネーム
  • channel_id
    (文字列):チャネルのID
  • channel_follower_count
    (数値):チャンネルのフォロワー数
  • location
    (string): Physical location where the video was filmed
  • duration
    (numeric): Length of the video in seconds
  • duration_string
    (string): Length of the video (HH:mm:ss)
  • view_count
    (numeric): How many users have watched the video on the platform
  • like_count
    (numeric): Number of positive ratings of the video
  • dislike_count
    (numeric): Number of negative ratings of the video
  • repost_count
    (numeric): Number of reposts of the video
  • average_rating
    (numeric): Average rating give by users, the scale used depends on the webpage
  • comment_count
    (numeric): Number of comments on the video (For some extractors, comments are only downloaded at the end, and so this field cannot be used)
  • age_limit
    (numeric): Age restriction for the video (years)
  • live_status
    (string): One of "is_live", "was_live", "is_upcoming", "not_live"
  • is_live
    (boolean): Whether this video is a live stream or a fixed-length video
  • was_live
    (boolean): Whether this video was originally a live stream
  • playable_in_embed
    (string): Whether this video is allowed to play in embedded players on other sites
  • availability
    (string): Whether the video is "private", "premium_only", "subscriber_only", "needs_auth", "unlisted" or "public"
  • start_time
    (numeric): Time in seconds where the reproduction should start, as specified in the URL
  • end_time
    (numeric): Time in seconds where the reproduction should end, as specified in the URL
  • format
    (string): A human-readable description of the format
  • format_id
    (string): Format code specified by
    --format
  • format_note
    (string): Additional info about the format
  • width
    (numeric): Width of the video
  • height
    (numeric): Height of the video
  • resolution
    (string): Textual description of width and height
  • tbr
    (numeric): Average bitrate of audio and video in KBit/s
  • abr
    (numeric): Average audio bitrate in KBit/s
  • acodec
    (string): Name of the audio codec in use
  • asr
    (numeric): Audio sampling rate in Hertz
  • vbr
    (numeric): Average video bitrate in KBit/s
  • fps
    (numeric): Frame rate
  • dynamic_range
    (string): The dynamic range of the video
  • stretched_ratio
    (float):
    width:height
    of the video's pixels, if not square
  • vcodec
    (string): Name of the video codec in use
  • container
    (string): Name of the container format
  • filesize
    (numeric): The number of bytes, if known in advance
  • filesize_approx
    (numeric): An estimate for the number of bytes
  • protocol
    (string): The protocol that will be used for the actual download
  • extractor
    (string): Name of the extractor
  • extractor_key
    (string): Key name of the extractor
  • epoch
    (numeric): Unix epoch of when the information extraction was completed
  • autonumber
    (numeric): Number that will be increased with each download, starting at
    --autonumber-start
  • video_autonumber
    (numeric): Number that will be increased with each video
  • n_entries
    (numeric): Total number of extracted items in the playlist
  • playlist_id
    (string): Identifier of the playlist that contains the video
  • playlist_title
    (string): Name of the playlist that contains the video
  • playlist
    (string):
    playlist_id
    or
    playlist_title
  • playlist_count
    (numeric): Total number of items in the playlist. May not be known if entire playlist is not extracted
  • playlist_index
    (numeric): Index of the video in the playlist padded with leading zeros according the final index
  • playlist_autonumber
    (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
  • playlist_uploader
    (string): Full name of the playlist uploader
  • playlist_uploader_id
    (string): Nickname or id of the playlist uploader
  • webpage_url
    (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
  • webpage_url_basename
    (string): The basename of the webpage URL
  • webpage_url_domain
    (string): The domain of the webpage URL
  • original_url
    (string): The URL given by the user (or same as
    webpage_url
    for playlist entries)

Available for the video that belongs to some logical chapter or section:

  • chapter
    (string): Name or title of the chapter the video belongs to
  • chapter_number
    (numeric): Number of the chapter the video belongs to
  • chapter_id
    (string): Id of the chapter the video belongs to

Available for the video that is an episode of some series or programme:

  • series
    (string): Title of the series or programme the video episode belongs to
  • season
    (string): Title of the season the video episode belongs to
  • season_number
    (numeric): Number of the season the video episode belongs to
  • season_id
    (string): Id of the season the video episode belongs to
  • episode
    (string): Title of the video episode
  • episode_number
    (numeric): Number of the video episode within a season
  • episode_id
    (string): Id of the video episode

Available for the media that is a track or a part of a music album:

  • track
    (string): Title of the track
  • track_number
    (numeric): Number of the track within an album or a disc
  • track_id
    (string): Id of the track
  • artist
    (string): Artist(s) of the track
  • genre
    (string): Genre(s) of the track
  • album
    (string): Title of the album the track belongs to
  • album_type
    (string): Type of the album
  • album_artist
    (string): List of all artists appeared on the album
  • disc_number
    (numeric): Number of the disc or other physical medium the track belongs to
  • release_year
    (numeric): Year (YYYY) when the album was released

Available only when using

--download-sections
and for
chapter:
prefix when using
--split-chapters
for videos with internal chapters:

  • section_title
    (string): Title of the chapter
  • section_number
    (numeric): Number of the chapter within the file
  • section_start
    (numeric): Start time of the chapter in seconds
  • section_end
    (numeric): End time of the chapter in seconds

Available only when used in

--print
:

  • urls
    (string): The URLs of all requested formats, one in each line
  • filename
    (string): Name of the video file. Note that the actual filename may be different due to post-processing. Use
    --exec echo
    to get the name after all postprocessing is complete
  • formats_table
    (table): The video format table as printed by
    --list-formats
  • thumbnails_table
    (table): The thumbnail format table as printed by
    --list-thumbnails
  • subtitles_table
    (table): The subtitle format table as printed by
    --list-subs
  • automatic_captions_table
    (table): The automatic subtitle format table as printed by
    --list-subs

Available only in

--sponsorblock-chapter-title
:

  • start_time
    (numeric): Start time of the chapter in seconds
  • end_time
    (numeric): End time of the chapter in seconds
  • categories
    (list): The SponsorBlock categories the chapter belongs to
  • category
    (string): The smallest SponsorBlock category the chapter belongs to
  • category_names
    (list): Friendly names of the categories
  • name
    (string): Friendly name of the smallest category

Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. For example for

-o %(title)s-%(id)s.%(ext)s
and an mp4 video with title
yt-dlp test video
and id
BaW_jenozKc
, this will result in a
yt-dlp test video-BaW_jenozKc.mp4
file created in the current directory.

Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with

--output-na-placeholder
(
NA
by default).

Tip: Look at the

-j
output to identify which fields are available for the particular URL

For numeric sequences you can use numeric related formatting, for example,

%(view_count)05d
will result in a string with view count padded with zeros up to 5 characters, like in
00042
.

Output templates can also contain arbitrary hierarchical path, e.g.

-o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s"
which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.

To use percent literals in an output template use

%%
. To output to stdout use
-o -
.

The current default template is

%(title)s [%(id)s].%(ext)s
.

In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the

--restrict-filenames
flag to get a shorter title.

Output template and Windows batch files

If you are using an output template inside a Windows batch file then you must escape plain percent characters (

%
) by doubling, so that
-o "%(title)s-%(id)s.%(ext)s"
should become
-o "%%(title)s-%%(id)s.%%(ext)s"
. However you should not touch
%
's that are not plain characters, e.g. environment variables for expansion should stay intact:
-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"
.

Output template examples

$ yt-dlp --get-filename -o "test video.%(ext)s" BaW_jenozKc
test video.webm    # Literal name with correct extension

$ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
youtube-dl test video ''_ä↭𝕐.webm    # All kinds of weird characters

$ yt-dlp --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
youtube-dl_test_video_.webm    # Restricted file name

# Download YouTube playlist videos in separate directory indexed by video order in a playlist
$ yt-dlp -o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"

# Download YouTube playlist videos in separate directories according to their uploaded year
$ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"

# Prefix playlist index with " - " separator, but only if it is available
$ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"

# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
$ yt-dlp -o "%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s" "https://www.youtube.com/user/TheLinuxFoundation/playlists"

# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
$ yt-dlp -u user -p password -P "~/MyVideos" -o "%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s" "https://www.udemy.com/java-tutorial"

# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
$ yt-dlp -P "C:/MyVideos" -o "%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" "https://videomore.ru/kino_v_detalayah/5_sezon/367617"

# Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
# and put all temporary files in "C:\MyVideos\tmp"
$ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs

# Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
$ yt-dlp -P "C:/MyVideos" -o "%(uploader)s/%(title)s.%(ext)s" -o "subtitle:%(uploader)s/subs/%(title)s.%(ext)s" BaW_jenozKc --write-subs

# Stream the video being downloaded to stdout
$ yt-dlp -o - BaW_jenozKc

FORMAT SELECTION

By default, yt-dlp tries to download the best available quality if you don't pass any options. This is generally equivalent to using

-f bestvideo*+bestaudio/best
. However, if multiple audiostreams is enabled (
--audio-multistreams
), the default format changes to
-f bestvideo+bestaudio/best
. Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to
stdout
(
-o -
), the default becomes
-f best/bestvideo+bestaudio
.

Deprecation warning: Latest versions of yt-dlp can stream multiple formats to the stdout simultaneously using ffmpeg. So, in future versions, the default for this will be set to

-f bv*+ba/b
similar to normal downloads. If you want to preserve the
-f b/bv+ba
setting, it is recommended to explicitly specify it in the configuration options.

The general syntax for format selection is

-f FORMAT
(or
--format FORMAT
) where
FORMAT
is a selector expression, i.e. an expression that describes format or formats you would like to download.

tl;dr: navigate me to examples.

The simplest case is requesting a specific format, for example with

-f 22
you can download the format with format code equal to 22. You can get the list of available format codes for particular video using
--list-formats
or
-F
. Note that these format codes are extractor specific.

You can also use a file extension (currently

3gp
,
aac
,
flv
,
m4a
,
mp3
,
mp4
,
ogg
,
wav
,
webm
are supported) to download the best quality format of a particular file extension served as a single file, e.g.
-f webm
will download the best quality format with the
webm
extension served as a single file.

You can use

-f -
to interactively provide the format selector for each video

You can also use special names to select particular edge case formats:

  • all
    : Select all formats separately
  • mergeall
    : Select and merge all formats (Must be used with
    --audio-multistreams
    ,
    --video-multistreams
    or both)
  • b*
    ,
    best*
    : Select the best quality format that contains either a video or an audio
  • b
    ,
    best
    : Select the best quality format that contains both video and audio. Equivalent to
    best*[vcodec!=none][acodec!=none]
  • bv
    ,
    bestvideo
    : Select the best quality video-only format. Equivalent to
    best*[acodec=none]
  • bv*
    ,
    bestvideo*
    : Select the best quality format that contains video. It may also contain audio. Equivalent to
    best*[vcodec!=none]
  • ba
    ,
    bestaudio
    : Select the best quality audio-only format. Equivalent to
    best*[vcodec=none]
  • ba*
    ,
    bestaudio*
    : Select the best quality format that contains audio. It may also contain video. Equivalent to
    best*[acodec!=none]
    (Do not use!)
  • w*
    ,
    worst*
    : Select the worst quality format that contains either a video or an audio
  • w
    ,
    worst
    : Select the worst quality format that contains both video and audio. Equivalent to
    worst*[vcodec!=none][acodec!=none]
  • wv
    ,
    worstvideo
    : Select the worst quality video-only format. Equivalent to
    worst*[acodec=none]
  • wv*
    ,
    worstvideo*
    : Select the worst quality format that contains video. It may also contain audio. Equivalent to
    worst*[vcodec!=none]
  • wa
    ,
    worstaudio
    : Select the worst quality audio-only format. Equivalent to
    worst*[vcodec=none]
  • wa*
    ,
    worstaudio*
    : Select the worst quality format that contains audio. It may also contain video. Equivalent to
    worst*[acodec!=none]

For example, to download the worst quality video-only format you can use

-f worstvideo
. It is however recommended not to use
worst
and related options. When your format selector is
worst
, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use
-S +size
or more rigorously,
-S +size,+br,+res,+fps
instead of
-f worst
. See sorting formats for more details.

You can select the n'th best format of a type by using

best<type>.<n>
. For example,
best.2
will select the 2nd best combined format. Similarly,
bv*.3
will select the 3rd best format that contains a video stream.

If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred, for example

-f 22/17/18
will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.

If you want to download several formats of the same video use a comma as a separator, e.g.

-f 22,17,18
will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature:
-f 136/137/mp4/bestvideo,140/m4a/bestaudio
.

You can merge the video and audio of multiple formats into a single file using

-f <format1>+<format2>+...
(requires ffmpeg installed), for example
-f bestvideo+bestaudio
will download the best video-only format, the best audio-only format and mux them together with ffmpeg.

Deprecation warning: Since the below described behavior is complex and counter-intuitive, this will be removed and multistreams will be enabled by default in the future. A new operator will be instead added to limit formats to single audio/video

Unless

--video-multistreams
is used, all formats with a video stream except the first one are ignored. Similarly, unless
--audio-multistreams
is used, all formats with an audio stream except the first one are ignored. For example,
-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams
will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But
-f bestvideo+best+bestaudio --no-video-multistreams
will download and merge only
bestvideo
and
bestaudio
.
best
is ignored since another format containing a video stream (
bestvideo
) has already been selected. The order of the formats is therefore important.
-f best+bestaudio --no-audio-multistreams
will download and merge both formats while
-f bestaudio+best --no-audio-multistreams
will ignore
best
and download only
bestaudio
.

Filtering Formats

You can also filter the video formats by putting a condition in brackets, as in

-f "best[height=720]"
(or
-f "[filesize>10M]"
).

The following numeric meta fields can be used with comparisons

<
,
<=
,
>
,
>=
,
=
(equals),
!=
(not equals):

  • filesize
    : The number of bytes, if known in advance
  • width
    : Width of the video, if known
  • height
    : Height of the video, if known
  • tbr
    : Average bitrate of audio and video in KBit/s
  • abr
    : Average audio bitrate in KBit/s
  • vbr
    : Average video bitrate in KBit/s
  • asr
    : Audio sampling rate in Hertz
  • fps
    : Frame rate

Also filtering work for comparisons

=
(equals),
^=
(starts with),
$=
(ends with),
*=
(contains),
~=
(matches regex) and following string meta fields:

  • ext
    : File extension
  • acodec
    : Name of the audio codec in use
  • vcodec
    : Name of the video codec in use
  • container
    : Name of the container format
  • protocol
    : The protocol that will be used for the actual download, lower-case (
    http
    ,
    https
    ,
    rtsp
    ,
    rtmp
    ,
    rtmpe
    ,
    mms
    ,
    f4m
    ,
    ism
    ,
    http_dash_segments
    ,
    m3u8
    , or
    m3u8_native
    )
  • format_id
    : A short description of the format
  • language
    : Language code

Any string comparison may be prefixed with negation

!
in order to produce an opposite comparison, e.g.
!*=
(does not contain). The comparand of a string comparison needs to be quoted with either double or single quotes if it contains spaces or special characters other than
._-
.

Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.

Formats for which the value is not known are excluded unless you put a question mark (

?
) after the operator. You can combine format filters, so
-f "[height<=?720][tbr>500]"
selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s. You can also use the filters with
all
to download all formats that satisfy the filter. For example,
-f "all[vcodec=none]"
selects all audio-only formats.

Format selectors can also be grouped using parentheses, for example if you want to download the best pre-merged mp4 and webm formats with a height lower than 480 you can use

-f "(mp4,webm)[height<480]"
.

Sorting Formats

You can change the criteria for being considered the

best
by using
-S
(
--format-sort
). The general format for this is
--format-sort field1,field2...
.

The available fields are:

  • hasvid
    : Gives priority to formats that has a video stream
  • hasaud
    : Gives priority to formats that has a audio stream
  • ie_pref
    : The format preference
  • lang
    : The language preference
  • quality
    : The quality of the format
  • source
    : The preference of the source
  • proto
    : Protocol used for download (
    https
    /
    ftps
    >
    http
    /
    ftp
    >
    m3u8_native
    /
    m3u8
    >
    http_dash_segments
    >
    websocket_frag
    >
    mms
    /
    rtsp
    >
    f4f
    /
    f4m
    )
  • vcodec
    : Video Codec (
    av01
    >
    vp9.2
    >
    vp9
    >
    h265
    >
    h264
    >
    vp8
    >
    h263
    >
    theora
    > other)
  • acodec
    : Audio Codec (
    flac
    /
    alac
    >
    wav
    /
    aiff
    >
    opus
    >
    vorbis
    >
    aac
    >
    mp4a
    >
    mp3
    >
    eac3
    >
    ac3
    >
    dts
    > other)
  • codec
    : Equivalent to
    vcodec,acodec
  • vext
    : Video Extension (
    mp4
    >
    webm
    >
    flv
    > other). If
    --prefer-free-formats
    is used,
    webm
    is preferred.
  • aext
    : Audio Extension (
    m4a
    >
    aac
    >
    mp3
    >
    ogg
    >
    opus
    >
    webm
    > other). If
    --prefer-free-formats
    is used, the order changes to
    opus
    >
    ogg
    >
    webm
    >
    m4a
    >
    mp3
    >
    aac
    .
  • ext
    : Equivalent to
    vext,aext
  • filesize
    : Exact filesize, if known in advance
  • fs_approx
    : Approximate filesize calculated from the manifests
  • size
    : Exact filesize if available, otherwise approximate filesize
  • height
    : Height of video
  • width
    : Width of video
  • res
    : Video resolution, calculated as the smallest dimension.
  • fps
    : Framerate of video
  • hdr
    : The dynamic range of the video (
    DV
    >
    HDR12
    >
    HDR10+
    >
    HDR10
    >
    HLG
    >
    SDR
    )
  • tbr
    : Total average bitrate in KBit/s
  • vbr
    : Average video bitrate in KBit/s
  • abr
    : Average audio bitrate in KBit/s
  • br
    : Equivalent to using
    tbr,vbr,abr
  • asr
    : Audio sample rate in Hz

Deprecation warning: Many of these fields have (currently undocumented) aliases, that may be removed in a future version. It is recommended to use only the documented field names.

All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a

+
. Eg:
+res
prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a
:
. Eg:
res:720
prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For
codec
and
ext
, you can provide two preferred values, the first for video and the second for audio. Eg:
+codec:avc:m4a
(equivalent to
+vcodec:avc,+acodec:m4a
) sets the video codec preference to
h264
>
h265
>
vp9
>
vp9.2
>
av01
>
vp8
>
h263
>
theora
and audio codec preference to
mp4a
>
aac
>
vorbis
>
opus
>
mp3
>
ac3
>
dts
. You can also make the sorting prefer the nearest values to the provided by using
~
as the delimiter. Eg:
filesize~1G
prefers the format with filesize closest to 1 GiB.

The fields

hasvid
and
ie_pref
are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using
--format-sort-force
. Apart from these, the default order used is:
lang,quality,res,fps,hdr:12,codec:vp9.2,size,br,asr,proto,ext,hasaud,source,id
. The extractors may override this default order, but they cannot override the user-provided order.

デフォルトには

codec:vp9.2
;があることに注意してください。すなわち
av1
、好ましくありません。同様に、hdrのデフォルトは
hdr:12
;です。つまり、ドルビービジョンは好ましくありません。DVおよびAV1形式はまだほとんどのデバイスと完全に互換性がないため、これらの選択が行われます。より多くのデバイスがこれらのフォーマットをスムーズに再生できるようになるにつれて、これは将来変更される可能性があります。

フォーマットセレクターが

worst
の場合、ソート後に最後の項目が選択されます。これは、すべての点で最悪のフォーマットを選択することを意味します。ほとんどの場合、実際に必要なのは、代わりにファイルサイズが最小のビデオです。したがって、一般的にはを使用することをお勧めします
-f best -S +size,+br,+res,+fps

ヒント:を使用し

-v -F
て、フォーマットがどのようにソートされているかを確認できます(最悪から最高)。

フォーマット選択例

# Download and merge the best video-only format and the best audio-only format,
# or download the best combined format if video-only format is not available
$ yt-dlp -f "bv+ba/b"

# Download best format that contains video,
# and if it doesn't already have an audio stream, merge it with best audio-only format
$ yt-dlp -f "bv*+ba/b"

# Same as above
$ yt-dlp

# Download the best video-only format and the best audio-only format without merging them
# For this case, an output template should be used since
# by default, bestvideo and bestaudio will have the same file name.
$ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"

# Download and merge the best format that has a video stream,
# and all audio-only formats into one file
$ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams

# Download and merge the best format that has a video stream,
# and the best 2 audio-only formats into one file
$ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams


# The following examples show the old method (without -S) of format selection
# and how to use -S to achieve a similar but (generally) better result

# Download the worst video available (old method)
$ yt-dlp -f "wv*+wa/w"

# Download the best video available but with the smallest resolution
$ yt-dlp -S "+res"

# Download the smallest video available
$ yt-dlp -S "+size,+br"



# Download the best mp4 video available, or the best video if no mp4 available
$ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"

# Download the best video with the best extension
# (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
$ yt-dlp -S "ext"



# Download the best video available but no better than 480p,
# or the worst video if there is no video under 480p
$ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"

# Download the best video available with the largest height but no better than 480p,
# or the best video with the smallest resolution if there is no video under 480p
$ yt-dlp -S "height:480"

# Download the best video available with the largest resolution but no better than 480p,
# or the best video with the smallest resolution if there is no video under 480p
# Resolution is determined by using the smallest dimension.
# So this works correctly for vertical videos as well
$ yt-dlp -S "res:480"



# Download the best video (that also has audio) but no bigger than 50 MB,
# or the worst video (that also has audio) if there is no video under 50 MB
$ yt-dlp -f "b[filesize<50M] / w"

# Download largest video (that also has audio) but no bigger than 50 MB,
# or the smallest video (that also has audio) if there is no video under 50 MB
$ yt-dlp -f "b" -S "filesize:50M"

# Download best video (that also has audio) that is closest in size to 50 MB
$ yt-dlp -f "b" -S "filesize~50M"



# Download best video available via direct link over HTTP/HTTPS protocol,
# or the best video available via any protocol if there is no such video
$ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"

# Download best video available via the best protocol
# (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
$ yt-dlp -S "proto"



# Download the best video with either h264 or h265 codec,
# or the best video if there is no such video
$ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"

# Download the best video with best codec no better than h264,
# or the best video with worst codec if there is no such video
$ yt-dlp -S "codec:h264"

# Download the best video with worst codec no worse than h264,
# or the best video with best codec if there is no such video
$ yt-dlp -S "+codec:h264"



# More complex examples

# Download the best video no better than 720p preferring framerate greater than 30,
# or the worst video (still preferring framerate greater than 30) if there is no such video
$ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"

# Download the video with the largest resolution no better than 720p,
# or the video with the smallest resolution available if there is no such video,
# preferring larger framerate for formats with the same resolution
$ yt-dlp -S "res:720,fps"



# Download the video with smallest resolution no worse than 480p,
# or the video with the largest resolution available if there is no such video,
# preferring better codec and then larger total bitrate for the same resolution
$ yt-dlp -S "+res:480,codec,br"

メタデータの変更

--parse-metadata
エクストラクタによって取得されたメタデータは、およびを使用して変更できます。
--replace-in-metadata

--replace-in-metadata FIELDS REGEX REPLACE
Python正規表現を使用して、メタデータフィールドのテキストを置き換えるために使用されます。高度な使用のために、置換文字列で後方参照を使用できます。

の一般的な構文は、データを抽出

--parse-metadata FROM:TO
するフィールドまたは出力テンプレートの名前と、それを解釈するための形式をコロンで区切って指定すること
:
です。名前付きキャプチャグループを使用したPython正規表現、または出力テンプレートと同様の構文(
%(field)s
フォーマットのみがサポートされています)のいずれかをに使用できます
TO
。このオプションは、さまざまなフィールドを解析および変更するために複数回使用できます。

これによって作成されたフィールドはすべて出力テンプレートで使用でき、を使用するときに追加されるメディアファイルのメタデータにも影響することに注意してください

--add-metadata

このオプションには、いくつかの特別な用途もあります。

  • 現在ダウンロードされているビデオのメタデータに基づいて、追加のURLをダウンロードできます。これを行うには、フィールド

    additional_urls
    をダウンロードするURLに設定します。例:
    --parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)
    説明にある最初のvimeoビデオをダウンロードします

  • これを使用して、メディアファイルに埋め込まれているメタデータを変更できます。これを行うには、対応するフィールドの値に

    meta_
    プレフィックスを付けます。たとえば、fieldに設定した値は、ファイル
    meta_description
    のフィールドに追加され
    description
    ます。たとえば、これを使用して、別の「説明」と「概要」を設定できます。個々のストリームのメタデータを変更するには、
    meta<n>_
    プレフィックス(例:)を使用します
    meta1_language
    。フィールドに設定された値は、
    meta_
    すべてのデフォルト値を上書きします。

:メタデータの変更は、形式の選択、後抽出、およびその他の後処理操作の前に行われます。これらの手順の間に一部のフィールドが追加または変更され、変更が上書きされる場合があります。

参考までに、yt-dlpがデフォルトでファイルメタデータに追加するフィールドは次のとおりです。

メタデータフィールド から
title
track
また
title
date
upload_date
description
synopsis
description
purl
comment
webpage_url
track
track_number
artist
artist
,
creator
,
uploader
or
uploader_id
genre
genre
album
album
album_artist
album_artist
disc
disc_number
show
series
season_number
season_number
episode_id
episode
or
episode_id
episode_sort
episode_number
language
of each stream
the format's
language

Note: The file format may not support some of these fields

Modifying metadata examples

# Interpret the title as "Artist - Title"
$ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"

# Regex example
$ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"

# Set title as "Series name S01E05"
$ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"

# Prioritize uploader as the "artist" field in video metadata
$ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --add-metadata

# Set "comment" field in video metadata using description instead of webpage_url,
# handling multiple lines correctly
$ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --add-metadata

# Do not set any "synopsis" in the video metadata
$ yt-dlp --parse-metadata ":(?P<meta_synopsis>)"

# Remove "formats" field from the infojson by setting it to an empty string
$ yt-dlp --parse-metadata ":(?P<formats>)" -j

# Replace all spaces and "_" in title and uploader with a `-`
$ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"

EXTRACTOR ARGUMENTS

Some extractors accept additional arguments which can be passed using

--extractor-args KEY:ARGS
.
ARGS
is a
;
(semicolon) separated string of
ARG=VAL1,VAL2
. Eg:
--extractor-args "youtube:player-client=android_embedded,web;include_live_dash" --extractor-args "funimation:version=uncut"

The following extractors use this feature:

youtube

  • skip
    : One or more of
    hls
    ,
    dash
    or
    translated_subs
    to skip extraction of the m3u8 manifests, dash manifests and auto-translated subtitles respectively
  • player_client
    : Clients to extract video data from. The main clients are
    web
    ,
    android
    and
    ios
    with variants
    _music
    ,
    _embedded
    ,
    _embedscreen
    ,
    _creator
    (Eg:
    web_embedded
    ); and
    mweb
    and
    tv_embedded
    (agegate bypass) with no variants. By default,
    android,web
    is used, but
    tv_embedded
    and
    creator
    variants are added as required for age-gated videos. Similarly the music variants are added for
    music.youtube.com
    urls. You can use
    all
    to use all the clients, and
    default
    for the default clients.
  • player_skip
    : Skip some network requests that are generally needed for robust extraction. One or more of
    configs
    (skip client configs),
    webpage
    (skip initial webpage),
    js
    (skip js player). While these options can help reduce the number of requests needed or avoid some rate-limiting, they could cause some issues. See #860 for more details
  • include_live_dash
    : Include live dash formats even without
    --live-from-start
    (These formats don't download properly)
  • comment_sort
    :
    top
    or
    new
    (default) - choose comment sorting mode (on YouTube's side)
  • max_comments
    : Limit the amount of comments to gather. Comma-separated list of integers representing
    max-comments,max-parents,max-replies,max-replies-per-thread
    . Default is
    all,all,all,all
    • E.g.
      all,all,1000,10
      will get a maximum of 1000 replies total, with up to 10 replies per thread.
      1000,all,100
      will get a maximum of 1000 comments, with a maximum of 100 replies total
  • innertube_host
    : Innertube API host to use for all API requests
    • e.g.
      studio.youtube.com
      ,
      youtubei.googleapis.com
    • Note: Cookies exported from
      www.youtube.com
      will not work with hosts other than
      *.youtube.com
  • innertube_key
    : Innertube API key to use for all API requests

youtubetab (YouTube playlists, channels, feeds, etc.)

  • skip
    : One or more of
    webpage
    (skip initial webpage download),
    authcheck
    (allow the download of playlists requiring authentication when no initial webpage is downloaded. This may cause unwanted behavior, see #1122 for more details)
  • approximate_date
    : Extract approximate
    upload_date
    in flat-playlist. This may cause date-based filters to be slightly off

funimation

  • language
    : Languages to extract. Eg:
    funimation:language=english,japanese
  • version
    : The video version to extract -
    uncut
    or
    simulcast

crunchyroll

  • language
    : Languages to extract. Eg:
    crunchyroll:language=jaJp
  • hardsub
    : Which hard-sub versions to extract. Eg:
    crunchyroll:hardsub=None,enUS

crunchyrollbeta

  • format
    : Which stream type(s) to extract. Default is
    adaptive_hls
    Eg:
    crunchyrollbeta:format=vo_adaptive_hls
    • Potentially useful values include
      adaptive_hls
      ,
      adaptive_dash
      ,
      vo_adaptive_hls
      ,
      vo_adaptive_dash
      ,
      download_hls
      ,
      trailer_hls
      ,
      trailer_dash
  • hardsub
    : Preference order for which hardsub versions to extract. Default is
    None
    (no hardsubs). Eg:
    crunchyrollbeta:hardsub=en-US,None

vikichannel

  • video_types
    : Types of videos to download - one or more of
    episodes
    ,
    movies
    ,
    clips
    ,
    trailers

niconico

  • segment_duration
    : Segment duration in milliseconds for HLS-DMC formats. Use it at your own risk since this feature may result in your account termination.

youtubewebarchive

  • check_all
    : Try to check more at the cost of more requests. One or more of
    thumbnails
    ,
    captures

gamejolt

  • comment_sort
    :
    hot
    (default),
    you
    (cookies needed),
    top
    ,
    new
    - choose comment sorting mode (on GameJolt's side)

hotstar

  • res
    : resolution to ignore - one or more of
    sd
    ,
    hd
    ,
    fhd
  • vcodec
    : vcodec to ignore - one or more of
    h264
    ,
    h265
    ,
    dvh265
  • dr
    : dynamic range to ignore - one or more of
    sdr
    ,
    hdr10
    ,
    dv

tiktok

  • app_version
    : App version to call mobile APIs with - should be set along with
    manifest_app_version
    . (e.g.
    20.2.1
    )
  • manifest_app_version
    : Numeric app version to call mobile APIs with. (e.g.
    221
    )

rokfinchannel

  • tab
    : Which tab to download. One of
    new
    ,
    top
    ,
    videos
    ,
    podcasts
    ,
    streams
    ,
    stacks
    . (E.g.
    rokfinchannel:tab=streams
    )

NOTE: These options may be changed/removed in the future without concern for backward compatibility

PLUGINS

Plugins are loaded from

<root-dir>/ytdlp_plugins/<type>/__init__.py
; where
<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
). Plugins are currently not supported for the
pip
version

Plugins can be of

<type>
s
extractor
or
postprocessor
. Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it. Postprocessor plugins can be invoked using
--use-postprocessor NAME
.

See ytdlp_plugins for example plugins.

Note that all plugins are imported even if not invoked, and that there are no checks performed on plugin code. Use plugins at your own risk and only if you trust the code

If you are a plugin author, add ytdlp-plugins as a topic to your repository for discoverability

EMBEDDING YT-DLP

yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.

Your program should avoid parsing the normal stdout since they may change in future versions. Instead they should use options such as

-J
,
--print
,
--progress-template
,
--exec
etc to create console output that you can reliably reproduce and parse.

From a Python program, you can embed yt-dlp in a more powerful fashion, like this:

from yt_dlp import YoutubeDL

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
with YoutubeDL() as ydl:
    ydl.download(URLS)

Most likely, you'll want to use various options. For a list of options available, have a look at

yt_dlp/YoutubeDL.py
.

Tip: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of

YoutubeDL.extract_info
to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through
YoutubeDL.sanitize_info
as shown in the example below

Embedding examples

Extracting information

import json
import yt_dlp

URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'

# ℹ️ See help(yt_dlp.YoutubeDL) for a list of available options and public functions
ydl_opts = {}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    info = ydl.extract_info(URL, download=False)

    # ℹ️ ydl.sanitize_info makes the info json-serializable
    print(json.dumps(ydl.sanitize_info(info)))

Download using an info-json

import yt_dlp

INFO_FILE = 'path/to/video.info.json'

with yt_dlp.YoutubeDL() as ydl:
    error_code = ydl.download_with_info_file(INFO_FILE)

print('Some videos failed to download' if error_code
      else 'All videos successfully downloaded')

Extract audio

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

ydl_opts = {
    'format': 'm4a/bestaudio/best',
    # ℹ️ See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
    'postprocessors': [{  # Extract audio using ffmpeg
        'key': 'FFmpegExtractAudio',
        'preferredcodec': 'm4a',
    }]
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    error_code = ydl.download(URLS)

Filter videos

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

def longer_than_a_minute(info, *, incomplete):
    """Download only videos longer than a minute (or with unknown duration)"""
    duration = info.get('duration')
    if duration and duration < 60:
        return 'The video is too short'

ydl_opts = {
    'match_filter': longer_than_a_minute,
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    error_code = ydl.download(URLS)

ロガーとプログレスフックを追加する

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

class MyLogger:
    def debug(self, msg):
        # For compatibility with youtube-dl, both debug and info are passed into debug
        # You can distinguish them by the prefix '[debug] '
        if msg.startswith('[debug] '):
            pass
        else:
            self.info(msg)

    def info(self, msg):
        pass

    def warning(self, msg):
        pass

    def error(self, msg):
        print(msg)


# ℹ️ See "progress_hooks" in help(yt_dlp.YoutubeDL)
def my_hook(d):
    if d['status'] == 'finished':
        print('Done downloading, now post-processing ...')


ydl_opts = {
    'logger': MyLogger(),
    'progress_hooks': [my_hook],
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    ydl.download(URLS)

カスタムPostProcessorを追加します

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

# ℹ️ See help(yt_dlp.postprocessor.PostProcessor)
class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
    def run(self, info):
        self.to_screen('Doing stuff')
        return [], info


with yt_dlp.YoutubeDL() as ydl:
    # ℹ️ "when" can take any value in yt_dlp.utils.POSTPROCESS_WHEN
    ydl.add_post_processor(MyCustomPP(), when='pre_process')
    ydl.download(URLS)

カスタムフォーマットセレクターを使用する

import yt_dlp

URL = ['https://www.youtube.com/watch?v=BaW_jenozKc']

def format_selector(ctx):
    """ Select the best video and the best audio that won't result in an mkv.
    NOTE: This is just an example and does not handle all cases """

    # formats are already sorted worst to best
    formats = ctx.get('formats')[::-1]

    # acodec='none' means there is no audio
    best_video = next(f for f in formats
                      if f['vcodec'] != 'none' and f['acodec'] == 'none')

    # find compatible audio extension
    audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
    # vcodec='none' means there is no video
    best_audio = next(f for f in formats if (
        f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))

    # These are the minimum required fields for a merged format
    yield {
        'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
        'ext': best_video['ext'],
        'requested_formats': [best_video, best_audio],
        # Must be + separated list of protocols
        'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
    }


ydl_opts = {
    'format': format_selector,
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    ydl.download(URLS)

非推奨のオプション

これらはすべて非推奨のオプションであり、同じ効果を達成するための現在の代替手段です

ほとんど冗長なオプション

これらのオプションは新しいオプションとほぼ同じですが、冗長性を妨げるいくつかの違いがあります

-j, --dump-json                  --print "%()j"
-F, --list-formats               --print formats_table
--list-thumbnails                --print thumbnails_table --print playlist:thumbnails_table
--list-subs                      --print automatic_captions_table --print subtitles_table

冗長オプション

これらのオプションは冗長ですが、使いやすさから引き続き使用されることが期待されます。

--get-description                --print description
--get-duration                   --print duration_string
--get-filename                   --print filename
--get-format                     --print format
--get-id                         --print id
--get-thumbnail                  --print thumbnail
-e, --get-title                  --print title
-g, --get-url                    --print urls
--match-title REGEX              --match-filter "title ~= (?i)REGEX"
--reject-title REGEX             --match-filter "title !~= (?i)REGEX"
--min-views COUNT                --match-filter "view_count >=? COUNT"
--max-views COUNT                --match-filter "view_count <=? COUNT"
--user-agent UA                  --add-header "User-Agent:UA"
--referer URL                    --add-header "Referer:URL"
--playlist-start NUMBER          -I NUMBER:
--playlist-end NUMBER            -I :NUMBER
--playlist-reverse               -I ::-1
--no-playlist-reverse            Default

推奨されません

これらのオプションは引き続き機能しますが、同じことを実現する他の方法があるため、これらのオプションの使用はお勧めしません。

--exec-before-download CMD       --exec "before_dl:CMD"
--no-exec-before-download        --no-exec
--all-formats                    -f all
--all-subs                       --sub-langs all --write-subs
--print-json                     -j --no-simulate
--autonumber-size NUMBER         Use string formatting. Eg: %(autonumber)03d
--autonumber-start NUMBER        Use internal field formatting like %(autonumber+NUMBER)s
--id                             -o "%(id)s.%(ext)s"
--metadata-from-title FORMAT     --parse-metadata "%(title)s:FORMAT"
--hls-prefer-native              --downloader "m3u8:native"
--hls-prefer-ffmpeg              --downloader "m3u8:ffmpeg"
--list-formats-old               --compat-options list-formats (Alias: --no-list-formats-as-table)
--list-formats-as-table          --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
--youtube-skip-dash-manifest     --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
--youtube-skip-hls-manifest      --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
--youtube-include-dash-manifest  Default (Alias: --no-youtube-skip-dash-manifest)
--youtube-include-hls-manifest   Default (Alias: --no-youtube-skip-hls-manifest)

開発者向けオプション

これらのオプションは、エンドユーザーが使用することを意図したものではありません

--test                           Download only part of video for testing extractors
--load-pages                     Load pages dumped by --write-pages
--youtube-print-sig-code         For testing youtube signatures
--allow-unplayable-formats       List unplayable formats also
--no-allow-unplayable-formats    Default

古いエイリアス

これらは、さまざまな理由で文書化されなくなったエイリアスです。

--avconv-location                --ffmpeg-location
--clean-infojson                 --clean-info-json
--cn-verification-proxy URL      --geo-verification-proxy URL
--dump-headers                   --print-traffic
--dump-intermediate-pages        --dump-pages
--force-write-download-archive   --force-write-archive
--load-info                      --load-info-json
--no-clean-infojson              --no-clean-info-json
--no-split-tracks                --no-split-chapters
--no-write-srt                   --no-write-subs
--prefer-unsecure                --prefer-insecure
--rate-limit RATE                --limit-rate RATE
--split-tracks                   --split-chapters
--srt-lang LANGS                 --sub-langs LANGS
--trim-file-names LENGTH         --trim-filenames LENGTH
--write-srt                      --write-subs
--yes-overwrites                 --force-overwrites

Sponskrubオプション

SponSkrubのサポートは廃止され、

--sponsorblock
オプションが採用されました

--sponskrub                      --sponsorblock-mark all
--no-sponskrub                   --no-sponsorblock
--sponskrub-cut                  --sponsorblock-remove all
--no-sponskrub-cut               --sponsorblock-remove -all
--sponskrub-force                Not applicable
--no-sponskrub-force             Not applicable
--sponskrub-location             Not applicable
--sponskrub-args                 Not applicable

サポートされなくなりました

これらのオプションは、意図したとおりに機能しなくなる可能性があります

--prefer-avconv                  avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
--prefer-ffmpeg                  Default (Alias: --no-prefer-avconv)
-C, --call-home                  Not implemented
--no-call-home                   Default
--include-ads                    No longer supported
--no-include-ads                 Default
--write-annotations              No supported site has annotations now
--no-write-annotations           Default

削除

これらのオプションは2014年以降廃止され、現在は完全に削除されています

-A, --auto-number                -o "%(autonumber)s-%(id)s.%(ext)s"
-t, -l, --title, --literal       -o "%(title)s-%(id)s.%(ext)s"

貢献

問題を開いてプロジェクトにコードを提供する手順については、 CONTRIBUTING.mdを参照してください。

もっと

FAQについては、youtube-dlREADMEを参照してください。