# peerflix

> Streaming torrent client for Node.js

Latest version **0.39.0** (published 2018-06-09) · MIT license · 0 weekly downloads

## Install

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

Provides the command `peerflix`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.39.0 |
| Published | 2018-06-09 |
| First published | 2013-03-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 54.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6269 |
| Author | Mathias Buus |
| Maintainers | mafintosh |

## Links

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

## Dependencies (17)

- [rc](https://npm.io/package/rc.md) ^1.1.6
- [mime](https://npm.io/package/mime.md) ^2.2.0
- [open](https://npm.io/package/open.md) 0.0.5
- [pump](https://npm.io/package/pump.md) ^2.0.0
- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [clivas](https://npm.io/package/clivas.md) ^0.2.0
- [winreg](https://npm.io/package/winreg.md) 1.2.4
- [numeral](https://npm.io/package/numeral.md) ^2.0.6
- [inquirer](https://npm.io/package/inquirer.md) ^5.0.1
- [keypress](https://npm.io/package/keypress.md) ^0.2.1
- [optimist](https://npm.io/package/optimist.md) ^0.6.1
- [airplayer](https://npm.io/package/airplayer.md) ^2.0.0
- [buffer-from](https://npm.io/package/buffer-from.md) ^1.0.0
- [range-parser](https://npm.io/package/range-parser.md) ^1.0.0
- [parse-torrent](https://npm.io/package/parse-torrent.md) ^5.4.0
- [torrent-stream](https://npm.io/package/torrent-stream.md) ^1.0.1
- [network-address](https://npm.io/package/network-address.md) ^1.1.0

## Recent versions

- 0.39.0 (latest) — 2018-06-09
- 0.38.0 — 2018-04-25
- 0.37.0 — 2017-07-04
- 0.36.3 — 2017-05-03
- 0.36.2 — 2017-03-27
- 0.36.1 — 2016-11-22
- 0.36.0 — 2016-10-24
- 0.35.1 — 2016-06-27
- 0.35.0 — 2016-05-16
- 0.34.0 — 2016-04-20
- 0.33.0 — 2016-04-15
- 0.32.4 — 2016-01-24
- 0.32.3 — 2016-01-06
- 0.32.2 — 2015-11-01
- 0.32.1 — 2015-10-24
- … 128 more at https://npm.io/package/peerflix/versions

## README

# peerflix

Streaming torrent client for Node.js

```
npm install -g peerflix
```

[![build status](http://img.shields.io/travis/mafintosh/peerflix.svg?style=flat)](http://travis-ci.org/mafintosh/peerflix)

## Usage

Peerflix can be used with a magnet link or a torrent file.
To stream a video with its magnet link use the following command.

```
peerflix "magnet:?xt=urn:btih:ef330b39f4801d25b4245212e75a38634bfc856e" --vlc
```

Remember to put `"` around your magnet link since they usually contain `&`.
`peerflix` will print a terminal interface. The first line contains an address to a http server. The `--vlc` flag ensures vlc is opened when the torrent is ready to stream.

![peerflix](https://raw.github.com/mafintosh/peerflix/master/screenshot.png)

To stream music with a torrent file use the following command.

```
peerflix "http://some-torrent/music.torrent" -a --vlc
```

The `-a` flag ensures that all files in the music repository are played with vlc.
Otherwise if the torrent contains multiple files, `peerflix` will choose the biggest one.
To get a full list of available options run peerflix with the help flag.

```
peerflix --help
```

Examples of usage of could be

```
peerflix magnet-link --list # Select from a list of files to download
peerflix magnet-link --vlc -- --fullscreen # will pass --fullscreen to vlc
peerflix magnet-link --mplayer --subtitles subtitle-file.srt # play in mplayer with subtitles
peerflix magnet-link --connection 200 # set max connection to 200
```


## Programmatic usage

If you want to build your own app using streaming bittorent in Node you should checkout [torrent-stream](https://github.com/mafintosh/torrent-stream)

## Chromebook users

Chromebooks are set to refuse all incoming connections by default - to change this:  

```
sudo iptables -P INPUT ACCEPT
```

## Chromecast

If you wanna use peerflix on your chromecast checkout [peercast](https://github.com/mafintosh/peercast)
or [castnow](https://github.com/xat/castnow)

## License

MIT

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