Somebody took it down, I think and I won't say who. I'm Putin or Trumping it back up
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 92KB

9 years ago
10 months ago
9 years ago
5 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446
  1. [![Build Status](https://travis-ci.org/ytdl-org/youtube-dl.svg?branch=master)](https://travis-ci.org/ytdl-org/youtube-dl)
  2. youtube-dl - download videos from youtube.com or other video platforms
  3. - [INSTALLATION](#installation)
  4. - [DESCRIPTION](#description)
  5. - [OPTIONS](#options)
  6. - [CONFIGURATION](#configuration)
  7. - [OUTPUT TEMPLATE](#output-template)
  8. - [FORMAT SELECTION](#format-selection)
  9. - [VIDEO SELECTION](#video-selection)
  10. - [FAQ](#faq)
  11. - [DEVELOPER INSTRUCTIONS](#developer-instructions)
  12. - [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
  13. - [BUGS](#bugs)
  14. - [COPYRIGHT](#copyright)
  15. # INSTALLATION
  16. To install it right away for all UNIX users (Linux, macOS, etc.), type:
  17. sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl
  18. sudo chmod a+rx /usr/local/bin/youtube-dl
  19. If you do not have curl, you can alternatively use a recent wget:
  20. sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
  21. sudo chmod a+rx /usr/local/bin/youtube-dl
  22. Windows users can [download an .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in any location on their [PATH](https://en.wikipedia.org/wiki/PATH_%28variable%29) except for `%SYSTEMROOT%\System32` (e.g. **do not** put in `C:\Windows\System32`).
  23. You can also use pip:
  24. sudo -H pip install --upgrade youtube-dl
  25. This command will update youtube-dl if you have already installed it. See the [pypi page](https://pypi.python.org/pypi/youtube_dl) for more information.
  26. macOS users can install youtube-dl with [Homebrew](https://brew.sh/):
  27. brew install youtube-dl
  28. Or with [MacPorts](https://www.macports.org/):
  29. sudo port install youtube-dl
  30. Alternatively, refer to the [developer instructions](#developer-instructions) for how to check out and work with the git repository. For further options, including PGP signatures, see the [youtube-dl Download Page](https://ytdl-org.github.io/youtube-dl/download.html).
  31. # DESCRIPTION
  32. **youtube-dl** is a command-line program to download videos from YouTube.com and a few more sites. It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.
  33. youtube-dl [OPTIONS] URL [URL...]
  34. # OPTIONS
  35. -h, --help Print this help text and exit
  36. --version Print program version and exit
  37. -U, --update Update this program to latest version. Make
  38. sure that you have sufficient permissions
  39. (run with sudo if needed)
  40. -i, --ignore-errors Continue on download errors, for example to
  41. skip unavailable videos in a playlist
  42. --abort-on-error Abort downloading of further videos (in the
  43. playlist or the command line) if an error
  44. occurs
  45. --dump-user-agent Display the current browser identification
  46. --list-extractors List all supported extractors
  47. --extractor-descriptions Output descriptions of all supported
  48. extractors
  49. --force-generic-extractor Force extraction to use the generic
  50. extractor
  51. --default-search PREFIX Use this prefix for unqualified URLs. For
  52. example "gvsearch2:" downloads two videos
  53. from google videos for youtube-dl "large
  54. apple". Use the value "auto" to let
  55. youtube-dl guess ("auto_warning" to emit a
  56. warning when guessing). "error" just throws
  57. an error. The default value "fixup_error"
  58. repairs broken URLs, but emits an error if
  59. this is not possible instead of searching.
  60. --ignore-config Do not read configuration files. When given
  61. in the global configuration file
  62. /etc/youtube-dl.conf: Do not read the user
  63. configuration in ~/.config/youtube-
  64. dl/config (%APPDATA%/youtube-dl/config.txt
  65. on Windows)
  66. --config-location PATH Location of the configuration file; either
  67. the path to the config or its containing
  68. directory.
  69. --flat-playlist Do not extract the videos of a playlist,
  70. only list them.
  71. --mark-watched Mark videos watched (YouTube only)
  72. --no-mark-watched Do not mark videos watched (YouTube only)
  73. --no-color Do not emit color codes in output
  74. ## Network Options:
  75. --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
  76. To enable SOCKS proxy, specify a proper
  77. scheme. For example
  78. socks5://127.0.0.1:1080/. Pass in an empty
  79. string (--proxy "") for direct connection
  80. --socket-timeout SECONDS Time to wait before giving up, in seconds
  81. --source-address IP Client-side IP address to bind to
  82. -4, --force-ipv4 Make all connections via IPv4
  83. -6, --force-ipv6 Make all connections via IPv6
  84. ## Geo Restriction:
  85. --geo-verification-proxy URL Use this proxy to verify the IP address for
  86. some geo-restricted sites. The default
  87. proxy specified by --proxy (or none, if the
  88. option is not present) is used for the
  89. actual downloading.
  90. --geo-bypass Bypass geographic restriction via faking
  91. X-Forwarded-For HTTP header
  92. --no-geo-bypass Do not bypass geographic restriction via
  93. faking X-Forwarded-For HTTP header
  94. --geo-bypass-country CODE Force bypass geographic restriction with
  95. explicitly provided two-letter ISO 3166-2
  96. country code
  97. --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
  98. explicitly provided IP block in CIDR
  99. notation
  100. ## Video Selection:
  101. --playlist-start NUMBER Playlist video to start at (default is 1)
  102. --playlist-end NUMBER Playlist video to end at (default is last)
  103. --playlist-items ITEM_SPEC Playlist video items to download. Specify
  104. indices of the videos in the playlist
  105. separated by commas like: "--playlist-items
  106. 1,2,5,8" if you want to download videos
  107. indexed 1, 2, 5, 8 in the playlist. You can
  108. specify range: "--playlist-items
  109. 1-3,7,10-13", it will download the videos
  110. at index 1, 2, 3, 7, 10, 11, 12 and 13.
  111. --match-title REGEX Download only matching titles (regex or
  112. caseless sub-string)
  113. --reject-title REGEX Skip download for matching titles (regex or
  114. caseless sub-string)
  115. --max-downloads NUMBER Abort after downloading NUMBER files
  116. --min-filesize SIZE Do not download any videos smaller than
  117. SIZE (e.g. 50k or 44.6m)
  118. --max-filesize SIZE Do not download any videos larger than SIZE
  119. (e.g. 50k or 44.6m)
  120. --date DATE Download only videos uploaded in this date
  121. --datebefore DATE Download only videos uploaded on or before
  122. this date (i.e. inclusive)
  123. --dateafter DATE Download only videos uploaded on or after
  124. this date (i.e. inclusive)
  125. --min-views COUNT Do not download any videos with less than
  126. COUNT views
  127. --max-views COUNT Do not download any videos with more than
  128. COUNT views
  129. --match-filter FILTER Generic video filter. Specify any key (see
  130. the "OUTPUT TEMPLATE" for a list of
  131. available keys) to match if the key is
  132. present, !key to check if the key is not
  133. present, key > NUMBER (like "comment_count
  134. > 12", also works with >=, <, <=, !=, =) to
  135. compare against a number, key = 'LITERAL'
  136. (like "uploader = 'Mike Smith'", also works
  137. with !=) to match against a string literal
  138. and & to require multiple matches. Values
  139. which are not known are excluded unless you
  140. put a question mark (?) after the operator.
  141. For example, to only match videos that have
  142. been liked more than 100 times and disliked
  143. less than 50 times (or the dislike
  144. functionality is not available at the given
  145. service), but who also have a description,
  146. use --match-filter "like_count > 100 &
  147. dislike_count <? 50 & description" .
  148. --no-playlist Download only the video, if the URL refers
  149. to a video and a playlist.
  150. --yes-playlist Download the playlist, if the URL refers to
  151. a video and a playlist.
  152. --age-limit YEARS Download only videos suitable for the given
  153. age
  154. --download-archive FILE Download only videos not listed in the
  155. archive file. Record the IDs of all
  156. downloaded videos in it.
  157. --include-ads Download advertisements as well
  158. (experimental)
  159. ## Download Options:
  160. -r, --limit-rate RATE Maximum download rate in bytes per second
  161. (e.g. 50K or 4.2M)
  162. -R, --retries RETRIES Number of retries (default is 10), or
  163. "infinite".
  164. --fragment-retries RETRIES Number of retries for a fragment (default
  165. is 10), or "infinite" (DASH, hlsnative and
  166. ISM)
  167. --skip-unavailable-fragments Skip unavailable fragments (DASH, hlsnative
  168. and ISM)
  169. --abort-on-unavailable-fragment Abort downloading when some fragment is not
  170. available
  171. --keep-fragments Keep downloaded fragments on disk after
  172. downloading is finished; fragments are
  173. erased by default
  174. --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
  175. (default is 1024)
  176. --no-resize-buffer Do not automatically adjust the buffer
  177. size. By default, the buffer size is
  178. automatically resized from an initial value
  179. of SIZE.
  180. --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
  181. downloading (e.g. 10485760 or 10M) (default
  182. is disabled). May be useful for bypassing
  183. bandwidth throttling imposed by a webserver
  184. (experimental)
  185. --playlist-reverse Download playlist videos in reverse order
  186. --playlist-random Download playlist videos in random order
  187. --xattr-set-filesize Set file xattribute ytdl.filesize with
  188. expected file size
  189. --hls-prefer-native Use the native HLS downloader instead of
  190. ffmpeg
  191. --hls-prefer-ffmpeg Use ffmpeg instead of the native HLS
  192. downloader
  193. --hls-use-mpegts Use the mpegts container for HLS videos,
  194. allowing to play the video while
  195. downloading (some players may not be able
  196. to play it)
  197. --external-downloader COMMAND Use the specified external downloader.
  198. Currently supports
  199. aria2c,avconv,axel,curl,ffmpeg,httpie,wget
  200. --external-downloader-args ARGS Give these arguments to the external
  201. downloader
  202. ## Filesystem Options:
  203. -a, --batch-file FILE File containing URLs to download ('-' for
  204. stdin), one URL per line. Lines starting
  205. with '#', ';' or ']' are considered as
  206. comments and ignored.
  207. --id Use only video ID in file name
  208. -o, --output TEMPLATE Output filename template, see the "OUTPUT
  209. TEMPLATE" for all the info
  210. --autonumber-start NUMBER Specify the start value for %(autonumber)s
  211. (default is 1)
  212. --restrict-filenames Restrict filenames to only ASCII
  213. characters, and avoid "&" and spaces in
  214. filenames
  215. -w, --no-overwrites Do not overwrite files
  216. -c, --continue Force resume of partially downloaded files.
  217. By default, youtube-dl will resume
  218. downloads if possible.
  219. --no-continue Do not resume partially downloaded files
  220. (restart from beginning)
  221. --no-part Do not use .part files - write directly
  222. into output file
  223. --no-mtime Do not use the Last-modified header to set
  224. the file modification time
  225. --write-description Write video description to a .description
  226. file
  227. --write-info-json Write video metadata to a .info.json file
  228. --write-annotations Write video annotations to a
  229. .annotations.xml file
  230. --load-info-json FILE JSON file containing the video information
  231. (created with the "--write-info-json"
  232. option)
  233. --cookies FILE File to read cookies from and dump cookie
  234. jar in
  235. --cache-dir DIR Location in the filesystem where youtube-dl
  236. can store some downloaded information
  237. permanently. By default
  238. $XDG_CACHE_HOME/youtube-dl or
  239. ~/.cache/youtube-dl . At the moment, only
  240. YouTube player files (for videos with
  241. obfuscated signatures) are cached, but that
  242. may change.
  243. --no-cache-dir Disable filesystem caching
  244. --rm-cache-dir Delete all filesystem cache files
  245. ## Thumbnail images:
  246. --write-thumbnail Write thumbnail image to disk
  247. --write-all-thumbnails Write all thumbnail image formats to disk
  248. --list-thumbnails Simulate and list all available thumbnail
  249. formats
  250. ## Verbosity / Simulation Options:
  251. -q, --quiet Activate quiet mode
  252. --no-warnings Ignore warnings
  253. -s, --simulate Do not download the video and do not write
  254. anything to disk
  255. --skip-download Do not download the video
  256. -g, --get-url Simulate, quiet but print URL
  257. -e, --get-title Simulate, quiet but print title
  258. --get-id Simulate, quiet but print id
  259. --get-thumbnail Simulate, quiet but print thumbnail URL
  260. --get-description Simulate, quiet but print video description
  261. --get-duration Simulate, quiet but print video length
  262. --get-filename Simulate, quiet but print output filename
  263. --get-format Simulate, quiet but print output format
  264. -j, --dump-json Simulate, quiet but print JSON information.
  265. See the "OUTPUT TEMPLATE" for a description
  266. of available keys.
  267. -J, --dump-single-json Simulate, quiet but print JSON information
  268. for each command-line argument. If the URL
  269. refers to a playlist, dump the whole
  270. playlist information in a single line.
  271. --print-json Be quiet and print the video information as
  272. JSON (video is still being downloaded).
  273. --newline Output progress bar as new lines
  274. --no-progress Do not print progress bar
  275. --console-title Display progress in console titlebar
  276. -v, --verbose Print various debugging information
  277. --dump-pages Print downloaded pages encoded using base64
  278. to debug problems (very verbose)
  279. --write-pages Write downloaded intermediary pages to
  280. files in the current directory to debug
  281. problems
  282. --print-traffic Display sent and read HTTP traffic
  283. -C, --call-home Contact the youtube-dl server for debugging
  284. --no-call-home Do NOT contact the youtube-dl server for
  285. debugging
  286. ## Workarounds:
  287. --encoding ENCODING Force the specified encoding (experimental)
  288. --no-check-certificate Suppress HTTPS certificate validation
  289. --prefer-insecure Use an unencrypted connection to retrieve
  290. information about the video. (Currently
  291. supported only for YouTube)
  292. --user-agent UA Specify a custom user agent
  293. --referer URL Specify a custom referer, use if the video
  294. access is restricted to one domain
  295. --add-header FIELD:VALUE Specify a custom HTTP header and its value,
  296. separated by a colon ':'. You can use this
  297. option multiple times
  298. --bidi-workaround Work around terminals that lack
  299. bidirectional text support. Requires bidiv
  300. or fribidi executable in PATH
  301. --sleep-interval SECONDS Number of seconds to sleep before each
  302. download when used alone or a lower bound
  303. of a range for randomized sleep before each
  304. download (minimum possible number of
  305. seconds to sleep) when used along with
  306. --max-sleep-interval.
  307. --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
  308. before each download (maximum possible
  309. number of seconds to sleep). Must only be
  310. used along with --min-sleep-interval.
  311. ## Video Format Options:
  312. -f, --format FORMAT Video format code, see the "FORMAT
  313. SELECTION" for all the info
  314. --all-formats Download all available video formats
  315. --prefer-free-formats Prefer free video formats unless a specific
  316. one is requested
  317. -F, --list-formats List all available formats of requested
  318. videos
  319. --youtube-skip-dash-manifest Do not download the DASH manifests and
  320. related data on YouTube videos
  321. --merge-output-format FORMAT If a merge is required (e.g.
  322. bestvideo+bestaudio), output to given
  323. container format. One of mkv, mp4, ogg,
  324. webm, flv. Ignored if no merge is required
  325. ## Subtitle Options:
  326. --write-sub Write subtitle file
  327. --write-auto-sub Write automatically generated subtitle file
  328. (YouTube only)
  329. --all-subs Download all the available subtitles of the
  330. video
  331. --list-subs List all available subtitles for the video
  332. --sub-format FORMAT Subtitle format, accepts formats
  333. preference, for example: "srt" or
  334. "ass/srt/best"
  335. --sub-lang LANGS Languages of the subtitles to download
  336. (optional) separated by commas, use --list-
  337. subs for available language tags
  338. ## Authentication Options:
  339. -u, --username USERNAME Login with this account ID
  340. -p, --password PASSWORD Account password. If this option is left
  341. out, youtube-dl will ask interactively.
  342. -2, --twofactor TWOFACTOR Two-factor authentication code
  343. -n, --netrc Use .netrc authentication data
  344. --video-password PASSWORD Video password (vimeo, smotri, youku)
  345. ## Adobe Pass Options:
  346. --ap-mso MSO Adobe Pass multiple-system operator (TV
  347. provider) identifier, use --ap-list-mso for
  348. a list of available MSOs
  349. --ap-username USERNAME Multiple-system operator account login
  350. --ap-password PASSWORD Multiple-system operator account password.
  351. If this option is left out, youtube-dl will
  352. ask interactively.
  353. --ap-list-mso List all supported multiple-system
  354. operators
  355. ## Post-processing Options:
  356. -x, --extract-audio Convert video files to audio-only files
  357. (requires ffmpeg or avconv and ffprobe or
  358. avprobe)
  359. --audio-format FORMAT Specify audio format: "best", "aac",
  360. "flac", "mp3", "m4a", "opus", "vorbis", or
  361. "wav"; "best" by default; No effect without
  362. -x
  363. --audio-quality QUALITY Specify ffmpeg/avconv audio quality, insert
  364. a value between 0 (better) and 9 (worse)
  365. for VBR or a specific bitrate like 128K
  366. (default 5)
  367. --recode-video FORMAT Encode the video to another format if
  368. necessary (currently supported:
  369. mp4|flv|ogg|webm|mkv|avi)
  370. --postprocessor-args ARGS Give these arguments to the postprocessor
  371. -k, --keep-video Keep the video file on disk after the post-
  372. processing; the video is erased by default
  373. --no-post-overwrites Do not overwrite post-processed files; the
  374. post-processed files are overwritten by
  375. default
  376. --embed-subs Embed subtitles in the video (only for mp4,
  377. webm and mkv videos)
  378. --embed-thumbnail Embed thumbnail in the audio as cover art
  379. --add-metadata Write metadata to the video file
  380. --metadata-from-title FORMAT Parse additional metadata like song title /
  381. artist from the video title. The format
  382. syntax is the same as --output. Regular
  383. expression with named capture groups may
  384. also be used. The parsed parameters replace
  385. existing values. Example: --metadata-from-
  386. title "%(artist)s - %(title)s" matches a
  387. title like "Coldplay - Paradise". Example
  388. (regex): --metadata-from-title
  389. "(?P<artist>.+?) - (?P<title>.+)"
  390. --xattrs Write metadata to the video file's xattrs
  391. (using dublin core and xdg standards)
  392. --fixup POLICY Automatically correct known faults of the
  393. file. One of never (do nothing), warn (only
  394. emit a warning), detect_or_warn (the
  395. default; fix file if we can, warn
  396. otherwise)
  397. --prefer-avconv Prefer avconv over ffmpeg for running the
  398. postprocessors
  399. --prefer-ffmpeg Prefer ffmpeg over avconv for running the
  400. postprocessors (default)
  401. --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
  402. either the path to the binary or its
  403. containing directory.
  404. --exec CMD Execute a command on the file after
  405. downloading and post-processing, similar to
  406. find's -exec syntax. Example: --exec 'adb
  407. push {} /sdcard/Music/ && rm {}'
  408. --convert-subs FORMAT Convert the subtitles to other format
  409. (currently supported: srt|ass|vtt|lrc)
  410. # CONFIGURATION
  411. You can configure youtube-dl by placing any supported command line option to a configuration file. On Linux and macOS, the system wide configuration file is located at `/etc/youtube-dl.conf` and the user wide configuration file at `~/.config/youtube-dl/config`. On Windows, the user wide configuration file locations are `%APPDATA%\youtube-dl\config.txt` or `C:\Users\<user name>\youtube-dl.conf`. Note that by default configuration file may not exist so you may need to create it yourself.
  412. For example, with the following configuration file youtube-dl will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory:
  413. ```
  414. # Lines starting with # are comments
  415. # Always extract audio
  416. -x
  417. # Do not copy the mtime
  418. --no-mtime
  419. # Use this proxy
  420. --proxy 127.0.0.1:3128
  421. # Save all videos under Movies directory in your home directory
  422. -o ~/Movies/%(title)s.%(ext)s
  423. ```
  424. Note that options in configuration file are just the same options aka switches used in regular command line calls thus there **must be no whitespace** after `-` or `--`, e.g. `-o` or `--proxy` but not `- o` or `-- proxy`.
  425. You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
  426. You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dl run.
  427. ### Authentication with `.netrc` file
  428. You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every youtube-dl execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](https://stackoverflow.com/tags/.netrc/info) on a per extractor basis. For that you will need to create a `.netrc` file in your `$HOME` and restrict permissions to read/write by only you:
  429. ```
  430. touch $HOME/.netrc
  431. chmod a-rwx,u+rw $HOME/.netrc
  432. ```
  433. After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
  434. ```
  435. machine <extractor> login <login> password <password>
  436. ```
  437. For example:
  438. ```
  439. machine youtube login myaccount@gmail.com password my_youtube_password
  440. machine twitch login my_twitch_account_name password my_twitch_password
  441. ```
  442. To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
  443. On Windows you may also need to setup the `%HOME%` environment variable manually. For example:
  444. ```
  445. set HOME=%USERPROFILE%
  446. ```
  447. # OUTPUT TEMPLATE
  448. The `-o` option allows users to indicate a template for the output file names.
  449. **tl;dr:** [navigate me to examples](#output-template-examples).
  450. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "https://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [python string formatting operations](https://docs.python.org/2/library/stdtypes.html#string-formatting). For example, `%(NAME)s` or `%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations. Allowed names along with sequence type are:
  451. - `id` (string): Video identifier
  452. - `title` (string): Video title
  453. - `url` (string): Video URL
  454. - `ext` (string): Video filename extension
  455. - `alt_title` (string): A secondary title of the video
  456. - `display_id` (string): An alternative identifier for the video
  457. - `uploader` (string): Full name of the video uploader
  458. - `license` (string): License name the video is licensed under
  459. - `creator` (string): The creator of the video
  460. - `release_date` (string): The date (YYYYMMDD) when the video was released
  461. - `timestamp` (numeric): UNIX timestamp of the moment the video became available
  462. - `upload_date` (string): Video upload date (YYYYMMDD)
  463. - `uploader_id` (string): Nickname or id of the video uploader
  464. - `channel` (string): Full name of the channel the video is uploaded on
  465. - `channel_id` (string): Id of the channel
  466. - `location` (string): Physical location where the video was filmed
  467. - `duration` (numeric): Length of the video in seconds
  468. - `view_count` (numeric): How many users have watched the video on the platform
  469. - `like_count` (numeric): Number of positive ratings of the video
  470. - `dislike_count` (numeric): Number of negative ratings of the video
  471. - `repost_count` (numeric): Number of reposts of the video
  472. - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
  473. - `comment_count` (numeric): Number of comments on the video
  474. - `age_limit` (numeric): Age restriction for the video (years)
  475. - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
  476. - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
  477. - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
  478. - `format` (string): A human-readable description of the format
  479. - `format_id` (string): Format code specified by `--format`
  480. - `format_note` (string): Additional info about the format
  481. - `width` (numeric): Width of the video
  482. - `height` (numeric): Height of the video
  483. - `resolution` (string): Textual description of width and height
  484. - `tbr` (numeric): Average bitrate of audio and video in KBit/s
  485. - `abr` (numeric): Average audio bitrate in KBit/s
  486. - `acodec` (string): Name of the audio codec in use
  487. - `asr` (numeric): Audio sampling rate in Hertz
  488. - `vbr` (numeric): Average video bitrate in KBit/s
  489. - `fps` (numeric): Frame rate
  490. - `vcodec` (string): Name of the video codec in use
  491. - `container` (string): Name of the container format
  492. - `filesize` (numeric): The number of bytes, if known in advance
  493. - `filesize_approx` (numeric): An estimate for the number of bytes
  494. - `protocol` (string): The protocol that will be used for the actual download
  495. - `extractor` (string): Name of the extractor
  496. - `extractor_key` (string): Key name of the extractor
  497. - `epoch` (numeric): Unix epoch when creating the file
  498. - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
  499. - `playlist` (string): Name or id of the playlist that contains the video
  500. - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
  501. - `playlist_id` (string): Playlist identifier
  502. - `playlist_title` (string): Playlist title
  503. - `playlist_uploader` (string): Full name of the playlist uploader
  504. - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
  505. Available for the video that belongs to some logical chapter or section:
  506. - `chapter` (string): Name or title of the chapter the video belongs to
  507. - `chapter_number` (numeric): Number of the chapter the video belongs to
  508. - `chapter_id` (string): Id of the chapter the video belongs to
  509. Available for the video that is an episode of some series or programme:
  510. - `series` (string): Title of the series or programme the video episode belongs to
  511. - `season` (string): Title of the season the video episode belongs to
  512. - `season_number` (numeric): Number of the season the video episode belongs to
  513. - `season_id` (string): Id of the season the video episode belongs to
  514. - `episode` (string): Title of the video episode
  515. - `episode_number` (numeric): Number of the video episode within a season
  516. - `episode_id` (string): Id of the video episode
  517. Available for the media that is a track or a part of a music album:
  518. - `track` (string): Title of the track
  519. - `track_number` (numeric): Number of the track within an album or a disc
  520. - `track_id` (string): Id of the track
  521. - `artist` (string): Artist(s) of the track
  522. - `genre` (string): Genre(s) of the track
  523. - `album` (string): Title of the album the track belongs to
  524. - `album_type` (string): Type of the album
  525. - `album_artist` (string): List of all artists appeared on the album
  526. - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
  527. - `release_year` (numeric): Year (YYYY) when the album was released
  528. Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with `NA`.
  529. For example for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `youtube-dl test video` and id `BaW_jenozKcj`, this will result in a `youtube-dl test video-BaW_jenozKcj.mp4` file created in the current directory.
  530. For numeric sequences you can use numeric related formatting, for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.
  531. Output templates can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
  532. To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
  533. The current default template is `%(title)s-%(id)s.%(ext)s`.
  534. In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:
  535. #### Output template and Windows batch files
  536. If you are using an output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
  537. #### Output template examples
  538. Note that on Windows you may need to use double quotes instead of single.
  539. ```bash
  540. $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
  541. youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
  542. $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
  543. youtube-dl_test_video_.mp4 # A simple file name
  544. # Download YouTube playlist videos in separate directory indexed by video order in a playlist
  545. $ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
  546. # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
  547. $ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
  548. # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
  549. $ youtube-dl -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
  550. # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
  551. $ youtube-dl -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" https://videomore.ru/kino_v_detalayah/5_sezon/367617
  552. # Stream the video being downloaded to stdout
  553. $ youtube-dl -o - BaW_jenozKc
  554. ```
  555. # FORMAT SELECTION
  556. By default youtube-dl tries to download the best available quality, i.e. if you want the best quality you **don't need** to pass any special options, youtube-dl will guess it for you by **default**.
  557. But sometimes you may want to download in a different format, for example when you are on a slow or intermittent connection. The key mechanism for achieving this is so-called *format selection* based on which you can explicitly specify desired format, select formats based on some criterion or criteria, setup precedence and much more.
  558. The general syntax for format selection is `--format FORMAT` or shorter `-f FORMAT` where `FORMAT` is a *selector expression*, i.e. an expression that describes format or formats you would like to download.
  559. **tl;dr:** [navigate me to examples](#format-selection-examples).
  560. The simplest case is requesting a specific format, for example with `-f 22` you can download the format with format code equal to 22. You can get the list of available format codes for particular video using `--list-formats` or `-F`. Note that these format codes are extractor specific.
  561. You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
  562. You can also use special names to select particular edge case formats:
  563. - `best`: Select the best quality format represented by a single file with video and audio.
  564. - `worst`: Select the worst quality format represented by a single file with video and audio.
  565. - `bestvideo`: Select the best quality video-only format (e.g. DASH video). May not be available.
  566. - `worstvideo`: Select the worst quality video-only format. May not be available.
  567. - `bestaudio`: Select the best quality audio only-format. May not be available.
  568. - `worstaudio`: Select the worst quality audio only-format. May not be available.
  569. For example, to download the worst quality video-only format you can use `-f worstvideo`.
  570. If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that slash is left-associative, i.e. formats on the left hand side are preferred, for example `-f 22/17/18` will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
  571. If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
  572. You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
  573. The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
  574. - `filesize`: The number of bytes, if known in advance
  575. - `width`: Width of the video, if known
  576. - `height`: Height of the video, if known
  577. - `tbr`: Average bitrate of audio and video in KBit/s
  578. - `abr`: Average audio bitrate in KBit/s
  579. - `vbr`: Average video bitrate in KBit/s
  580. - `asr`: Audio sampling rate in Hertz
  581. - `fps`: Frame rate
  582. Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
  583. - `ext`: File extension
  584. - `acodec`: Name of the audio codec in use
  585. - `vcodec`: Name of the video codec in use
  586. - `container`: Name of the container format
  587. - `protocol`: The protocol that will be used for the actual download, lower-case (`http`, `https`, `rtsp`, `rtmp`, `rtmpe`, `mms`, `f4m`, `ism`, `http_dash_segments`, `m3u8`, or `m3u8_native`)
  588. - `format_id`: A short description of the format
  589. Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
  590. Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the video hoster.
  591. Formats for which the value is not known are excluded unless you put a question mark (`?`) after the operator. You can combine format filters, so `-f "[height <=? 720][tbr>500]"` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s.
  592. You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg/avconv.
  593. Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than 480 you can use `-f '(mp4,webm)[height<480]'`.
  594. Since the end of April 2015 and version 2015.04.26, youtube-dl uses `-f bestvideo+bestaudio/best` as the default format selection (see [#5447](https://github.com/ytdl-org/youtube-dl/issues/5447), [#5456](https://github.com/ytdl-org/youtube-dl/issues/5456)). If ffmpeg or avconv are installed this results in downloading `bestvideo` and `bestaudio` separately and muxing them together into a single file giving the best overall quality available. Otherwise it falls back to `best` and results in downloading the best available quality served as a single file. `best` is also needed for videos that don't come from YouTube because they don't provide the audio and video in two different files. If you want to only download some DASH formats (for example if you are not interested in getting videos with a resolution higher than 1080p), you can add `-f bestvideo[height<=?1080]+bestaudio/best` to your configuration file. Note that if you use youtube-dl to stream to `stdout` (and most likely to pipe it to your media player then), i.e. you explicitly specify output template as `-o -`, youtube-dl still uses `-f best` format selection in order to start content delivery immediately to your player and not to wait until `bestvideo` and `bestaudio` are downloaded and muxed.
  595. If you want to preserve the old format selection behavior (prior to youtube-dl 2015.04.26), i.e. you want to download the best available quality media served as a single file, you should explicitly specify your choice with `-f best`. You may want to add it to the [configuration file](#configuration) in order not to type it every time you run youtube-dl.
  596. #### Format selection examples
  597. Note that on Windows you may need to use double quotes instead of single.
  598. ```bash
  599. # Download best mp4 format available or any other best if no mp4 available
  600. $ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
  601. # Download best format available but no better than 480p
  602. $ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
  603. # Download best video only format but no bigger than 50 MB
  604. $ youtube-dl -f 'best[filesize<50M]'
  605. # Download best format available via direct link over HTTP/HTTPS protocol
  606. $ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
  607. # Download the best video format and the best audio format without merging them
  608. $ youtube-dl -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
  609. ```
  610. Note that in the last example, an output template is recommended as bestvideo and bestaudio may have the same file name.
  611. # VIDEO SELECTION
  612. Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
  613. - Absolute dates: Dates in the format `YYYYMMDD`.
  614. - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
  615. Examples:
  616. ```bash
  617. # Download only the videos uploaded in the last 6 months
  618. $ youtube-dl --dateafter now-6months
  619. # Download only the videos uploaded on January 1, 1970
  620. $ youtube-dl --date 19700101
  621. $ # Download only the videos uploaded in the 200x decade
  622. $ youtube-dl --dateafter 20000101 --datebefore 20091231
  623. ```
  624. # FAQ
  625. ### How do I update youtube-dl?
  626. If you've followed [our manual installation instructions](https://ytdl-org.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
  627. If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
  628. If you have installed youtube-dl using a package manager like *apt-get* or *yum*, use the standard system update mechanism to update. Note that distribution packages are often outdated. As a rule of thumb, youtube-dl releases at least once a month, and often weekly or even daily. Simply go to https://yt-dl.org to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
  629. As a last resort, you can also uninstall the version installed by your package manager and follow our manual installation instructions. For that, remove the distribution's package, with a line like
  630. sudo apt-get remove -y youtube-dl
  631. Afterwards, simply follow [our manual installation instructions](https://ytdl-org.github.io/youtube-dl/download.html):
  632. ```
  633. sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
  634. sudo chmod a+rx /usr/local/bin/youtube-dl
  635. hash -r
  636. ```
  637. Again, from then on you'll be able to update with `sudo youtube-dl -U`.
  638. ### youtube-dl is extremely slow to start on Windows
  639. Add a file exclusion for `youtube-dl.exe` in Windows Defender settings.
  640. ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
  641. YouTube changed their playlist format in March 2014 and later on, so you'll need at least youtube-dl 2014.07.25 to download all YouTube videos.
  642. If you have installed youtube-dl with a package manager, pip, setup.py or a tarball, please use that to update. Note that Ubuntu packages do not seem to get updated anymore. Since we are not affiliated with Ubuntu, there is little we can do. Feel free to [report bugs](https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to the [Ubuntu packaging people](mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl) - all they have to do is update the package to a somewhat recent version. See above for a way to update.
  643. ### I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`
  644. Make sure you are not using `-o` with any of these options `-t`, `--title`, `--id`, `-A` or `--auto-number` set in command line or in a configuration file. Remove the latter if any.
  645. ### Do I always have to pass `-citw`?
  646. By default, youtube-dl intends to have the best options (incidentally, if you have a convincing case that these should be different, [please file an issue where you explain that](https://yt-dl.org/bug)). Therefore, it is unnecessary and sometimes harmful to copy long option strings from webpages. In particular, the only option out of `-citw` that is regularly useful is `-i`.
  647. ### Can you please put the `-b` option back?
  648. Most people asking this question are not aware that youtube-dl now defaults to downloading the highest available quality as reported by YouTube, which will be 1080p or 720p in some cases, so you no longer need the `-b` option. For some specific videos, maybe YouTube does not report them to be available in a specific high quality format you're interested in. In that case, simply request it with the `-f` option and youtube-dl will try to download it.
  649. ### I get HTTP error 402 when trying to download a video. What's this?
  650. Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/ytdl-org/youtube-dl/issues/154), but at the moment, your best course of action is pointing a web browser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
  651. ### Do I need any other programs?
  652. youtube-dl works fine on its own on most sites. However, if you want to convert video/audio, you'll need [avconv](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/). On some sites - most notably YouTube - videos can be retrieved in a higher quality format without sound. youtube-dl will detect whether avconv/ffmpeg is present and automatically pick the best option.
  653. Videos or video formats streamed via RTMP protocol can only be downloaded when [rtmpdump](https://rtmpdump.mplayerhq.hu/) is installed. Downloading MMS and RTSP videos requires either [mplayer](https://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
  654. ### I have downloaded a video but how can I play it?
  655. Once the video is fully downloaded, use any video player, such as [mpv](https://mpv.io/), [vlc](https://www.videolan.org/) or [mplayer](https://www.mplayerhq.hu/).
  656. ### I extracted a video URL with `-g`, but it does not play on another machine / in my web browser.
  657. It depends a lot on the service. In many cases, requests for the video (to download/play it) must come from the same IP address and with the same cookies and/or HTTP headers. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl. You can also get necessary cookies and HTTP headers from JSON output obtained with `--dump-json`.
  658. It may be beneficial to use IPv6; in some cases, the restrictions are only applied to IPv4. Some services (sometimes only for a subset of videos) do not restrict the video URL by IP address, cookie, or user-agent, but these are the exception rather than the rule.
  659. Please bear in mind that some URL protocols are **not** supported by browsers out of the box, including RTMP. If you are using `-g`, your own downloader must support these as well.
  660. If you want to play the video on a machine that is not running youtube-dl, you can relay the video content from the machine that runs youtube-dl. You can use `-o -` to let youtube-dl stream a video to stdout, or simply allow the player to download the files written by youtube-dl in turn.
  661. ### ERROR: no fmt_url_map or conn information found in video info
  662. YouTube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
  663. ### ERROR: unable to download video
  664. YouTube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
  665. ### Video URL contains an ampersand and I'm getting some strange output `[1] 2839` or `'v' is not recognized as an internal or external command`
  666. That's actually the output from your shell. Since ampersand is one of the special shell characters it's interpreted by the shell preventing you from passing the whole URL to youtube-dl. To disable your shell from interpreting the ampersands (or any other special characters) you have to either put the whole URL in quotes or escape them with a backslash (which approach will work depends on your shell).
  667. For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
  668. ```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
  669. or
  670. ```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
  671. For Windows you have to use the double quotes:
  672. ```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
  673. ### ExtractorError: Could not find JS function u'OF'
  674. In February 2015, the new YouTube player contained a character sequence in a string that was misinterpreted by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
  675. ### HTTP Error 429: Too Many Requests or 402: Payment Required
  676. These two error codes indicate that the service is blocking your IP address because of overuse. Usually this is a soft block meaning that you can gain access again after solving CAPTCHA. Just open a browser and solve a CAPTCHA the service suggests you and after that [pass cookies](#how-do-i-pass-cookies-to-youtube-dl) to youtube-dl. Note that if your machine has multiple external IPs then you should also pass exactly the same IP you've used for solving CAPTCHA with [`--source-address`](#network-options). Also you may need to pass a `User-Agent` HTTP header of your browser with [`--user-agent`](#workarounds).
  677. If this is not the case (no CAPTCHA suggested to solve by the service) then you can contact the service and ask them to unblock your IP address, or - if you have acquired a whitelisted IP address already - use the [`--proxy` or `--source-address` options](#network-options) to select another IP address.
  678. ### SyntaxError: Non-ASCII character
  679. The error
  680. File "youtube-dl", line 2
  681. SyntaxError: Non-ASCII character '\x93' ...
  682. means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
  683. ### What is this binary file? Where has the code gone?
  684. Since June 2012 ([#342](https://github.com/ytdl-org/youtube-dl/issues/342)) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
  685. ### The exe throws an error due to missing `MSVCR100.dll`
  686. To run the exe you need to install first the [Microsoft Visual C++ 2010 Redistributable Package (x86)](https://www.microsoft.com/en-US/download/details.aspx?id=5555).
  687. ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
  688. If you put youtube-dl and ffmpeg in the same directory that you're running the command from, it will work, but that's rather cumbersome.
  689. To make a different directory work - either for ffmpeg, or for youtube-dl, or for both - simply create the directory (say, `C:\bin`, or `C:\Users\<User name>\bin`), put all the executables directly in there, and then [set your PATH environment variable](https://www.java.com/en/download/help/path.xml) to include that directory.
  690. From then on, after restarting your shell, you will be able to access both youtube-dl and ffmpeg (and youtube-dl will be able to find ffmpeg) by simply typing `youtube-dl` or `ffmpeg`, no matter what directory you're in.
  691. ### How do I put downloads into a specific folder?
  692. Use the `-o` to specify an [output template](#output-template), for example `-o "/home/user/videos/%(title)s-%(id)s.%(ext)s"`. If you want this for all of your downloads, put the option into your [configuration file](#configuration).
  693. ### How do I download a video starting with a `-`?
  694. Either prepend `https://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
  695. youtube-dl -- -wNyEUrxzFU
  696. youtube-dl "https://www.youtube.com/watch?v=-wNyEUrxzFU"
  697. ### How do I pass cookies to youtube-dl?
  698. Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`.
  699. In order to extract cookies from browser use any conforming browser extension for exporting cookies. For example, [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg) (for Chrome) or [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/) (for Firefox).
  700. Note that the cookies file must be in Mozilla/Netscape format and the first line of the cookies file must be either `# HTTP Cookie File` or `# Netscape HTTP Cookie File`. Make sure you have correct [newline format](https://en.wikipedia.org/wiki/Newline) in the cookies file and convert newlines if necessary to correspond with your OS, namely `CRLF` (`\r\n`) for Windows and `LF` (`\n`) for Unix and Unix-like systems (Linux, macOS, etc.). `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
  701. Passing cookies to youtube-dl is a good way to workaround login when a particular extractor does not implement it explicitly. Another use case is working around [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) some websites require you to solve in particular cases in order to get access (e.g. YouTube, CloudFlare).
  702. ### How do I stream directly to media player?
  703. You will first need to tell youtube-dl to stream media to stdout with `-o -`, and also tell your media player to read from stdin (it must be capable of this for streaming) and then pipe former to latter. For example, streaming to [vlc](https://www.videolan.org/) can be achieved with:
  704. youtube-dl -o - "https://www.youtube.com/watch?v=BaW_jenozKcj" | vlc -
  705. ### How do I download only new videos from a playlist?
  706. Use download-archive feature. With this feature you should initially download the complete playlist with `--download-archive /path/to/download/archive/file.txt` that will record identifiers of all the videos in a special file. Each subsequent run with the same `--download-archive` will download only new videos and skip all videos that have been downloaded before. Note that only successful downloads are recorded in the file.
  707. For example, at first,
  708. youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
  709. will download the complete `PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re` playlist and create a file `archive.txt`. Each subsequent run will only download new videos if any:
  710. youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
  711. ### Should I add `--hls-prefer-native` into my config?
  712. When youtube-dl detects an HLS video, it can download it either with the built-in downloader or ffmpeg. Since many HLS streams are slightly invalid and ffmpeg/youtube-dl each handle some invalid cases better than the other, there is an option to switch the downloader if needed.
  713. When youtube-dl knows that one particular downloader works better for a given website, that downloader will be picked. Otherwise, youtube-dl will pick the best downloader for general compatibility, which at the moment happens to be ffmpeg. This choice may change in future versions of youtube-dl, with improvements of the built-in downloader and/or ffmpeg.
  714. In particular, the generic extractor (used when your website is not in the [list of supported sites by youtube-dl](https://ytdl-org.github.io/youtube-dl/supportedsites.html) cannot mandate one specific downloader.
  715. If you put either `--hls-prefer-native` or `--hls-prefer-ffmpeg` into your configuration, a different subset of videos will fail to download correctly. Instead, it is much better to [file an issue](https://yt-dl.org/bug) or a pull request which details why the native or the ffmpeg HLS downloader is a better choice for your use case.
  716. ### Can you add support for this anime video site, or site which shows current movies for free?
  717. As a matter of policy (as well as legality), youtube-dl does not include support for services that specialize in infringing copyright. As a rule of thumb, if you cannot easily find a video that the service is quite obviously allowed to distribute (i.e. that has been uploaded by the creator, the creator's distributor, or is published under a free license), the service is probably unfit for inclusion to youtube-dl.
  718. A note on the service that they don't host the infringing content, but just link to those who do, is evidence that the service should **not** be included into youtube-dl. The same goes for any DMCA note when the whole front page of the service is filled with videos they are not allowed to distribute. A "fair use" note is equally unconvincing if the service shows copyright-protected videos in full without authorization.
  719. Support requests for services that **do** purchase the rights to distribute their content are perfectly fine though. If in doubt, you can simply include a source that mentions the legitimate purchase of content.
  720. ### How can I speed up work on my issue?
  721. (Also known as: Help, my important issue not being solved!) The youtube-dl core developer team is quite small. While we do our best to solve as many issues as possible, sometimes that can take quite a while. To speed up your issue, here's what you can do:
  722. First of all, please do report the issue [at our issue tracker](https://yt-dl.org/bugs). That allows us to coordinate all efforts by users and developers, and serves as a unified point. Unfortunately, the youtube-dl project has grown too large to use personal email as an effective communication channel.
  723. Please read the [bug reporting instructions](#bugs) below. A lot of bugs lack all the necessary information. If you can, offer proxy, VPN, or shell access to the youtube-dl developers. If you are able to, test the issue from multiple computers in multiple countries to exclude local censorship or misconfiguration issues.
  724. If nobody is interested in solving your issue, you are welcome to take matters into your own hands and submit a pull request (or coerce/pay somebody else to do so).
  725. Feel free to bump the issue from time to time by writing a small comment ("Issue is still present in youtube-dl version ...from France, but fixed from Belgium"), but please not more than once a month. Please do not declare your issue as `important` or `urgent`.
  726. ### How can I detect whether a given URL is supported by youtube-dl?
  727. For one, have a look at the [list of supported sites](docs/supportedsites.md). Note that it can sometimes happen that the site changes its URL scheme (say, from https://example.com/video/1234567 to https://example.com/v/1234567 ) and youtube-dl reports an URL of a service in that list as unsupported. In that case, simply report a bug.
  728. It is *not* possible to detect whether a URL is supported or not. That's because youtube-dl contains a generic extractor which matches **all** URLs. You may be tempted to disable, exclude, or remove the generic extractor, but the generic extractor not only allows users to extract videos from lots of websites that embed a video from another service, but may also be used to extract video from a service that it's hosting itself. Therefore, we neither recommend nor support disabling, excluding, or removing the generic extractor.
  729. If you want to find out whether a given URL is supported, simply call youtube-dl with it. If you get no videos back, chances are the URL is either not referring to a video or unsupported. You can find out which by examining the output (if you run youtube-dl on the console) or catching an `UnsupportedError` exception if you run it from a Python program.
  730. # Why do I need to go through that much red tape when filing bugs?
  731. Before we had the issue template, despite our extensive [bug reporting instructions](#bugs), about 80% of the issue reports we got were useless, for instance because people used ancient versions hundreds of releases old, because of simple syntactic errors (not in youtube-dl but in general shell usage), because the problem was already reported multiple times before, because people did not actually read an error message, even if it said "please install ffmpeg", because people did not mention the URL they were trying to download and many more simple, easy-to-avoid problems, many of whom were totally unrelated to youtube-dl.
  732. youtube-dl is an open-source project manned by too few volunteers, so we'd rather spend time fixing bugs where we are certain none of those simple problems apply, and where we can be reasonably confident to be able to reproduce the issue without asking the reporter repeatedly. As such, the output of `youtube-dl -v YOUR_URL_HERE` is really all that's required to file an issue. The issue template also guides you through some basic steps you can do, such as checking that your version of youtube-dl is current.
  733. # DEVELOPER INSTRUCTIONS
  734. Most users do not need to build youtube-dl and can [download the builds](https://ytdl-org.github.io/youtube-dl/download.html) or get them from their distribution.
  735. To run youtube-dl as a developer, you don't need to build anything either. Simply execute
  736. python -m youtube_dl
  737. To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
  738. python -m unittest discover
  739. python test/test_download.py
  740. nosetests
  741. See item 6 of [new extractor tutorial](#adding-support-for-a-new-site) for how to run extractor specific test cases.
  742. If you want to create a build of youtube-dl yourself, you'll need
  743. * python
  744. * make (only GNU make is supported)
  745. * pandoc
  746. * zip
  747. * nosetests
  748. ### Adding support for a new site
  749. If you want to add support for a new site, first of all **make sure** this site is **not dedicated to [copyright infringement](README.md#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)**. youtube-dl does **not support** such sites thus pull requests adding support for them **will be rejected**.
  750. After you have ensured this site is distributing its content legally, you can follow this quick list (assuming your service is called `yourextractor`):
  751. 1. [Fork this repository](https://github.com/ytdl-org/youtube-dl/fork)
  752. 2. Check out the source code with:
  753. git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
  754. 3. Start a new git branch with
  755. cd youtube-dl
  756. git checkout -b yourextractor
  757. 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
  758. ```python
  759. # coding: utf-8
  760. from __future__ import unicode_literals
  761. from .common import InfoExtractor
  762. class YourExtractorIE(InfoExtractor):
  763. _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
  764. _TEST = {
  765. 'url': 'https://yourextractor.com/watch/42',
  766. 'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
  767. 'info_dict': {
  768. 'id': '42',
  769. 'ext': 'mp4',
  770. 'title': 'Video title goes here',
  771. 'thumbnail': r're:^https?://.*\.jpg$',
  772. # TODO more properties, either as:
  773. # * A value
  774. # * MD5 checksum; start the string with md5:
  775. # * A regular expression; start the string with re:
  776. # * Any Python type (for example int or float)
  777. }
  778. }
  779. def _real_extract(self, url):
  780. video_id = self._match_id(url)
  781. webpage = self._download_webpage(url, video_id)
  782. # TODO more code goes here, for example ...
  783. title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
  784. return {
  785. 'id': video_id,
  786. 'title': title,
  787. 'description': self._og_search_description(webpage),
  788. 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
  789. # TODO more properties (see youtube_dl/extractor/common.py)
  790. }
  791. ```
  792. 5. Add an import in [`youtube_dl/extractor/extractors.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
  793. 6. Run `python test/test_download.py TestDownload.test_YourExtractor`. This *should fail* at first, but you can continually re-run it until you're done. If you decide to add more than one test, then rename ``_TEST`` to ``_TESTS`` and make it into a list of dictionaries. The tests will then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc. Note that tests with `only_matching` key in test's dict are not counted in.
  794. 7. Have a look at [`youtube_dl/extractor/common.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should and may return](https://github.com/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L94-L303). Add tests and code for as many as you want.
  795. 8. Make sure your code follows [youtube-dl coding conventions](#youtube-dl-coding-conventions) and check the code with [flake8](https://flake8.pycqa.org/en/latest/index.html#quickstart):
  796. $ flake8 youtube_dl/extractor/yourextractor.py
  797. 9. Make sure your code works under all [Python](https://www.python.org/) versions claimed supported by youtube-dl, namely 2.6, 2.7, and 3.2+.
  798. 10. When the tests pass, [add](https://git-scm.com/docs/git-add) the new files and [commit](https://git-scm.com/docs/git-commit) them and [push](https://git-scm.com/docs/git-push) the result, like this:
  799. $ git add youtube_dl/extractor/extractors.py
  800. $ git add youtube_dl/extractor/yourextractor.py
  801. $ git commit -m '[yourextractor] Add new extractor'
  802. $ git push origin yourextractor
  803. 11. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
  804. In any case, thank you very much for your contributions!
  805. ## youtube-dl coding conventions
  806. This section introduces a guide lines for writing idiomatic, robust and future-proof extractor code.
  807. Extractors are very fragile by nature since they depend on the layout of the source data provided by 3rd party media hosters out of your control and this layout tends to change. As an extractor implementer your task is not only to write code that will extract media links and metadata correctly but also to minimize dependency on the source's layout and even to make the code foresee potential future changes and be ready for that. This is important because it will allow the extractor not to break on minor layout changes thus keeping old youtube-dl versions working. Even though this breakage issue is easily fixed by emitting a new version of youtube-dl with a fix incorporated, all the previous versions become broken in all repositories and distros' packages that may not be so prompt in fetching the update from us. Needless to say, some non rolling release distros may never receive an update at all.
  808. ### Mandatory and optional metafields
  809. For extraction to work youtube-dl relies on metadata your extractor extracts and provides to youtube-dl expressed by an [information dictionary](https://github.com/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L94-L303) or simply *info dict*. Only the following meta fields in the *info dict* are considered mandatory for a successful extraction process by youtube-dl:
  810. - `id` (media identifier)
  811. - `title` (media title)
  812. - `url` (media download URL) or `formats`
  813. In fact only the last option is technically mandatory (i.e. if you can't figure out the download location of the media the extraction does not make any sense). But by convention youtube-dl also treats `id` and `title` as mandatory. Thus the aforementioned metafields are the critical data that the extraction does not make any sense without and if any of them fail to be extracted then the extractor is considered completely broken.
  814. [Any field](https://github.com/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L188-L303) apart from the aforementioned ones are considered **optional**. That means that extraction should be **tolerant** to situations when sources for these fields can potentially be unavailable (even if they are always available at the moment) and **future-proof** in order not to break the extraction of general purpose mandatory fields.
  815. #### Example
  816. Say you have some source dictionary `meta` that you've fetched as JSON with HTTP request and it has a key `summary`:
  817. ```python
  818. meta = self._download_json(url, video_id)
  819. ```
  820. Assume at this point `meta`'s layout is:
  821. ```python
  822. {
  823. ...
  824. "summary": "some fancy summary text",
  825. ...
  826. }
  827. ```
  828. Assume you want to extract `summary` and put it into the resulting info dict as `description`. Since `description` is an optional meta field you should be ready that this key may be missing from the `meta` dict, so that you should extract it like:
  829. ```python
  830. description = meta.get('summary') # correct
  831. ```
  832. and not like:
  833. ```python
  834. description = meta['summary'] # incorrect
  835. ```
  836. The latter will break extraction process with `KeyError` if `summary` disappears from `meta` at some later time but with the former approach extraction will just go ahead with `description` set to `None` which is perfectly fine (remember `None` is equivalent to the absence of data).
  837. Similarly, you should pass `fatal=False` when extracting optional data from a webpage with `_search_regex`, `_html_search_regex` or similar methods, for instance:
  838. ```python
  839. description = self._search_regex(
  840. r'<span[^>]+id="title"[^>]*>([^<]+)<',
  841. webpage, 'description', fatal=False)
  842. ```
  843. With `fatal` set to `False` if `_search_regex` fails to extract `description` it will emit a warning and continue extraction.
  844. You can also pass `default=<some fallback value>`, for example:
  845. ```python
  846. description = self._search_regex(
  847. r'<span[^>]+id="title"[^>]*>([^<]+)<',
  848. webpage, 'description', default=None)
  849. ```
  850. On failure this code will silently continue the extraction with `description` set to `None`. That is useful for metafields that may or may not be present.
  851. ### Provide fallbacks
  852. When extracting metadata try to do so from multiple sources. For example if `title` is present in several places, try extracting from at least some of them. This makes it more future-proof in case some of the sources become unavailable.
  853. #### Example
  854. Say `meta` from the previous example has a `title` and you are about to extract it. Since `title` is a mandatory meta field you should end up with something like:
  855. ```python
  856. title = meta['title']
  857. ```
  858. If `title` disappears from `meta` in future due to some changes on the hoster's side the extraction would fail since `title` is mandatory. That's expected.
  859. Assume that you have some another source you can extract `title` from, for example `og:title` HTML meta of a `webpage`. In this case you can provide a fallback scenario:
  860. ```python
  861. title = meta.get('title') or self._og_search_title(webpage)
  862. ```
  863. This code will try to extract from `meta` first and if it fails it will try extracting `og:title` from a `webpage`.
  864. ### Regular expressions
  865. #### Don't capture groups you don't use
  866. Capturing group must be an indication that it's used somewhere in the code. Any group that is not used must be non capturing.
  867. ##### Example
  868. Don't capture id attribute name here since you can't use it for anything anyway.
  869. Correct:
  870. ```python
  871. r'(?:id|ID)=(?P<id>\d+)'
  872. ```
  873. Incorrect:
  874. ```python
  875. r'(id|ID)=(?P<id>\d+)'
  876. ```
  877. #### Make regular expressions relaxed and flexible
  878. When using regular expressions try to write them fuzzy, relaxed and flexible, skipping insignificant parts that are more likely to change, allowing both single and double quotes for quoted values and so on.
  879. ##### Example
  880. Say you need to extract `title` from the following HTML code:
  881. ```html
  882. <span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">some fancy title</span>
  883. ```
  884. The code for that task should look similar to:
  885. ```python
  886. title = self._search_regex(
  887. r'<span[^>]+class="title"[^>]*>([^<]+)', webpage, 'title')
  888. ```
  889. Or even better:
  890. ```python
  891. title = self._search_regex(
  892. r'<span[^>]+class=(["\'])title\1[^>]*>(?P<title>[^<]+)',
  893. webpage, 'title', group='title')
  894. ```
  895. Note how you tolerate potential changes in the `style` attribute's value or switch from using double quotes to single for `class` attribute:
  896. The code definitely should not look like:
  897. ```python
  898. title = self._search_regex(
  899. r'<span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">(.*?)</span>',
  900. webpage, 'title', group='title')
  901. ```
  902. ### Long lines policy
  903. There is a soft limit to keep lines of code under 80 characters long. This means it should be respected if possible and if it does not make readability and code maintenance worse.
  904. For example, you should **never** split long string literals like URLs or some other often copied entities over multiple lines to fit this limit:
  905. Correct:
  906. ```python
  907. 'https://www.youtube.com/watch?v=FqZTN594JQw&list=PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
  908. ```
  909. Incorrect:
  910. ```python
  911. 'https://www.youtube.com/watch?v=FqZTN594JQw&list='
  912. 'PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
  913. ```
  914. ### Inline values
  915. Extracting variables is acceptable for reducing code duplication and improving readability of complex expressions. However, you should avoid extracting variables used only once and moving them to opposite parts of the extractor file, which makes reading the linear flow difficult.
  916. #### Example
  917. Correct:
  918. ```python
  919. title = self._html_search_regex(r'<title>([^<]+)</title>', webpage, 'title')
  920. ```
  921. Incorrect:
  922. ```python
  923. TITLE_RE = r'<title>([^<]+)</title>'
  924. # ...some lines of code...
  925. title = self._html_search_regex(TITLE_RE, webpage, 'title')
  926. ```
  927. ### Collapse fallbacks
  928. Multiple fallback values can quickly become unwieldy. Collapse multiple fallback values into a single expression via a list of patterns.
  929. #### Example
  930. Good:
  931. ```python
  932. description = self._html_search_meta(
  933. ['og:description', 'description', 'twitter:description'],
  934. webpage, 'description', default=None)
  935. ```
  936. Unwieldy:
  937. ```python
  938. description = (
  939. self._og_search_description(webpage, default=None)
  940. or self._html_search_meta('description', webpage, default=None)
  941. or self._html_search_meta('twitter:description', webpage, default=None))
  942. ```
  943. Methods supporting list of patterns are: `_search_regex`, `_html_search_regex`, `_og_search_property`, `_html_search_meta`.
  944. ### Trailing parentheses
  945. Always move trailing parentheses after the last argument.
  946. #### Example
  947. Correct:
  948. ```python
  949. lambda x: x['ResultSet']['Result'][0]['VideoUrlSet']['VideoUrl'],
  950. list)
  951. ```
  952. Incorrect:
  953. ```python
  954. lambda x: x['ResultSet']['Result'][0]['VideoUrlSet']['VideoUrl'],
  955. list,
  956. )
  957. ```
  958. ### Use convenience conversion and parsing functions
  959. Wrap all extracted numeric data into safe functions from [`youtube_dl/utils.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/utils.py): `int_or_none`, `float_or_none`. Use them for string to number conversions as well.
  960. Use `url_or_none` for safe URL processing.
  961. Use `try_get` for safe metadata extraction from parsed JSON.
  962. Use `unified_strdate` for uniform `upload_date` or any `YYYYMMDD` meta field extraction, `unified_timestamp` for uniform `timestamp` extraction, `parse_filesize` for `filesize` extraction, `parse_count` for count meta fields extraction, `parse_resolution`, `parse_duration` for `duration` extraction, `parse_age_limit` for `age_limit` extraction.
  963. Explore [`youtube_dl/utils.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/utils.py) for more useful convenience functions.
  964. #### More examples
  965. ##### Safely extract optional description from parsed JSON
  966. ```python
  967. description = try_get(response, lambda x: x['result']['video'][0]['summary'], compat_str)
  968. ```
  969. ##### Safely extract more optional metadata
  970. ```python
  971. video = try_get(response, lambda x: x['result']['video'][0], dict) or {}
  972. description = video.get('summary')
  973. duration = float_or_none(video.get('durationMs'), scale=1000)
  974. view_count = int_or_none(video.get('views'))
  975. ```
  976. # EMBEDDING YOUTUBE-DL
  977. youtube-dl makes the best effort to be a good command-line program, and thus should be callable from any programming language. If you encounter any problems parsing its output, feel free to [create a report](https://github.com/ytdl-org/youtube-dl/issues/new).
  978. From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
  979. ```python
  980. from __future__ import unicode_literals
  981. import youtube_dl
  982. ydl_opts = {}
  983. with youtube_dl.YoutubeDL(ydl_opts) as ydl:
  984. ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
  985. ```
  986. Most likely, you'll want to use various options. For a list of options available, have a look at [`youtube_dl/YoutubeDL.py`](https://github.com/ytdl-org/youtube-dl/blob/3e4cedf9e8cd3157df2457df7274d0c842421945/youtube_dl/YoutubeDL.py#L137-L312). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
  987. Here's a more complete example of a program that outputs only errors (and a short message after the download is finished), and downloads/converts the video to an mp3 file:
  988. ```python
  989. from __future__ import unicode_literals
  990. import youtube_dl
  991. class MyLogger(object):
  992. def debug(self, msg):
  993. pass
  994. def warning(self, msg):
  995. pass
  996. def error(self, msg):
  997. print(msg)
  998. def my_hook(d):
  999. if d['status'] == 'finished':
  1000. print('Done downloading, now converting ...')
  1001. ydl_opts = {
  1002. 'format': 'bestaudio/best',
  1003. 'postprocessors': [{
  1004. 'key': 'FFmpegExtractAudio',
  1005. 'preferredcodec': 'mp3',
  1006. 'preferredquality': '192',
  1007. }],
  1008. 'logger': MyLogger(),
  1009. 'progress_hooks': [my_hook],
  1010. }
  1011. with youtube_dl.YoutubeDL(ydl_opts) as ydl:
  1012. ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
  1013. ```
  1014. # BUGS
  1015. Bugs and suggestions should be reported at: <https://github.com/ytdl-org/youtube-dl/issues>. Unless you were prompted to or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email. For discussions, join us in the IRC channel [#youtube-dl](irc://chat.freenode.net/#youtube-dl) on freenode ([webchat](https://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
  1016. **Please include the full output of youtube-dl when run with `-v`**, i.e. **add** `-v` flag to **your command line**, copy the **whole** output and post it in the issue body wrapped in \`\`\` for better formatting. It should look similar to this:
  1017. ```
  1018. $ youtube-dl -v <your command line>
  1019. [debug] System config: []
  1020. [debug] User config: []
  1021. [debug] Command-line args: [u'-v', u'https://www.youtube.com/watch?v=BaW_jenozKcj']
  1022. [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
  1023. [debug] youtube-dl version 2015.12.06
  1024. [debug] Git HEAD: 135392e
  1025. [debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
  1026. [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
  1027. [debug] Proxy map: {}
  1028. ...
  1029. ```
  1030. **Do not post screenshots of verbose logs; only plain text is acceptable.**
  1031. The output (including the first lines) contains important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
  1032. Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
  1033. ### Is the description of the issue itself sufficient?
  1034. We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources. Many contributors, including myself, are also not native speakers, so we may misread some parts.
  1035. So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
  1036. - What the problem is
  1037. - How it could be fixed
  1038. - How your proposed solution would look like
  1039. If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a committer myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
  1040. For bug reports, this means that your report should contain the *complete* output of youtube-dl when called with the `-v` flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
  1041. If your server has multiple IPs or you suspect censorship, adding `--call-home` may be a good idea to get more diagnostics. If the error is `ERROR: Unable to extract ...` and you cannot reproduce it from multiple countries, add `--dump-pages` (warning: this will yield a rather large output, redirect it to the file `log.txt` by adding `>log.txt 2>&1` to your command-line) or upload the `.dump` files you get when you add `--write-pages` [somewhere](https://gist.github.com/).
  1042. **Site support requests must contain an example URL**. An example URL is a URL you might want to download, like `https://www.youtube.com/watch?v=BaW_jenozKc`. There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. `https://www.youtube.com/`) is *not* an example URL.
  1043. ### Are you using the latest version?
  1044. Before reporting any issue, type `youtube-dl -U`. This should report that you're up-to-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. This goes for feature requests as well.
  1045. ### Is the issue already documented?
  1046. Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or browse the [GitHub Issues](https://github.com/ytdl-org/youtube-dl/search?type=Issues) of this repository. If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
  1047. ### Why are existing options not enough?
  1048. Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/ytdl-org/youtube-dl/blob/master/README.md#options). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
  1049. ### Is there enough context in your bug report?
  1050. People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
  1051. We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
  1052. ### Does the issue involve one problem, and one problem only?
  1053. Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
  1054. In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, White house podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
  1055. ### Is anyone going to need the feature?
  1056. Only post features that you (or an incapacitated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
  1057. ### Is your question about youtube-dl?
  1058. It may sound strange, but some bug reports we receive are completely unrelated to youtube-dl and relate to a different, or even the reporter's own, application. Please make sure that you are actually using youtube-dl. If you are using a UI for youtube-dl, report the bug to the maintainer of the actual application providing the UI. On the other hand, if your UI for youtube-dl fails in some way you believe is related to youtube-dl, by all means, go ahead and report the bug.
  1059. # COPYRIGHT
  1060. youtube-dl is released into the public domain by the copyright holders.
  1061. This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.