logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

yt-dlp.1 (152520B)

    

  1. .\"t
  2. .\" Automatically generated by Pandoc 2.9.2.1
  3. .\"
  4. .TH "yt-dlp" "1" "" "" ""
  5. .hy
  6. .SH NAME
  7. .PP
  8. yt-dlp - A feature-rich command-line audio/video downloader
  9. .SH SYNOPSIS
  10. .PP
  11. \f[B]yt-dlp\f[R] [OPTIONS] URL [URL...]
  12. .SH DESCRIPTION
  13. .PP
  14. yt-dlp is a feature-rich command-line audio/video downloader with
  15. support for thousands of sites.
  16. The project is a fork of
  17. youtube-dl (https://github.com/ytdl-org/youtube-dl) based on the now
  18. inactive youtube-dlc (https://github.com/blackjack4494/yt-dlc).
  19. .SH OPTIONS
  20. .SS General Options:
  21. .TP
  22. -h, --help
  23. Print this help text and exit
  24. .TP
  25. --version
  26. Print program version and exit
  27. .TP
  28. -U, --update
  29. Update this program to the latest version
  30. .TP
  31. --no-update
  32. Do not check for updates (default)
  33. .TP
  34. --update-to \f[I][CHANNEL]\[at][TAG]\f[R]
  35. Upgrade/downgrade to a specific version.
  36. CHANNEL can be a repository as well.
  37. CHANNEL and TAG default to \[dq]stable\[dq] and \[dq]latest\[dq]
  38. respectively if omitted; See \[dq]UPDATE\[dq] for details.
  39. Supported channels: stable, nightly, master
  40. .TP
  41. -i, --ignore-errors
  42. Ignore download and postprocessing errors.
  43. The download will be considered successful even if the postprocessing
  44. fails
  45. .TP
  46. --no-abort-on-error
  47. Continue with next video on download errors; e.g.
  48. to skip unavailable videos in a playlist (default)
  49. .TP
  50. --abort-on-error
  51. Abort downloading of further videos if an error occurs (Alias:
  52. --no-ignore-errors)
  53. .TP
  54. --dump-user-agent
  55. Display the current user-agent and exit
  56. .TP
  57. --list-extractors
  58. List all supported extractors and exit
  59. .TP
  60. --extractor-descriptions
  61. Output descriptions of all supported extractors and exit
  62. .TP
  63. --use-extractors \f[I]NAMES\f[R]
  64. Extractor names to use separated by commas.
  65. You can also use regexes, \[dq]all\[dq], \[dq]default\[dq] and
  66. \[dq]end\[dq] (end URL matching); e.g.
  67. --ies \[dq]holodex.*,end,youtube\[dq].
  68. Prefix the name with a \[dq]-\[dq] to exclude it, e.g.
  69. --ies default,-generic.
  70. Use --list-extractors for a list of extractor names.
  71. (Alias: --ies)
  72. .TP
  73. --default-search \f[I]PREFIX\f[R]
  74. Use this prefix for unqualified URLs.
  75. E.g.
  76. \[dq]gvsearch2:python\[dq] downloads two videos from google videos for
  77. the search term \[dq]python\[dq].
  78. Use the value \[dq]auto\[dq] to let yt-dlp guess (\[dq]auto_warning\[dq]
  79. to emit a warning when guessing).
  80. \[dq]error\[dq] just throws an error.
  81. The default value \[dq]fixup_error\[dq] repairs broken URLs, but emits
  82. an error if this is not possible instead of searching
  83. .TP
  84. --ignore-config
  85. Don\[aq]t load any more configuration files except those given to
  86. --config-locations.
  87. For backward compatibility, if this option is found inside the system
  88. configuration file, the user configuration is not loaded.
  89. (Alias: --no-config)
  90. .TP
  91. --no-config-locations
  92. Do not load any custom configuration files (default).
  93. When given inside a configuration file, ignore all previous
  94. --config-locations defined in the current file
  95. .TP
  96. --config-locations \f[I]PATH\f[R]
  97. Location of the main configuration file; either the path to the config
  98. or its containing directory (\[dq]-\[dq] for stdin).
  99. Can be used multiple times and inside other configuration files
  100. .TP
  101. --plugin-dirs \f[I]PATH\f[R]
  102. Path to an additional directory to search for plugins.
  103. This option can be used multiple times to add multiple directories.
  104. Note that this currently only works for extractor plugins; postprocessor
  105. plugins can only be loaded from the default plugin directories
  106. .TP
  107. --flat-playlist
  108. Do not extract a playlist\[aq]s URL result entries; some entry metadata
  109. may be missing and downloading may be bypassed
  110. .TP
  111. --no-flat-playlist
  112. Fully extract the videos of a playlist (default)
  113. .TP
  114. --live-from-start
  115. Download livestreams from the start.
  116. Currently only supported for YouTube (Experimental)
  117. .TP
  118. --no-live-from-start
  119. Download livestreams from the current time (default)
  120. .TP
  121. --wait-for-video \f[I]MIN[-MAX]\f[R]
  122. Wait for scheduled streams to become available.
  123. Pass the minimum number of seconds (or range) to wait between retries
  124. .TP
  125. --no-wait-for-video
  126. Do not wait for scheduled streams (default)
  127. .TP
  128. --mark-watched
  129. Mark videos watched (even with --simulate)
  130. .TP
  131. --no-mark-watched
  132. Do not mark videos watched (default)
  133. .TP
  134. --color \f[I][STREAM:]POLICY\f[R]
  135. Whether to emit color codes in output, optionally prefixed by the STREAM
  136. (stdout or stderr) to apply the setting to.
  137. Can be one of \[dq]always\[dq], \[dq]auto\[dq] (default),
  138. \[dq]never\[dq], or \[dq]no_color\[dq] (use non color terminal
  139. sequences).
  140. Use \[dq]auto-tty\[dq] or \[dq]no_color-tty\[dq] to decide based on
  141. terminal support only.
  142. Can be used multiple times
  143. .TP
  144. --compat-options \f[I]OPTS\f[R]
  145. Options that can help keep compatibility with youtube-dl or youtube-dlc
  146. configurations by reverting some of the changes made in yt-dlp.
  147. See \[dq]Differences in default behavior\[dq] for details
  148. .TP
  149. --alias \f[I]ALIASES OPTIONS\f[R]
  150. Create aliases for an option string.
  151. Unless an alias starts with a dash \[dq]-\[dq], it is prefixed with
  152. \[dq]--\[dq].
  153. Arguments are parsed according to the Python string formatting
  154. mini-language.
  155. E.g.
  156. --alias get-audio,-X \[dq]-S=aext:{0},abr -x --audio-format {0}\[dq]
  157. creates options \[dq]--get-audio\[dq] and \[dq]-X\[dq] that takes an
  158. argument (ARG0) and expands to \[dq]-S=aext:ARG0,abr -x --audio-format
  159. ARG0\[dq].
  160. All defined aliases are listed in the --help output.
  161. Alias options can trigger more aliases; so be careful to avoid defining
  162. recursive options.
  163. As a safety measure, each alias may be triggered a maximum of 100 times.
  164. This option can be used multiple times
  165. .SS Network Options:
  166. .TP
  167. --proxy \f[I]URL\f[R]
  168. Use the specified HTTP/HTTPS/SOCKS proxy.
  169. To enable SOCKS proxy, specify a proper scheme, e.g.
  170. socks5://user:pass\[at]127.0.0.1:1080/.
  171. Pass in an empty string (--proxy \[dq]\[dq]) for direct connection
  172. .TP
  173. --socket-timeout \f[I]SECONDS\f[R]
  174. Time to wait before giving up, in seconds
  175. .TP
  176. --source-address \f[I]IP\f[R]
  177. Client-side IP address to bind to
  178. .TP
  179. --impersonate \f[I]CLIENT[:OS]\f[R]
  180. Client to impersonate for requests.
  181. E.g.
  182. chrome, chrome-110, chrome:windows-10.
  183. Pass --impersonate=\[dq]\[dq] to impersonate any client.
  184. Note that forcing impersonation for all requests may have a detrimental
  185. impact on download speed and stability
  186. .TP
  187. --list-impersonate-targets
  188. List available clients to impersonate.
  189. .TP
  190. -4, --force-ipv4
  191. Make all connections via IPv4
  192. .TP
  193. -6, --force-ipv6
  194. Make all connections via IPv6
  195. .TP
  196. --enable-file-urls
  197. Enable file:// URLs.
  198. This is disabled by default for security reasons.
  199. .SS Geo-restriction:
  200. .TP
  201. --geo-verification-proxy \f[I]URL\f[R]
  202. Use this proxy to verify the IP address for some geo-restricted sites.
  203. The default proxy specified by --proxy (or none, if the option is not
  204. present) is used for the actual downloading
  205. .TP
  206. --xff \f[I]VALUE\f[R]
  207. How to fake X-Forwarded-For HTTP header to try bypassing geographic
  208. restriction.
  209. One of \[dq]default\[dq] (only when known to be useful),
  210. \[dq]never\[dq], an IP block in CIDR notation, or a two-letter ISO
  211. 3166-2 country code
  212. .SS Video Selection:
  213. .TP
  214. -I, --playlist-items \f[I]ITEM_SPEC\f[R]
  215. Comma separated playlist_index of the items to download.
  216. You can specify a range using \[dq][START]:[STOP][:STEP]\[dq].
  217. For backward compatibility, START-STOP is also supported.
  218. Use negative indices to count from the right and negative STEP to
  219. download in reverse order.
  220. E.g.
  221. \[dq]-I 1:3,7,-5::2\[dq] used on a playlist of size 15 will download the
  222. items at index 1,2,3,7,11,13,15
  223. .TP
  224. --min-filesize \f[I]SIZE\f[R]
  225. Abort download if filesize is smaller than SIZE, e.g.
  226. 50k or 44.6M
  227. .TP
  228. --max-filesize \f[I]SIZE\f[R]
  229. Abort download if filesize is larger than SIZE, e.g.
  230. 50k or 44.6M
  231. .TP
  232. --date \f[I]DATE\f[R]
  233. Download only videos uploaded on this date.
  234. The date can be \[dq]YYYYMMDD\[dq] or in the format
  235. [now|today|yesterday][-N[day|week|month|year]].
  236. E.g.
  237. \[dq]--date today-2weeks\[dq] downloads only videos uploaded on the same
  238. day two weeks ago
  239. .TP
  240. --datebefore \f[I]DATE\f[R]
  241. Download only videos uploaded on or before this date.
  242. The date formats accepted are the same as --date
  243. .TP
  244. --dateafter \f[I]DATE\f[R]
  245. Download only videos uploaded on or after this date.
  246. The date formats accepted are the same as --date
  247. .TP
  248. --match-filters \f[I]FILTER\f[R]
  249. Generic video filter.
  250. Any \[dq]OUTPUT TEMPLATE\[dq] field can be compared with a number or a
  251. string using the operators defined in \[dq]Filtering Formats\[dq].
  252. You can also simply specify a field to match if the field is present,
  253. use \[dq]!field\[dq] to check if the field is not present, and
  254. \[dq]&\[dq] to check multiple conditions.
  255. Use a \[dq]\[dq] to escape \[dq]&\[dq] or quotes if needed.
  256. If used multiple times, the filter matches if at least one of the
  257. conditions is met.
  258. E.g.
  259. --match-filters !is_live --match-filters \[dq]like_count>?100 &
  260. description\[ti]=\[aq](?i)& dogs\[dq] matches only videos that are not
  261. live OR those that have a like count more than 100 (or the like field is
  262. not available) and also has a description that contains the phrase
  263. \[dq]cats & dogs\[dq] (caseless).
  264. Use \[dq]--match-filters -\[dq] to interactively ask whether to download
  265. each video
  266. .TP
  267. --no-match-filters
  268. Do not use any --match-filters (default)
  269. .TP
  270. --break-match-filters \f[I]FILTER\f[R]
  271. Same as \[dq]--match-filters\[dq] but stops the download process when a
  272. video is rejected
  273. .TP
  274. --no-break-match-filters
  275. Do not use any --break-match-filters (default)
  276. .TP
  277. --no-playlist
  278. Download only the video, if the URL refers to a video and a playlist
  279. .TP
  280. --yes-playlist
  281. Download the playlist, if the URL refers to a video and a playlist
  282. .TP
  283. --age-limit \f[I]YEARS\f[R]
  284. Download only videos suitable for the given age
  285. .TP
  286. --download-archive \f[I]FILE\f[R]
  287. Download only videos not listed in the archive file.
  288. Record the IDs of all downloaded videos in it
  289. .TP
  290. --no-download-archive
  291. Do not use archive file (default)
  292. .TP
  293. --max-downloads \f[I]NUMBER\f[R]
  294. Abort after downloading NUMBER files
  295. .TP
  296. --break-on-existing
  297. Stop the download process when encountering a file that is in the
  298. archive supplied with the --download-archive option
  299. .TP
  300. --no-break-on-existing
  301. Do not stop the download process when encountering a file that is in the
  302. archive (default)
  303. .TP
  304. --break-per-input
  305. Alters --max-downloads, --break-on-existing, --break-match-filters, and
  306. autonumber to reset per input URL
  307. .TP
  308. --no-break-per-input
  309. --break-on-existing and similar options terminates the entire download
  310. queue
  311. .TP
  312. --skip-playlist-after-errors \f[I]N\f[R]
  313. Number of allowed failures until the rest of the playlist is skipped
  314. .SS Download Options:
  315. .TP
  316. -N, --concurrent-fragments \f[I]N\f[R]
  317. Number of fragments of a dash/hlsnative video that should be downloaded
  318. concurrently (default is 1)
  319. .TP
  320. -r, --limit-rate \f[I]RATE\f[R]
  321. Maximum download rate in bytes per second, e.g.
  322. 50K or 4.2M
  323. .TP
  324. --throttled-rate \f[I]RATE\f[R]
  325. Minimum download rate in bytes per second below which throttling is
  326. assumed and the video data is re-extracted, e.g.
  327. 100K
  328. .TP
  329. -R, --retries \f[I]RETRIES\f[R]
  330. Number of retries (default is 10), or \[dq]infinite\[dq]
  331. .TP
  332. --file-access-retries \f[I]RETRIES\f[R]
  333. Number of times to retry on file access error (default is 3), or
  334. \[dq]infinite\[dq]
  335. .TP
  336. --fragment-retries \f[I]RETRIES\f[R]
  337. Number of retries for a fragment (default is 10), or \[dq]infinite\[dq]
  338. (DASH, hlsnative and ISM)
  339. .TP
  340. --retry-sleep \f[I][TYPE:]EXPR\f[R]
  341. Time to sleep between retries in seconds (optionally) prefixed by the
  342. type of retry (http (default), fragment, file_access, extractor) to
  343. apply the sleep to.
  344. EXPR can be a number, linear=START[:END[:STEP=1]] or
  345. exp=START[:END[:BASE=2]].
  346. This option can be used multiple times to set the sleep for the
  347. different retry types, e.g.
  348. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20
  349. .TP
  350. --skip-unavailable-fragments
  351. Skip unavailable fragments for DASH, hlsnative and ISM downloads
  352. (default) (Alias: --no-abort-on-unavailable-fragments)
  353. .TP
  354. --abort-on-unavailable-fragments
  355. Abort download if a fragment is unavailable (Alias:
  356. --no-skip-unavailable-fragments)
  357. .TP
  358. --keep-fragments
  359. Keep downloaded fragments on disk after downloading is finished
  360. .TP
  361. --no-keep-fragments
  362. Delete downloaded fragments after downloading is finished (default)
  363. .TP
  364. --buffer-size \f[I]SIZE\f[R]
  365. Size of download buffer, e.g.
  366. 1024 or 16K (default is 1024)
  367. .TP
  368. --resize-buffer
  369. The buffer size is automatically resized from an initial value of
  370. --buffer-size (default)
  371. .TP
  372. --no-resize-buffer
  373. Do not automatically adjust the buffer size
  374. .TP
  375. --http-chunk-size \f[I]SIZE\f[R]
  376. Size of a chunk for chunk-based HTTP downloading, e.g.
  377. 10485760 or 10M (default is disabled).
  378. May be useful for bypassing bandwidth throttling imposed by a webserver
  379. (experimental)
  380. .TP
  381. --playlist-random
  382. Download playlist videos in random order
  383. .TP
  384. --lazy-playlist
  385. Process entries in the playlist as they are received.
  386. This disables n_entries, --playlist-random and --playlist-reverse
  387. .TP
  388. --no-lazy-playlist
  389. Process videos in the playlist only after the entire playlist is parsed
  390. (default)
  391. .TP
  392. --xattr-set-filesize
  393. Set file xattribute ytdl.filesize with expected file size
  394. .TP
  395. --hls-use-mpegts
  396. Use the mpegts container for HLS videos; allowing some players to play
  397. the video while downloading, and reducing the chance of file corruption
  398. if download is interrupted.
  399. This is enabled by default for live streams
  400. .TP
  401. --no-hls-use-mpegts
  402. Do not use the mpegts container for HLS videos.
  403. This is default when not downloading live streams
  404. .TP
  405. --download-sections \f[I]REGEX\f[R]
  406. Download only chapters that match the regular expression.
  407. A \[dq]*\[dq] prefix denotes time-range instead of chapter.
  408. Negative timestamps are calculated from the end.
  409. \[dq]*from-url\[dq] can be used to download between the
  410. \[dq]start_time\[dq] and \[dq]end_time\[dq] extracted from the URL.
  411. Needs ffmpeg.
  412. This option can be used multiple times to download multiple sections,
  413. e.g.
  414. --download-sections \[dq]*10:15-inf\[dq] --download-sections
  415. \[dq]intro\[dq]
  416. .TP
  417. --downloader \f[I][PROTO:]NAME\f[R]
  418. Name or path of the external downloader to use (optionally) prefixed by
  419. the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for.
  420. Currently supports native, aria2c, avconv, axel, curl, ffmpeg, httpie,
  421. wget.
  422. You can use this option multiple times to set different downloaders for
  423. different protocols.
  424. E.g.
  425. --downloader aria2c --downloader \[dq]dash,m3u8:native\[dq] will use
  426. aria2c for http/ftp downloads, and the native downloader for dash/m3u8
  427. downloads (Alias: --external-downloader)
  428. .TP
  429. --downloader-args \f[I]NAME:ARGS\f[R]
  430. Give these arguments to the external downloader.
  431. Specify the downloader name and the arguments separated by a colon
  432. \[dq]:\[dq].
  433. For ffmpeg, arguments can be passed to different positions using the
  434. same syntax as --postprocessor-args.
  435. You can use this option multiple times to give different arguments to
  436. different downloaders (Alias: --external-downloader-args)
  437. .SS Filesystem Options:
  438. .TP
  439. -a, --batch-file \f[I]FILE\f[R]
  440. File containing URLs to download (\[dq]-\[dq] for stdin), one URL per
  441. line.
  442. Lines starting with \[dq]#\[dq], \[dq];\[dq] or \[dq]]\[dq] are
  443. considered as comments and ignored
  444. .TP
  445. --no-batch-file
  446. Do not read URLs from batch file (default)
  447. .TP
  448. -P, --paths \f[I][TYPES:]PATH\f[R]
  449. The paths where the files should be downloaded.
  450. Specify the type of file and the path separated by a colon \[dq]:\[dq].
  451. All the same TYPES as --output are supported.
  452. Additionally, you can also provide \[dq]home\[dq] (default) and
  453. \[dq]temp\[dq] paths.
  454. All intermediary files are first downloaded to the temp path and then
  455. the final files are moved over to the home path after download is
  456. finished.
  457. This option is ignored if --output is an absolute path
  458. .TP
  459. -o, --output \f[I][TYPES:]TEMPLATE\f[R]
  460. Output filename template; see \[dq]OUTPUT TEMPLATE\[dq] for details
  461. .TP
  462. --output-na-placeholder \f[I]TEXT\f[R]
  463. Placeholder for unavailable fields in --output (default: \[dq]NA\[dq])
  464. .TP
  465. --restrict-filenames
  466. Restrict filenames to only ASCII characters, and avoid \[dq]&\[dq] and
  467. spaces in filenames
  468. .TP
  469. --no-restrict-filenames
  470. Allow Unicode characters, \[dq]&\[dq] and spaces in filenames (default)
  471. .TP
  472. --windows-filenames
  473. Force filenames to be Windows-compatible
  474. .TP
  475. --no-windows-filenames
  476. Sanitize filenames only minimally
  477. .TP
  478. --trim-filenames \f[I]LENGTH\f[R]
  479. Limit the filename length (excluding extension) to the specified number
  480. of characters
  481. .TP
  482. -w, --no-overwrites
  483. Do not overwrite any files
  484. .TP
  485. --force-overwrites
  486. Overwrite all video and metadata files.
  487. This option includes --no-continue
  488. .TP
  489. --no-force-overwrites
  490. Do not overwrite the video, but overwrite related files (default)
  491. .TP
  492. -c, --continue
  493. Resume partially downloaded files/fragments (default)
  494. .TP
  495. --no-continue
  496. Do not resume partially downloaded fragments.
  497. If the file is not fragmented, restart download of the entire file
  498. .TP
  499. --part
  500. Use .part files instead of writing directly into output file (default)
  501. .TP
  502. --no-part
  503. Do not use .part files - write directly into output file
  504. .TP
  505. --mtime
  506. Use the Last-modified header to set the file modification time (default)
  507. .TP
  508. --no-mtime
  509. Do not use the Last-modified header to set the file modification time
  510. .TP
  511. --write-description
  512. Write video description to a .description file
  513. .TP
  514. --no-write-description
  515. Do not write video description (default)
  516. .TP
  517. --write-info-json
  518. Write video metadata to a .info.json file (this may contain personal
  519. information)
  520. .TP
  521. --no-write-info-json
  522. Do not write video metadata (default)
  523. .TP
  524. --write-playlist-metafiles
  525. Write playlist metadata in addition to the video metadata when using
  526. --write-info-json, --write-description etc.
  527. (default)
  528. .TP
  529. --no-write-playlist-metafiles
  530. Do not write playlist metadata when using --write-info-json,
  531. --write-description etc.
  532. .TP
  533. --clean-info-json
  534. Remove some internal metadata such as filenames from the infojson
  535. (default)
  536. .TP
  537. --no-clean-info-json
  538. Write all fields to the infojson
  539. .TP
  540. --write-comments
  541. Retrieve video comments to be placed in the infojson.
  542. The comments are fetched even without this option if the extraction is
  543. known to be quick (Alias: --get-comments)
  544. .TP
  545. --no-write-comments
  546. Do not retrieve video comments unless the extraction is known to be
  547. quick (Alias: --no-get-comments)
  548. .TP
  549. --load-info-json \f[I]FILE\f[R]
  550. JSON file containing the video information (created with the
  551. \[dq]--write-info-json\[dq] option)
  552. .TP
  553. --cookies \f[I]FILE\f[R]
  554. Netscape formatted file to read cookies from and dump cookie jar in
  555. .TP
  556. --no-cookies
  557. Do not read/dump cookies from/to file (default)
  558. .TP
  559. --cookies-from-browser \f[I]BROWSER[+KEYRING][:PROFILE][::CONTAINER]\f[R]
  560. The name of the browser to load cookies from.
  561. Currently supported browsers are: brave, chrome, chromium, edge,
  562. firefox, opera, safari, vivaldi, whale.
  563. Optionally, the KEYRING used for decrypting Chromium cookies on Linux,
  564. the name/path of the PROFILE to load cookies from, and the CONTAINER
  565. name (if Firefox) (\[dq]none\[dq] for no container) can be given with
  566. their respective separators.
  567. By default, all containers of the most recently accessed profile are
  568. used.
  569. Currently supported keyrings are: basictext, gnomekeyring, kwallet,
  570. kwallet5, kwallet6
  571. .TP
  572. --no-cookies-from-browser
  573. Do not load cookies from browser (default)
  574. .TP
  575. --cache-dir \f[I]DIR\f[R]
  576. Location in the filesystem where yt-dlp can store some downloaded
  577. information (such as client ids and signatures) permanently.
  578. By default ${XDG_CACHE_HOME}/yt-dlp
  579. .TP
  580. --no-cache-dir
  581. Disable filesystem caching
  582. .TP
  583. --rm-cache-dir
  584. Delete all filesystem cache files
  585. .SS Thumbnail Options:
  586. .TP
  587. --write-thumbnail
  588. Write thumbnail image to disk
  589. .TP
  590. --no-write-thumbnail
  591. Do not write thumbnail image to disk (default)
  592. .TP
  593. --write-all-thumbnails
  594. Write all thumbnail image formats to disk
  595. .TP
  596. --list-thumbnails
  597. List available thumbnails of each video.
  598. Simulate unless --no-simulate is used
  599. .SS Internet Shortcut Options:
  600. .TP
  601. --write-link
  602. Write an internet shortcut file, depending on the current platform
  603. (.url, .webloc or .desktop).
  604. The URL may be cached by the OS
  605. .TP
  606. --write-url-link
  607. Write a .url Windows internet shortcut.
  608. The OS caches the URL based on the file path
  609. .TP
  610. --write-webloc-link
  611. Write a .webloc macOS internet shortcut
  612. .TP
  613. --write-desktop-link
  614. Write a .desktop Linux internet shortcut
  615. .SS Verbosity and Simulation Options:
  616. .TP
  617. -q, --quiet
  618. Activate quiet mode.
  619. If used with --verbose, print the log to stderr
  620. .TP
  621. --no-quiet
  622. Deactivate quiet mode.
  623. (Default)
  624. .TP
  625. --no-warnings
  626. Ignore warnings
  627. .TP
  628. -s, --simulate
  629. Do not download the video and do not write anything to disk
  630. .TP
  631. --no-simulate
  632. Download the video even if printing/listing options are used
  633. .TP
  634. --ignore-no-formats-error
  635. Ignore \[dq]No video formats\[dq] error.
  636. Useful for extracting metadata even if the videos are not actually
  637. available for download (experimental)
  638. .TP
  639. --no-ignore-no-formats-error
  640. Throw error when no downloadable video formats are found (default)
  641. .TP
  642. --skip-download
  643. Do not download the video but write all related files (Alias:
  644. --no-download)
  645. .TP
  646. -O, --print \f[I][WHEN:]TEMPLATE\f[R]
  647. Field name or output template to print to screen, optionally prefixed
  648. with when to print it, separated by a \[dq]:\[dq].
  649. Supported values of \[dq]WHEN\[dq] are the same as that of
  650. --use-postprocessor (default: video).
  651. Implies --quiet.
  652. Implies --simulate unless --no-simulate or later stages of WHEN are
  653. used.
  654. This option can be used multiple times
  655. .TP
  656. --print-to-file \f[I][WHEN:]TEMPLATE FILE\f[R]
  657. Append given template to the file.
  658. The values of WHEN and TEMPLATE are the same as that of --print.
  659. FILE uses the same syntax as the output template.
  660. This option can be used multiple times
  661. .TP
  662. -j, --dump-json
  663. Quiet, but print JSON information for each video.
  664. Simulate unless --no-simulate is used.
  665. See \[dq]OUTPUT TEMPLATE\[dq] for a description of available keys
  666. .TP
  667. -J, --dump-single-json
  668. Quiet, but print JSON information for each URL or infojson passed.
  669. Simulate unless --no-simulate is used.
  670. If the URL refers to a playlist, the whole playlist information is
  671. dumped in a single line
  672. .TP
  673. --force-write-archive
  674. Force download archive entries to be written as far as no errors occur,
  675. even if -s or another simulation option is used (Alias:
  676. --force-download-archive)
  677. .TP
  678. --newline
  679. Output progress bar as new lines
  680. .TP
  681. --no-progress
  682. Do not print progress bar
  683. .TP
  684. --progress
  685. Show progress bar, even if in quiet mode
  686. .TP
  687. --console-title
  688. Display progress in console titlebar
  689. .TP
  690. --progress-template \f[I][TYPES:]TEMPLATE\f[R]
  691. Template for progress outputs, optionally prefixed with one of
  692. \[dq]download:\[dq] (default), \[dq]download-title:\[dq] (the console
  693. title), \[dq]postprocess:\[dq], or \[dq]postprocess-title:\[dq].
  694. The video\[aq]s fields are accessible under the \[dq]info\[dq] key and
  695. the progress attributes are accessible under \[dq]progress\[dq] key.
  696. E.g.
  697. --console-title --progress-template
  698. \[dq]download-title:%(info.id)s-%(progress.eta)s\[dq]
  699. .TP
  700. --progress-delta \f[I]SECONDS\f[R]
  701. Time between progress output (default: 0)
  702. .TP
  703. -v, --verbose
  704. Print various debugging information
  705. .TP
  706. --dump-pages
  707. Print downloaded pages encoded using base64 to debug problems (very
  708. verbose)
  709. .TP
  710. --write-pages
  711. Write downloaded intermediary pages to files in the current directory to
  712. debug problems
  713. .TP
  714. --print-traffic
  715. Display sent and read HTTP traffic
  716. .SS Workarounds:
  717. .TP
  718. --encoding \f[I]ENCODING\f[R]
  719. Force the specified encoding (experimental)
  720. .TP
  721. --legacy-server-connect
  722. Explicitly allow HTTPS connection to servers that do not support RFC
  723. 5746 secure renegotiation
  724. .TP
  725. --no-check-certificates
  726. Suppress HTTPS certificate validation
  727. .TP
  728. --prefer-insecure
  729. Use an unencrypted connection to retrieve information about the video
  730. (Currently supported only for YouTube)
  731. .TP
  732. --add-headers \f[I]FIELD:VALUE\f[R]
  733. Specify a custom HTTP header and its value, separated by a colon
  734. \[dq]:\[dq].
  735. You can use this option multiple times
  736. .TP
  737. --bidi-workaround
  738. Work around terminals that lack bidirectional text support.
  739. Requires bidiv or fribidi executable in PATH
  740. .TP
  741. --sleep-requests \f[I]SECONDS\f[R]
  742. Number of seconds to sleep between requests during data extraction
  743. .TP
  744. --sleep-interval \f[I]SECONDS\f[R]
  745. Number of seconds to sleep before each download.
  746. This is the minimum time to sleep when used along with
  747. --max-sleep-interval (Alias: --min-sleep-interval)
  748. .TP
  749. --max-sleep-interval \f[I]SECONDS\f[R]
  750. Maximum number of seconds to sleep.
  751. Can only be used along with --min-sleep-interval
  752. .TP
  753. --sleep-subtitles \f[I]SECONDS\f[R]
  754. Number of seconds to sleep before each subtitle download
  755. .SS Video Format Options:
  756. .TP
  757. -f, --format \f[I]FORMAT\f[R]
  758. Video format code, see \[dq]FORMAT SELECTION\[dq] for more details
  759. .TP
  760. -S, --format-sort \f[I]SORTORDER\f[R]
  761. Sort the formats by the fields given, see \[dq]Sorting Formats\[dq] for
  762. more details
  763. .TP
  764. --format-sort-force
  765. Force user specified sort order to have precedence over all fields, see
  766. \[dq]Sorting Formats\[dq] for more details (Alias: --S-force)
  767. .TP
  768. --no-format-sort-force
  769. Some fields have precedence over the user specified sort order (default)
  770. .TP
  771. --video-multistreams
  772. Allow multiple video streams to be merged into a single file
  773. .TP
  774. --no-video-multistreams
  775. Only one video stream is downloaded for each output file (default)
  776. .TP
  777. --audio-multistreams
  778. Allow multiple audio streams to be merged into a single file
  779. .TP
  780. --no-audio-multistreams
  781. Only one audio stream is downloaded for each output file (default)
  782. .TP
  783. --prefer-free-formats
  784. Prefer video formats with free containers over non-free ones of the same
  785. quality.
  786. Use with \[dq]-S ext\[dq] to strictly prefer free containers
  787. irrespective of quality
  788. .TP
  789. --no-prefer-free-formats
  790. Don\[aq]t give any special preference to free containers (default)
  791. .TP
  792. --check-formats
  793. Make sure formats are selected only from those that are actually
  794. downloadable
  795. .TP
  796. --check-all-formats
  797. Check all formats for whether they are actually downloadable
  798. .TP
  799. --no-check-formats
  800. Do not check that the formats are actually downloadable
  801. .TP
  802. -F, --list-formats
  803. List available formats of each video.
  804. Simulate unless --no-simulate is used
  805. .TP
  806. --merge-output-format \f[I]FORMAT\f[R]
  807. Containers that may be used when merging formats, separated by
  808. \[dq]/\[dq], e.g.
  809. \[dq]mp4/mkv\[dq].
  810. Ignored if no merge is required.
  811. (currently supported: avi, flv, mkv, mov, mp4, webm)
  812. .SS Subtitle Options:
  813. .TP
  814. --write-subs
  815. Write subtitle file
  816. .TP
  817. --no-write-subs
  818. Do not write subtitle file (default)
  819. .TP
  820. --write-auto-subs
  821. Write automatically generated subtitle file (Alias:
  822. --write-automatic-subs)
  823. .TP
  824. --no-write-auto-subs
  825. Do not write auto-generated subtitles (default) (Alias:
  826. --no-write-automatic-subs)
  827. .TP
  828. --list-subs
  829. List available subtitles of each video.
  830. Simulate unless --no-simulate is used
  831. .TP
  832. --sub-format \f[I]FORMAT\f[R]
  833. Subtitle format; accepts formats preference separated by \[dq]/\[dq],
  834. e.g.
  835. \[dq]srt\[dq] or \[dq]ass/srt/best\[dq]
  836. .TP
  837. --sub-langs \f[I]LANGS\f[R]
  838. Languages of the subtitles to download (can be regex) or \[dq]all\[dq]
  839. separated by commas, e.g.
  840. --sub-langs \[dq]en.*,ja\[dq] (where \[dq]en.*\[dq] is a regex pattern
  841. that matches \[dq]en\[dq] followed by 0 or more of any character).
  842. You can prefix the language code with a \[dq]-\[dq] to exclude it from
  843. the requested languages, e.g.
  844. --sub- langs all,-live_chat.
  845. Use --list-subs for a list of available language tags
  846. .SS Authentication Options:
  847. .TP
  848. -u, --username \f[I]USERNAME\f[R]
  849. Login with this account ID
  850. .TP
  851. -p, --password \f[I]PASSWORD\f[R]
  852. Account password.
  853. If this option is left out, yt-dlp will ask interactively
  854. .TP
  855. -2, --twofactor \f[I]TWOFACTOR\f[R]
  856. Two-factor authentication code
  857. .TP
  858. -n, --netrc
  859. Use .netrc authentication data
  860. .TP
  861. --netrc-location \f[I]PATH\f[R]
  862. Location of .netrc authentication data; either the path or its
  863. containing directory.
  864. Defaults to \[ti]/.netrc
  865. .TP
  866. --netrc-cmd \f[I]NETRC_CMD\f[R]
  867. Command to execute to get the credentials for an extractor.
  868. .TP
  869. --video-password \f[I]PASSWORD\f[R]
  870. Video-specific password
  871. .TP
  872. --ap-mso \f[I]MSO\f[R]
  873. Adobe Pass multiple-system operator (TV provider) identifier, use
  874. --ap-list-mso for a list of available MSOs
  875. .TP
  876. --ap-username \f[I]USERNAME\f[R]
  877. Multiple-system operator account login
  878. .TP
  879. --ap-password \f[I]PASSWORD\f[R]
  880. Multiple-system operator account password.
  881. If this option is left out, yt-dlp will ask interactively
  882. .TP
  883. --ap-list-mso
  884. List all supported multiple-system operators
  885. .TP
  886. --client-certificate \f[I]CERTFILE\f[R]
  887. Path to client certificate file in PEM format.
  888. May include the private key
  889. .TP
  890. --client-certificate-key \f[I]KEYFILE\f[R]
  891. Path to private key file for client certificate
  892. .TP
  893. --client-certificate-password \f[I]PASSWORD\f[R]
  894. Password for client certificate private key, if encrypted.
  895. If not provided, and the key is encrypted, yt-dlp will ask interactively
  896. .SS Post-Processing Options:
  897. .TP
  898. -x, --extract-audio
  899. Convert video files to audio-only files (requires ffmpeg and ffprobe)
  900. .TP
  901. --audio-format \f[I]FORMAT\f[R]
  902. Format to convert the audio to when -x is used.
  903. (currently supported: best (default), aac, alac, flac, m4a, mp3, opus,
  904. vorbis, wav).
  905. You can specify multiple rules using similar syntax as --remux-video
  906. .TP
  907. --audio-quality \f[I]QUALITY\f[R]
  908. Specify ffmpeg audio quality to use when converting the audio with -x.
  909. Insert a value between 0 (best) and 10 (worst) for VBR or a specific
  910. bitrate like 128K (default 5)
  911. .TP
  912. --remux-video \f[I]FORMAT\f[R]
  913. Remux the video into another container if necessary (currently
  914. supported: avi, flv, gif, mkv, mov, mp4, webm, aac, aiff, alac, flac,
  915. m4a, mka, mp3, ogg, opus, vorbis, wav).
  916. If the target container does not support the video/audio codec, remuxing
  917. will fail.
  918. You can specify multiple rules; e.g.
  919. \[dq]aac>m4a/mov>mp4/mkv\[dq] will remux aac to m4a, mov to mp4 and
  920. anything else to mkv
  921. .TP
  922. --recode-video \f[I]FORMAT\f[R]
  923. Re-encode the video into another format if necessary.
  924. The syntax and supported formats are the same as --remux-video
  925. .TP
  926. --postprocessor-args \f[I]NAME:ARGS\f[R]
  927. Give these arguments to the postprocessors.
  928. Specify the postprocessor/executable name and the arguments separated by
  929. a colon \[dq]:\[dq] to give the argument to the specified
  930. postprocessor/executable.
  931. Supported PP are: Merger, ModifyChapters, SplitChapters, ExtractAudio,
  932. VideoRemuxer, VideoConvertor, Metadata, EmbedSubtitle, EmbedThumbnail,
  933. SubtitlesConvertor, ThumbnailsConvertor, FixupStretched, FixupM4a,
  934. FixupM3u8, FixupTimestamp and FixupDuration.
  935. The supported executables are: AtomicParsley, FFmpeg and FFprobe.
  936. You can also specify \[dq]PP+EXE:ARGS\[dq] to give the arguments to the
  937. specified executable only when being used by the specified
  938. postprocessor.
  939. Additionally, for ffmpeg/ffprobe, \[dq]_i\[dq]/\[dq]_o\[dq] can be
  940. appended to the prefix optionally followed by a number to pass the
  941. argument before the specified input/output file, e.g.
  942. --ppa \[dq]Merger+ffmpeg_i1:-v quiet\[dq].
  943. You can use this option multiple times to give different arguments to
  944. different postprocessors.
  945. (Alias: --ppa)
  946. .TP
  947. -k, --keep-video
  948. Keep the intermediate video file on disk after post-processing
  949. .TP
  950. --no-keep-video
  951. Delete the intermediate video file after post-processing (default)
  952. .TP
  953. --post-overwrites
  954. Overwrite post-processed files (default)
  955. .TP
  956. --no-post-overwrites
  957. Do not overwrite post-processed files
  958. .TP
  959. --embed-subs
  960. Embed subtitles in the video (only for mp4, webm and mkv videos)
  961. .TP
  962. --no-embed-subs
  963. Do not embed subtitles (default)
  964. .TP
  965. --embed-thumbnail
  966. Embed thumbnail in the video as cover art
  967. .TP
  968. --no-embed-thumbnail
  969. Do not embed thumbnail (default)
  970. .TP
  971. --embed-metadata
  972. Embed metadata to the video file.
  973. Also embeds chapters/infojson if present unless
  974. --no-embed-chapters/--no-embed-info-json are used (Alias:
  975. --add-metadata)
  976. .TP
  977. --no-embed-metadata
  978. Do not add metadata to file (default) (Alias: --no-add-metadata)
  979. .TP
  980. --embed-chapters
  981. Add chapter markers to the video file (Alias: --add-chapters)
  982. .TP
  983. --no-embed-chapters
  984. Do not add chapter markers (default) (Alias: --no-add-chapters)
  985. .TP
  986. --embed-info-json
  987. Embed the infojson as an attachment to mkv/mka video files
  988. .TP
  989. --no-embed-info-json
  990. Do not embed the infojson as an attachment to the video file
  991. .TP
  992. --parse-metadata \f[I][WHEN:]FROM:TO\f[R]
  993. Parse additional metadata like title/artist from other fields; see
  994. \[dq]MODIFYING METADATA\[dq] for details.
  995. Supported values of \[dq]WHEN\[dq] are the same as that of
  996. --use-postprocessor (default: pre_process)
  997. .TP
  998. --replace-in-metadata \f[I][WHEN:]FIELDS REGEX REPLACE\f[R]
  999. Replace text in a metadata field using the given regex.
  1000. This option can be used multiple times.
  1001. Supported values of \[dq]WHEN\[dq] are the same as that of
  1002. --use-postprocessor (default: pre_process)
  1003. .TP
  1004. --xattrs
  1005. Write metadata to the video file\[aq]s xattrs (using Dublin Core and XDG
  1006. standards)
  1007. .TP
  1008. --concat-playlist \f[I]POLICY\f[R]
  1009. Concatenate videos in a playlist.
  1010. One of \[dq]never\[dq], \[dq]always\[dq], or \[dq]multi_video\[dq]
  1011. (default; only when the videos form a single show).
  1012. All the video files must have the same codecs and number of streams to
  1013. be concatenable.
  1014. The \[dq]pl_video:\[dq] prefix can be used with \[dq]--paths\[dq] and
  1015. \[dq]--output\[dq] to set the output filename for the concatenated
  1016. files.
  1017. See \[dq]OUTPUT TEMPLATE\[dq] for details
  1018. .TP
  1019. --fixup \f[I]POLICY\f[R]
  1020. Automatically correct known faults of the file.
  1021. One of never (do nothing), warn (only emit a warning), detect_or_warn
  1022. (the default; fix the file if we can, warn otherwise), force (try fixing
  1023. even if the file already exists)
  1024. .TP
  1025. --ffmpeg-location \f[I]PATH\f[R]
  1026. Location of the ffmpeg binary; either the path to the binary or its
  1027. containing directory
  1028. .TP
  1029. --exec \f[I][WHEN:]CMD\f[R]
  1030. Execute a command, optionally prefixed with when to execute it,
  1031. separated by a \[dq]:\[dq].
  1032. Supported values of \[dq]WHEN\[dq] are the same as that of
  1033. --use-postprocessor (default: after_move).
  1034. The same syntax as the output template can be used to pass any field as
  1035. arguments to the command.
  1036. If no fields are passed, %(filepath,_filename|)q is appended to the end
  1037. of the command.
  1038. This option can be used multiple times
  1039. .TP
  1040. --no-exec
  1041. Remove any previously defined --exec
  1042. .TP
  1043. --convert-subs \f[I]FORMAT\f[R]
  1044. Convert the subtitles to another format (currently supported: ass, lrc,
  1045. srt, vtt).
  1046. Use \[dq]--convert-subs none\[dq] to disable conversion (default)
  1047. (Alias: --convert- subtitles)
  1048. .TP
  1049. --convert-thumbnails \f[I]FORMAT\f[R]
  1050. Convert the thumbnails to another format (currently supported: jpg, png,
  1051. webp).
  1052. You can specify multiple rules using similar syntax as
  1053. \[dq]--remux-video\[dq].
  1054. Use \[dq]--convert- thumbnails none\[dq] to disable conversion (default)
  1055. .TP
  1056. --split-chapters
  1057. Split video into multiple files based on internal chapters.
  1058. The \[dq]chapter:\[dq] prefix can be used with \[dq]--paths\[dq] and
  1059. \[dq]--output\[dq] to set the output filename for the split files.
  1060. See \[dq]OUTPUT TEMPLATE\[dq] for details
  1061. .TP
  1062. --no-split-chapters
  1063. Do not split video based on chapters (default)
  1064. .TP
  1065. --remove-chapters \f[I]REGEX\f[R]
  1066. Remove chapters whose title matches the given regular expression.
  1067. The syntax is the same as --download-sections.
  1068. This option can be used multiple times
  1069. .TP
  1070. --no-remove-chapters
  1071. Do not remove any chapters from the file (default)
  1072. .TP
  1073. --force-keyframes-at-cuts
  1074. Force keyframes at cuts when downloading/splitting/removing sections.
  1075. This is slow due to needing a re-encode, but the resulting video may
  1076. have fewer artifacts around the cuts
  1077. .TP
  1078. --no-force-keyframes-at-cuts
  1079. Do not force keyframes around the chapters when cutting/splitting
  1080. (default)
  1081. .TP
  1082. --use-postprocessor \f[I]NAME[:ARGS]\f[R]
  1083. The (case-sensitive) name of plugin postprocessors to be enabled, and
  1084. (optionally) arguments to be passed to it, separated by a colon
  1085. \[dq]:\[dq].
  1086. ARGS are a semicolon \[dq];\[dq] delimited list of NAME=VALUE.
  1087. The \[dq]when\[dq] argument determines when the postprocessor is
  1088. invoked.
  1089. It can be one of \[dq]pre_process\[dq] (after video extraction),
  1090. \[dq]after_filter\[dq] (after video passes filter), \[dq]video\[dq]
  1091. (after --format; before --print/--output), \[dq]before_dl\[dq] (before
  1092. each video download), \[dq]post_process\[dq] (after each video download;
  1093. default), \[dq]after_move\[dq] (after moving the video file to its final
  1094. location), \[dq]after_video\[dq] (after downloading and processing all
  1095. formats of a video), or \[dq]playlist\[dq] (at end of playlist).
  1096. This option can be used multiple times to add different postprocessors
  1097. .SS SponsorBlock Options:
  1098. .PP
  1099. Make chapter entries for, or remove various segments (sponsor,
  1100. introductions, etc.) from downloaded YouTube videos using the
  1101. SponsorBlock API (https://sponsor.ajay.app)
  1102. .TP
  1103. --sponsorblock-mark \f[I]CATS\f[R]
  1104. SponsorBlock categories to create chapters for, separated by commas.
  1105. Available categories are sponsor, intro, outro, selfpromo, preview,
  1106. filler, interaction, music_offtopic, poi_highlight, chapter, all and
  1107. default (=all).
  1108. You can prefix the category with a \[dq]-\[dq] to exclude it.
  1109. See [1] for descriptions of the categories.
  1110. E.g.
  1111. --sponsorblock-mark all,-preview [1]
  1112. https://wiki.sponsor.ajay.app/w/Segment_Categories
  1113. .TP
  1114. --sponsorblock-remove \f[I]CATS\f[R]
  1115. SponsorBlock categories to be removed from the video file, separated by
  1116. commas.
  1117. If a category is present in both mark and remove, remove takes
  1118. precedence.
  1119. The syntax and available categories are the same as for
  1120. --sponsorblock-mark except that \[dq]default\[dq] refers to
  1121. \[dq]all,-filler\[dq] and poi_highlight, chapter are not available
  1122. .TP
  1123. --sponsorblock-chapter-title \f[I]TEMPLATE\f[R]
  1124. An output template for the title of the SponsorBlock chapters created by
  1125. --sponsorblock-mark.
  1126. The only available fields are start_time, end_time, category,
  1127. categories, name, category_names.
  1128. Defaults to \[dq][SponsorBlock]: %(category_names)l\[dq]
  1129. .TP
  1130. --no-sponsorblock
  1131. Disable both --sponsorblock-mark and --sponsorblock-remove
  1132. .TP
  1133. --sponsorblock-api \f[I]URL\f[R]
  1134. SponsorBlock API location, defaults to https://sponsor.ajay.app
  1135. .SS Extractor Options:
  1136. .TP
  1137. --extractor-retries \f[I]RETRIES\f[R]
  1138. Number of retries for known extractor errors (default is 3), or
  1139. \[dq]infinite\[dq]
  1140. .TP
  1141. --allow-dynamic-mpd
  1142. Process dynamic DASH manifests (default) (Alias:
  1143. --no-ignore-dynamic-mpd)
  1144. .TP
  1145. --ignore-dynamic-mpd
  1146. Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)
  1147. .TP
  1148. --hls-split-discontinuity
  1149. Split HLS playlists to different formats at discontinuities such as ad
  1150. breaks
  1151. .TP
  1152. --no-hls-split-discontinuity
  1153. Do not split HLS playlists into different formats at discontinuities
  1154. such as ad breaks (default)
  1155. .TP
  1156. --extractor-args \f[I]IE_KEY:ARGS\f[R]
  1157. Pass ARGS arguments to the IE_KEY extractor.
  1158. See \[dq]EXTRACTOR ARGUMENTS\[dq] for details.
  1159. You can use this option multiple times to give arguments for different
  1160. extractors
  1161. .SH CONFIGURATION
  1162. .PP
  1163. You can configure yt-dlp by placing any supported command line option in
  1164. a configuration file.
  1165. The configuration is loaded from the following locations:
  1166. .IP "1." 3
  1167. \f[B]Main Configuration\f[R]:
  1168. .RS 4
  1169. .IP \[bu] 2
  1170. The file given to \f[C]--config-location\f[R]
  1171. .RE
  1172. .IP "2." 3
  1173. \f[B]Portable Configuration\f[R]: (Recommended for portable
  1174. installations)
  1175. .RS 4
  1176. .IP \[bu] 2
  1177. If using a binary, \f[C]yt-dlp.conf\f[R] in the same directory as the
  1178. binary
  1179. .IP \[bu] 2
  1180. If running from source-code, \f[C]yt-dlp.conf\f[R] in the parent
  1181. directory of \f[C]yt_dlp\f[R]
  1182. .RE
  1183. .IP "3." 3
  1184. \f[B]Home Configuration\f[R]:
  1185. .RS 4
  1186. .IP \[bu] 2
  1187. \f[C]yt-dlp.conf\f[R] in the home path given to \f[C]-P\f[R]
  1188. .IP \[bu] 2
  1189. If \f[C]-P\f[R] is not given, the current directory is searched
  1190. .RE
  1191. .IP "4." 3
  1192. \f[B]User Configuration\f[R]:
  1193. .RS 4
  1194. .IP \[bu] 2
  1195. \f[C]${XDG_CONFIG_HOME}/yt-dlp.conf\f[R]
  1196. .IP \[bu] 2
  1197. \f[C]${XDG_CONFIG_HOME}/yt-dlp/config\f[R] (recommended on Linux/macOS)
  1198. .IP \[bu] 2
  1199. \f[C]${XDG_CONFIG_HOME}/yt-dlp/config.txt\f[R]
  1200. .IP \[bu] 2
  1201. \f[C]${APPDATA}/yt-dlp.conf\f[R]
  1202. .IP \[bu] 2
  1203. \f[C]${APPDATA}/yt-dlp/config\f[R] (recommended on Windows)
  1204. .IP \[bu] 2
  1205. \f[C]${APPDATA}/yt-dlp/config.txt\f[R]
  1206. .IP \[bu] 2
  1207. \f[C]\[ti]/yt-dlp.conf\f[R]
  1208. .IP \[bu] 2
  1209. \f[C]\[ti]/yt-dlp.conf.txt\f[R]
  1210. .IP \[bu] 2
  1211. \f[C]\[ti]/.yt-dlp/config\f[R]
  1212. .IP \[bu] 2
  1213. \f[C]\[ti]/.yt-dlp/config.txt\f[R]
  1214. See also: Notes about environment variables
  1215. .RE
  1216. .IP "5." 3
  1217. \f[B]System Configuration\f[R]:
  1218. .RS 4
  1219. .IP \[bu] 2
  1220. \f[C]/etc/yt-dlp.conf\f[R]
  1221. .IP \[bu] 2
  1222. \f[C]/etc/yt-dlp/config\f[R]
  1223. .IP \[bu] 2
  1224. \f[C]/etc/yt-dlp/config.txt\f[R]
  1225. .RE
  1226. .PP
  1227. E.g.
  1228. with the following configuration file, yt-dlp will always extract the
  1229. audio, not copy the mtime, use a proxy and save all videos under
  1230. \f[C]YouTube\f[R] directory in your home directory:
  1231. .IP
  1232. .nf
  1233. \f[C]
  1234. # Lines starting with # are comments
  1236. # Always extract audio
  1237. -x
  1239. # Do not copy the mtime
  1240. --no-mtime
  1242. # Use this proxy
  1243. --proxy 127.0.0.1:3128
  1245. # Save all videos under YouTube directory in your home directory
  1246. -o \[ti]/YouTube/%(title)s.%(ext)s
  1247. \f[R]
  1248. .fi
  1249. .PP
  1250. \f[B]Note\f[R]: Options in a configuration file are just the same
  1251. options aka switches used in regular command line calls; thus there
  1252. \f[B]must be no whitespace\f[R] after \f[C]-\f[R] or \f[C]--\f[R], e.g.
  1253. \f[C]-o\f[R] or \f[C]--proxy\f[R] but not \f[C]- o\f[R] or
  1254. \f[C]-- proxy\f[R].
  1255. They must also be quoted when necessary, as if it were a UNIX shell.
  1256. .PP
  1257. You can use \f[C]--ignore-config\f[R] if you want to disable all
  1258. configuration files for a particular yt-dlp run.
  1259. If \f[C]--ignore-config\f[R] is found inside any configuration file, no
  1260. further configuration will be loaded.
  1261. For example, having the option in the portable configuration file
  1262. prevents loading of home, user, and system configurations.
  1263. Additionally, (for backward compatibility) if \f[C]--ignore-config\f[R]
  1264. is found inside the system configuration file, the user configuration is
  1265. not loaded.
  1266. .SS Configuration file encoding
  1267. .PP
  1268. The configuration files are decoded according to the UTF BOM if present,
  1269. and in the encoding from system locale otherwise.
  1270. .PP
  1271. If you want your file to be decoded differently, add
  1272. \f[C]# coding: ENCODING\f[R] to the beginning of the file (e.g.
  1273. \f[C]# coding: shift-jis\f[R]).
  1274. There must be no characters before that, even spaces or BOM.
  1275. .SS Authentication with netrc
  1276. .PP
  1277. You may also want to configure automatic credentials storage for
  1278. extractors that support authentication (by providing login and password
  1279. with \f[C]--username\f[R] and \f[C]--password\f[R]) in order not to pass
  1280. credentials as command line arguments on every yt-dlp execution and
  1281. prevent tracking plain text passwords in the shell command history.
  1282. You can achieve this using a \f[C].netrc\f[R]
  1283. file (https://stackoverflow.com/tags/.netrc/info) on a per-extractor
  1284. basis.
  1285. For that, you will need to create a \f[C].netrc\f[R] file in
  1286. \f[C]--netrc-location\f[R] and restrict permissions to read/write by
  1287. only you:
  1288. .IP
  1289. .nf
  1290. \f[C]
  1291. touch ${HOME}/.netrc
  1292. chmod a-rwx,u+rw ${HOME}/.netrc
  1293. \f[R]
  1294. .fi
  1295. .PP
  1296. After that, you can add credentials for an extractor in the following
  1297. format, where \f[I]extractor\f[R] is the name of the extractor in
  1298. lowercase:
  1299. .IP
  1300. .nf
  1301. \f[C]
  1302. machine <extractor> login <username> password <password>
  1303. \f[R]
  1304. .fi
  1305. .PP
  1306. E.g.
  1307. .IP
  1308. .nf
  1309. \f[C]
  1310. machine youtube login myaccount\[at]gmail.com password my_youtube_password
  1311. machine twitch login my_twitch_account_name password my_twitch_password
  1312. \f[R]
  1313. .fi
  1314. .PP
  1315. To activate authentication with the \f[C].netrc\f[R] file you should
  1316. pass \f[C]--netrc\f[R] to yt-dlp or place it in the configuration file.
  1317. .PP
  1318. The default location of the .netrc file is \f[C]\[ti]\f[R] (see below).
  1319. .PP
  1320. As an alternative to using the \f[C].netrc\f[R] file, which has the
  1321. disadvantage of keeping your passwords in a plain text file, you can
  1322. configure a custom shell command to provide the credentials for an
  1323. extractor.
  1324. This is done by providing the \f[C]--netrc-cmd\f[R] parameter, it shall
  1325. output the credentials in the netrc format and return \f[C]0\f[R] on
  1326. success, other values will be treated as an error.
  1327. \f[C]{}\f[R] in the command will be replaced by the name of the
  1328. extractor to make it possible to select the credentials for the right
  1329. extractor.
  1330. .PP
  1331. E.g.
  1332. To use an encrypted \f[C].netrc\f[R] file stored as
  1333. \f[C].authinfo.gpg\f[R]
  1334. .IP
  1335. .nf
  1336. \f[C]
  1337. yt-dlp --netrc-cmd \[aq]gpg --decrypt \[ti]/.authinfo.gpg\[aq] \[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]
  1338. \f[R]
  1339. .fi
  1340. .SS Notes about environment variables
  1341. .IP \[bu] 2
  1342. Environment variables are normally specified as
  1343. \f[C]${VARIABLE}\f[R]/\f[C]$VARIABLE\f[R] on UNIX and
  1344. \f[C]%VARIABLE%\f[R] on Windows; but is always shown as
  1345. \f[C]${VARIABLE}\f[R] in this documentation
  1346. .IP \[bu] 2
  1347. yt-dlp also allows using UNIX-style variables on Windows for path-like
  1348. options; e.g.
  1349. \f[C]--output\f[R], \f[C]--config-location\f[R]
  1350. .IP \[bu] 2
  1351. If unset, \f[C]${XDG_CONFIG_HOME}\f[R] defaults to
  1352. \f[C]\[ti]/.config\f[R] and \f[C]${XDG_CACHE_HOME}\f[R] to
  1353. \f[C]\[ti]/.cache\f[R]
  1354. .IP \[bu] 2
  1355. On Windows, \f[C]\[ti]\f[R] points to \f[C]${HOME}\f[R] if present; or,
  1356. \f[C]${USERPROFILE}\f[R] or \f[C]${HOMEDRIVE}${HOMEPATH}\f[R] otherwise
  1357. .IP \[bu] 2
  1358. On Windows, \f[C]${USERPROFILE}\f[R] generally points to
  1359. \f[C]C:\[rs]Users\[rs]<user name>\f[R] and \f[C]${APPDATA}\f[R] to
  1360. \f[C]${USERPROFILE}\[rs]AppData\[rs]Roaming\f[R]
  1361. .SH OUTPUT TEMPLATE
  1362. .PP
  1363. The \f[C]-o\f[R] option is used to indicate a template for the output
  1364. file names while \f[C]-P\f[R] option is used to specify the path each
  1365. type of file should be saved to.
  1366. .PP
  1367. The simplest usage of \f[C]-o\f[R] is not to set any template arguments
  1368. when downloading a single file, like in
  1369. \f[C]yt-dlp -o funny_video.flv \[dq]https://some/video\[dq]\f[R]
  1370. (hard-coding file extension like this is \f[I]not\f[R] recommended and
  1371. could break some post-processing).
  1372. .PP
  1373. It may however also contain special sequences that will be replaced when
  1374. downloading each video.
  1375. The special sequences may be formatted according to Python string
  1376. formatting
  1377. operations (https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting),
  1378. e.g.
  1379. \f[C]%(NAME)s\f[R] or \f[C]%(NAME)05d\f[R].
  1380. To clarify, that is a percent symbol followed by a name in parentheses,
  1381. followed by formatting operations.
  1382. .PP
  1383. The field names themselves (the part inside the parenthesis) can also
  1384. have some special formatting:
  1385. .IP "1." 3
  1386. \f[B]Object traversal\f[R]: The dictionaries and lists available in
  1387. metadata can be traversed by using a dot \f[C].\f[R] separator; e.g.
  1388. \f[C]%(tags.0)s\f[R], \f[C]%(subtitles.en.-1.ext)s\f[R].
  1389. You can do Python slicing with colon \f[C]:\f[R]; E.g.
  1390. \f[C]%(id.3:7)s\f[R], \f[C]%(id.6:2:-1)s\f[R],
  1391. \f[C]%(formats.:.format_id)s\f[R].
  1392. Curly braces \f[C]{}\f[R] can be used to build dictionaries with only
  1393. specific keys; e.g.
  1394. \f[C]%(formats.:.{format_id,height})#j\f[R].
  1395. An empty field name \f[C]%()s\f[R] refers to the entire infodict; e.g.
  1396. \f[C]%(.{id,title})s\f[R].
  1397. Note that all the fields that become available using this method are not
  1398. listed below.
  1399. Use \f[C]-j\f[R] to see such fields
  1400. .IP "2." 3
  1401. \f[B]Arithmetic\f[R]: Simple arithmetic can be done on numeric fields
  1402. using \f[C]+\f[R], \f[C]-\f[R] and \f[C]*\f[R].
  1403. E.g.
  1404. \f[C]%(playlist_index+10)03d\f[R],
  1405. \f[C]%(n_entries+1-playlist_index)d\f[R]
  1406. .IP "3." 3
  1407. \f[B]Date/time Formatting\f[R]: Date/time fields can be formatted
  1408. according to strftime
  1409. formatting (https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes)
  1410. by specifying it separated from the field name using a \f[C]>\f[R].
  1411. E.g.
  1412. \f[C]%(duration>%H-%M-%S)s\f[R], \f[C]%(upload_date>%Y-%m-%d)s\f[R],
  1413. \f[C]%(epoch-3600>%H-%M-%S)s\f[R]
  1414. .IP "4." 3
  1415. \f[B]Alternatives\f[R]: Alternate fields can be specified separated with
  1416. a \f[C],\f[R].
  1417. E.g.
  1418. \f[C]%(release_date>%Y,upload_date>%Y|Unknown)s\f[R]
  1419. .IP "5." 3
  1420. \f[B]Replacement\f[R]: A replacement value can be specified using a
  1421. \f[C]&\f[R] separator according to the \f[C]str.format\f[R]
  1422. mini-language (https://docs.python.org/3/library/string.html#format-specification-mini-language).
  1423. If the field is \f[I]not\f[R] empty, this replacement value will be used
  1424. instead of the actual field content.
  1425. This is done after alternate fields are considered; thus the replacement
  1426. is used if \f[I]any\f[R] of the alternative fields is \f[I]not\f[R]
  1427. empty.
  1428. E.g.
  1429. \f[C]%(chapters&has chapters|no chapters)s\f[R],
  1430. \f[C]%(title&TITLE={:>20}|NO TITLE)s\f[R]
  1431. .IP "6." 3
  1432. \f[B]Default\f[R]: A literal default value can be specified for when the
  1433. field is empty using a \f[C]|\f[R] separator.
  1434. This overrides \f[C]--output-na-placeholder\f[R].
  1435. E.g.
  1436. \f[C]%(uploader|Unknown)s\f[R]
  1437. .IP "7." 3
  1438. \f[B]More Conversions\f[R]: In addition to the normal format types
  1439. \f[C]diouxXeEfFgGcrs\f[R], yt-dlp additionally supports converting to
  1440. \f[C]B\f[R] = \f[B]B\f[R]ytes, \f[C]j\f[R] = \f[B]j\f[R]son (flag
  1441. \f[C]#\f[R] for pretty-printing, \f[C]+\f[R] for Unicode), \f[C]h\f[R] =
  1442. HTML escaping, \f[C]l\f[R] = a comma separated \f[B]l\f[R]ist (flag
  1443. \f[C]#\f[R] for \f[C]\[rs]n\f[R] newline-separated), \f[C]q\f[R] = a
  1444. string \f[B]q\f[R]uoted for the terminal (flag \f[C]#\f[R] to split a
  1445. list into different arguments), \f[C]D\f[R] = add \f[B]D\f[R]ecimal
  1446. suffixes (e.g.
  1447. 10M) (flag \f[C]#\f[R] to use 1024 as factor), and \f[C]S\f[R] =
  1448. \f[B]S\f[R]anitize as filename (flag \f[C]#\f[R] for restricted)
  1449. .IP "8." 3
  1450. \f[B]Unicode normalization\f[R]: The format type \f[C]U\f[R] can be used
  1451. for NFC Unicode
  1452. normalization (https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize).
  1453. The alternate form flag (\f[C]#\f[R]) changes the normalization to NFD
  1454. and the conversion flag \f[C]+\f[R] can be used for NFKC/NFKD
  1455. compatibility equivalence normalization.
  1456. E.g.
  1457. \f[C]%(title)+.100U\f[R] is NFKC
  1458. .PP
  1459. To summarize, the general syntax for a field is:
  1460. .IP
  1461. .nf
  1462. \f[C]
  1463. %(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type
  1464. \f[R]
  1465. .fi
  1466. .PP
  1467. Additionally, you can set different output templates for the various
  1468. metadata files separately from the general output template by specifying
  1469. the type of file followed by the template separated by a colon
  1470. \f[C]:\f[R].
  1471. The different file types supported are \f[C]subtitle\f[R],
  1472. \f[C]thumbnail\f[R], \f[C]description\f[R], \f[C]annotation\f[R]
  1473. (deprecated), \f[C]infojson\f[R], \f[C]link\f[R],
  1474. \f[C]pl_thumbnail\f[R], \f[C]pl_description\f[R], \f[C]pl_infojson\f[R],
  1475. \f[C]chapter\f[R], \f[C]pl_video\f[R].
  1476. E.g.
  1477. \f[C]-o \[dq]%(title)s.%(ext)s\[dq] -o \[dq]thumbnail:%(title)s\[rs]%(title)s.%(ext)s\[dq]\f[R]
  1478. will put the thumbnails in a folder with the same name as the video.
  1479. If any of the templates is empty, that type of file will not be written.
  1480. E.g.
  1481. \f[C]--write-thumbnail -o \[dq]thumbnail:\[dq]\f[R] will write
  1482. thumbnails only for playlists and not for video.
  1483. .PP
  1484. .PP
  1485. \f[B]Note\f[R]: Due to post-processing (i.e.
  1486. merging etc.), the actual output filename might differ.
  1487. Use \f[C]--print after_move:filepath\f[R] to get the name after all
  1488. post-processing is complete.
  1489. .PP
  1490. The available fields are:
  1491. .IP \[bu] 2
  1492. \f[C]id\f[R] (string): Video identifier
  1493. .IP \[bu] 2
  1494. \f[C]title\f[R] (string): Video title
  1495. .IP \[bu] 2
  1496. \f[C]fulltitle\f[R] (string): Video title ignoring live timestamp and
  1497. generic title
  1498. .IP \[bu] 2
  1499. \f[C]ext\f[R] (string): Video filename extension
  1500. .IP \[bu] 2
  1501. \f[C]alt_title\f[R] (string): A secondary title of the video
  1502. .IP \[bu] 2
  1503. \f[C]description\f[R] (string): The description of the video
  1504. .IP \[bu] 2
  1505. \f[C]display_id\f[R] (string): An alternative identifier for the video
  1506. .IP \[bu] 2
  1507. \f[C]uploader\f[R] (string): Full name of the video uploader
  1508. .IP \[bu] 2
  1509. \f[C]uploader_id\f[R] (string): Nickname or id of the video uploader
  1510. .IP \[bu] 2
  1511. \f[C]uploader_url\f[R] (string): URL to the video uploader\[aq]s profile
  1512. .IP \[bu] 2
  1513. \f[C]license\f[R] (string): License name the video is licensed under
  1514. .IP \[bu] 2
  1515. \f[C]creators\f[R] (list): The creators of the video
  1516. .IP \[bu] 2
  1517. \f[C]creator\f[R] (string): The creators of the video; comma-separated
  1518. .IP \[bu] 2
  1519. \f[C]timestamp\f[R] (numeric): UNIX timestamp of the moment the video
  1520. became available
  1521. .IP \[bu] 2
  1522. \f[C]upload_date\f[R] (string): Video upload date in UTC (YYYYMMDD)
  1523. .IP \[bu] 2
  1524. \f[C]release_timestamp\f[R] (numeric): UNIX timestamp of the moment the
  1525. video was released
  1526. .IP \[bu] 2
  1527. \f[C]release_date\f[R] (string): The date (YYYYMMDD) when the video was
  1528. released in UTC
  1529. .IP \[bu] 2
  1530. \f[C]release_year\f[R] (numeric): Year (YYYY) when the video or album
  1531. was released
  1532. .IP \[bu] 2
  1533. \f[C]modified_timestamp\f[R] (numeric): UNIX timestamp of the moment the
  1534. video was last modified
  1535. .IP \[bu] 2
  1536. \f[C]modified_date\f[R] (string): The date (YYYYMMDD) when the video was
  1537. last modified in UTC
  1538. .IP \[bu] 2
  1539. \f[C]channel\f[R] (string): Full name of the channel the video is
  1540. uploaded on
  1541. .IP \[bu] 2
  1542. \f[C]channel_id\f[R] (string): Id of the channel
  1543. .IP \[bu] 2
  1544. \f[C]channel_url\f[R] (string): URL of the channel
  1545. .IP \[bu] 2
  1546. \f[C]channel_follower_count\f[R] (numeric): Number of followers of the
  1547. channel
  1548. .IP \[bu] 2
  1549. \f[C]channel_is_verified\f[R] (boolean): Whether the channel is verified
  1550. on the platform
  1551. .IP \[bu] 2
  1552. \f[C]location\f[R] (string): Physical location where the video was
  1553. filmed
  1554. .IP \[bu] 2
  1555. \f[C]duration\f[R] (numeric): Length of the video in seconds
  1556. .IP \[bu] 2
  1557. \f[C]duration_string\f[R] (string): Length of the video (HH:mm:ss)
  1558. .IP \[bu] 2
  1559. \f[C]view_count\f[R] (numeric): How many users have watched the video on
  1560. the platform
  1561. .IP \[bu] 2
  1562. \f[C]concurrent_view_count\f[R] (numeric): How many users are currently
  1563. watching the video on the platform.
  1564. .IP \[bu] 2
  1565. \f[C]like_count\f[R] (numeric): Number of positive ratings of the video
  1566. .IP \[bu] 2
  1567. \f[C]dislike_count\f[R] (numeric): Number of negative ratings of the
  1568. video
  1569. .IP \[bu] 2
  1570. \f[C]repost_count\f[R] (numeric): Number of reposts of the video
  1571. .IP \[bu] 2
  1572. \f[C]average_rating\f[R] (numeric): Average rating given by users, the
  1573. scale used depends on the webpage
  1574. .IP \[bu] 2
  1575. \f[C]comment_count\f[R] (numeric): Number of comments on the video (For
  1576. some extractors, comments are only downloaded at the end, and so this
  1577. field cannot be used)
  1578. .IP \[bu] 2
  1579. \f[C]age_limit\f[R] (numeric): Age restriction for the video (years)
  1580. .IP \[bu] 2
  1581. \f[C]live_status\f[R] (string): One of \[dq]not_live\[dq],
  1582. \[dq]is_live\[dq], \[dq]is_upcoming\[dq], \[dq]was_live\[dq],
  1583. \[dq]post_live\[dq] (was live, but VOD is not yet processed)
  1584. .IP \[bu] 2
  1585. \f[C]is_live\f[R] (boolean): Whether this video is a live stream or a
  1586. fixed-length video
  1587. .IP \[bu] 2
  1588. \f[C]was_live\f[R] (boolean): Whether this video was originally a live
  1589. stream
  1590. .IP \[bu] 2
  1591. \f[C]playable_in_embed\f[R] (string): Whether this video is allowed to
  1592. play in embedded players on other sites
  1593. .IP \[bu] 2
  1594. \f[C]availability\f[R] (string): Whether the video is \[dq]private\[dq],
  1595. \[dq]premium_only\[dq], \[dq]subscriber_only\[dq], \[dq]needs_auth\[dq],
  1596. \[dq]unlisted\[dq] or \[dq]public\[dq]
  1597. .IP \[bu] 2
  1598. \f[C]media_type\f[R] (string): The type of media as classified by the
  1599. site, e.g.
  1600. \[dq]episode\[dq], \[dq]clip\[dq], \[dq]trailer\[dq]
  1601. .IP \[bu] 2
  1602. \f[C]start_time\f[R] (numeric): Time in seconds where the reproduction
  1603. should start, as specified in the URL
  1604. .IP \[bu] 2
  1605. \f[C]end_time\f[R] (numeric): Time in seconds where the reproduction
  1606. should end, as specified in the URL
  1607. .IP \[bu] 2
  1608. \f[C]extractor\f[R] (string): Name of the extractor
  1609. .IP \[bu] 2
  1610. \f[C]extractor_key\f[R] (string): Key name of the extractor
  1611. .IP \[bu] 2
  1612. \f[C]epoch\f[R] (numeric): Unix epoch of when the information extraction
  1613. was completed
  1614. .IP \[bu] 2
  1615. \f[C]autonumber\f[R] (numeric): Number that will be increased with each
  1616. download, starting at \f[C]--autonumber-start\f[R], padded with leading
  1617. zeros to 5 digits
  1618. .IP \[bu] 2
  1619. \f[C]video_autonumber\f[R] (numeric): Number that will be increased with
  1620. each video
  1621. .IP \[bu] 2
  1622. \f[C]n_entries\f[R] (numeric): Total number of extracted items in the
  1623. playlist
  1624. .IP \[bu] 2
  1625. \f[C]playlist_id\f[R] (string): Identifier of the playlist that contains
  1626. the video
  1627. .IP \[bu] 2
  1628. \f[C]playlist_title\f[R] (string): Name of the playlist that contains
  1629. the video
  1630. .IP \[bu] 2
  1631. \f[C]playlist\f[R] (string): \f[C]playlist_title\f[R] if available or
  1632. else \f[C]playlist_id\f[R]
  1633. .IP \[bu] 2
  1634. \f[C]playlist_count\f[R] (numeric): Total number of items in the
  1635. playlist.
  1636. May not be known if entire playlist is not extracted
  1637. .IP \[bu] 2
  1638. \f[C]playlist_index\f[R] (numeric): Index of the video in the playlist
  1639. padded with leading zeros according the final index
  1640. .IP \[bu] 2
  1641. \f[C]playlist_autonumber\f[R] (numeric): Position of the video in the
  1642. playlist download queue padded with leading zeros according to the total
  1643. length of the playlist
  1644. .IP \[bu] 2
  1645. \f[C]playlist_uploader\f[R] (string): Full name of the playlist uploader
  1646. .IP \[bu] 2
  1647. \f[C]playlist_uploader_id\f[R] (string): Nickname or id of the playlist
  1648. uploader
  1649. .IP \[bu] 2
  1650. \f[C]playlist_channel\f[R] (string): Display name of the channel that
  1651. uploaded the playlist
  1652. .IP \[bu] 2
  1653. \f[C]playlist_channel_id\f[R] (string): Identifier of the channel that
  1654. uploaded the playlist
  1655. .IP \[bu] 2
  1656. \f[C]playlist_webpage_url\f[R] (string): URL of the playlist webpage
  1657. .IP \[bu] 2
  1658. \f[C]webpage_url\f[R] (string): A URL to the video webpage which, if
  1659. given to yt-dlp, should yield the same result again
  1660. .IP \[bu] 2
  1661. \f[C]webpage_url_basename\f[R] (string): The basename of the webpage URL
  1662. .IP \[bu] 2
  1663. \f[C]webpage_url_domain\f[R] (string): The domain of the webpage URL
  1664. .IP \[bu] 2
  1665. \f[C]original_url\f[R] (string): The URL given by the user (or the same
  1666. as \f[C]webpage_url\f[R] for playlist entries)
  1667. .IP \[bu] 2
  1668. \f[C]categories\f[R] (list): List of categories the video belongs to
  1669. .IP \[bu] 2
  1670. \f[C]tags\f[R] (list): List of tags assigned to the video
  1671. .IP \[bu] 2
  1672. \f[C]cast\f[R] (list): List of cast members
  1673. .PP
  1674. All the fields in Filtering Formats can also be used
  1675. .PP
  1676. Available for the video that belongs to some logical chapter or section:
  1677. .IP \[bu] 2
  1678. \f[C]chapter\f[R] (string): Name or title of the chapter the video
  1679. belongs to
  1680. .IP \[bu] 2
  1681. \f[C]chapter_number\f[R] (numeric): Number of the chapter the video
  1682. belongs to
  1683. .IP \[bu] 2
  1684. \f[C]chapter_id\f[R] (string): Id of the chapter the video belongs to
  1685. .PP
  1686. Available for the video that is an episode of some series or program:
  1687. .IP \[bu] 2
  1688. \f[C]series\f[R] (string): Title of the series or program the video
  1689. episode belongs to
  1690. .IP \[bu] 2
  1691. \f[C]series_id\f[R] (string): Id of the series or program the video
  1692. episode belongs to
  1693. .IP \[bu] 2
  1694. \f[C]season\f[R] (string): Title of the season the video episode belongs
  1695. to
  1696. .IP \[bu] 2
  1697. \f[C]season_number\f[R] (numeric): Number of the season the video
  1698. episode belongs to
  1699. .IP \[bu] 2
  1700. \f[C]season_id\f[R] (string): Id of the season the video episode belongs
  1701. to
  1702. .IP \[bu] 2
  1703. \f[C]episode\f[R] (string): Title of the video episode
  1704. .IP \[bu] 2
  1705. \f[C]episode_number\f[R] (numeric): Number of the video episode within a
  1706. season
  1707. .IP \[bu] 2
  1708. \f[C]episode_id\f[R] (string): Id of the video episode
  1709. .PP
  1710. Available for the media that is a track or a part of a music album:
  1711. .IP \[bu] 2
  1712. \f[C]track\f[R] (string): Title of the track
  1713. .IP \[bu] 2
  1714. \f[C]track_number\f[R] (numeric): Number of the track within an album or
  1715. a disc
  1716. .IP \[bu] 2
  1717. \f[C]track_id\f[R] (string): Id of the track
  1718. .IP \[bu] 2
  1719. \f[C]artists\f[R] (list): Artist(s) of the track
  1720. .IP \[bu] 2
  1721. \f[C]artist\f[R] (string): Artist(s) of the track; comma-separated
  1722. .IP \[bu] 2
  1723. \f[C]genres\f[R] (list): Genre(s) of the track
  1724. .IP \[bu] 2
  1725. \f[C]genre\f[R] (string): Genre(s) of the track; comma-separated
  1726. .IP \[bu] 2
  1727. \f[C]composers\f[R] (list): Composer(s) of the piece
  1728. .IP \[bu] 2
  1729. \f[C]composer\f[R] (string): Composer(s) of the piece; comma-separated
  1730. .IP \[bu] 2
  1731. \f[C]album\f[R] (string): Title of the album the track belongs to
  1732. .IP \[bu] 2
  1733. \f[C]album_type\f[R] (string): Type of the album
  1734. .IP \[bu] 2
  1735. \f[C]album_artists\f[R] (list): All artists appeared on the album
  1736. .IP \[bu] 2
  1737. \f[C]album_artist\f[R] (string): All artists appeared on the album;
  1738. comma-separated
  1739. .IP \[bu] 2
  1740. \f[C]disc_number\f[R] (numeric): Number of the disc or other physical
  1741. medium the track belongs to
  1742. .PP
  1743. Available only when using \f[C]--download-sections\f[R] and for
  1744. \f[C]chapter:\f[R] prefix when using \f[C]--split-chapters\f[R] for
  1745. videos with internal chapters:
  1746. .IP \[bu] 2
  1747. \f[C]section_title\f[R] (string): Title of the chapter
  1748. .IP \[bu] 2
  1749. \f[C]section_number\f[R] (numeric): Number of the chapter within the
  1750. file
  1751. .IP \[bu] 2
  1752. \f[C]section_start\f[R] (numeric): Start time of the chapter in seconds
  1753. .IP \[bu] 2
  1754. \f[C]section_end\f[R] (numeric): End time of the chapter in seconds
  1755. .PP
  1756. Available only when used in \f[C]--print\f[R]:
  1757. .IP \[bu] 2
  1758. \f[C]urls\f[R] (string): The URLs of all requested formats, one in each
  1759. line
  1760. .IP \[bu] 2
  1761. \f[C]filename\f[R] (string): Name of the video file.
  1762. Note that the actual filename may differ
  1763. .IP \[bu] 2
  1764. \f[C]formats_table\f[R] (table): The video format table as printed by
  1765. \f[C]--list-formats\f[R]
  1766. .IP \[bu] 2
  1767. \f[C]thumbnails_table\f[R] (table): The thumbnail format table as
  1768. printed by \f[C]--list-thumbnails\f[R]
  1769. .IP \[bu] 2
  1770. \f[C]subtitles_table\f[R] (table): The subtitle format table as printed
  1771. by \f[C]--list-subs\f[R]
  1772. .IP \[bu] 2
  1773. \f[C]automatic_captions_table\f[R] (table): The automatic subtitle
  1774. format table as printed by \f[C]--list-subs\f[R]
  1775. .PP
  1776. Available only after the video is downloaded
  1777. (\f[C]post_process\f[R]/\f[C]after_move\f[R]):
  1778. .IP \[bu] 2
  1779. \f[C]filepath\f[R]: Actual path of downloaded video file
  1780. .PP
  1781. Available only in \f[C]--sponsorblock-chapter-title\f[R]:
  1782. .IP \[bu] 2
  1783. \f[C]start_time\f[R] (numeric): Start time of the chapter in seconds
  1784. .IP \[bu] 2
  1785. \f[C]end_time\f[R] (numeric): End time of the chapter in seconds
  1786. .IP \[bu] 2
  1787. \f[C]categories\f[R] (list): The SponsorBlock
  1788. categories (https://wiki.sponsor.ajay.app/w/Types#Category) the chapter
  1789. belongs to
  1790. .IP \[bu] 2
  1791. \f[C]category\f[R] (string): The smallest SponsorBlock category the
  1792. chapter belongs to
  1793. .IP \[bu] 2
  1794. \f[C]category_names\f[R] (list): Friendly names of the categories
  1795. .IP \[bu] 2
  1796. \f[C]name\f[R] (string): Friendly name of the smallest category
  1797. .IP \[bu] 2
  1798. \f[C]type\f[R] (string): The SponsorBlock action
  1799. type (https://wiki.sponsor.ajay.app/w/Types#Action_Type) of the chapter
  1800. .PP
  1801. Each aforementioned sequence when referenced in an output template will
  1802. be replaced by the actual value corresponding to the sequence name.
  1803. E.g.
  1804. for \f[C]-o %(title)s-%(id)s.%(ext)s\f[R] and an mp4 video with title
  1805. \f[C]yt-dlp test video\f[R] and id \f[C]BaW_jenozKc\f[R], this will
  1806. result in a \f[C]yt-dlp test video-BaW_jenozKc.mp4\f[R] file created in
  1807. the current directory.
  1808. .PP
  1809. \f[B]Note\f[R]: Some of the sequences are not guaranteed to be present,
  1810. since they depend on the metadata obtained by a particular extractor.
  1811. Such sequences will be replaced with placeholder value provided with
  1812. \f[C]--output-na-placeholder\f[R] (\f[C]NA\f[R] by default).
  1813. .PP
  1814. \f[B]Tip\f[R]: Look at the \f[C]-j\f[R] output to identify which fields
  1815. are available for the particular URL
  1816. .PP
  1817. For numeric sequences, you can use numeric related
  1818. formatting (https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting);
  1819. e.g.
  1820. \f[C]%(view_count)05d\f[R] will result in a string with view count
  1821. padded with zeros up to 5 characters, like in \f[C]00042\f[R].
  1822. .PP
  1823. Output templates can also contain arbitrary hierarchical path, e.g.
  1824. \f[C]-o \[dq]%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s\[dq]\f[R]
  1825. which will result in downloading each video in a directory corresponding
  1826. to this path template.
  1827. Any missing directory will be automatically created for you.
  1828. .PP
  1829. To use percent literals in an output template use \f[C]%%\f[R].
  1830. To output to stdout use \f[C]-o -\f[R].
  1831. .PP
  1832. The current default template is \f[C]%(title)s [%(id)s].%(ext)s\f[R].
  1833. .PP
  1834. In some cases, you don\[aq]t want special characters such as \[u4E2D],
  1835. spaces, or &, such as when transferring the downloaded filename to a
  1836. Windows system or the filename through an 8bit-unsafe channel.
  1837. In these cases, add the \f[C]--restrict-filenames\f[R] flag to get a
  1838. shorter title.
  1839. .SS Output template examples
  1840. .IP
  1841. .nf
  1842. \f[C]
  1843. $ yt-dlp --print filename -o \[dq]test video.%(ext)s\[dq] BaW_jenozKc
  1844. test video.webm    # Literal name with correct extension
  1846. $ yt-dlp --print filename -o \[dq]%(title)s.%(ext)s\[dq] BaW_jenozKc
  1847. youtube-dl test video \[aq]\[aq]_\[:a]\[u21AD]\[u1D550].webm    # All kinds of weird characters
  1849. $ yt-dlp --print filename -o \[dq]%(title)s.%(ext)s\[dq] BaW_jenozKc --restrict-filenames
  1850. youtube-dl_test_video_.webm    # Restricted file name
  1852. # Download YouTube playlist videos in separate directory indexed by video order in a playlist
  1853. $ yt-dlp -o \[dq]%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s\[dq] \[dq]https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re\[dq]
  1855. # Download YouTube playlist videos in separate directories according to their uploaded year
  1856. $ yt-dlp -o \[dq]%(upload_date>%Y)s/%(title)s.%(ext)s\[dq] \[dq]https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re\[dq]
  1858. # Prefix playlist index with \[dq] - \[dq] separator, but only if it is available
  1859. $ yt-dlp -o \[dq]%(playlist_index&{} - |)s%(title)s.%(ext)s\[dq] BaW_jenozKc \[dq]https://www.youtube.com/user/TheLinuxFoundation/playlists\[dq]
  1861. # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
  1862. $ yt-dlp -o \[dq]%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s\[dq] \[dq]https://www.youtube.com/user/TheLinuxFoundation/playlists\[dq]
  1864. # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
  1865. $ yt-dlp -u user -p password -P \[dq]\[ti]/MyVideos\[dq] -o \[dq]%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s\[dq] \[dq]https://www.udemy.com/java-tutorial\[dq]
  1867. # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
  1868. $ yt-dlp -P \[dq]C:/MyVideos\[dq] -o \[dq]%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s\[dq] \[dq]https://videomore.ru/kino_v_detalayah/5_sezon/367617\[dq]
  1870. # Download video as \[dq]C:\[rs]MyVideos\[rs]uploader\[rs]title.ext\[dq], subtitles as \[dq]C:\[rs]MyVideos\[rs]subs\[rs]uploader\[rs]title.ext\[dq]
  1871. # and put all temporary files in \[dq]C:\[rs]MyVideos\[rs]tmp\[dq]
  1872. $ yt-dlp -P \[dq]C:/MyVideos\[dq] -P \[dq]temp:tmp\[dq] -P \[dq]subtitle:subs\[dq] -o \[dq]%(uploader)s/%(title)s.%(ext)s\[dq] BaW_jenozKc --write-subs
  1874. # Download video as \[dq]C:\[rs]MyVideos\[rs]uploader\[rs]title.ext\[dq] and subtitles as \[dq]C:\[rs]MyVideos\[rs]uploader\[rs]subs\[rs]title.ext\[dq]
  1875. $ yt-dlp -P \[dq]C:/MyVideos\[dq] -o \[dq]%(uploader)s/%(title)s.%(ext)s\[dq] -o \[dq]subtitle:%(uploader)s/subs/%(title)s.%(ext)s\[dq] BaW_jenozKc --write-subs
  1877. # Stream the video being downloaded to stdout
  1878. $ yt-dlp -o - BaW_jenozKc
  1879. \f[R]
  1880. .fi
  1881. .SH FORMAT SELECTION
  1882. .PP
  1883. By default, yt-dlp tries to download the best available quality if you
  1884. \f[B]don\[aq]t\f[R] pass any options.
  1885. This is generally equivalent to using
  1886. \f[C]-f bestvideo*+bestaudio/best\f[R].
  1887. However, if multiple audiostreams is enabled
  1888. (\f[C]--audio-multistreams\f[R]), the default format changes to
  1889. \f[C]-f bestvideo+bestaudio/best\f[R].
  1890. Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to
  1891. \f[C]stdout\f[R] (\f[C]-o -\f[R]), the default becomes
  1892. \f[C]-f best/bestvideo+bestaudio\f[R].
  1893. .PP
  1894. \f[B]Deprecation warning\f[R]: Latest versions of yt-dlp can stream
  1895. multiple formats to the stdout simultaneously using ffmpeg.
  1896. So, in future versions, the default for this will be set to
  1897. \f[C]-f bv*+ba/b\f[R] similar to normal downloads.
  1898. If you want to preserve the \f[C]-f b/bv+ba\f[R] setting, it is
  1899. recommended to explicitly specify it in the configuration options.
  1900. .PP
  1901. The general syntax for format selection is \f[C]-f FORMAT\f[R] (or
  1902. \f[C]--format FORMAT\f[R]) where \f[C]FORMAT\f[R] is a \f[I]selector
  1903. expression\f[R], i.e.
  1904. an expression that describes format or formats you would like to
  1905. download.
  1906. .PP
  1907. The simplest case is requesting a specific format; e.g.
  1908. with \f[C]-f 22\f[R] you can download the format with format code equal
  1909. to 22.
  1910. You can get the list of available format codes for particular video
  1911. using \f[C]--list-formats\f[R] or \f[C]-F\f[R].
  1912. Note that these format codes are extractor specific.
  1913. .PP
  1914. You can also use a file extension (currently \f[C]3gp\f[R],
  1915. \f[C]aac\f[R], \f[C]flv\f[R], \f[C]m4a\f[R], \f[C]mp3\f[R],
  1916. \f[C]mp4\f[R], \f[C]ogg\f[R], \f[C]wav\f[R], \f[C]webm\f[R] are
  1917. supported) to download the best quality format of a particular file
  1918. extension served as a single file, e.g.
  1919. \f[C]-f webm\f[R] will download the best quality format with the
  1920. \f[C]webm\f[R] extension served as a single file.
  1921. .PP
  1922. You can use \f[C]-f -\f[R] to interactively provide the format selector
  1923. \f[I]for each video\f[R]
  1924. .PP
  1925. You can also use special names to select particular edge case formats:
  1926. .IP \[bu] 2
  1927. \f[C]all\f[R]: Select \f[B]all formats\f[R] separately
  1928. .IP \[bu] 2
  1929. \f[C]mergeall\f[R]: Select and \f[B]merge all formats\f[R] (Must be used
  1930. with \f[C]--audio-multistreams\f[R], \f[C]--video-multistreams\f[R] or
  1931. both)
  1932. .IP \[bu] 2
  1933. \f[C]b*\f[R], \f[C]best*\f[R]: Select the best quality format that
  1934. \f[B]contains either\f[R] a video or an audio or both (i.e.;
  1935. \f[C]vcodec!=none or acodec!=none\f[R])
  1936. .IP \[bu] 2
  1937. \f[C]b\f[R], \f[C]best\f[R]: Select the best quality format that
  1938. \f[B]contains both\f[R] video and audio.
  1939. Equivalent to \f[C]best*[vcodec!=none][acodec!=none]\f[R]
  1940. .IP \[bu] 2
  1941. \f[C]bv\f[R], \f[C]bestvideo\f[R]: Select the best quality
  1942. \f[B]video-only\f[R] format.
  1943. Equivalent to \f[C]best*[acodec=none]\f[R]
  1944. .IP \[bu] 2
  1945. \f[C]bv*\f[R], \f[C]bestvideo*\f[R]: Select the best quality format that
  1946. \f[B]contains video\f[R].
  1947. It may also contain audio.
  1948. Equivalent to \f[C]best*[vcodec!=none]\f[R]
  1949. .IP \[bu] 2
  1950. \f[C]ba\f[R], \f[C]bestaudio\f[R]: Select the best quality
  1951. \f[B]audio-only\f[R] format.
  1952. Equivalent to \f[C]best*[vcodec=none]\f[R]
  1953. .IP \[bu] 2
  1954. \f[C]ba*\f[R], \f[C]bestaudio*\f[R]: Select the best quality format that
  1955. \f[B]contains audio\f[R].
  1956. It may also contain video.
  1957. Equivalent to \f[C]best*[acodec!=none]\f[R] (Do not
  1958. use! (https://github.com/yt-dlp/yt-dlp/issues/979#issuecomment-919629354))
  1959. .IP \[bu] 2
  1960. \f[C]w*\f[R], \f[C]worst*\f[R]: Select the worst quality format that
  1961. contains either a video or an audio
  1962. .IP \[bu] 2
  1963. \f[C]w\f[R], \f[C]worst\f[R]: Select the worst quality format that
  1964. contains both video and audio.
  1965. Equivalent to \f[C]worst*[vcodec!=none][acodec!=none]\f[R]
  1966. .IP \[bu] 2
  1967. \f[C]wv\f[R], \f[C]worstvideo\f[R]: Select the worst quality video-only
  1968. format.
  1969. Equivalent to \f[C]worst*[acodec=none]\f[R]
  1970. .IP \[bu] 2
  1971. \f[C]wv*\f[R], \f[C]worstvideo*\f[R]: Select the worst quality format
  1972. that contains video.
  1973. It may also contain audio.
  1974. Equivalent to \f[C]worst*[vcodec!=none]\f[R]
  1975. .IP \[bu] 2
  1976. \f[C]wa\f[R], \f[C]worstaudio\f[R]: Select the worst quality audio-only
  1977. format.
  1978. Equivalent to \f[C]worst*[vcodec=none]\f[R]
  1979. .IP \[bu] 2
  1980. \f[C]wa*\f[R], \f[C]worstaudio*\f[R]: Select the worst quality format
  1981. that contains audio.
  1982. It may also contain video.
  1983. Equivalent to \f[C]worst*[acodec!=none]\f[R]
  1984. .PP
  1985. For example, to download the worst quality video-only format you can use
  1986. \f[C]-f worstvideo\f[R].
  1987. It is, however, recommended not to use \f[C]worst\f[R] and related
  1988. options.
  1989. When your format selector is \f[C]worst\f[R], the format which is worst
  1990. in all respects is selected.
  1991. Most of the time, what you actually want is the video with the smallest
  1992. filesize instead.
  1993. So it is generally better to use \f[C]-S +size\f[R] or more rigorously,
  1994. \f[C]-S +size,+br,+res,+fps\f[R] instead of \f[C]-f worst\f[R].
  1995. See Sorting Formats for more details.
  1996. .PP
  1997. You can select the n\[aq]th best format of a type by using
  1998. \f[C]best<type>.<n>\f[R].
  1999. For example, \f[C]best.2\f[R] will select the 2nd best combined format.
  2000. Similarly, \f[C]bv*.3\f[R] will select the 3rd best format that contains
  2001. a video stream.
  2002. .PP
  2003. If you want to download multiple videos, and they don\[aq]t have the
  2004. same formats available, you can specify the order of preference using
  2005. slashes.
  2006. Note that formats on the left hand side are preferred; e.g.
  2007. \f[C]-f 22/17/18\f[R] will download format 22 if it\[aq]s available,
  2008. otherwise it will download format 17 if it\[aq]s available, otherwise it
  2009. will download format 18 if it\[aq]s available, otherwise it will
  2010. complain that no suitable formats are available for download.
  2011. .PP
  2012. If you want to download several formats of the same video use a comma as
  2013. a separator, e.g.
  2014. \f[C]-f 22,17,18\f[R] will download all these three formats, of course
  2015. if they are available.
  2016. Or a more sophisticated example combined with the precedence feature:
  2017. \f[C]-f 136/137/mp4/bestvideo,140/m4a/bestaudio\f[R].
  2018. .PP
  2019. You can merge the video and audio of multiple formats into a single file
  2020. using \f[C]-f <format1>+<format2>+...\f[R] (requires ffmpeg installed);
  2021. e.g.
  2022. \f[C]-f bestvideo+bestaudio\f[R] will download the best video-only
  2023. format, the best audio-only format and mux them together with ffmpeg.
  2024. .PP
  2025. \f[B]Deprecation warning\f[R]: Since the \f[I]below\f[R] described
  2026. behavior is complex and counter-intuitive, this will be removed and
  2027. multistreams will be enabled by default in the future.
  2028. A new operator will be instead added to limit formats to single
  2029. audio/video
  2030. .PP
  2031. Unless \f[C]--video-multistreams\f[R] is used, all formats with a video
  2032. stream except the first one are ignored.
  2033. Similarly, unless \f[C]--audio-multistreams\f[R] is used, all formats
  2034. with an audio stream except the first one are ignored.
  2035. E.g.
  2036. \f[C]-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams\f[R]
  2037. will download and merge all 3 given formats.
  2038. The resulting file will have 2 video streams and 2 audio streams.
  2039. But \f[C]-f bestvideo+best+bestaudio --no-video-multistreams\f[R] will
  2040. download and merge only \f[C]bestvideo\f[R] and \f[C]bestaudio\f[R].
  2041. \f[C]best\f[R] is ignored since another format containing a video stream
  2042. (\f[C]bestvideo\f[R]) has already been selected.
  2043. The order of the formats is therefore important.
  2044. \f[C]-f best+bestaudio --no-audio-multistreams\f[R] will download only
  2045. \f[C]best\f[R] while \f[C]-f bestaudio+best --no-audio-multistreams\f[R]
  2046. will ignore \f[C]best\f[R] and download only \f[C]bestaudio\f[R].
  2047. .SS Filtering Formats
  2048. .PP
  2049. You can also filter the video formats by putting a condition in
  2050. brackets, as in \f[C]-f \[dq]best[height=720]\[dq]\f[R] (or
  2051. \f[C]-f \[dq][filesize>10M]\[dq]\f[R] since filters without a selector
  2052. are interpreted as \f[C]best\f[R]).
  2053. .PP
  2054. The following numeric meta fields can be used with comparisons
  2055. \f[C]<\f[R], \f[C]<=\f[R], \f[C]>\f[R], \f[C]>=\f[R], \f[C]=\f[R]
  2056. (equals), \f[C]!=\f[R] (not equals):
  2057. .IP \[bu] 2
  2058. \f[C]filesize\f[R]: The number of bytes, if known in advance
  2059. .IP \[bu] 2
  2060. \f[C]filesize_approx\f[R]: An estimate for the number of bytes
  2061. .IP \[bu] 2
  2062. \f[C]width\f[R]: Width of the video, if known
  2063. .IP \[bu] 2
  2064. \f[C]height\f[R]: Height of the video, if known
  2065. .IP \[bu] 2
  2066. \f[C]aspect_ratio\f[R]: Aspect ratio of the video, if known
  2067. .IP \[bu] 2
  2068. \f[C]tbr\f[R]: Average bitrate of audio and video in kbps
  2069. .IP \[bu] 2
  2070. \f[C]abr\f[R]: Average audio bitrate in kbps
  2071. .IP \[bu] 2
  2072. \f[C]vbr\f[R]: Average video bitrate in kbps
  2073. .IP \[bu] 2
  2074. \f[C]asr\f[R]: Audio sampling rate in Hertz
  2075. .IP \[bu] 2
  2076. \f[C]fps\f[R]: Frame rate
  2077. .IP \[bu] 2
  2078. \f[C]audio_channels\f[R]: The number of audio channels
  2079. .IP \[bu] 2
  2080. \f[C]stretched_ratio\f[R]: \f[C]width:height\f[R] of the video\[aq]s
  2081. pixels, if not square
  2082. .PP
  2083. Also filtering work for comparisons \f[C]=\f[R] (equals),
  2084. \f[C]\[ha]=\f[R] (starts with), \f[C]$=\f[R] (ends with), \f[C]*=\f[R]
  2085. (contains), \f[C]\[ti]=\f[R] (matches regex) and following string meta
  2086. fields:
  2087. .IP \[bu] 2
  2088. \f[C]url\f[R]: Video URL
  2089. .IP \[bu] 2
  2090. \f[C]ext\f[R]: File extension
  2091. .IP \[bu] 2
  2092. \f[C]acodec\f[R]: Name of the audio codec in use
  2093. .IP \[bu] 2
  2094. \f[C]vcodec\f[R]: Name of the video codec in use
  2095. .IP \[bu] 2
  2096. \f[C]container\f[R]: Name of the container format
  2097. .IP \[bu] 2
  2098. \f[C]protocol\f[R]: The protocol that will be used for the actual
  2099. download, lower-case (\f[C]http\f[R], \f[C]https\f[R], \f[C]rtsp\f[R],
  2100. \f[C]rtmp\f[R], \f[C]rtmpe\f[R], \f[C]mms\f[R], \f[C]f4m\f[R],
  2101. \f[C]ism\f[R], \f[C]http_dash_segments\f[R], \f[C]m3u8\f[R], or
  2102. \f[C]m3u8_native\f[R])
  2103. .IP \[bu] 2
  2104. \f[C]language\f[R]: Language code
  2105. .IP \[bu] 2
  2106. \f[C]dynamic_range\f[R]: The dynamic range of the video
  2107. .IP \[bu] 2
  2108. \f[C]format_id\f[R]: A short description of the format
  2109. .IP \[bu] 2
  2110. \f[C]format\f[R]: A human-readable description of the format
  2111. .IP \[bu] 2
  2112. \f[C]format_note\f[R]: Additional info about the format
  2113. .IP \[bu] 2
  2114. \f[C]resolution\f[R]: Textual description of width and height
  2115. .PP
  2116. Any string comparison may be prefixed with negation \f[C]!\f[R] in order
  2117. to produce an opposite comparison, e.g.
  2118. \f[C]!*=\f[R] (does not contain).
  2119. The comparand of a string comparison needs to be quoted with either
  2120. double or single quotes if it contains spaces or special characters
  2121. other than \f[C]._-\f[R].
  2122. .PP
  2123. \f[B]Note\f[R]: None of the aforementioned meta fields are guaranteed to
  2124. be present since this solely depends on the metadata obtained by the
  2125. particular extractor, i.e.
  2126. the metadata offered by the website.
  2127. Any other field made available by the extractor can also be used for
  2128. filtering.
  2129. .PP
  2130. Formats for which the value is not known are excluded unless you put a
  2131. question mark (\f[C]?\f[R]) after the operator.
  2132. You can combine format filters, so
  2133. \f[C]-f \[dq]bv[height<=?720][tbr>500]\[dq]\f[R] selects up to 720p
  2134. videos (or videos where the height is not known) with a bitrate of at
  2135. least 500 kbps.
  2136. You can also use the filters with \f[C]all\f[R] to download all formats
  2137. that satisfy the filter, e.g.
  2138. \f[C]-f \[dq]all[vcodec=none]\[dq]\f[R] selects all audio-only formats.
  2139. .PP
  2140. Format selectors can also be grouped using parentheses; e.g.
  2141. \f[C]-f \[dq](mp4,webm)[height<480]\[dq]\f[R] will download the best
  2142. pre-merged mp4 and webm formats with a height lower than 480.
  2143. .SS Sorting Formats
  2144. .PP
  2145. You can change the criteria for being considered the \f[C]best\f[R] by
  2146. using \f[C]-S\f[R] (\f[C]--format-sort\f[R]).
  2147. The general format for this is \f[C]--format-sort field1,field2...\f[R].
  2148. .PP
  2149. The available fields are:
  2150. .IP \[bu] 2
  2151. \f[C]hasvid\f[R]: Gives priority to formats that have a video stream
  2152. .IP \[bu] 2
  2153. \f[C]hasaud\f[R]: Gives priority to formats that have an audio stream
  2154. .IP \[bu] 2
  2155. \f[C]ie_pref\f[R]: The format preference
  2156. .IP \[bu] 2
  2157. \f[C]lang\f[R]: The language preference
  2158. .IP \[bu] 2
  2159. \f[C]quality\f[R]: The quality of the format
  2160. .IP \[bu] 2
  2161. \f[C]source\f[R]: The preference of the source
  2162. .IP \[bu] 2
  2163. \f[C]proto\f[R]: Protocol used for download
  2164. (\f[C]https\f[R]/\f[C]ftps\f[R] > \f[C]http\f[R]/\f[C]ftp\f[R] >
  2165. \f[C]m3u8_native\f[R]/\f[C]m3u8\f[R] > \f[C]http_dash_segments\f[R]>
  2166. \f[C]websocket_frag\f[R] > \f[C]mms\f[R]/\f[C]rtsp\f[R] >
  2167. \f[C]f4f\f[R]/\f[C]f4m\f[R])
  2168. .IP \[bu] 2
  2169. \f[C]vcodec\f[R]: Video Codec (\f[C]av01\f[R] > \f[C]vp9.2\f[R] >
  2170. \f[C]vp9\f[R] > \f[C]h265\f[R] > \f[C]h264\f[R] > \f[C]vp8\f[R] >
  2171. \f[C]h263\f[R] > \f[C]theora\f[R] > other)
  2172. .IP \[bu] 2
  2173. \f[C]acodec\f[R]: Audio Codec (\f[C]flac\f[R]/\f[C]alac\f[R] >
  2174. \f[C]wav\f[R]/\f[C]aiff\f[R] > \f[C]opus\f[R] > \f[C]vorbis\f[R] >
  2175. \f[C]aac\f[R] > \f[C]mp4a\f[R] > \f[C]mp3\f[R] > \f[C]ac4\f[R] >
  2176. \f[C]eac3\f[R] > \f[C]ac3\f[R] > \f[C]dts\f[R] > other)
  2177. .IP \[bu] 2
  2178. \f[C]codec\f[R]: Equivalent to \f[C]vcodec,acodec\f[R]
  2179. .IP \[bu] 2
  2180. \f[C]vext\f[R]: Video Extension (\f[C]mp4\f[R] > \f[C]mov\f[R] >
  2181. \f[C]webm\f[R] > \f[C]flv\f[R] > other).
  2182. If \f[C]--prefer-free-formats\f[R] is used, \f[C]webm\f[R] is preferred.
  2183. .IP \[bu] 2
  2184. \f[C]aext\f[R]: Audio Extension (\f[C]m4a\f[R] > \f[C]aac\f[R] >
  2185. \f[C]mp3\f[R] > \f[C]ogg\f[R] > \f[C]opus\f[R] > \f[C]webm\f[R] >
  2186. other).
  2187. If \f[C]--prefer-free-formats\f[R] is used, the order changes to
  2188. \f[C]ogg\f[R] > \f[C]opus\f[R] > \f[C]webm\f[R] > \f[C]mp3\f[R] >
  2189. \f[C]m4a\f[R] > \f[C]aac\f[R]
  2190. .IP \[bu] 2
  2191. \f[C]ext\f[R]: Equivalent to \f[C]vext,aext\f[R]
  2192. .IP \[bu] 2
  2193. \f[C]filesize\f[R]: Exact filesize, if known in advance
  2194. .IP \[bu] 2
  2195. \f[C]fs_approx\f[R]: Approximate filesize
  2196. .IP \[bu] 2
  2197. \f[C]size\f[R]: Exact filesize if available, otherwise approximate
  2198. filesize
  2199. .IP \[bu] 2
  2200. \f[C]height\f[R]: Height of video
  2201. .IP \[bu] 2
  2202. \f[C]width\f[R]: Width of video
  2203. .IP \[bu] 2
  2204. \f[C]res\f[R]: Video resolution, calculated as the smallest dimension.
  2205. .IP \[bu] 2
  2206. \f[C]fps\f[R]: Framerate of video
  2207. .IP \[bu] 2
  2208. \f[C]hdr\f[R]: The dynamic range of the video (\f[C]DV\f[R] >
  2209. \f[C]HDR12\f[R] > \f[C]HDR10+\f[R] > \f[C]HDR10\f[R] > \f[C]HLG\f[R] >
  2210. \f[C]SDR\f[R])
  2211. .IP \[bu] 2
  2212. \f[C]channels\f[R]: The number of audio channels
  2213. .IP \[bu] 2
  2214. \f[C]tbr\f[R]: Total average bitrate in kbps
  2215. .IP \[bu] 2
  2216. \f[C]vbr\f[R]: Average video bitrate in kbps
  2217. .IP \[bu] 2
  2218. \f[C]abr\f[R]: Average audio bitrate in kbps
  2219. .IP \[bu] 2
  2220. \f[C]br\f[R]: Average bitrate in kbps,
  2221. \f[C]tbr\f[R]/\f[C]vbr\f[R]/\f[C]abr\f[R]
  2222. .IP \[bu] 2
  2223. \f[C]asr\f[R]: Audio sample rate in Hz
  2224. .PP
  2225. \f[B]Deprecation warning\f[R]: Many of these fields have (currently
  2226. undocumented) aliases, that may be removed in a future version.
  2227. It is recommended to use only the documented field names.
  2228. .PP
  2229. All fields, unless specified otherwise, are sorted in descending order.
  2230. To reverse this, prefix the field with a \f[C]+\f[R].
  2231. E.g.
  2232. \f[C]+res\f[R] prefers format with the smallest resolution.
  2233. Additionally, you can suffix a preferred value for the fields, separated
  2234. by a \f[C]:\f[R].
  2235. E.g.
  2236. \f[C]res:720\f[R] prefers larger videos, but no larger than 720p and the
  2237. smallest video if there are no videos less than 720p.
  2238. For \f[C]codec\f[R] and \f[C]ext\f[R], you can provide two preferred
  2239. values, the first for video and the second for audio.
  2240. E.g.
  2241. \f[C]+codec:avc:m4a\f[R] (equivalent to
  2242. \f[C]+vcodec:avc,+acodec:m4a\f[R]) sets the video codec preference to
  2243. \f[C]h264\f[R] > \f[C]h265\f[R] > \f[C]vp9\f[R] > \f[C]vp9.2\f[R] >
  2244. \f[C]av01\f[R] > \f[C]vp8\f[R] > \f[C]h263\f[R] > \f[C]theora\f[R] and
  2245. audio codec preference to \f[C]mp4a\f[R] > \f[C]aac\f[R] >
  2246. \f[C]vorbis\f[R] > \f[C]opus\f[R] > \f[C]mp3\f[R] > \f[C]ac3\f[R] >
  2247. \f[C]dts\f[R].
  2248. You can also make the sorting prefer the nearest values to the provided
  2249. by using \f[C]\[ti]\f[R] as the delimiter.
  2250. E.g.
  2251. \f[C]filesize\[ti]1G\f[R] prefers the format with filesize closest to 1
  2252. GiB.
  2253. .PP
  2254. The fields \f[C]hasvid\f[R] and \f[C]ie_pref\f[R] are always given
  2255. highest priority in sorting, irrespective of the user-defined order.
  2256. This behavior can be changed by using \f[C]--format-sort-force\f[R].
  2257. Apart from these, the default order used is:
  2258. \f[C]lang,quality,res,fps,hdr:12,vcodec,channels,acodec,size,br,asr,proto,ext,hasaud,source,id\f[R].
  2259. The extractors may override this default order, but they cannot override
  2260. the user-provided order.
  2261. .PP
  2262. Note that the default for hdr is \f[C]hdr:12\f[R]; i.e.
  2263. Dolby Vision is not preferred.
  2264. This choice was made since DV formats are not yet fully compatible with
  2265. most devices.
  2266. This may be changed in the future.
  2267. .PP
  2268. If your format selector is \f[C]worst\f[R], the last item is selected
  2269. after sorting.
  2270. This means it will select the format that is worst in all respects.
  2271. Most of the time, what you actually want is the video with the smallest
  2272. filesize instead.
  2273. So it is generally better to use
  2274. \f[C]-f best -S +size,+br,+res,+fps\f[R].
  2275. .PP
  2276. \f[B]Tip\f[R]: You can use the \f[C]-v -F\f[R] to see how the formats
  2277. have been sorted (worst to best).
  2278. .SS Format Selection examples
  2279. .IP
  2280. .nf
  2281. \f[C]
  2282. # Download and merge the best video-only format and the best audio-only format,
  2283. # or download the best combined format if video-only format is not available
  2284. $ yt-dlp -f \[dq]bv+ba/b\[dq]
  2286. # Download best format that contains video,
  2287. # and if it doesn\[aq]t already have an audio stream, merge it with best audio-only format
  2288. $ yt-dlp -f \[dq]bv*+ba/b\[dq]
  2290. # Same as above
  2291. $ yt-dlp
  2293. # Download the best video-only format and the best audio-only format without merging them
  2294. # For this case, an output template should be used since
  2295. # by default, bestvideo and bestaudio will have the same file name.
  2296. $ yt-dlp -f \[dq]bv,ba\[dq] -o \[dq]%(title)s.f%(format_id)s.%(ext)s\[dq]
  2298. # Download and merge the best format that has a video stream,
  2299. # and all audio-only formats into one file
  2300. $ yt-dlp -f \[dq]bv*+mergeall[vcodec=none]\[dq] --audio-multistreams
  2302. # Download and merge the best format that has a video stream,
  2303. # and the best 2 audio-only formats into one file
  2304. $ yt-dlp -f \[dq]bv*+ba+ba.2\[dq] --audio-multistreams
  2307. # The following examples show the old method (without -S) of format selection
  2308. # and how to use -S to achieve a similar but (generally) better result
  2310. # Download the worst video available (old method)
  2311. $ yt-dlp -f \[dq]wv*+wa/w\[dq]
  2313. # Download the best video available but with the smallest resolution
  2314. $ yt-dlp -S \[dq]+res\[dq]
  2316. # Download the smallest video available
  2317. $ yt-dlp -S \[dq]+size,+br\[dq]
  2321. # Download the best mp4 video available, or the best video if no mp4 available
  2322. $ yt-dlp -f \[dq]bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b\[dq]
  2324. # Download the best video with the best extension
  2325. # (For video, mp4 > mov > webm > flv. For audio, m4a > aac > mp3 ...)
  2326. $ yt-dlp -S \[dq]ext\[dq]
  2330. # Download the best video available but no better than 480p,
  2331. # or the worst video if there is no video under 480p
  2332. $ yt-dlp -f \[dq]bv*[height<=480]+ba/b[height<=480] / wv*+ba/w\[dq]
  2334. # Download the best video available with the largest height but no better than 480p,
  2335. # or the best video with the smallest resolution if there is no video under 480p
  2336. $ yt-dlp -S \[dq]height:480\[dq]
  2338. # Download the best video available with the largest resolution but no better than 480p,
  2339. # or the best video with the smallest resolution if there is no video under 480p
  2340. # Resolution is determined by using the smallest dimension.
  2341. # So this works correctly for vertical videos as well
  2342. $ yt-dlp -S \[dq]res:480\[dq]
  2346. # Download the best video (that also has audio) but no bigger than 50 MB,
  2347. # or the worst video (that also has audio) if there is no video under 50 MB
  2348. $ yt-dlp -f \[dq]b[filesize<50M] / w\[dq]
  2350. # Download the largest video (that also has audio) but no bigger than 50 MB,
  2351. # or the smallest video (that also has audio) if there is no video under 50 MB
  2352. $ yt-dlp -f \[dq]b\[dq] -S \[dq]filesize:50M\[dq]
  2354. # Download the best video (that also has audio) that is closest in size to 50 MB
  2355. $ yt-dlp -f \[dq]b\[dq] -S \[dq]filesize\[ti]50M\[dq]
  2359. # Download best video available via direct link over HTTP/HTTPS protocol,
  2360. # or the best video available via any protocol if there is no such video
  2361. $ yt-dlp -f \[dq](bv*+ba/b)[protocol\[ha]=http][protocol!*=dash] / (bv*+ba/b)\[dq]
  2363. # Download best video available via the best protocol
  2364. # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
  2365. $ yt-dlp -S \[dq]proto\[dq]
  2369. # Download the best video with either h264 or h265 codec,
  2370. # or the best video if there is no such video
  2371. $ yt-dlp -f \[dq](bv*[vcodec\[ti]=\[aq]\[ha]((he|a)vc|h26[45])\[aq]]+ba) / (bv*+ba/b)\[dq]
  2373. # Download the best video with best codec no better than h264,
  2374. # or the best video with worst codec if there is no such video
  2375. $ yt-dlp -S \[dq]codec:h264\[dq]
  2377. # Download the best video with worst codec no worse than h264,
  2378. # or the best video with best codec if there is no such video
  2379. $ yt-dlp -S \[dq]+codec:h264\[dq]
  2383. # More complex examples
  2385. # Download the best video no better than 720p preferring framerate greater than 30,
  2386. # or the worst video (still preferring framerate greater than 30) if there is no such video
  2387. $ yt-dlp -f \[dq]((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)\[dq]
  2389. # Download the video with the largest resolution no better than 720p,
  2390. # or the video with the smallest resolution available if there is no such video,
  2391. # preferring larger framerate for formats with the same resolution
  2392. $ yt-dlp -S \[dq]res:720,fps\[dq]
  2396. # Download the video with smallest resolution no worse than 480p,
  2397. # or the video with the largest resolution available if there is no such video,
  2398. # preferring better codec and then larger total bitrate for the same resolution
  2399. $ yt-dlp -S \[dq]+res:480,codec,br\[dq]
  2400. \f[R]
  2401. .fi
  2402. .SH MODIFYING METADATA
  2403. .PP
  2404. The metadata obtained by the extractors can be modified by using
  2405. \f[C]--parse-metadata\f[R] and \f[C]--replace-in-metadata\f[R]
  2406. .PP
  2407. \f[C]--replace-in-metadata FIELDS REGEX REPLACE\f[R] is used to replace
  2408. text in any metadata field using Python regular
  2409. expression (https://docs.python.org/3/library/re.html#regular-expression-syntax).
  2410. Backreferences (https://docs.python.org/3/library/re.html?highlight=backreferences#re.sub)
  2411. can be used in the replace string for advanced use.
  2412. .PP
  2413. The general syntax of \f[C]--parse-metadata FROM:TO\f[R] is to give the
  2414. name of a field or an output template to extract data from, and the
  2415. format to interpret it as, separated by a colon \f[C]:\f[R].
  2416. Either a Python regular
  2417. expression (https://docs.python.org/3/library/re.html#regular-expression-syntax)
  2418. with named capture groups, a single field name, or a similar syntax to
  2419. the output template (only \f[C]%(field)s\f[R] formatting is supported)
  2420. can be used for \f[C]TO\f[R].
  2421. The option can be used multiple times to parse and modify various
  2422. fields.
  2423. .PP
  2424. Note that these options preserve their relative order, allowing
  2425. replacements to be made in parsed fields and vice versa.
  2426. Also, any field thus created can be used in the output template and will
  2427. also affect the media file\[aq]s metadata added when using
  2428. \f[C]--embed-metadata\f[R].
  2429. .PP
  2430. This option also has a few special uses:
  2431. .IP \[bu] 2
  2432. You can download an additional URL based on the metadata of the
  2433. currently downloaded video.
  2434. To do this, set the field \f[C]additional_urls\f[R] to the URL that you
  2435. want to download.
  2436. E.g.
  2437. \f[C]--parse-metadata \[dq]description:(?P<additional_urls>https?://www\[rs].vimeo\[rs].com/\[rs]d+)\[dq]\f[R]
  2438. will download the first vimeo video found in the description
  2439. .IP \[bu] 2
  2440. You can use this to change the metadata that is embedded in the media
  2441. file.
  2442. To do this, set the value of the corresponding field with a
  2443. \f[C]meta_\f[R] prefix.
  2444. For example, any value you set to \f[C]meta_description\f[R] field will
  2445. be added to the \f[C]description\f[R] field in the file - you can use
  2446. this to set a different \[dq]description\[dq] and \[dq]synopsis\[dq].
  2447. To modify the metadata of individual streams, use the \f[C]meta<n>_\f[R]
  2448. prefix (e.g.
  2449. \f[C]meta1_language\f[R]).
  2450. Any value set to the \f[C]meta_\f[R] field will overwrite all default
  2451. values.
  2452. .PP
  2453. \f[B]Note\f[R]: Metadata modification happens before format selection,
  2454. post-extraction and other post-processing operations.
  2455. Some fields may be added or changed during these steps, overriding your
  2456. changes.
  2457. .PP
  2458. For reference, these are the fields yt-dlp adds by default to the file
  2459. metadata:
  2460. .PP
  2461. .TS
  2462. tab(@);
  2463. l l.
  2464. T{
  2465. Metadata fields
  2466. T}@T{
  2467. From
  2468. T}
  2469. _
  2470. T{
  2471. \f[C]title\f[R]
  2472. T}@T{
  2473. \f[C]track\f[R] or \f[C]title\f[R]
  2474. T}
  2475. T{
  2476. \f[C]date\f[R]
  2477. T}@T{
  2478. \f[C]upload_date\f[R]
  2479. T}
  2480. T{
  2481. \f[C]description\f[R], \f[C]synopsis\f[R]
  2482. T}@T{
  2483. \f[C]description\f[R]
  2484. T}
  2485. T{
  2486. \f[C]purl\f[R], \f[C]comment\f[R]
  2487. T}@T{
  2488. \f[C]webpage_url\f[R]
  2489. T}
  2490. T{
  2491. \f[C]track\f[R]
  2492. T}@T{
  2493. \f[C]track_number\f[R]
  2494. T}
  2495. T{
  2496. \f[C]artist\f[R]
  2497. T}@T{
  2498. \f[C]artist\f[R], \f[C]artists\f[R], \f[C]creator\f[R],
  2499. \f[C]creators\f[R], \f[C]uploader\f[R] or \f[C]uploader_id\f[R]
  2500. T}
  2501. T{
  2502. \f[C]composer\f[R]
  2503. T}@T{
  2504. \f[C]composer\f[R] or \f[C]composers\f[R]
  2505. T}
  2506. T{
  2507. \f[C]genre\f[R]
  2508. T}@T{
  2509. \f[C]genre\f[R] or \f[C]genres\f[R]
  2510. T}
  2511. T{
  2512. \f[C]album\f[R]
  2513. T}@T{
  2514. \f[C]album\f[R]
  2515. T}
  2516. T{
  2517. \f[C]album_artist\f[R]
  2518. T}@T{
  2519. \f[C]album_artist\f[R] or \f[C]album_artists\f[R]
  2520. T}
  2521. T{
  2522. \f[C]disc\f[R]
  2523. T}@T{
  2524. \f[C]disc_number\f[R]
  2525. T}
  2526. T{
  2527. \f[C]show\f[R]
  2528. T}@T{
  2529. \f[C]series\f[R]
  2530. T}
  2531. T{
  2532. \f[C]season_number\f[R]
  2533. T}@T{
  2534. \f[C]season_number\f[R]
  2535. T}
  2536. T{
  2537. \f[C]episode_id\f[R]
  2538. T}@T{
  2539. \f[C]episode\f[R] or \f[C]episode_id\f[R]
  2540. T}
  2541. T{
  2542. \f[C]episode_sort\f[R]
  2543. T}@T{
  2544. \f[C]episode_number\f[R]
  2545. T}
  2546. T{
  2547. \f[C]language\f[R] of each stream
  2548. T}@T{
  2549. the format\[aq]s \f[C]language\f[R]
  2550. T}
  2551. .TE
  2552. .PP
  2553. \f[B]Note\f[R]: The file format may not support some of these fields
  2554. .SS Modifying metadata examples
  2555. .IP
  2556. .nf
  2557. \f[C]
  2558. # Interpret the title as \[dq]Artist - Title\[dq]
  2559. $ yt-dlp --parse-metadata \[dq]title:%(artist)s - %(title)s\[dq]
  2561. # Regex example
  2562. $ yt-dlp --parse-metadata \[dq]description:Artist - (?P<artist>.+)\[dq]
  2564. # Set title as \[dq]Series name S01E05\[dq]
  2565. $ yt-dlp --parse-metadata \[dq]%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s\[dq]
  2567. # Prioritize uploader as the \[dq]artist\[dq] field in video metadata
  2568. $ yt-dlp --parse-metadata \[dq]%(uploader|)s:%(meta_artist)s\[dq] --embed-metadata
  2570. # Set \[dq]comment\[dq] field in video metadata using description instead of webpage_url,
  2571. # handling multiple lines correctly
  2572. $ yt-dlp --parse-metadata \[dq]description:(?s)(?P<meta_comment>.+)\[dq] --embed-metadata
  2574. # Do not set any \[dq]synopsis\[dq] in the video metadata
  2575. $ yt-dlp --parse-metadata \[dq]:(?P<meta_synopsis>)\[dq]
  2577. # Remove \[dq]formats\[dq] field from the infojson by setting it to an empty string
  2578. $ yt-dlp --parse-metadata \[dq]video::(?P<formats>)\[dq] --write-info-json
  2580. # Replace all spaces and \[dq]_\[dq] in title and uploader with a \[ga]-\[ga]
  2581. $ yt-dlp --replace-in-metadata \[dq]title,uploader\[dq] \[dq][ _]\[dq] \[dq]-\[dq]
  2582. \f[R]
  2583. .fi
  2584. .SH EXTRACTOR ARGUMENTS
  2585. .PP
  2586. Some extractors accept additional arguments which can be passed using
  2587. \f[C]--extractor-args KEY:ARGS\f[R].
  2588. \f[C]ARGS\f[R] is a \f[C];\f[R] (semicolon) separated string of
  2589. \f[C]ARG=VAL1,VAL2\f[R].
  2590. E.g.
  2591. \f[C]--extractor-args \[dq]youtube:player-client=tv,mweb;formats=incomplete\[dq] --extractor-args \[dq]funimation:version=uncut\[dq]\f[R]
  2592. .PP
  2593. Note: In CLI, \f[C]ARG\f[R] can use \f[C]-\f[R] instead of \f[C]_\f[R];
  2594. e.g.
  2595. \f[C]youtube:player-client\[dq]\f[R] becomes
  2596. \f[C]youtube:player_client\[dq]\f[R]
  2597. .PP
  2598. The following extractors use this feature:
  2599. .SS youtube
  2600. .IP \[bu] 2
  2601. \f[C]lang\f[R]: Prefer translated metadata (\f[C]title\f[R],
  2602. \f[C]description\f[R] etc) of this language code (case-sensitive).
  2603. By default, the video primary language metadata is preferred, with a
  2604. fallback to \f[C]en\f[R] translated.
  2605. See
  2606. youtube.py (https://github.com/yt-dlp/yt-dlp/blob/c26f9b991a0681fd3ea548d535919cec1fbbd430/yt_dlp/extractor/youtube.py#L381-L390)
  2607. for list of supported content language codes
  2608. .IP \[bu] 2
  2609. \f[C]skip\f[R]: One or more of \f[C]hls\f[R], \f[C]dash\f[R] or
  2610. \f[C]translated_subs\f[R] to skip extraction of the m3u8 manifests, dash
  2611. manifests and auto-translated
  2612. subtitles (https://github.com/yt-dlp/yt-dlp/issues/4090#issuecomment-1158102032)
  2613. respectively
  2614. .IP \[bu] 2
  2615. \f[C]player_client\f[R]: Clients to extract video data from.
  2616. The main clients are \f[C]web\f[R], \f[C]ios\f[R] and \f[C]android\f[R],
  2617. with variants \f[C]_music\f[R] and \f[C]_creator\f[R] (e.g.
  2618. \f[C]ios_creator\f[R]); and \f[C]mweb\f[R], \f[C]android_vr\f[R],
  2619. \f[C]web_safari\f[R], \f[C]web_embedded\f[R], \f[C]tv\f[R] and
  2620. \f[C]tv_embedded\f[R] with no variants.
  2621. By default, \f[C]tv,ios,web\f[R] is used, or \f[C]tv,web\f[R] is used
  2622. when authenticating with cookies.
  2623. The \f[C]_music\f[R] variants may be added for
  2624. \f[C]music.youtube.com\f[R] URLs.
  2625. Some clients, such as \f[C]web\f[R] and \f[C]android\f[R], require a
  2626. \f[C]po_token\f[R] for their formats to be downloadable.
  2627. Some clients, such as the \f[C]_creator\f[R] variants, will only work
  2628. with authentication.
  2629. Not all clients support authentication via cookies.
  2630. You can use \f[C]default\f[R] for the default clients, or you can use
  2631. \f[C]all\f[R] for all clients (not recommended).
  2632. You can prefix a client with \f[C]-\f[R] to exclude it, e.g.
  2633. \f[C]youtube:player_client=default,-ios\f[R]
  2634. .IP \[bu] 2
  2635. \f[C]player_skip\f[R]: Skip some network requests that are generally
  2636. needed for robust extraction.
  2637. One or more of \f[C]configs\f[R] (skip client configs),
  2638. \f[C]webpage\f[R] (skip initial webpage), \f[C]js\f[R] (skip js player).
  2639. While these options can help reduce the number of requests needed or
  2640. avoid some rate-limiting, they could cause some issues.
  2641. See #860 (https://github.com/yt-dlp/yt-dlp/pull/860) for more details
  2642. .IP \[bu] 2
  2643. \f[C]player_params\f[R]: YouTube player parameters to use for player
  2644. requests.
  2645. Will overwrite any default ones set by yt-dlp.
  2646. .IP \[bu] 2
  2647. \f[C]comment_sort\f[R]: \f[C]top\f[R] or \f[C]new\f[R] (default) -
  2648. choose comment sorting mode (on YouTube\[aq]s side)
  2649. .IP \[bu] 2
  2650. \f[C]max_comments\f[R]: Limit the amount of comments to gather.
  2651. Comma-separated list of integers representing
  2652. \f[C]max-comments,max-parents,max-replies,max-replies-per-thread\f[R].
  2653. Default is \f[C]all,all,all,all\f[R]
  2654. .RS 2
  2655. .IP \[bu] 2
  2656. E.g.
  2657. \f[C]all,all,1000,10\f[R] will get a maximum of 1000 replies total, with
  2658. up to 10 replies per thread.
  2659. \f[C]1000,all,100\f[R] will get a maximum of 1000 comments, with a
  2660. maximum of 100 replies total
  2661. .RE
  2662. .IP \[bu] 2
  2663. \f[C]formats\f[R]: Change the types of formats to return.
  2664. \f[C]dashy\f[R] (convert HTTP to DASH), \f[C]duplicate\f[R] (identical
  2665. content but different URLs or protocol; includes \f[C]dashy\f[R]),
  2666. \f[C]incomplete\f[R] (cannot be downloaded completely - live dash and
  2667. post-live m3u8), \f[C]missing_pot\f[R] (include formats that require a
  2668. PO Token but are missing one)
  2669. .IP \[bu] 2
  2670. \f[C]innertube_host\f[R]: Innertube API host to use for all API
  2671. requests; e.g.
  2672. \f[C]studio.youtube.com\f[R], \f[C]youtubei.googleapis.com\f[R].
  2673. Note that cookies exported from one subdomain will not work on others
  2674. .IP \[bu] 2
  2675. \f[C]innertube_key\f[R]: Innertube API key to use for all API requests.
  2676. By default, no API key is used
  2677. .IP \[bu] 2
  2678. \f[C]raise_incomplete_data\f[R]: \f[C]Incomplete Data Received\f[R]
  2679. raises an error instead of reporting a warning
  2680. .IP \[bu] 2
  2681. \f[C]data_sync_id\f[R]: Overrides the account Data Sync ID used in
  2682. Innertube API requests.
  2683. This may be needed if you are using an account with
  2684. \f[C]youtube:player_skip=webpage,configs\f[R] or
  2685. \f[C]youtubetab:skip=webpage\f[R]
  2686. .IP \[bu] 2
  2687. \f[C]visitor_data\f[R]: Overrides the Visitor Data used in Innertube API
  2688. requests.
  2689. This should be used with \f[C]player_skip=webpage,configs\f[R] and
  2690. without cookies.
  2691. Note: this may have adverse effects if used improperly.
  2692. If a session from a browser is wanted, you should pass cookies instead
  2693. (which contain the Visitor ID)
  2694. .IP \[bu] 2
  2695. \f[C]po_token\f[R]: Proof of Origin (PO) Token(s) to use for requesting
  2696. video playback.
  2697. Comma seperated list of PO Tokens in the format
  2698. \f[C]CLIENT+PO_TOKEN\f[R], e.g.
  2699. \f[C]youtube:po_token=web+XXX,android+YYY\f[R]
  2700. .SS youtubetab (YouTube playlists, channels, feeds, etc.)
  2701. .IP \[bu] 2
  2702. \f[C]skip\f[R]: One or more of \f[C]webpage\f[R] (skip initial webpage
  2703. download), \f[C]authcheck\f[R] (allow the download of playlists
  2704. requiring authentication when no initial webpage is downloaded.
  2705. This may cause unwanted behavior, see
  2706. #1122 (https://github.com/yt-dlp/yt-dlp/pull/1122) for more details)
  2707. .IP \[bu] 2
  2708. \f[C]approximate_date\f[R]: Extract approximate \f[C]upload_date\f[R]
  2709. and \f[C]timestamp\f[R] in flat-playlist.
  2710. This may cause date-based filters to be slightly off
  2711. .SS generic
  2712. .IP \[bu] 2
  2713. \f[C]fragment_query\f[R]: Passthrough any query in mpd/m3u8 manifest
  2714. URLs to their fragments if no value is provided, or else apply the query
  2715. string given as \f[C]fragment_query=VALUE\f[R].
  2716. Note that if the stream has an HLS AES-128 key, then the query
  2717. parameters will be passed to the key URI as well, unless the
  2718. \f[C]key_query\f[R] extractor-arg is passed, or unless an external key
  2719. URI is provided via the \f[C]hls_key\f[R] extractor-arg.
  2720. Does not apply to ffmpeg
  2721. .IP \[bu] 2
  2722. \f[C]variant_query\f[R]: Passthrough the master m3u8 URL query to its
  2723. variant playlist URLs if no value is provided, or else apply the query
  2724. string given as \f[C]variant_query=VALUE\f[R]
  2725. .IP \[bu] 2
  2726. \f[C]key_query\f[R]: Passthrough the master m3u8 URL query to its HLS
  2727. AES-128 decryption key URI if no value is provided, or else apply the
  2728. query string given as \f[C]key_query=VALUE\f[R].
  2729. Note that this will have no effect if the key URI is provided via the
  2730. \f[C]hls_key\f[R] extractor-arg.
  2731. Does not apply to ffmpeg
  2732. .IP \[bu] 2
  2733. \f[C]hls_key\f[R]: An HLS AES-128 key URI \f[I]or\f[R] key (as hex), and
  2734. optionally the IV (as hex), in the form of \f[C](URI|KEY)[,IV]\f[R];
  2735. e.g.
  2736. \f[C]generic:hls_key=ABCDEF1234567980,0xFEDCBA0987654321\f[R].
  2737. Passing any of these values will force usage of the native HLS
  2738. downloader and override the corresponding values found in the m3u8
  2739. playlist
  2740. .IP \[bu] 2
  2741. \f[C]is_live\f[R]: Bypass live HLS detection and manually set
  2742. \f[C]live_status\f[R] - a value of \f[C]false\f[R] will set
  2743. \f[C]not_live\f[R], any other value (or no value) will set
  2744. \f[C]is_live\f[R]
  2745. .IP \[bu] 2
  2746. \f[C]impersonate\f[R]: Target(s) to try and impersonate with the initial
  2747. webpage request; e.g.
  2748. \f[C]generic:impersonate=safari,chrome-110\f[R].
  2749. Use \f[C]generic:impersonate\f[R] to impersonate any available target,
  2750. and use \f[C]generic:impersonate=false\f[R] to disable impersonation
  2751. (default)
  2752. .SS funimation
  2753. .IP \[bu] 2
  2754. \f[C]language\f[R]: Audio languages to extract, e.g.
  2755. \f[C]funimation:language=english,japanese\f[R]
  2756. .IP \[bu] 2
  2757. \f[C]version\f[R]: The video version to extract - \f[C]uncut\f[R] or
  2758. \f[C]simulcast\f[R]
  2759. .SS crunchyrollbeta (Crunchyroll)
  2760. .IP \[bu] 2
  2761. \f[C]hardsub\f[R]: One or more hardsub versions to extract (in order of
  2762. preference), or \f[C]all\f[R] (default: \f[C]None\f[R] = no hardsubs
  2763. will be extracted), e.g.
  2764. \f[C]crunchyrollbeta:hardsub=en-US,de-DE\f[R]
  2765. .SS vikichannel
  2766. .IP \[bu] 2
  2767. \f[C]video_types\f[R]: Types of videos to download - one or more of
  2768. \f[C]episodes\f[R], \f[C]movies\f[R], \f[C]clips\f[R],
  2769. \f[C]trailers\f[R]
  2770. .SS niconico
  2771. .IP \[bu] 2
  2772. \f[C]segment_duration\f[R]: Segment duration in milliseconds for HLS-DMC
  2773. formats.
  2774. Use it at your own risk since this feature \f[B]may result in your
  2775. account termination.\f[R]
  2776. .SS youtubewebarchive
  2777. .IP \[bu] 2
  2778. \f[C]check_all\f[R]: Try to check more at the cost of more requests.
  2779. One or more of \f[C]thumbnails\f[R], \f[C]captures\f[R]
  2780. .SS gamejolt
  2781. .IP \[bu] 2
  2782. \f[C]comment_sort\f[R]: \f[C]hot\f[R] (default), \f[C]you\f[R] (cookies
  2783. needed), \f[C]top\f[R], \f[C]new\f[R] - choose comment sorting mode (on
  2784. GameJolt\[aq]s side)
  2785. .SS hotstar
  2786. .IP \[bu] 2
  2787. \f[C]res\f[R]: resolution to ignore - one or more of \f[C]sd\f[R],
  2788. \f[C]hd\f[R], \f[C]fhd\f[R]
  2789. .IP \[bu] 2
  2790. \f[C]vcodec\f[R]: vcodec to ignore - one or more of \f[C]h264\f[R],
  2791. \f[C]h265\f[R], \f[C]dvh265\f[R]
  2792. .IP \[bu] 2
  2793. \f[C]dr\f[R]: dynamic range to ignore - one or more of \f[C]sdr\f[R],
  2794. \f[C]hdr10\f[R], \f[C]dv\f[R]
  2795. .SS niconicochannelplus
  2796. .IP \[bu] 2
  2797. \f[C]max_comments\f[R]: Maximum number of comments to extract - default
  2798. is \f[C]120\f[R]
  2799. .SS tiktok
  2800. .IP \[bu] 2
  2801. \f[C]api_hostname\f[R]: Hostname to use for mobile API calls, e.g.
  2802. \f[C]api22-normal-c-alisg.tiktokv.com\f[R]
  2803. .IP \[bu] 2
  2804. \f[C]app_name\f[R]: Default app name to use with mobile API calls, e.g.
  2805. \f[C]trill\f[R]
  2806. .IP \[bu] 2
  2807. \f[C]app_version\f[R]: Default app version to use with mobile API calls
  2808. - should be set along with \f[C]manifest_app_version\f[R], e.g.
  2809. \f[C]34.1.2\f[R]
  2810. .IP \[bu] 2
  2811. \f[C]manifest_app_version\f[R]: Default numeric app version to use with
  2812. mobile API calls, e.g.
  2813. \f[C]2023401020\f[R]
  2814. .IP \[bu] 2
  2815. \f[C]aid\f[R]: Default app ID to use with mobile API calls, e.g.
  2816. \f[C]1180\f[R]
  2817. .IP \[bu] 2
  2818. \f[C]app_info\f[R]: Enable mobile API extraction with one or more app
  2819. info strings in the format of
  2820. \f[C]<iid>/[app_name]/[app_version]/[manifest_app_version]/[aid]\f[R],
  2821. where \f[C]iid\f[R] is the unique app install ID.
  2822. \f[C]iid\f[R] is the only required value; all other values and their
  2823. \f[C]/\f[R] separators can be omitted, e.g.
  2824. \f[C]tiktok:app_info=1234567890123456789\f[R] or
  2825. \f[C]tiktok:app_info=123,456/trill///1180,789//34.0.1/340001\f[R]
  2826. .IP \[bu] 2
  2827. \f[C]device_id\f[R]: Enable mobile API extraction with a genuine device
  2828. ID to be used with mobile API calls.
  2829. Default is a random 19-digit string
  2830. .SS rokfinchannel
  2831. .IP \[bu] 2
  2832. \f[C]tab\f[R]: Which tab to download - one of \f[C]new\f[R],
  2833. \f[C]top\f[R], \f[C]videos\f[R], \f[C]podcasts\f[R], \f[C]streams\f[R],
  2834. \f[C]stacks\f[R]
  2835. .SS twitter
  2836. .IP \[bu] 2
  2837. \f[C]api\f[R]: Select one of \f[C]graphql\f[R] (default),
  2838. \f[C]legacy\f[R] or \f[C]syndication\f[R] as the API for tweet
  2839. extraction.
  2840. Has no effect if logged in
  2841. .SS stacommu, wrestleuniverse
  2842. .IP \[bu] 2
  2843. \f[C]device_id\f[R]: UUID value assigned by the website and used to
  2844. enforce device limits for paid livestream content.
  2845. Can be found in browser local storage
  2846. .SS twitch
  2847. .IP \[bu] 2
  2848. \f[C]client_id\f[R]: Client ID value to be sent with GraphQL requests,
  2849. e.g.
  2850. \f[C]twitch:client_id=kimne78kx3ncx6brgo4mv6wki5h1ko\f[R]
  2851. .SS nhkradirulive (NHK \[u3089]\[u3058]\[u308B]\[u2605]\[u3089]\[u3058]\[u308B] LIVE)
  2852. .IP \[bu] 2
  2853. \f[C]area\f[R]: Which regional variation to extract.
  2854. Valid areas are: \f[C]sapporo\f[R], \f[C]sendai\f[R], \f[C]tokyo\f[R],
  2855. \f[C]nagoya\f[R], \f[C]osaka\f[R], \f[C]hiroshima\f[R],
  2856. \f[C]matsuyama\f[R], \f[C]fukuoka\f[R].
  2857. Defaults to \f[C]tokyo\f[R]
  2858. .SS nflplusreplay
  2859. .IP \[bu] 2
  2860. \f[C]type\f[R]: Type(s) of game replays to extract.
  2861. Valid types are: \f[C]full_game\f[R], \f[C]full_game_spanish\f[R],
  2862. \f[C]condensed_game\f[R] and \f[C]all_22\f[R].
  2863. You can use \f[C]all\f[R] to extract all available replay types, which
  2864. is the default
  2865. .SS jiocinema
  2866. .IP \[bu] 2
  2867. \f[C]refresh_token\f[R]: The \f[C]refreshToken\f[R] UUID from browser
  2868. local storage can be passed to extend the life of your login session
  2869. when logging in with \f[C]token\f[R] as username and the
  2870. \f[C]accessToken\f[R] from browser local storage as password
  2871. .SS jiosaavn
  2872. .IP \[bu] 2
  2873. \f[C]bitrate\f[R]: Audio bitrates to request.
  2874. One or more of \f[C]16\f[R], \f[C]32\f[R], \f[C]64\f[R], \f[C]128\f[R],
  2875. \f[C]320\f[R].
  2876. Default is \f[C]128,320\f[R]
  2877. .SS afreecatvlive
  2878. .IP \[bu] 2
  2879. \f[C]cdn\f[R]: One or more CDN IDs to use with the API call for stream
  2880. URLs, e.g.
  2881. \f[C]gcp_cdn\f[R], \f[C]gs_cdn_pc_app\f[R], \f[C]gs_cdn_mobile_web\f[R],
  2882. \f[C]gs_cdn_pc_web\f[R]
  2883. .SS soundcloud
  2884. .IP \[bu] 2
  2885. \f[C]formats\f[R]: Formats to request from the API.
  2886. Requested values should be in the format of
  2887. \f[C]{protocol}_{codec}\f[R], e.g.
  2888. \f[C]hls_opus,http_aac\f[R].
  2889. The \f[C]*\f[R] character functions as a wildcard, e.g.
  2890. \f[C]*_mp3\f[R], and can be passed by itself to request all formats.
  2891. Known protocols include \f[C]http\f[R], \f[C]hls\f[R] and
  2892. \f[C]hls-aes\f[R]; known codecs include \f[C]aac\f[R], \f[C]opus\f[R]
  2893. and \f[C]mp3\f[R].
  2894. Original \f[C]download\f[R] formats are always extracted.
  2895. Default is
  2896. \f[C]http_aac,hls_aac,http_opus,hls_opus,http_mp3,hls_mp3\f[R]
  2897. .SS orfon (orf:on)
  2898. .IP \[bu] 2
  2899. \f[C]prefer_segments_playlist\f[R]: Prefer a playlist of program
  2900. segments instead of a single complete video when available.
  2901. If individual segments are desired, use
  2902. \f[C]--concat-playlist never --extractor-args \[dq]orfon:prefer_segments_playlist\[dq]\f[R]
  2903. .SS bilibili
  2904. .IP \[bu] 2
  2905. \f[C]prefer_multi_flv\f[R]: Prefer extracting flv formats over mp4 for
  2906. older videos that still provide legacy formats
  2907. .SS sonylivseries
  2908. .IP \[bu] 2
  2909. \f[C]sort_order\f[R]: Episode sort order for series extraction - one of
  2910. \f[C]asc\f[R] (ascending, oldest first) or \f[C]desc\f[R] (descending,
  2911. newest first).
  2912. Default is \f[C]asc\f[R]
  2913. .PP
  2914. \f[B]Note\f[R]: These options may be changed/removed in the future
  2915. without concern for backward compatibility
  2916. .SH INSTALLATION
  2917. .PP
  2918. You can install yt-dlp using the binaries,
  2919. pip (https://pypi.org/project/yt-dlp) or one using a third-party package
  2920. manager.
  2921. See the wiki (https://github.com/yt-dlp/yt-dlp/wiki/Installation) for
  2922. detailed instructions
  2923. .PP
  2924. \f[B]Note\f[R]: The manpages, shell completion (autocomplete) files etc.
  2925. are available inside the source
  2926. tarball (https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)
  2927. .SS UPDATE
  2928. .PP
  2929. You can use \f[C]yt-dlp -U\f[R] to update if you are using the release
  2930. binaries
  2931. .PP
  2932. If you installed with
  2933. pip (https://github.com/yt-dlp/yt-dlp/wiki/Installation#with-pip),
  2934. simply re-run the same command that was used to install the program
  2935. .PP
  2936. For other third-party package managers, see the
  2937. wiki (https://github.com/yt-dlp/yt-dlp/wiki/Installation#third-party-package-managers)
  2938. or refer to their documentation
  2939. .PP
  2940. .PP
  2941. There are currently three release channels for binaries:
  2942. \f[C]stable\f[R], \f[C]nightly\f[R] and \f[C]master\f[R].
  2943. .IP \[bu] 2
  2944. \f[C]stable\f[R] is the default channel, and many of its changes have
  2945. been tested by users of the \f[C]nightly\f[R] and \f[C]master\f[R]
  2946. channels.
  2947. .IP \[bu] 2
  2948. The \f[C]nightly\f[R] channel has releases scheduled to build every day
  2949. around midnight UTC, for a snapshot of the project\[aq]s new patches and
  2950. changes.
  2951. This is the \f[B]recommended channel for regular users\f[R] of yt-dlp.
  2952. The \f[C]nightly\f[R] releases are available from
  2953. yt-dlp/yt-dlp-nightly-builds (https://github.com/yt-dlp/yt-dlp-nightly-builds/releases)
  2954. or as development releases of the \f[C]yt-dlp\f[R] PyPI package (which
  2955. can be installed with pip\[aq]s \f[C]--pre\f[R] flag).
  2956. .IP \[bu] 2
  2957. The \f[C]master\f[R] channel features releases that are built after each
  2958. push to the master branch, and these will have the very latest fixes and
  2959. additions, but may also be more prone to regressions.
  2960. They are available from
  2961. yt-dlp/yt-dlp-master-builds (https://github.com/yt-dlp/yt-dlp-master-builds/releases).
  2962. .PP
  2963. When using \f[C]--update\f[R]/\f[C]-U\f[R], a release binary will only
  2964. update to its current channel.
  2965. \f[C]--update-to CHANNEL\f[R] can be used to switch to a different
  2966. channel when a newer version is available.
  2967. \f[C]--update-to [CHANNEL\[at]]TAG\f[R] can also be used to upgrade or
  2968. downgrade to specific tags from a channel.
  2969. .PP
  2970. You may also use \f[C]--update-to <repository>\f[R]
  2971. (\f[C]<owner>/<repository>\f[R]) to update to a channel on a completely
  2972. different repository.
  2973. Be careful with what repository you are updating to though, there is no
  2974. verification done for binaries from different repositories.
  2975. .PP
  2976. Example usage:
  2977. .IP \[bu] 2
  2978. \f[C]yt-dlp --update-to master\f[R] switch to the \f[C]master\f[R]
  2979. channel and update to its latest release
  2980. .IP \[bu] 2
  2981. \f[C]yt-dlp --update-to stable\[at]2023.07.06\f[R] upgrade/downgrade to
  2982. release to \f[C]stable\f[R] channel tag \f[C]2023.07.06\f[R]
  2983. .IP \[bu] 2
  2984. \f[C]yt-dlp --update-to 2023.10.07\f[R] upgrade/downgrade to tag
  2985. \f[C]2023.10.07\f[R] if it exists on the current channel
  2986. .IP \[bu] 2
  2987. \f[C]yt-dlp --update-to example/yt-dlp\[at]2023.09.24\f[R]
  2988. upgrade/downgrade to the release from the \f[C]example/yt-dlp\f[R]
  2989. repository, tag \f[C]2023.09.24\f[R]
  2990. .PP
  2991. \f[B]Important\f[R]: Any user experiencing an issue with the
  2992. \f[C]stable\f[R] release should install or update to the
  2993. \f[C]nightly\f[R] release before submitting a bug report:
  2994. .IP
  2995. .nf
  2996. \f[C]
  2997. # To update to nightly from stable executable/binary:
  2998. yt-dlp --update-to nightly
  3000. # To install nightly with pip:
  3001. python3 -m pip install -U --pre \[dq]yt-dlp[default]\[dq]
  3002. \f[R]
  3003. .fi
  3004. .SS DEPENDENCIES
  3005. .PP
  3006. Python versions 3.9+ (CPython) and 3.10+ (PyPy) are supported.
  3007. Other versions and implementations may or may not work correctly.
  3008. .PP
  3009. While all the other dependencies are optional, \f[C]ffmpeg\f[R] and
  3010. \f[C]ffprobe\f[R] are highly recommended
  3011. .SS Strongly recommended
  3012. .IP \[bu] 2
  3013. \f[B]ffmpeg\f[R] and \f[B]ffprobe\f[R] (https://www.ffmpeg.org) -
  3014. Required for merging separate video and audio files, as well as for
  3015. various post-processing tasks.
  3016. License depends on the build (https://www.ffmpeg.org/legal.html)
  3017. .RS 2
  3018. .PP
  3019. There are bugs in ffmpeg that cause various issues when used alongside
  3020. yt-dlp.
  3021. Since ffmpeg is such an important dependency, we provide custom
  3022. builds (https://github.com/yt-dlp/FFmpeg-Builds#ffmpeg-static-auto-builds)
  3023. with patches for some of these issues at
  3024. yt-dlp/FFmpeg-Builds (https://github.com/yt-dlp/FFmpeg-Builds).
  3025. See the readme (https://github.com/yt-dlp/FFmpeg-Builds#patches-applied)
  3026. for details on the specific issues solved by these builds
  3027. .PP
  3028. \f[B]Important\f[R]: What you need is ffmpeg \f[I]binary\f[R],
  3029. \f[B]NOT\f[R] the Python package of the same
  3030. name (https://pypi.org/project/ffmpeg)
  3031. .RE
  3032. .SS Networking
  3033. .IP \[bu] 2
  3034. \f[B]certifi\f[R] (https://github.com/certifi/python-certifi)* -
  3035. Provides Mozilla\[aq]s root certificate bundle.
  3036. Licensed under
  3037. MPLv2 (https://github.com/certifi/python-certifi/blob/master/LICENSE)
  3038. .IP \[bu] 2
  3039. \f[B]brotli\f[R] (https://github.com/google/brotli)* or
  3040. \f[B]brotlicffi\f[R] (https://github.com/python-hyper/brotlicffi) -
  3041. Brotli (https://en.wikipedia.org/wiki/Brotli) content encoding support.
  3042. Both licensed under MIT
  3043. 1 (https://github.com/google/brotli/blob/master/LICENSE)
  3044. 2 (https://github.com/python-hyper/brotlicffi/blob/master/LICENSE)
  3045. .IP \[bu] 2
  3046. \f[B]websockets\f[R] (https://github.com/aaugustin/websockets)* - For
  3047. downloading over websocket.
  3048. Licensed under
  3049. BSD-3-Clause (https://github.com/aaugustin/websockets/blob/main/LICENSE)
  3050. .IP \[bu] 2
  3051. \f[B]requests\f[R] (https://github.com/psf/requests)* - HTTP library.
  3052. For HTTPS proxy and persistent connections support.
  3053. Licensed under
  3054. Apache-2.0 (https://github.com/psf/requests/blob/main/LICENSE)
  3055. .SS Impersonation
  3056. .PP
  3057. The following provide support for impersonating browser requests.
  3058. This may be required for some sites that employ TLS fingerprinting.
  3059. .IP \[bu] 2
  3060. \f[B]curl_cffi\f[R] (https://github.com/lexiforest/curl_cffi)
  3061. (recommended) - Python binding for
  3062. curl-impersonate (https://github.com/lexiforest/curl-impersonate).
  3063. Provides impersonation targets for Chrome, Edge and Safari.
  3064. Licensed under
  3065. MIT (https://github.com/lexiforest/curl_cffi/blob/main/LICENSE)
  3066. .RS 2
  3067. .IP \[bu] 2
  3068. Can be installed with the \f[C]curl-cffi\f[R] group, e.g.
  3069. \f[C]pip install \[dq]yt-dlp[default,curl-cffi]\[dq]\f[R]
  3070. .IP \[bu] 2
  3071. Currently included in \f[C]yt-dlp.exe\f[R], \f[C]yt-dlp_linux\f[R] and
  3072. \f[C]yt-dlp_macos\f[R] builds
  3073. .RE
  3074. .SS Metadata
  3075. .IP \[bu] 2
  3076. \f[B]mutagen\f[R] (https://github.com/quodlibet/mutagen)* - For
  3077. \f[C]--embed-thumbnail\f[R] in certain formats.
  3078. Licensed under
  3079. GPLv2+ (https://github.com/quodlibet/mutagen/blob/master/COPYING)
  3080. .IP \[bu] 2
  3081. \f[B]AtomicParsley\f[R] (https://github.com/wez/atomicparsley) - For
  3082. \f[C]--embed-thumbnail\f[R] in \f[C]mp4\f[R]/\f[C]m4a\f[R] files when
  3083. \f[C]mutagen\f[R]/\f[C]ffmpeg\f[R] cannot.
  3084. Licensed under
  3085. GPLv2+ (https://github.com/wez/atomicparsley/blob/master/COPYING)
  3086. .IP \[bu] 2
  3087. \f[B]xattr\f[R] (https://github.com/xattr/xattr),
  3088. \f[B]pyxattr\f[R] (https://github.com/iustin/pyxattr) or
  3089. \f[B]setfattr\f[R] (http://savannah.nongnu.org/projects/attr) - For
  3090. writing xattr metadata (\f[C]--xattr\f[R]) on \f[B]Mac\f[R] and
  3091. \f[B]BSD\f[R].
  3092. Licensed under
  3093. MIT (https://github.com/xattr/xattr/blob/master/LICENSE.txt),
  3094. LGPL2.1 (https://github.com/iustin/pyxattr/blob/master/COPYING) and
  3095. GPLv2+ (http://git.savannah.nongnu.org/cgit/attr.git/tree/doc/COPYING)
  3096. respectively
  3097. .SS Misc
  3098. .IP \[bu] 2
  3099. \f[B]pycryptodomex\f[R] (https://github.com/Legrandin/pycryptodome)* -
  3100. For decrypting AES-128 HLS streams and various other data.
  3101. Licensed under
  3102. BSD-2-Clause (https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
  3103. .IP \[bu] 2
  3104. \f[B]phantomjs\f[R] (https://github.com/ariya/phantomjs) - Used in
  3105. extractors where javascript needs to be run.
  3106. Licensed under
  3107. BSD-3-Clause (https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD)
  3108. .IP \[bu] 2
  3109. \f[B]secretstorage\f[R] (https://github.com/mitya57/secretstorage)* -
  3110. For \f[C]--cookies-from-browser\f[R] to access the \f[B]Gnome\f[R]
  3111. keyring while decrypting cookies of \f[B]Chromium\f[R]-based browsers on
  3112. \f[B]Linux\f[R].
  3113. Licensed under
  3114. BSD-3-Clause (https://github.com/mitya57/secretstorage/blob/master/LICENSE)
  3115. .IP \[bu] 2
  3116. Any external downloader that you want to use with \f[C]--downloader\f[R]
  3117. .SS Deprecated
  3118. .IP \[bu] 2
  3119. \f[B]avconv\f[R] and \f[B]avprobe\f[R] (https://www.libav.org) - Now
  3120. \f[B]deprecated\f[R] alternative to ffmpeg.
  3121. License depends on the build (https://libav.org/legal)
  3122. .IP \[bu] 2
  3123. \f[B]sponskrub\f[R] (https://github.com/faissaloo/SponSkrub) - For using
  3124. the now \f[B]deprecated\f[R] sponskrub options.
  3125. Licensed under
  3126. GPLv3+ (https://github.com/faissaloo/SponSkrub/blob/master/LICENCE.md)
  3127. .IP \[bu] 2
  3128. \f[B]rtmpdump\f[R] (http://rtmpdump.mplayerhq.hu) - For downloading
  3129. \f[C]rtmp\f[R] streams.
  3130. ffmpeg can be used instead with \f[C]--downloader ffmpeg\f[R].
  3131. Licensed under GPLv2+ (http://rtmpdump.mplayerhq.hu)
  3132. .IP \[bu] 2
  3133. \f[B]mplayer\f[R] (http://mplayerhq.hu/design7/info.html) or
  3134. \f[B]mpv\f[R] (https://mpv.io) - For downloading
  3135. \f[C]rstp\f[R]/\f[C]mms\f[R] streams.
  3136. ffmpeg can be used instead with \f[C]--downloader ffmpeg\f[R].
  3137. Licensed under
  3138. GPLv2+ (https://github.com/mpv-player/mpv/blob/master/Copyright)
  3139. .PP
  3140. To use or redistribute the dependencies, you must agree to their
  3141. respective licensing terms.
  3142. .PP
  3143. The standalone release binaries are built with the Python interpreter
  3144. and the packages marked with \f[B]*\f[R] included.
  3145. .PP
  3146. If you do not have the necessary dependencies for a task you are
  3147. attempting, yt-dlp will warn you.
  3148. All the currently available dependencies are visible at the top of the
  3149. \f[C]--verbose\f[R] output
  3150. .SS COMPILE
  3151. .SS Standalone PyInstaller Builds
  3152. .PP
  3153. To build the standalone executable, you must have Python and
  3154. \f[C]pyinstaller\f[R] (plus any of yt-dlp\[aq]s optional dependencies if
  3155. needed).
  3156. The executable will be built for the same CPU architecture as the Python
  3157. used.
  3158. .PP
  3159. You can run the following commands:
  3160. .IP
  3161. .nf
  3162. \f[C]
  3163. python3 devscripts/install_deps.py --include pyinstaller
  3164. python3 devscripts/make_lazy_extractors.py
  3165. python3 -m bundle.pyinstaller
  3166. \f[R]
  3167. .fi
  3168. .PP
  3169. On some systems, you may need to use \f[C]py\f[R] or \f[C]python\f[R]
  3170. instead of \f[C]python3\f[R].
  3171. .PP
  3172. \f[C]python -m bundle.pyinstaller\f[R] accepts any arguments that can be
  3173. passed to \f[C]pyinstaller\f[R], such as \f[C]--onefile/-F\f[R] or
  3174. \f[C]--onedir/-D\f[R], which is further documented
  3175. here (https://pyinstaller.org/en/stable/usage.html#what-to-generate).
  3176. .PP
  3177. \f[B]Note\f[R]: Pyinstaller versions below 4.4 do not
  3178. support (https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms)
  3179. Python installed from the Windows store without using a virtual
  3180. environment.
  3181. .PP
  3182. \f[B]Important\f[R]: Running \f[C]pyinstaller\f[R] directly \f[B]instead
  3183. of\f[R] using \f[C]python -m bundle.pyinstaller\f[R] is \f[B]not\f[R]
  3184. officially supported.
  3185. This may or may not work correctly.
  3186. .SS Platform-independent Binary (UNIX)
  3187. .PP
  3188. You will need the build tools \f[C]python\f[R] (3.9+), \f[C]zip\f[R],
  3189. \f[C]make\f[R] (GNU), \f[C]pandoc\f[R]* and \f[C]pytest\f[R]*.
  3190. .PP
  3191. After installing these, simply run \f[C]make\f[R].
  3192. .PP
  3193. You can also run \f[C]make yt-dlp\f[R] instead to compile only the
  3194. binary without updating any of the additional files.
  3195. (The build tools marked with \f[B]*\f[R] are not needed for this)
  3196. .SS Related scripts
  3197. .IP \[bu] 2
  3198. \f[B]\f[CB]devscripts/install_deps.py\f[B]\f[R] - Install dependencies
  3199. for yt-dlp.
  3200. .IP \[bu] 2
  3201. \f[B]\f[CB]devscripts/update-version.py\f[B]\f[R] - Update the version
  3202. number based on the current date.
  3203. .IP \[bu] 2
  3204. \f[B]\f[CB]devscripts/set-variant.py\f[B]\f[R] - Set the build variant
  3205. of the executable.
  3206. .IP \[bu] 2
  3207. \f[B]\f[CB]devscripts/make_changelog.py\f[B]\f[R] - Create a markdown
  3208. changelog using short commit messages and update \f[C]CONTRIBUTORS\f[R]
  3209. file.
  3210. .IP \[bu] 2
  3211. \f[B]\f[CB]devscripts/make_lazy_extractors.py\f[B]\f[R] - Create lazy
  3212. extractors.
  3213. Running this before building the binaries (any variant) will improve
  3214. their startup performance.
  3215. Set the environment variable \f[C]YTDLP_NO_LAZY_EXTRACTORS\f[R] to
  3216. something nonempty to forcefully disable lazy extractor loading.
  3217. .PP
  3218. Note: See their \f[C]--help\f[R] for more info.
  3219. .SS Forking the project
  3220. .PP
  3221. If you fork the project on GitHub, you can run your fork\[aq]s build
  3222. workflow to automatically build the selected version(s) as artifacts.
  3223. Alternatively, you can run the release workflow or enable the nightly
  3224. workflow to create full (pre-)releases.
  3225. .SH PLUGINS
  3226. .PP
  3227. Note that \f[B]all\f[R] plugins are imported even if not invoked, and
  3228. that \f[B]there are no checks\f[R] performed on plugin code.
  3229. \f[B]Use plugins at your own risk and only if you trust the code!\f[R]
  3230. .PP
  3231. Plugins can be of \f[C]<type>\f[R]s \f[C]extractor\f[R] or
  3232. \f[C]postprocessor\f[R].
  3233. - Extractor plugins do not need to be enabled from the CLI and are
  3234. automatically invoked when the input URL is suitable for it.
  3235. - Extractor plugins take priority over built-in extractors.
  3236. - Postprocessor plugins can be invoked using
  3237. \f[C]--use-postprocessor NAME\f[R].
  3238. .PP
  3239. Plugins are loaded from the namespace packages
  3240. \f[C]yt_dlp_plugins.extractor\f[R] and
  3241. \f[C]yt_dlp_plugins.postprocessor\f[R].
  3242. .PP
  3243. In other words, the file structure on the disk looks something like:
  3244. .IP
  3245. .nf
  3246. \f[C]
  3247.     yt_dlp_plugins/
  3248.         extractor/
  3249.             myplugin.py
  3250.         postprocessor/
  3251.             myplugin.py
  3252. \f[R]
  3253. .fi
  3254. .PP
  3255. yt-dlp looks for these \f[C]yt_dlp_plugins\f[R] namespace folders in
  3256. many locations (see below) and loads in plugins from \f[B]all\f[R] of
  3257. them.
  3258. Set the environment variable \f[C]YTDLP_NO_PLUGINS\f[R] to something
  3259. nonempty to disable loading plugins entirely.
  3260. .PP
  3261. See the wiki for some known
  3262. plugins (https://github.com/yt-dlp/yt-dlp/wiki/Plugins)
  3263. .SS Installing Plugins
  3264. .PP
  3265. Plugins can be installed using various methods and locations.
  3266. .IP "1." 3
  3267. \f[B]Configuration directories\f[R]: Plugin packages (containing a
  3268. \f[C]yt_dlp_plugins\f[R] namespace folder) can be dropped into the
  3269. following standard configuration locations:
  3270. .RS 4
  3271. .IP \[bu] 2
  3272. \f[B]User Plugins\f[R]
  3273. .RS 2
  3274. .IP \[bu] 2
  3275. \f[C]${XDG_CONFIG_HOME}/yt-dlp/plugins/<package name>/yt_dlp_plugins/\f[R]
  3276. (recommended on Linux/macOS)
  3277. .IP \[bu] 2
  3278. \f[C]${XDG_CONFIG_HOME}/yt-dlp-plugins/<package name>/yt_dlp_plugins/\f[R]
  3279. .IP \[bu] 2
  3280. \f[C]${APPDATA}/yt-dlp/plugins/<package name>/yt_dlp_plugins/\f[R]
  3281. (recommended on Windows)
  3282. .IP \[bu] 2
  3283. \f[C]${APPDATA}/yt-dlp-plugins/<package name>/yt_dlp_plugins/\f[R]
  3284. .IP \[bu] 2
  3285. \f[C]\[ti]/.yt-dlp/plugins/<package name>/yt_dlp_plugins/\f[R]
  3286. .IP \[bu] 2
  3287. \f[C]\[ti]/yt-dlp-plugins/<package name>/yt_dlp_plugins/\f[R]
  3288. .RE
  3289. .IP \[bu] 2
  3290. \f[B]System Plugins\f[R]
  3291. .RS 2
  3292. .IP \[bu] 2
  3293. \f[C]/etc/yt-dlp/plugins/<package name>/yt_dlp_plugins/\f[R]
  3294. .IP \[bu] 2
  3295. \f[C]/etc/yt-dlp-plugins/<package name>/yt_dlp_plugins/\f[R]
  3296. .RE
  3297. .RE
  3298. .IP "2." 3
  3299. \f[B]Executable location\f[R]: Plugin packages can similarly be
  3300. installed in a \f[C]yt-dlp-plugins\f[R] directory under the executable
  3301. location (recommended for portable installations):
  3302. .RS 4
  3303. .IP \[bu] 2
  3304. Binary: where \f[C]<root-dir>/yt-dlp.exe\f[R],
  3305. \f[C]<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/\f[R]
  3306. .IP \[bu] 2
  3307. Source: where \f[C]<root-dir>/yt_dlp/__main__.py\f[R],
  3308. \f[C]<root-dir>/yt-dlp-plugins/<package name>/yt_dlp_plugins/\f[R]
  3309. .RE
  3310. .IP "3." 3
  3311. \f[B]pip and other locations in \f[CB]PYTHONPATH\f[B]\f[R]
  3312. .RS 4
  3313. .IP \[bu] 2
  3314. Plugin packages can be installed and managed using \f[C]pip\f[R].
  3315. See
  3316. yt-dlp-sample-plugins (https://github.com/yt-dlp/yt-dlp-sample-plugins)
  3317. for an example.
  3318. .RS 2
  3319. .IP \[bu] 2
  3320. Note: plugin files between plugin packages installed with pip must have
  3321. unique filenames.
  3322. .RE
  3323. .IP \[bu] 2
  3324. Any path in \f[C]PYTHONPATH\f[R] is searched in for the
  3325. \f[C]yt_dlp_plugins\f[R] namespace folder.
  3326. .RS 2
  3327. .IP \[bu] 2
  3328. Note: This does not apply for Pyinstaller builds.
  3329. .RE
  3330. .RE
  3331. .PP
  3332. \f[C].zip\f[R], \f[C].egg\f[R] and \f[C].whl\f[R] archives containing a
  3333. \f[C]yt_dlp_plugins\f[R] namespace folder in their root are also
  3334. supported as plugin packages.
  3335. .IP \[bu] 2
  3336. e.g.
  3337. \f[C]${XDG_CONFIG_HOME}/yt-dlp/plugins/mypluginpkg.zip\f[R] where
  3338. \f[C]mypluginpkg.zip\f[R] contains
  3339. \f[C]yt_dlp_plugins/<type>/myplugin.py\f[R]
  3340. .PP
  3341. Run yt-dlp with \f[C]--verbose\f[R] to check if the plugin has been
  3342. loaded.
  3343. .SS Developing Plugins
  3344. .PP
  3345. See the
  3346. yt-dlp-sample-plugins (https://github.com/yt-dlp/yt-dlp-sample-plugins)
  3347. repo for a template plugin package and the Plugin
  3348. Development (https://github.com/yt-dlp/yt-dlp/wiki/Plugin-Development)
  3349. section of the wiki for a plugin development guide.
  3350. .PP
  3351. All public classes with a name ending in \f[C]IE\f[R]/\f[C]PP\f[R] are
  3352. imported from each file for extractors and postprocessors respectively.
  3353. This respects underscore prefix (e.g.
  3354. \f[C]_MyBasePluginIE\f[R] is private) and \f[C]__all__\f[R].
  3355. Modules can similarly be excluded by prefixing the module name with an
  3356. underscore (e.g.
  3357. \f[C]_myplugin.py\f[R]).
  3358. .PP
  3359. To replace an existing extractor with a subclass of one, set the
  3360. \f[C]plugin_name\f[R] class keyword argument (e.g.
  3361. \f[C]class MyPluginIE(ABuiltInIE, plugin_name=\[aq]myplugin\[aq])\f[R]
  3362. will replace \f[C]ABuiltInIE\f[R] with \f[C]MyPluginIE\f[R]).
  3363. Since the extractor replaces the parent, you should exclude the subclass
  3364. extractor from being imported separately by making it private using one
  3365. of the methods described above.
  3366. .PP
  3367. If you are a plugin author, add
  3368. yt-dlp-plugins (https://github.com/topics/yt-dlp-plugins) as a topic to
  3369. your repository for discoverability.
  3370. .PP
  3371. See the Developer
  3372. Instructions (https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions)
  3373. on how to write and test an extractor.
  3374. .SH EMBEDDING YT-DLP
  3375. .PP
  3376. yt-dlp makes the best effort to be a good command-line program, and thus
  3377. should be callable from any programming language.
  3378. .PP
  3379. Your program should avoid parsing the normal stdout since they may
  3380. change in future versions.
  3381. Instead, they should use options such as \f[C]-J\f[R],
  3382. \f[C]--print\f[R], \f[C]--progress-template\f[R], \f[C]--exec\f[R] etc
  3383. to create console output that you can reliably reproduce and parse.
  3384. .PP
  3385. From a Python program, you can embed yt-dlp in a more powerful fashion,
  3386. like this:
  3387. .IP
  3388. .nf
  3389. \f[C]
  3390. from yt_dlp import YoutubeDL
  3392. URLS = [\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]]
  3393. with YoutubeDL() as ydl:
  3394.     ydl.download(URLS)
  3395. \f[R]
  3396. .fi
  3397. .PP
  3398. Most likely, you\[aq]ll want to use various options.
  3399. For a list of options available, have a look at
  3400. \f[C]yt_dlp/YoutubeDL.py\f[R] or \f[C]help(yt_dlp.YoutubeDL)\f[R] in a
  3401. Python shell.
  3402. If you are already familiar with the CLI, you can use
  3403. \f[C]devscripts/cli_to_api.py\f[R] (https://github.com/yt-dlp/yt-dlp/blob/master/devscripts/cli_to_api.py)
  3404. to translate any CLI switches to \f[C]YoutubeDL\f[R] params.
  3405. .PP
  3406. \f[B]Tip\f[R]: If you are porting your code from youtube-dl to yt-dlp,
  3407. one important point to look out for is that we do not guarantee the
  3408. return value of \f[C]YoutubeDL.extract_info\f[R] to be json
  3409. serializable, or even be a dictionary.
  3410. It will be dictionary-like, but if you want to ensure it is a
  3411. serializable dictionary, pass it through
  3412. \f[C]YoutubeDL.sanitize_info\f[R] as shown in the example below
  3413. .SS Embedding examples
  3414. .SS Extracting information
  3415. .IP
  3416. .nf
  3417. \f[C]
  3418. import json
  3419. import yt_dlp
  3421. URL = \[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]
  3423. # \[u2139]\[uFE0F] See help(yt_dlp.YoutubeDL) for a list of available options and public functions
  3424. ydl_opts = {}
  3425. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  3426.     info = ydl.extract_info(URL, download=False)
  3428.     # \[u2139]\[uFE0F] ydl.sanitize_info makes the info json-serializable
  3429.     print(json.dumps(ydl.sanitize_info(info)))
  3430. \f[R]
  3431. .fi
  3432. .SS Download using an info-json
  3433. .IP
  3434. .nf
  3435. \f[C]
  3436. import yt_dlp
  3438. INFO_FILE = \[aq]path/to/video.info.json\[aq]
  3440. with yt_dlp.YoutubeDL() as ydl:
  3441.     error_code = ydl.download_with_info_file(INFO_FILE)
  3443. print(\[aq]Some videos failed to download\[aq] if error_code
  3444.       else \[aq]All videos successfully downloaded\[aq])
  3445. \f[R]
  3446. .fi
  3447. .SS Extract audio
  3448. .IP
  3449. .nf
  3450. \f[C]
  3451. import yt_dlp
  3453. URLS = [\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]]
  3455. ydl_opts = {
  3456.     \[aq]format\[aq]: \[aq]m4a/bestaudio/best\[aq],
  3457.     # \[u2139]\[uFE0F] See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
  3458.     \[aq]postprocessors\[aq]: [{  # Extract audio using ffmpeg
  3459.         \[aq]key\[aq]: \[aq]FFmpegExtractAudio\[aq],
  3460.         \[aq]preferredcodec\[aq]: \[aq]m4a\[aq],
  3461.     }]
  3462. }
  3464. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  3465.     error_code = ydl.download(URLS)
  3466. \f[R]
  3467. .fi
  3468. .SS Filter videos
  3469. .IP
  3470. .nf
  3471. \f[C]
  3472. import yt_dlp
  3474. URLS = [\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]]
  3476. def longer_than_a_minute(info, *, incomplete):
  3477.     \[dq]\[dq]\[dq]Download only videos longer than a minute (or with unknown duration)\[dq]\[dq]\[dq]
  3478.     duration = info.get(\[aq]duration\[aq])
  3479.     if duration and duration < 60:
  3480.         return \[aq]The video is too short\[aq]
  3482. ydl_opts = {
  3483.     \[aq]match_filter\[aq]: longer_than_a_minute,
  3484. }
  3486. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  3487.     error_code = ydl.download(URLS)
  3488. \f[R]
  3489. .fi
  3490. .SS Adding logger and progress hook
  3491. .IP
  3492. .nf
  3493. \f[C]
  3494. import yt_dlp
  3496. URLS = [\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]]
  3498. class MyLogger:
  3499.     def debug(self, msg):
  3500.         # For compatibility with youtube-dl, both debug and info are passed into debug
  3501.         # You can distinguish them by the prefix \[aq][debug] \[aq]
  3502.         if msg.startswith(\[aq][debug] \[aq]):
  3503.             pass
  3504.         else:
  3505.             self.info(msg)
  3507.     def info(self, msg):
  3508.         pass
  3510.     def warning(self, msg):
  3511.         pass
  3513.     def error(self, msg):
  3514.         print(msg)
  3517. # \[u2139]\[uFE0F] See \[dq]progress_hooks\[dq] in help(yt_dlp.YoutubeDL)
  3518. def my_hook(d):
  3519.     if d[\[aq]status\[aq]] == \[aq]finished\[aq]:
  3520.         print(\[aq]Done downloading, now post-processing ...\[aq])
  3523. ydl_opts = {
  3524.     \[aq]logger\[aq]: MyLogger(),
  3525.     \[aq]progress_hooks\[aq]: [my_hook],
  3526. }
  3528. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  3529.     ydl.download(URLS)
  3530. \f[R]
  3531. .fi
  3532. .SS Add a custom PostProcessor
  3533. .IP
  3534. .nf
  3535. \f[C]
  3536. import yt_dlp
  3538. URLS = [\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]]
  3540. # \[u2139]\[uFE0F] See help(yt_dlp.postprocessor.PostProcessor)
  3541. class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
  3542.     def run(self, info):
  3543.         self.to_screen(\[aq]Doing stuff\[aq])
  3544.         return [], info
  3547. with yt_dlp.YoutubeDL() as ydl:
  3548.     # \[u2139]\[uFE0F] \[dq]when\[dq] can take any value in yt_dlp.utils.POSTPROCESS_WHEN
  3549.     ydl.add_post_processor(MyCustomPP(), when=\[aq]pre_process\[aq])
  3550.     ydl.download(URLS)
  3551. \f[R]
  3552. .fi
  3553. .SS Use a custom format selector
  3554. .IP
  3555. .nf
  3556. \f[C]
  3557. import yt_dlp
  3559. URLS = [\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]]
  3561. def format_selector(ctx):
  3562.     \[dq]\[dq]\[dq] Select the best video and the best audio that won\[aq]t result in an mkv.
  3563.     NOTE: This is just an example and does not handle all cases \[dq]\[dq]\[dq]
  3565.     # formats are already sorted worst to best
  3566.     formats = ctx.get(\[aq]formats\[aq])[::-1]
  3568.     # acodec=\[aq]none\[aq] means there is no audio
  3569.     best_video = next(f for f in formats
  3570.                       if f[\[aq]vcodec\[aq]] != \[aq]none\[aq] and f[\[aq]acodec\[aq]] == \[aq]none\[aq])
  3572.     # find compatible audio extension
  3573.     audio_ext = {\[aq]mp4\[aq]: \[aq]m4a\[aq], \[aq]webm\[aq]: \[aq]webm\[aq]}[best_video[\[aq]ext\[aq]]]
  3574.     # vcodec=\[aq]none\[aq] means there is no video
  3575.     best_audio = next(f for f in formats if (
  3576.         f[\[aq]acodec\[aq]] != \[aq]none\[aq] and f[\[aq]vcodec\[aq]] == \[aq]none\[aq] and f[\[aq]ext\[aq]] == audio_ext))
  3578.     # These are the minimum required fields for a merged format
  3579.     yield {
  3580.         \[aq]format_id\[aq]: f\[aq]{best_video[\[dq]format_id\[dq]]}+{best_audio[\[dq]format_id\[dq]]}\[aq],
  3581.         \[aq]ext\[aq]: best_video[\[aq]ext\[aq]],
  3582.         \[aq]requested_formats\[aq]: [best_video, best_audio],
  3583.         # Must be + separated list of protocols
  3584.         \[aq]protocol\[aq]: f\[aq]{best_video[\[dq]protocol\[dq]]}+{best_audio[\[dq]protocol\[dq]]}\[aq]
  3585.     }
  3588. ydl_opts = {
  3589.     \[aq]format\[aq]: format_selector,
  3590. }
  3592. with yt_dlp.YoutubeDL(ydl_opts) as ydl:
  3593.     ydl.download(URLS)
  3594. \f[R]
  3595. .fi
  3596. .SH CHANGES FROM YOUTUBE-DL
  3597. .SS New features
  3598. .IP \[bu] 2
  3599. Forked from
  3600. \f[B]yt-dlc\[at]f9401f2\f[R] (https://github.com/blackjack4494/yt-dlc/commit/f9401f2a91987068139c5f757b12fc711d4c0cee)
  3601. and merged with
  3602. \f[B]youtube-dl\[at]a08f2b7\f[R] (https://github.com/ytdl-org/youtube-dl/commit/a08f2b7e4567cdc50c0614ee0a4ffdff49b8b6e6)
  3603. (exceptions (https://github.com/yt-dlp/yt-dlp/issues/21))
  3604. .IP \[bu] 2
  3605. \f[B]SponsorBlock Integration\f[R]: You can mark/remove sponsor sections
  3606. in YouTube videos by utilizing the
  3607. SponsorBlock (https://sponsor.ajay.app) API
  3608. .IP \[bu] 2
  3609. \f[B]Format Sorting\f[R]: The default format sorting options have been
  3610. changed so that higher resolution and better codecs will be now
  3611. preferred instead of simply using larger bitrate.
  3612. Furthermore, you can now specify the sort order using \f[C]-S\f[R].
  3613. This allows for much easier format selection than what is possible by
  3614. simply using \f[C]--format\f[R] (examples)
  3615. .IP \[bu] 2
  3616. \f[B]Merged with animelover1984/youtube-dl\f[R]: You get most of the
  3617. features and improvements from
  3618. animelover1984/youtube-dl (https://github.com/animelover1984/youtube-dl)
  3619. including \f[C]--write-comments\f[R], \f[C]BiliBiliSearch\f[R],
  3620. \f[C]BilibiliChannel\f[R], Embedding thumbnail in mp4/ogg/opus, playlist
  3621. infojson etc.
  3622. Note that NicoNico livestreams are not available.
  3623. See #31 (https://github.com/yt-dlp/yt-dlp/pull/31) for details.
  3624. .IP \[bu] 2
  3625. \f[B]YouTube improvements\f[R]:
  3626. .RS 2
  3627. .IP \[bu] 2
  3628. Supports Clips, Stories (\f[C]ytstories:<channel UCID>\f[R]), Search
  3629. (including filters)\f[B]*\f[R], YouTube Music Search, Channel-specific
  3630. search, Search prefixes (\f[C]ytsearch:\f[R],
  3631. \f[C]ytsearchdate:\f[R])\f[B]*\f[R], Mixes, and Feeds (\f[C]:ytfav\f[R],
  3632. \f[C]:ytwatchlater\f[R], \f[C]:ytsubs\f[R], \f[C]:ythistory\f[R],
  3633. \f[C]:ytrec\f[R], \f[C]:ytnotif\f[R])
  3634. .IP \[bu] 2
  3635. Fix for n-sig based
  3636. throttling (https://github.com/ytdl-org/youtube-dl/issues/29326)
  3637. \f[B]*\f[R]
  3638. .IP \[bu] 2
  3639. Download livestreams from the start using \f[C]--live-from-start\f[R]
  3640. (\f[I]experimental\f[R])
  3641. .IP \[bu] 2
  3642. Channel URLs download all uploads of the channel, including shorts and
  3643. live
  3644. .IP \[bu] 2
  3645. Support for logging in with
  3646. OAuth (https://github.com/yt-dlp/yt-dlp/wiki/Extractors#logging-in-with-oauth)
  3647. .RE
  3648. .IP \[bu] 2
  3649. \f[B]Cookies from browser\f[R]: Cookies can be automatically extracted
  3650. from all major web browsers using
  3651. \f[C]--cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]\f[R]
  3652. .IP \[bu] 2
  3653. \f[B]Download time range\f[R]: Videos can be downloaded partially based
  3654. on either timestamps or chapters using \f[C]--download-sections\f[R]
  3655. .IP \[bu] 2
  3656. \f[B]Split video by chapters\f[R]: Videos can be split into multiple
  3657. files based on chapters using \f[C]--split-chapters\f[R]
  3658. .IP \[bu] 2
  3659. \f[B]Multi-threaded fragment downloads\f[R]: Download multiple fragments
  3660. of m3u8/mpd videos in parallel.
  3661. Use \f[C]--concurrent-fragments\f[R] (\f[C]-N\f[R]) option to set the
  3662. number of threads used
  3663. .IP \[bu] 2
  3664. \f[B]Aria2c with HLS/DASH\f[R]: You can use \f[C]aria2c\f[R] as the
  3665. external downloader for DASH(mpd) and HLS(m3u8) formats
  3666. .IP \[bu] 2
  3667. \f[B]New and fixed extractors\f[R]: Many new extractors have been added
  3668. and a lot of existing ones have been fixed.
  3669. See the changelog or the list of supported sites
  3670. .IP \[bu] 2
  3671. \f[B]New MSOs\f[R]: Philo, Spectrum, SlingTV, Cablevision, RCN etc.
  3672. .IP \[bu] 2
  3673. \f[B]Subtitle extraction from manifests\f[R]: Subtitles can be extracted
  3674. from streaming media manifests.
  3675. See
  3676. commit/be6202f (https://github.com/yt-dlp/yt-dlp/commit/be6202f12b97858b9d716e608394b51065d0419f)
  3677. for details
  3678. .IP \[bu] 2
  3679. \f[B]Multiple paths and output templates\f[R]: You can give different
  3680. output templates and download paths for different types of files.
  3681. You can also set a temporary path where intermediary files are
  3682. downloaded to using \f[C]--paths\f[R] (\f[C]-P\f[R])
  3683. .IP \[bu] 2
  3684. \f[B]Portable Configuration\f[R]: Configuration files are automatically
  3685. loaded from the home and root directories.
  3686. See CONFIGURATION for details
  3687. .IP \[bu] 2
  3688. \f[B]Output template improvements\f[R]: Output templates can now have
  3689. date-time formatting, numeric offsets, object traversal etc.
  3690. See output template for details.
  3691. Even more advanced operations can also be done with the help of
  3692. \f[C]--parse-metadata\f[R] and \f[C]--replace-in-metadata\f[R]
  3693. .IP \[bu] 2
  3694. \f[B]Other new options\f[R]: Many new options have been added such as
  3695. \f[C]--alias\f[R], \f[C]--print\f[R], \f[C]--concat-playlist\f[R],
  3696. \f[C]--wait-for-video\f[R], \f[C]--retry-sleep\f[R],
  3697. \f[C]--sleep-requests\f[R], \f[C]--convert-thumbnails\f[R],
  3698. \f[C]--force-download-archive\f[R], \f[C]--force-overwrites\f[R],
  3699. \f[C]--break-match-filters\f[R] etc
  3700. .IP \[bu] 2
  3701. \f[B]Improvements\f[R]: Regex and other operators in
  3702. \f[C]--format\f[R]/\f[C]--match-filters\f[R], multiple
  3703. \f[C]--postprocessor-args\f[R] and \f[C]--downloader-args\f[R], faster
  3704. archive checking, more format selection options, merge
  3705. multi-video/audio, multiple \f[C]--config-locations\f[R],
  3706. \f[C]--exec\f[R] at different stages, etc
  3707. .IP \[bu] 2
  3708. \f[B]Plugins\f[R]: Extractors and PostProcessors can be loaded from an
  3709. external file.
  3710. See plugins for details
  3711. .IP \[bu] 2
  3712. \f[B]Self updater\f[R]: The releases can be updated using
  3713. \f[C]yt-dlp -U\f[R], and downgraded using \f[C]--update-to\f[R] if
  3714. required
  3715. .IP \[bu] 2
  3716. \f[B]Automated builds\f[R]: Nightly/master builds can be used with
  3717. \f[C]--update-to nightly\f[R] and \f[C]--update-to master\f[R]
  3718. .PP
  3719. See changelog or commits (https://github.com/yt-dlp/yt-dlp/commits) for
  3720. the full list of changes
  3721. .PP
  3722. Features marked with a \f[B]*\f[R] have been back-ported to youtube-dl
  3723. .SS Differences in default behavior
  3724. .PP
  3725. Some of yt-dlp\[aq]s default options are different from that of
  3726. youtube-dl and youtube-dlc:
  3727. .IP \[bu] 2
  3728. yt-dlp supports only Python 3.9+, and will remove support for more
  3729. versions as they become
  3730. EOL (https://devguide.python.org/versions/#python-release-cycle); while
  3731. youtube-dl still supports Python 2.6+ and
  3732. 3.2+ (https://github.com/ytdl-org/youtube-dl/issues/30568#issue-1118238743)
  3733. .IP \[bu] 2
  3734. The options \f[C]--auto-number\f[R] (\f[C]-A\f[R]), \f[C]--title\f[R]
  3735. (\f[C]-t\f[R]) and \f[C]--literal\f[R] (\f[C]-l\f[R]), no longer work.
  3736. See removed options for details
  3737. .IP \[bu] 2
  3738. \f[C]avconv\f[R] is not supported as an alternative to \f[C]ffmpeg\f[R]
  3739. .IP \[bu] 2
  3740. yt-dlp stores config files in slightly different locations to
  3741. youtube-dl.
  3742. See CONFIGURATION for a list of correct locations
  3743. .IP \[bu] 2
  3744. The default output template is \f[C]%(title)s [%(id)s].%(ext)s\f[R].
  3745. There is no real reason for this change.
  3746. This was changed before yt-dlp was ever made public and now there are no
  3747. plans to change it back to \f[C]%(title)s-%(id)s.%(ext)s\f[R].
  3748. Instead, you may use \f[C]--compat-options filename\f[R]
  3749. .IP \[bu] 2
  3750. The default format sorting is different from youtube-dl and prefers
  3751. higher resolution and better codecs rather than higher bitrates.
  3752. You can use the \f[C]--format-sort\f[R] option to change this to any
  3753. order you prefer, or use \f[C]--compat-options format-sort\f[R] to use
  3754. youtube-dl\[aq]s sorting order.
  3755. Older versions of yt-dlp preferred VP9 due to its broader compatibility;
  3756. you can use \f[C]--compat-options prefer-vp9-sort\f[R] to revert to that
  3757. format sorting preference.
  3758. These two compat options cannot be used together
  3759. .IP \[bu] 2
  3760. The default format selector is \f[C]bv*+ba/b\f[R].
  3761. This means that if a combined video + audio format that is better than
  3762. the best video-only format is found, the former will be preferred.
  3763. Use \f[C]-f bv+ba/b\f[R] or \f[C]--compat-options format-spec\f[R] to
  3764. revert this
  3765. .IP \[bu] 2
  3766. Unlike youtube-dlc, yt-dlp does not allow merging multiple audio/video
  3767. streams into one file by default (since this conflicts with the use of
  3768. \f[C]-f bv*+ba\f[R]).
  3769. If needed, this feature must be enabled using
  3770. \f[C]--audio-multistreams\f[R] and \f[C]--video-multistreams\f[R].
  3771. You can also use \f[C]--compat-options multistreams\f[R] to enable both
  3772. .IP \[bu] 2
  3773. \f[C]--no-abort-on-error\f[R] is enabled by default.
  3774. Use \f[C]--abort-on-error\f[R] or
  3775. \f[C]--compat-options abort-on-error\f[R] to abort on errors instead
  3776. .IP \[bu] 2
  3777. When writing metadata files such as thumbnails, description or infojson,
  3778. the same information (if available) is also written for playlists.
  3779. Use \f[C]--no-write-playlist-metafiles\f[R] or
  3780. \f[C]--compat-options no-playlist-metafiles\f[R] to not write these
  3781. files
  3782. .IP \[bu] 2
  3783. \f[C]--add-metadata\f[R] attaches the \f[C]infojson\f[R] to
  3784. \f[C]mkv\f[R] files in addition to writing the metadata when used with
  3785. \f[C]--write-info-json\f[R].
  3786. Use \f[C]--no-embed-info-json\f[R] or
  3787. \f[C]--compat-options no-attach-info-json\f[R] to revert this
  3788. .IP \[bu] 2
  3789. Some metadata are embedded into different fields when using
  3790. \f[C]--add-metadata\f[R] as compared to youtube-dl.
  3791. Most notably, \f[C]comment\f[R] field contains the \f[C]webpage_url\f[R]
  3792. and \f[C]synopsis\f[R] contains the \f[C]description\f[R].
  3793. You can use \f[C]--parse-metadata\f[R] to modify this to your liking or
  3794. use \f[C]--compat-options embed-metadata\f[R] to revert this
  3795. .IP \[bu] 2
  3796. \f[C]playlist_index\f[R] behaves differently when used with options like
  3797. \f[C]--playlist-reverse\f[R] and \f[C]--playlist-items\f[R].
  3798. See #302 (https://github.com/yt-dlp/yt-dlp/issues/302) for details.
  3799. You can use \f[C]--compat-options playlist-index\f[R] if you want to
  3800. keep the earlier behavior
  3801. .IP \[bu] 2
  3802. The output of \f[C]-F\f[R] is listed in a new format.
  3803. Use \f[C]--compat-options list-formats\f[R] to revert this
  3804. .IP \[bu] 2
  3805. Live chats (if available) are considered as subtitles.
  3806. Use \f[C]--sub-langs all,-live_chat\f[R] to download all subtitles
  3807. except live chat.
  3808. You can also use \f[C]--compat-options no-live-chat\f[R] to prevent any
  3809. live chat/danmaku from downloading
  3810. .IP \[bu] 2
  3811. YouTube channel URLs download all uploads of the channel.
  3812. To download only the videos in a specific tab, pass the tab\[aq]s URL.
  3813. If the channel does not show the requested tab, an error will be raised.
  3814. Also, \f[C]/live\f[R] URLs raise an error if there are no live videos
  3815. instead of silently downloading the entire channel.
  3816. You may use \f[C]--compat-options no-youtube-channel-redirect\f[R] to
  3817. revert all these redirections
  3818. .IP \[bu] 2
  3819. Unavailable videos are also listed for YouTube playlists.
  3820. Use \f[C]--compat-options no-youtube-unavailable-videos\f[R] to remove
  3821. this
  3822. .IP \[bu] 2
  3823. The upload dates extracted from YouTube are in UTC when
  3824. available (https://github.com/yt-dlp/yt-dlp/blob/89e4d86171c7b7c997c77d4714542e0383bf0db0/yt_dlp/extractor/youtube.py#L3898-L3900).
  3825. Use \f[C]--compat-options no-youtube-prefer-utc-upload-date\f[R] to
  3826. prefer the non-UTC upload date.
  3827. .IP \[bu] 2
  3828. If \f[C]ffmpeg\f[R] is used as the downloader, the downloading and
  3829. merging of formats happen in a single step when possible.
  3830. Use \f[C]--compat-options no-direct-merge\f[R] to revert this
  3831. .IP \[bu] 2
  3832. Thumbnail embedding in \f[C]mp4\f[R] is done with mutagen if possible.
  3833. Use \f[C]--compat-options embed-thumbnail-atomicparsley\f[R] to force
  3834. the use of AtomicParsley instead
  3835. .IP \[bu] 2
  3836. Some internal metadata such as filenames are removed by default from the
  3837. infojson.
  3838. Use \f[C]--no-clean-infojson\f[R] or
  3839. \f[C]--compat-options no-clean-infojson\f[R] to revert this
  3840. .IP \[bu] 2
  3841. When \f[C]--embed-subs\f[R] and \f[C]--write-subs\f[R] are used
  3842. together, the subtitles are written to disk and also embedded in the
  3843. media file.
  3844. You can use just \f[C]--embed-subs\f[R] to embed the subs and
  3845. automatically delete the separate file.
  3846. See #630
  3847. (comment) (https://github.com/yt-dlp/yt-dlp/issues/630#issuecomment-893659460)
  3848. for more info.
  3849. \f[C]--compat-options no-keep-subs\f[R] can be used to revert this
  3850. .IP \[bu] 2
  3851. \f[C]certifi\f[R] will be used for SSL root certificates, if installed.
  3852. If you want to use system certificates (e.g.
  3853. self-signed), use \f[C]--compat-options no-certifi\f[R]
  3854. .IP \[bu] 2
  3855. yt-dlp\[aq]s sanitization of invalid characters in filenames is
  3856. different/smarter than in youtube-dl.
  3857. You can use \f[C]--compat-options filename-sanitization\f[R] to revert
  3858. to youtube-dl\[aq]s behavior
  3859. .IP \[bu] 2
  3860. [STRIKEOUT:yt-dlp tries to parse the external downloader outputs into
  3861. the standard progress output if possible (Currently implemented:
  3862. aria2c (https://github.com/yt-dlp/yt-dlp/issues/5931)). You can use
  3863. \f[C]--compat-options no-external-downloader-progress\f[R] to get the
  3864. downloader output as-is]
  3865. .IP \[bu] 2
  3866. yt-dlp versions between 2021.09.01 and 2023.01.02 applies
  3867. \f[C]--match-filters\f[R] to nested playlists.
  3868. This was an unintentional side-effect of
  3869. 8f18ac (https://github.com/yt-dlp/yt-dlp/commit/8f18aca8717bb0dd49054555af8d386e5eda3a88)
  3870. and is fixed in
  3871. d7b460 (https://github.com/yt-dlp/yt-dlp/commit/d7b460d0e5fc710950582baed2e3fc616ed98a80).
  3872. Use \f[C]--compat-options playlist-match-filter\f[R] to revert this
  3873. .IP \[bu] 2
  3874. yt-dlp versions between 2021.11.10 and 2023.06.21 estimated
  3875. \f[C]filesize_approx\f[R] values for fragmented/manifest formats.
  3876. This was added for convenience in
  3877. f2fe69 (https://github.com/yt-dlp/yt-dlp/commit/f2fe69c7b0d208bdb1f6292b4ae92bc1e1a7444a),
  3878. but was reverted in
  3879. 0dff8e (https://github.com/yt-dlp/yt-dlp/commit/0dff8e4d1e6e9fb938f4256ea9af7d81f42fd54f)
  3880. due to the potentially extreme inaccuracy of the estimated values.
  3881. Use \f[C]--compat-options manifest-filesize-approx\f[R] to keep
  3882. extracting the estimated values
  3883. .IP \[bu] 2
  3884. yt-dlp uses modern http client backends such as \f[C]requests\f[R].
  3885. Use \f[C]--compat-options prefer-legacy-http-handler\f[R] to prefer the
  3886. legacy http handler (\f[C]urllib\f[R]) to be used for standard http
  3887. requests.
  3888. .IP \[bu] 2
  3889. The sub-modules \f[C]swfinterp\f[R], \f[C]casefold\f[R] are removed.
  3890. .IP \[bu] 2
  3891. Passing \f[C]--simulate\f[R] (or calling \f[C]extract_info\f[R] with
  3892. \f[C]download=False\f[R]) no longer alters the default format selection.
  3893. See #9843 (https://github.com/yt-dlp/yt-dlp/issues/9843) for details.
  3894. .PP
  3895. For ease of use, a few more compat options are available:
  3896. .IP \[bu] 2
  3897. \f[C]--compat-options all\f[R]: Use all compat options (\f[B]Do NOT use
  3898. this!\f[R])
  3899. .IP \[bu] 2
  3900. \f[C]--compat-options youtube-dl\f[R]: Same as
  3901. \f[C]--compat-options all,-multistreams,-playlist-match-filter,-manifest-filesize-approx,-allow-unsafe-ext,-prefer-vp9-sort\f[R]
  3902. .IP \[bu] 2
  3903. \f[C]--compat-options youtube-dlc\f[R]: Same as
  3904. \f[C]--compat-options all,-no-live-chat,-no-youtube-channel-redirect,-playlist-match-filter,-manifest-filesize-approx,-allow-unsafe-ext,-prefer-vp9-sort\f[R]
  3905. .IP \[bu] 2
  3906. \f[C]--compat-options 2021\f[R]: Same as
  3907. \f[C]--compat-options 2022,no-certifi,filename-sanitization,no-youtube-prefer-utc-upload-date\f[R]
  3908. .IP \[bu] 2
  3909. \f[C]--compat-options 2022\f[R]: Same as
  3910. \f[C]--compat-options 2023,playlist-match-filter,no-external-downloader-progress,prefer-legacy-http-handler,manifest-filesize-approx\f[R]
  3911. .IP \[bu] 2
  3912. \f[C]--compat-options 2023\f[R]: Same as
  3913. \f[C]--compat-options prefer-vp9-sort\f[R].
  3914. Use this to enable all future compat options
  3915. .PP
  3916. The following compat options restore vulnerable behavior from before
  3917. security patches:
  3918. .IP \[bu] 2
  3919. \f[C]--compat-options allow-unsafe-ext\f[R]: Allow files with any
  3920. extension (including unsafe ones) to be downloaded
  3921. (GHSA-79w7-vh3h-8g4j (https://github.com/yt-dlp/yt-dlp/security/advisories/GHSA-79w7-vh3h-8g4j))
  3922. .RS 2
  3923. .RS
  3924. .PP
  3925. :warning: Only use if a valid file download is rejected because its
  3926. extension is detected as uncommon
  3927. .PP
  3928. \f[B]This option can enable remote code execution! Consider opening an
  3929. issue (https://github.com/yt-dlp/yt-dlp/issues/new/choose) instead!\f[R]
  3930. .RE
  3931. .RE
  3932. .SS Deprecated options
  3933. .PP
  3934. These are all the deprecated options and the current alternative to
  3935. achieve the same effect
  3936. .SS Almost redundant options
  3937. .PP
  3938. While these options are almost the same as their new counterparts, there
  3939. are some differences that prevents them being redundant
  3940. .IP
  3941. .nf
  3942. \f[C]
  3943. -j, --dump-json                  --print \[dq]%()j\[dq]
  3944. -F, --list-formats               --print formats_table
  3945. --list-thumbnails                --print thumbnails_table --print playlist:thumbnails_table
  3946. --list-subs                      --print automatic_captions_table --print subtitles_table
  3947. \f[R]
  3948. .fi
  3949. .SS Redundant options
  3950. .PP
  3951. While these options are redundant, they are still expected to be used
  3952. due to their ease of use
  3953. .IP
  3954. .nf
  3955. \f[C]
  3956. --get-description                --print description
  3957. --get-duration                   --print duration_string
  3958. --get-filename                   --print filename
  3959. --get-format                     --print format
  3960. --get-id                         --print id
  3961. --get-thumbnail                  --print thumbnail
  3962. -e, --get-title                  --print title
  3963. -g, --get-url                    --print urls
  3964. --match-title REGEX              --match-filters \[dq]title \[ti]= (?i)REGEX\[dq]
  3965. --reject-title REGEX             --match-filters \[dq]title !\[ti]= (?i)REGEX\[dq]
  3966. --min-views COUNT                --match-filters \[dq]view_count >=? COUNT\[dq]
  3967. --max-views COUNT                --match-filters \[dq]view_count <=? COUNT\[dq]
  3968. --break-on-reject                Use --break-match-filters
  3969. --user-agent UA                  --add-headers \[dq]User-Agent:UA\[dq]
  3970. --referer URL                    --add-headers \[dq]Referer:URL\[dq]
  3971. --playlist-start NUMBER          -I NUMBER:
  3972. --playlist-end NUMBER            -I :NUMBER
  3973. --playlist-reverse               -I ::-1
  3974. --no-playlist-reverse            Default
  3975. --no-colors                      --color no_color
  3976. \f[R]
  3977. .fi
  3978. .SS Not recommended
  3979. .PP
  3980. While these options still work, their use is not recommended since there
  3981. are other alternatives to achieve the same
  3982. .IP
  3983. .nf
  3984. \f[C]
  3985. --force-generic-extractor        --ies generic,default
  3986. --exec-before-download CMD       --exec \[dq]before_dl:CMD\[dq]
  3987. --no-exec-before-download        --no-exec
  3988. --all-formats                    -f all
  3989. --all-subs                       --sub-langs all --write-subs
  3990. --print-json                     -j --no-simulate
  3991. --autonumber-size NUMBER         Use string formatting, e.g. %(autonumber)03d
  3992. --autonumber-start NUMBER        Use internal field formatting like %(autonumber+NUMBER)s
  3993. --id                             -o \[dq]%(id)s.%(ext)s\[dq]
  3994. --metadata-from-title FORMAT     --parse-metadata \[dq]%(title)s:FORMAT\[dq]
  3995. --hls-prefer-native              --downloader \[dq]m3u8:native\[dq]
  3996. --hls-prefer-ffmpeg              --downloader \[dq]m3u8:ffmpeg\[dq]
  3997. --list-formats-old               --compat-options list-formats (Alias: --no-list-formats-as-table)
  3998. --list-formats-as-table          --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
  3999. --youtube-skip-dash-manifest     --extractor-args \[dq]youtube:skip=dash\[dq] (Alias: --no-youtube-include-dash-manifest)
  4000. --youtube-skip-hls-manifest      --extractor-args \[dq]youtube:skip=hls\[dq] (Alias: --no-youtube-include-hls-manifest)
  4001. --youtube-include-dash-manifest  Default (Alias: --no-youtube-skip-dash-manifest)
  4002. --youtube-include-hls-manifest   Default (Alias: --no-youtube-skip-hls-manifest)
  4003. --geo-bypass                     --xff \[dq]default\[dq]
  4004. --no-geo-bypass                  --xff \[dq]never\[dq]
  4005. --geo-bypass-country CODE        --xff CODE
  4006. --geo-bypass-ip-block IP_BLOCK   --xff IP_BLOCK
  4007. \f[R]
  4008. .fi
  4009. .SS Developer options
  4010. .PP
  4011. These options are not intended to be used by the end-user
  4012. .IP
  4013. .nf
  4014. \f[C]
  4015. --test                           Download only part of video for testing extractors
  4016. --load-pages                     Load pages dumped by --write-pages
  4017. --youtube-print-sig-code         For testing youtube signatures
  4018. --allow-unplayable-formats       List unplayable formats also
  4019. --no-allow-unplayable-formats    Default
  4020. \f[R]
  4021. .fi
  4022. .SS Old aliases
  4023. .PP
  4024. These are aliases that are no longer documented for various reasons
  4025. .IP
  4026. .nf
  4027. \f[C]
  4028. --avconv-location                --ffmpeg-location
  4029. --clean-infojson                 --clean-info-json
  4030. --cn-verification-proxy URL      --geo-verification-proxy URL
  4031. --dump-headers                   --print-traffic
  4032. --dump-intermediate-pages        --dump-pages
  4033. --force-write-download-archive   --force-write-archive
  4034. --load-info                      --load-info-json
  4035. --no-clean-infojson              --no-clean-info-json
  4036. --no-split-tracks                --no-split-chapters
  4037. --no-write-srt                   --no-write-subs
  4038. --prefer-unsecure                --prefer-insecure
  4039. --rate-limit RATE                --limit-rate RATE
  4040. --split-tracks                   --split-chapters
  4041. --srt-lang LANGS                 --sub-langs LANGS
  4042. --trim-file-names LENGTH         --trim-filenames LENGTH
  4043. --write-srt                      --write-subs
  4044. --yes-overwrites                 --force-overwrites
  4045. \f[R]
  4046. .fi
  4047. .SS Sponskrub Options
  4048. .PP
  4049. Support for SponSkrub (https://github.com/faissaloo/SponSkrub) has been
  4050. deprecated in favor of the \f[C]--sponsorblock\f[R] options
  4051. .IP
  4052. .nf
  4053. \f[C]
  4054. --sponskrub                      --sponsorblock-mark all
  4055. --no-sponskrub                   --no-sponsorblock
  4056. --sponskrub-cut                  --sponsorblock-remove all
  4057. --no-sponskrub-cut               --sponsorblock-remove -all
  4058. --sponskrub-force                Not applicable
  4059. --no-sponskrub-force             Not applicable
  4060. --sponskrub-location             Not applicable
  4061. --sponskrub-args                 Not applicable
  4062. \f[R]
  4063. .fi
  4064. .SS No longer supported
  4065. .PP
  4066. These options may no longer work as intended
  4067. .IP
  4068. .nf
  4069. \f[C]
  4070. --prefer-avconv                  avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
  4071. --prefer-ffmpeg                  Default (Alias: --no-prefer-avconv)
  4072. -C, --call-home                  Not implemented
  4073. --no-call-home                   Default
  4074. --include-ads                    No longer supported
  4075. --no-include-ads                 Default
  4076. --write-annotations              No supported site has annotations now
  4077. --no-write-annotations           Default
  4078. --compat-options seperate-video-versions  No longer needed
  4079. --compat-options no-youtube-prefer-utc-upload-date  No longer supported
  4080. \f[R]
  4081. .fi
  4082. .SS Removed
  4083. .PP
  4084. These options were deprecated since 2014 and have now been entirely
  4085. removed
  4086. .IP
  4087. .nf
  4088. \f[C]
  4089. -A, --auto-number                -o \[dq]%(autonumber)s-%(id)s.%(ext)s\[dq]
  4090. -t, -l, --title, --literal       -o \[dq]%(title)s-%(id)s.%(ext)s\[dq]
  4091. \f[R]
  4092. .fi
  4093. .SH CONTRIBUTING
  4094. .PP
  4095. See CONTRIBUTING.md for instructions on Opening an Issue and
  4096. Contributing code to the project
  4097. .SH WIKI
  4098. .PP
  4099. See the Wiki (https://github.com/yt-dlp/yt-dlp/wiki) for more
  4100. information