dnx-ytdown 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# ytdown
+
+A simple command-line tool to download YouTube videos, music, or playlists using `yt-dlp`.
+
+## Prerequisites
+
+You must have **[yt-dlp](https://github.com/yt-dlp/yt-dlp)** installed on your system and available in your system's PATH.
+
+This tool is a wrapper around `yt-dlp` and will not work without it.
+
+## Installation
+
+Install the tool globally using npm:
+
+```bash
+npm install -g .
+```
+*(Note: Since this is a local project, you install it with `.`)*
+
+To publish and install from the registry, you would use:
+```bash
+npm install -g ytdown
+```
+
+## Usage
+
+You can use `ytdown` directly from your command line after global installation, or you can use it without installation via `npx`.
+
+### Synopsis
+
+```bash
+ytdown <link> [options]
+```
+
+### Arguments
+
+-   `<link>`: **(Required)** The URL of the YouTube video, music, or playlist you want to download.
+
+### Options
+
+-   `--format`, `-f`: The format to download.
+    -   Choices: `mp3`, `mp4`
+    -   Default: `mp4`
+-   `--output`, `-o`: The directory where files will be saved.
+    -   Default: The current working directory.
+-   `--help`, `-h`: Show the help message.
+
+### Examples
+
+**1. Download a video as MP4 (default format):**
+
+```bash
+ytdown "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
+```
+
+**2. Download a video as MP3 and save it to a specific folder:**
+
+```bash
+ytdown "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --format mp3 --output "/home/user/Music/MyDownloads"
+```
+
+**3. Download a full playlist as MP3:**
+
+```bash
+ytdown "https://www.youtube.com/playlist?list=PL..." --format mp3
+```
+
+**4. Use with `npx` (no global installation needed):**
+
+This command assumes you are running it from within the project directory.
+
+```bash
+npx . "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --format mp3
+```

package/index.js

@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { spawn, exec } from 'child_process';
+import path from 'path';
+import process from 'process';
+
+// First, check if yt-dlp is installed
+exec('yt-dlp --version', (error, stdout, stderr) => {
+    if (error) {
+        console.error("Error: 'yt-dlp' is not installed or not in your PATH.");
+        console.error("Please install it to use this tool. See: https://github.com/yt-dlp/yt-dlp");
+        process.exit(1);
+    }
+    // If check is successful, run the main program
+    main();
+});
+
+function main() {
+    yargs(hideBin(process.argv))
+        .command(
+            '$0 <link>',
+            'Download a YouTube video, music, or playlist.',
+            (yargs) => {
+                return yargs.positional('link', {
+                    describe: 'URL of the video, music, or playlist',
+                    type: 'string',
+                });
+            },
+            (argv) => {
+                if (argv.link) {
+                    download(argv.link, argv.format, argv.output);
+                } else {
+                    yargs.showHelp();
+                }
+            }
+        )
+        .option('format', {
+            alias: 'f',
+            describe: 'Download format',
+            choices: ['mp3', 'mp4'],
+            default: 'mp4',
+        })
+        .option('output', {
+            alias: 'o',
+            describe: 'Output directory',
+            type: 'string',
+            default: process.cwd(), // Defaults to the current working directory
+        })
+        .help()
+        .alias('help', 'h')
+        .parse();
+}
+
+function download(link, format, outputDir) {
+    console.log(`Starting download...`);
+    console.log(`  - URL: ${link}`);
+    console.log(`  - Format: ${format}`);
+    console.log(`  - Output Dir: ${outputDir}`);
+
+    const args = [
+        '-i', // Ignore errors
+        '--no-overwrites',
+        '--extractor-args', 'youtube:player_client=default',
+    ];
+
+    // Add format-specific arguments
+    if (format === 'mp3') {
+        args.push(
+            '-x', // Extract audio
+            '--audio-format', 'mp3',
+            '--embed-thumbnail', // Embed thumbnail
+            '--add-metadata' // Add metadata
+        );
+    } else { // for mp4
+        args.push(
+            '-f', 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
+        );
+    }
+    
+    // Define the output template
+    const outputTemplate = path.join(outputDir, '%(title)s.%(ext)s');
+    args.push('-o', outputTemplate);
+
+    // Add the URL to the arguments
+    args.push(link);
+
+    console.log(`\nExecuting: yt-dlp ${args.join(' ')}\n`);
+
+    const ytdlp = spawn('yt-dlp', args);
+
+    ytdlp.stdout.on('data', (data) => {
+        process.stdout.write(data.toString());
+    });
+
+    ytdlp.stderr.on('data', (data) => {
+        process.stderr.write(data.toString());
+    });
+
+    ytdlp.on('close', (code) => {
+        if (code === 0) {
+            console.log('\nDownload completed successfully.');
+        } else {
+            console.error(`\nProcess exited with code ${code}. There might have been an error.`);
+        }
+    });
+
+    ytdlp.on('error', (err) => {
+        console.error('Failed to start the yt-dlp process. Is it installed and in your PATH?', err);
+    });
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "dnx-ytdown",
+  "version": "1.0.0",
+  "description": "A command-line tool to download YouTube videos, music, or playlists as MP4 or MP3.",
+  "main": "index.js",
+  "type": "module",
+  "bin": {
+    "dnx-ytdown": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "youtube",
+    "download",
+    "mp3",
+    "mp4",
+    "cli",
+    "yt-dlp"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "yargs": "^18.0.0"
+  }
+}