Skip to content
WebTorrent, the streaming torrent client. For the command line.
Branch: master
Clone or download
DiegoRBaquero Merge pull request #94 from webtorrent/greenkeeper/ecstatic-4.0.0
Update ecstatic to the latest version 🚀
Latest commit 4ad2cca Apr 8, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin fix(mime package): fix issue of using deprecated(missed) method of mi… Apr 3, 2019
test Adapt to standard spec Oct 2, 2018
tools scripts/ -> tools/ May 15, 2018
.gitignore Ignore files Oct 2, 2018
.travis.yml travis: node LTS Sep 3, 2018 authors Jun 9, 2018 feross -> webtorrent Apr 14, 2017
LICENSE feross -> webtorrent Apr 14, 2017 updating readme Apr 11, 2018
package.json fix(package): update ecstatic to version 4.0.0 Apr 5, 2019

WebTorrent CLI

The streaming torrent client. For the command line.

travis npm version npm downloads javascript style guide

WebTorrent is the first BitTorrent client that works in the browser, but webtorrent-cli, i.e. THIS PACKAGE, is for using WebTorrent from the command line.

webtorrent-cli is a simple torrent client for use in node.js, as a command line app. It uses TCP and UDP to talk to other torrent clients.

NOTE: To connect to "web peers" (browsers) in addition to normal BitTorrent peers, use webtorrent-hybrid which includes WebRTC support for node.

To use WebTorrent in the browser, see webtorrent.


  • Use WebTorrent from the command line!
  • Insanely fast
  • Pure Javascript (no native dependencies)
  • Streaming
    • Stream to AirPlay, Chromecast, VLC player, IINA, and many other devices/players
    • Fetches pieces from the network on-demand so seeking is supported (even before torrent is finished)
    • Seamlessly switches between sequential and rarest-first piece selection strategy
  • Supports advanced torrent client features


To install a webtorrent command line program, run:

npm install webtorrent-cli -g


$ webtorrent --help

    webtorrent [command] <torrent-id> <options>

    webtorrent download "magnet:..." --vlc

    download <torrent-id>   Download a torrent
    downloadmeta <torrent-id>   Download the .torrent file from a magnet link
    seed <file/folder>      Seed a file or folder
    create <file>           Create a .torrent file
    info <torrent-id>       Show info for a .torrent file or magnet uri

Specify <torrent-id> as one of:
    * magnet uri
    * http url to .torrent file
    * filesystem path to .torrent file
    * info hash (hex string)

Options (streaming):
    --airplay               Apple TV
    --chromecast            Chromecast
    --dlna                  DLNA
    --mplayer               MPlayer
    --mpv                   MPV
    --omx [jack]            omx [default: hdmi]
    --vlc                   VLC
    --iina                  IINA
    --xbmc                  XBMC
    --stdout                standard out (implies --quiet)

Options (simple):
    -o, --out [path]        set download destination [default: current directory]
    -s, --select [index]    select specific file in torrent (omit index for file list)
    -t, --subtitles [path]  load subtitles file
    -v, --version           print the current version

Options (advanced):
    -p, --port [number]     change the http server port [default: 8000]
    -b, --blocklist [path]  load blocklist file/http url
    -a, --announce [url]    tracker URL to announce to
    -q, --quiet             don't show UI on stdout
    --keep-seeding          don't quit when done downloading
    --on-done [script]      run script after torrent download is done
    --on-exit [script]      run script before program exit
    --verbose               show torrent protocol details

To download a torrent:

$ webtorrent magnet_uri

To stream a torrent to a device like AirPlay or Chromecast, just pass a flag:

$ webtorrent magnet_uri --airplay

In addition to magnet uris, webtorrent supports many ways to specify a torrent:

  • magnet uri (string)
  • torrent file (buffer)
  • info hash (hex string or buffer)
  • parsed torrent (from parse-torrent)
  • http/https url to a torrent file (string)
  • filesystem path to a torrent file (string)


MIT. Copyright (c) Feross Aboukhadijeh and WebTorrent, LLC.

You can’t perform that action at this time.