Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JimmyBoh/pully
A simple CLI and library for downloading high quality YouTube videos!
https://github.com/JimmyBoh/pully
cli hacktoberfest high-quality node-module video youtube-downloader
Last synced: 5 days ago
JSON representation
A simple CLI and library for downloading high quality YouTube videos!
- Host: GitHub
- URL: https://github.com/JimmyBoh/pully
- Owner: jimbuck
- License: mit
- Created: 2014-12-15T03:24:20.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:37:52.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T05:56:16.047Z (about 2 months ago)
- Topics: cli, hacktoberfest, high-quality, node-module, video, youtube-downloader
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/pully
- Size: 780 KB
- Stars: 189
- Watchers: 11
- Forks: 19
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-typescript - pully - A simple CLI and library for downloading high quality YouTube videos! (Table of Contents / YouTube)
README
# pully
[](https://travis-ci.org/JimmyBoh/pully)
[](https://coveralls.io/github/JimmyBoh/pully?branch=master)
[](https://david-dm.org/JimmyBoh/pully)
[](https://david-dm.org/JimmyBoh/pully?type=dev)
[](https://www.npmjs.com/package/pully)
[](https://www.npmjs.com/package/pully)
[](https://www.npmjs.com/package/pully)
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](https://www.npmjs.com/package/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](https://github.com/kribblo/node-ffmpeg-installer)!
```bash
npm i -g pully
```
### Usage
```bash
pully download [-p ="hd"] [-d ="."] [-t ="${channelName}/${videoTitle}"] [--silent]
pully set dir "~/Jim/videos/YouTube"
pully get dir # Prints ~/Jim/videos/YouTube
pully dl # Downloads specified video to ~/Jim/videos/YouTube//.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
```bash
npm i pully
```
### Usage
```ts
import { Pully, Presets } from 'pully';
const pully = new Pully();
const video = await pully.query('');
console.log(`${video.videoTitle} by ${video.channelName} has ${video.views} views!`);
const options = {
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
1. `npm i`
1. `npm run watch`
1. Make changes and **write tests**.
1. Send pull request! :sunglasses:
## License
MIT