youtube-dl-exec

!Last version

> A simple Node.js wrapper for yt-dlp.

Why

- Auto install the latest yt-dlp version available.
- Executes any command in an efficient way.
- Promise & Stream interface support.

Install

> Note: It requires Python 3.9 or above available in your system as python3. Otherwise, the library will throw an error.

``bash
$ npm install youtube-dl-exec --save
`

By default, the library will auto-install the latest yt-dlp available that will downloaded on build time.

Usage

Any yt-dlp flags is supported:

`js
const youtubedl = require('youtube-dl-exec')

youtubedl('https://www.youtube.com/watch?v=6xKWiCMKKJg', {
dumpSingleJson: true,
noCheckCertificates: true,
noWarnings: true,
preferFreeFormats: true,
addHeader: ['referer:youtube.com', 'user-agent:googlebot']
}).then(output => console.log(output))
`

It's equivalent to:

`bash
$ ./bin/yt-dlp \
--dump-single-json \
--no-check-certificates \
--no-warnings \
--prefer-free-formats \
--add-header='user-agent:googlebot' \
--add-header='referer:youtube.com' \
'https://www.youtube.com/watch?v=6xKWiCMKKJg'
`

Type yt-dlp --help for seeing all of them.

Custom binary

In case you need, you can specify your own binary path using [.create]():

`js
const { create: createYoutubeDl } = require('youtube-dl-exec')
const youtubedl = createYoutubeDl('/my/binary/path')
`

Progress bar

Since the library is returning a promise, you can use any library that makes a progress estimation taking a promise as input:

`js
const logger = require('progress-estimator')()
const youtubedl = require('youtube-dl-exec')

const url = 'https://www.youtube.com/watch?v=6xKWiCMKKJg'
const promise = youtubedl(url, { dumpSingleJson: true })
const result = await logger(promise, Obtaining ${url})

console.log(result)
`

Alternatively, you can access to the subprocess to have more granular control. See youtubedl.exec.

Also, combine that with YOUTUBE_DL_SKIP_DOWNLOAD. See environment variables to know more.

Plugins

In order to use yt-dlp plugins, you just need to create a plugin.zip file inside yt-dlp-plugins directory under the same binaty path.

For example, if you are using the default binary path:

`
node_modules/youtube-dl-exec/bin
`

Then the plugins should be placed at:

`
node_modules/youtube-dl-exec/bin/yt-dlp-plugins/plugin.zip
`

For more detailed information you can see yt-dlp's plugins installation guide: yt-dlp#installing-plugins.

Timeout & cancellation

You can customize spawn#options by passing a third argument:

`js
const url = 'https://www.youtube.com/watch?v=6xKWiCMKKJg'
const result = await youtubedl.exec(url, ,{ dumpSingleJson: true }, {
timeout: 5000,
killSignal: 'SIGKILL'
})

console.log(result)
`

You can also interact with the subprocess programmatically:

`js
const url = 'https://www.youtube.com/watch?v=6xKWiCMKKJg'
const subprocess = youtubedl.exec(url, { dumpSingleJson: true })

setTimeout(() => {
subprocess.kill('SIGKILL')
}, 5000)

const result = await subprocess
console.log(result)
`

API

$3

It execs any yt-dlp command, returning back the output.

#### url

_Required_

Type: string

The URL to target.

#### flags

Type: object

Any flag supported by yt-dlp.

#### options

Any option provided here will passed to spawn#options.

$3

Similar to main method but instead of a parsed output, it will return the internal subprocess object:

`js
const youtubedl = require('youtube-dl-exec')
const fs = require('fs')

const subprocess = youtubedl.exec(
'https://www.youtube.com/watch?v=6xKWiCMKKJg',
{
dumpSingleJson: true
}
)

console.log(Running subprocess as ${subprocess.pid})

subprocess.stdout.pipe(fs.createWriteStream('stdout.txt'))
subprocess.stderr.pipe(fs.createWriteStream('stderr.txt'))

setTimeout(subprocess.cancel, 30000)
`

$3

It creates a yt-dlp using the binaryPath provided.

Environment variables

The environment variables are used to customize the postinstall script behavior that will be triggered after npm install is performed.

This is mostly for backward compatibility or debugging purposes. You don't need to do anything by default.

$3

Set DEBUG="youtube-dl-exec*" to enable debug mode. This will enable log additional information during the post-install script.

$3

It determines the folder where to put the binary file.

The default folder is bin.

$3

It determines the binary filename.

The default binary file could be yt-dlp or youtube-dl.exe, depending of the YOUTUBE_DL_PLATFORM value.

$3

It determines the remote URL for getting the yt-dlp binary file.

The default URL is yt-dlp/yt-dlp latest release.

$3

It determines the architecture of the machine that will use the yt-dlp binary.

The default value will computed from process.platform, being 'unix' or 'win32'.

$3

When is present, it will skip the postinstall script for fetching the latest yt-dlp version.

That variable should be set before performing the installation command, such as:

`bash
YOUTUBE_DL_SKIP_DOWNLOAD=true npm install
``

$3

When is present, it skip the python step on installation.

License

youtube-dl-exec © microlink.io, released under the MIT License.

Authored and maintained by Kiko Beats with help from contributors.

> microlink.io · GitHub microlink.io · X @microlinkhq