pully

KO | EN

gitlite — search

#javascript #react #ai #typescript #go #deep-learning #docker #macos #nodejs #cli #awesome-list #pytorch #openai #open-source

(★ 189)

A simple CLI and library for downloading high quality YouTube videos!

File Explorer

Download Latest Version (.zip)

- cSpell.json
- launch.json
- settings.json
- - pully.ts
- - analyzer.spec.ts
  - analyzer.ts
  - download.ts
  - models.ts
  - presets.ts
- - guid.spec.ts
  - guid.ts
  - human.spec.ts
  - human.ts
  - progress.spec.ts
  - progress.ts
  - speedometer.ts
- benchmark.ts
- debug.ts
- index.spec.ts
- index.ts
.gitignore
.npmignore
.travis.yml
index.js
jsconfig.json
LICENSE
package-lock.json
package.json
README.md
tsconfig.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# pully

[![Build Status](https://img.shields.io/travis/JimmyBoh/pully/master.svg?style=flat-square)](https://travis-ci.org/JimmyBoh/pully)
[![Code Coverage](https://img.shields.io/coveralls/JimmyBoh/pully/master.svg?style=flat-square)](https://coveralls.io/github/JimmyBoh/pully?branch=master)
[![Dependencies](https://img.shields.io/david/JimmyBoh/pully.svg?style=flat-square)](https://david-dm.org/JimmyBoh/pully)
[![DevDependencies](https://img.shields.io/david/dev/JimmyBoh/pully.svg?style=flat-square)](https://david-dm.org/JimmyBoh/pully?type=dev)
[![npm](https://img.shields.io/npm/v/pully.svg?style=flat-square)](https://www.npmjs.com/package/pully)
[![Monthly Downloads](https://img.shields.io/npm/dm/pully.svg?style=flat-square)](https://www.npmjs.com/package/pully)
[![Total Downloads](https://img.shields.io/npm/dt/pully.svg?style=flat-square)](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 <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

```bash
npm i pully
```

### Usage

```ts
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
1. `npm i`
1. `npm run watch`
1. Make changes and **write tests**.
1. Send pull request! :sunglasses:

## License

MIT

pully

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

pully

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README