Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eomm/youtube-download-playlist
CLI and npm module to extract audio from YouTube videos (so you are able to listen them like a podcast)
https://github.com/eomm/youtube-download-playlist
cli module youtube youtube-dl youtube-downloader
Last synced: about 4 hours ago
JSON representation
CLI and npm module to extract audio from YouTube videos (so you are able to listen them like a podcast)
- Host: GitHub
- URL: https://github.com/eomm/youtube-download-playlist
- Owner: Eomm
- License: mit
- Created: 2018-11-15T20:21:18.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T06:50:51.000Z (about 2 years ago)
- Last Synced: 2024-09-09T18:54:07.190Z (24 days ago)
- Topics: cli, module, youtube, youtube-dl, youtube-downloader
- Language: JavaScript
- Homepage:
- Size: 257 KB
- Stars: 17
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yt-dl-playlist
[](https://coveralls.io/github/Eomm/youtube-download-playlist?branch=master)
[](https://packagephobia.now.sh/result?p=yt-dl-playlist)
This module let you to programatic download the audio files of a video playlist on YouTube in MP3 format.
It exposes API to download also single audio.
The name of this module is due the npm policy, call it `youtube-download-playlist`.
⚠ You must use this module/cli respecting the [YouTube's Copyright Policies](https://www.youtube.com/intl/en/about/copyright/#support-and-troubleshooting).
## Install
### Requirements
- [Node.js](https://nodejs.org/it/download/) >= v10
- [`ffmpeg`](https://www.ffmpeg.org/download.html) installed in your system
```sh
npm install yt-dl-playlist
```
## Usage
### CLI - Command Line Interface
Run `yd --help` to see all the options!!
The cli is very simple and quick-and-dirty:
```sh
# NPM Global
npm install yt-dl-playlist -g
yd
# NPX
npx yt-dl-playlist [flags]
```
Examples:
```sh
# Download playlist
yd PLAv2aQ9JgGbVcUtDpuiTB9WgaMljCUpa_ -p
# Download audio
yd 2bexTB7xq_U
# View info video
yd --info 2bexTB7xq_U
```
#### FFMPEG
This program needs [`ffmpeg`](https://www.ffmpeg.org/download.html).
It is a free program that elaborate video and audio stream.
It can be download also in the portable `.zip` without installation!
To config the `ffmpeg` path you can run the script in a `cmd` shell like this:
```sh
yd ZIyyj2FrVI0 -F /ffmpeg/bin
```
Or more simply run the `yd` command from the directory where ffmpeg is saved:
```sh
cd download/ffmpeg/bin
yd ZIyyj2FrVI0
```
### Module
You can use this lib as a module also!
```js
const DownloadYTFile = require('yt-dl-playlist')
const downloader = new DownloadYTFile({
outputPath: process.cwd(),
ffmpegPath: './ffmpeg/bin/ffmpeg.exe',
maxParallelDownload: 10,
fileNameGenerator: (videoTitle) => {
return 'a-new-file-name.mp3'
}
})
downloader.on('video-info', (fileInfo, video) => {
console.log({ fileInfo, video })
})
downloader.on('video-setting', (fileInfo, settings) => {
console.log({ fileInfo, settings })
})
downloader.on('start', (fileInfo) => console.log(fileInfo))
downloader.on('progress', (fileInfo) => console.log(fileInfo))
downloader.on('complete', (fileInfo) => console.log(fileInfo))
downloader.on('error', (fileInfo) => console.log(fileInfo.error))
downloader.download(id, inputFileName = null) : Promise
downloader.downloadPlaylist(playlistId) : Promise
downloader.getPlaylistInfo(playlistId) : Promise
downloader.getVideoInfo(videoId) : Promise
```
## License
Copyright [MIT](./LICENSE).