Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 3.81 KB

README.md

File metadata and controls

94 lines (63 loc) · 3.81 KB
Raw

pully

Build Status Code Coverage Dependencies DevDependencies npm Monthly Downloads Total Downloads

A simple CLI for downloading high quality Youtube videos!

This tool allows the downloading of Youtube videos of 1080p and higher qualities. The video and audio is separate, so this combines them after downloading both.

ATTENTION

While this tool makes it easy to download content from Youtube, I do not endorse the theft of content created by hardworking citizens of the Internet. If you use Youtube as a primary source of entertainment, then please remember to turn off ad-block, buy their merchandise, or donate to the content creators you love to watch. And if you can't do that then simply like, comment, and subscribe to help them get more people enjoying their content.

CLI

Installation

Note: Pully requires ffmpeg to be installed. fluent-ffmpeg has great instructions on how to set this up. Pully now automatically downloads the required version of ffmpeg thanks to kribblo/node-ffmpeg-installer!

npm i -g pully

Usage

pully download <url> [-p <preset>="hd"] [-d <outputDir>="."] [-t <filenameTemplate>="${channelName}/${videoTitle}"] [--silent]

pully set dir "~/Jim/videos/YouTube"

pully get dir # Prints ~/Jim/videos/YouTube

pully dl <url> # Downloads specified video to ~/Jim/videos/YouTube/<author>/<title>.mp4

Downloads a specified video based on a preset, defaulting to HD (see below). By default the file is named after the title and placed in a folder named after the channel.

Presets

Presets are used in the CLI version to simplify getting the video you want. Presets are available in the module, and can be overridden/extended!

  • hd This will download the best video up to 1080p60. (default)
  • 2k This will download the best video up to 1440p60.
  • 4k This will download the best video up to 2160p60.
  • max This will download the best video, no limits on resolution or framerate.
  • hfr This will download the video with the highest framerate.
  • mp3 This will only download the audio only, and convert it to mp3.

Node Module

Installation

npm i pully

Usage

import { Pully, Presets } from 'pully';

const pully = new Pully();

const video = await pully.query('<some-neato-video-url>');
console.log(`${video.videoTitle} by ${video.channelName} has ${video.views} views!`);

const options = {
  url: '<some-really-high-def-video-url>',
  preset: Presets.FourK,
  progress: (data) => console.log(data.percent + '%') // Progress reporter callback...
};

const { path, format, duration } = await pully.download(options);
console.log(path);     // Path to the downloaded file.
console.log(format);   // Object containing all audio/video/meta data.
console.log(duration); // Number of milliseconds the download took.

Contribute

  1. Fork it
  2. npm i
  3. npm run watch
  4. Make changes and write tests.
  5. Send pull request! 😎

License

MIT