# @meteor314/stream

> Streaming torrent client for Node.js

Latest version **1.0.5** (published 2022-06-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @meteor314/stream
pnpm add @meteor314/stream
yarn add @meteor314/stream
bun add @meteor314/stream
```

Provides the command `stream`.

## 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.0.5 |
| Published | 2022-06-19 |
| First published | 2022-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 55.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | @meteor314 |
| Maintainers | meteor314 |
| Keywords | stream, torrent, from, cli |

## Links

- npm: https://www.npmjs.com/package/@meteor314/stream
- Repository: https://github.com/meteor314/stream
- Issues: https://github.com/meteor314/stream/issues
- npm.io page: https://npm.io/package/@meteor314/stream

## 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

## 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.0.5 (latest) — 2022-06-19
- 1.0.4 — 2022-05-09
- 1.0.3 — 2022-05-09
- 1.0.2 — 2022-05-09
- 1.0.1 — 2022-04-10
- 1.0.0 — 2022-04-09
- 0.0.19 — 2022-04-09
- 0.0.18 — 2022-04-09

## README

# stream

Streaming torrent client for Node.js

```
npm install -g @meteor314/stream
```
## Usage

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

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

Remember to put `"` around your magnet link since they usually contain `&`.
`stream` 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.

![stream](https://raw.github.com/meteor314/stream/master/screenshot.png)

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

```
stream "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, `stream` will choose the biggest one.
To get a full list of available options run stream with the help flag.

```
stream --help
```

Examples of usage of could be

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


## Programmatic usage

If you want to build your own app using streaming bittorrent 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 stream on your chromecast checkout [peercast](https://github.com/mafintosh/peercast)
or [castnow](https://github.com/xat/castnow)

## License

MIT

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