# ytmp

> A very lightweight YouTube-based music player

Latest version **1.1.1** (published 2019-12-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install ytmp
pnpm add ytmp
yarn add ytmp
bun add ytmp
```

Provides the command `ytmp`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-12-14 |
| First published | 2019-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=11.0.0 |
| Dependencies | 4 |
| Unpacked size | 10.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Domonkos Lezsák |
| Maintainers | lezsakdomi |
| Keywords | youtube, music, cli |

## Links

- npm: https://www.npmjs.com/package/ytmp
- Repository: https://github.com/lezsakdomi/ytmp
- Issues: https://github.com/lezsakdomi/ytmp/issues
- npm.io page: https://npm.io/package/ytmp

## Dependencies (4)

- [ytpl](https://npm.io/package/ytpl.md) lezsakdomi/node-ytpl
- [ytsr](https://npm.io/package/ytsr.md) ^0.1.10
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [ytdl-core](https://npm.io/package/ytdl-core.md) ^1.0.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2019-12-14
- 1.0.1 — 2019-12-14
- 1.0.0 — 2019-12-14

## README

# ytmp
A lightweight YouTube-based music player

## Setup
1. Install mpv on your OS (`sudo apt-get install mpv`, `sudo pacman -S mpv`, `sudo emerge mpv`).
   Sorry, `mpv` is an external dependency as of now. You can skip this step if
   you are into providing your own https-capable video player (like VLC or
   mplayer) using the `-p` flag
2. Run `yarn global add ytmp`

## CLI
A binary called `ytmp` is provided
```
Usage:
    ytmp --help
    ytmp [ options ] [ [--play] [--mix] [--radio] ] [--] [string]
    ytmp [ options ] --search [--] [string...]
    ytmp [ options ] --id=id | --id [--] [id]
    ytmp [ options ] --url=url | --url [--] [url]

Behaviour control:
    -x, --play      Play the selected playlist and/or video
                    Used in playlists to exit after playling all the songs.
    -m, --mix       After the playlist or video is over start a
                    non-personalized YouTube Mix
    -r, --radio     At the end, don't exit but start an endless radio instead

    The default behaviour is dependent on the song selection

Song selection:
    -s, --search    Use the positional argument(s) to perform a search and use
                    the first result as the video or playlist
    -i, --id id     Use the given ID or URL (either video, playlist or channel)
                    The value can also be supplied either as positional, after
                    the double-dash
    -u, --url url   And alias for --id. Behaviour may change.
    
    By default if the supplied positional argument(s) is a valid playlist or
    video ID or URL then used so, else a search is performed.

Format options:
    -a, --audio     Audio-only, never ever show video
    -v, --video     Optimize for video.
    -av             Select formats with video but optimize for audio

Developer options:
    -p, --player p Use a custom audio and video player executable. "mpv" by
                   default. A recommended alternative is mplayer or ffplay.
                   Should be able to play http streams.
    --saveinfo [f] Save latest video info, optionally to the given file
    --quiet        Don't log to stdout
    -v, --verbose  Log to stderr
```

## API
```javascript
const ytmp = require(ytmp)

let info = await ytmp(url_or_id_or_searchstring, options)
info = await ytmp.play(url_or_id_or_searchstring_or_info, options)
info = await ytmp.playMix(info || "Developers" || "KMU0tzLwhbE", {audio: true, video: false})
info = ytmp.playRadio(info || "Oxygene COMPLETE" || "PLCFC37B95C9159ACC", {player: "C:\Program Files\vlc\vlc.exe"})
```

The main exported function is _intelligent_, i.e. does not accept an
_info-object_, but accepts a search string tries to guess what the user wants.

Every function returns an info promise and accepts an URL or an ID indicating a
video, a playlist or a channel or an info object or promise returned from a
previous call. Passing the unresolved promise makes content preloading possible.

Every function accepts an options objects as a second arguments which controls
its behaviour. Currently undocumented, accepts the CLI arguments, look in the
source code for usage.

---
_Source: https://npm.io/package/ytmp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._