yt-dlp-static/Readme.md

yt-dlp-static

# yt-dlp-static

Static yt-dlp binaries for macOS, Linux, Windows.

Supports macOS (64-bit and arm64), Linux (32 and 64-bit, armhf, arm64), Windows (32 and 64-bit). The yt-dlp version currently used is [latest version].

## npm version minimum Node.js version

Note: The version of yt-dlp-static follows SemVer. When releasing new versions, we do not consider breaking changes in yt-dlp itself, but only the JS interface. For example, yt-dlp-static@1.0.0 might download yt-dlp [next version]. To prevent an yt-dlp-static upgrade downloading backwards-incompatible yt-dlp versions, use a strict version range for it or use a lockfile.

## Installation

```bash
$ npm install yt-dlp-static
```

## Electron & other cross-platform packaging tools

Because yt-dlp-static will download a binary specific to the OS/platform, you need to purge node_modules before (re-)packaging your app for a different OS/platform.

## Example Usage

Returns the path of a statically linked yt-dlp binary on the local filesystem.

```javascript
const ytdlp = require("yt-dlp-static");
console.log(ytdlp);
// /Users/j/playground/node_modules/yt-dlp-static/yt-dlp
```