yt-dlp-video

yt-dlp-video

🎥 The most reliable Node.js video downloader powered by yt-dlp

Download videos from YouTube and 1000+ sites with just a few lines of code! Zero configuration required - we handle the yt-dlp installation automatically.

✨ Key Features

• 🚀 Simple Promise-based API - Easy to use with async/await
• 📦 Zero Configuration - Automatic yt-dlp binary installation
• 🎯 Progress Tracking - Real-time download progress updates
• ⚙️ Flexible Options - Customize formats, quality, and more
• 💪 Cross-Platform - Works on Windows, macOS, and Linux
• 🌐 Universal Support - Compatible with 1000+ video sites

🚀 Installation

npm install yt-dlp-video

That's it! No need to install yt-dlp separately - everything is handled automatically.

📝 Usage

Basic Example

const { downloadVideo } = require('yt-dlp-video');

// Download video in best quality MP4 format
await downloadVideo('https://www.youtube.com/watch?v=VIDEO_ID');

Advanced Options

await downloadVideo('https://youtube.com/watch?v=VIDEO_ID', {
  outputDir: './downloads',  // Where to save the video
  format: 'mp4',            // Video format
  quality: 'best',          // Video quality
  filename: 'my-video'      // Custom filename (without extension)
});

With Progress Tracking

try {
  const result = await downloadVideo('https://youtube.com/watch?v=VIDEO_ID', {
    outputDir: './videos'
  });
  console.log('✅ Download complete!');
} catch (error) {
  console.error('❌ Download failed:', error);
}

// Console output:
// 📥 Download progress: 23.5%
// 📥 Download progress: 47.2%
// 📥 Download progress: 89.7%
// ✅ Download progress: 100%

⚙️ Configuration Options

Option	Type	Default	Description
outputDir	string	Current directory	Directory where videos will be saved
format	string	'mp4'	Video format (mp4, webm, etc.)
quality	string	'best'	Video quality (best, worst, or specific resolution)
filename	string	Video title	Custom filename (without extension)

🌐 Supported Platforms

Download videos from popular platforms including:

• YouTube
• Vimeo
• Twitter
• TikTok
• Instagram
• Facebook
• And 1000+ more sites!

📋 Requirements

• Node.js 14 or higher
• Internet connection (required only for first run)

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

---

Made with ❤️ by the yt-dlp-video team