Skip to content

An npm package to facilitate downloading music from YouTube, including automatic retrieval of ID3 tags and album art via the iTunes public API

License

Notifications You must be signed in to change notification settings

joshunrau/ytdl-mp3

Repository files navigation

ytdl-mp3

An NPM package to facilitate downloading music from YouTube, including automatic retrieval of ID3 tags and album art via the iTunes public API.
Report Bug · Request Feature

license version codecov


Installation

npm install -g ytdl-mp3

Usage

Command-Line

The easiest way to use ytdl-mp3 is through the command-line interface. Users must enter the URL of the YouTube video they wish to download. The title of the music video is then used to automatically retrieve ID3 tags (e.g., title, artist) and the associated cover art from iTunes. There is no need for the title of the YouTube video to follow a specific naming convention.

Usage: ytdl-mp3 [options] <url>

A NodeJS package and command-line tool for downloading music from YouTube, including automatic retrieval of ID3 tags and album art via iTunes.

Arguments:
url                     url of video to download

Options:
-V, --version           output the version number
-o --output-dir <path>  path to output directory
-n --no-get-tags        skip extracting/applying id3 tags
-v --verify-tags        verify id3 tags fetched from itunes
-s --silent-mode        skip console output
-h, --help              display help for command

ESM

import { Downloader } from 'ytdl-mp3';

const downloader = new Downloader({
  getTags: true
});

await downloader.downloadSong('https://www.youtube.com/watch?v=7jgnv0xCv-k');

CommonJS

const { Downloader } = require('ytdl-mp3');

async function main() {
  const downloader = new Downloader({
    getTags: true
  });
  await downloader.downloadSong('https://www.youtube.com/watch?v=7jgnv0xCv-k');
}

main();

About

An npm package to facilitate downloading music from YouTube, including automatic retrieval of ID3 tags and album art via the iTunes public API

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published