Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.51 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.51 KB
Raw

Magic Wormhole CLI

A Rust implementation of the classic magic-wormhole command line client.

This package provides a library and a command-line tool named wormhole-rs, which makes it possible to get arbitrary-sized files and directories (or short pieces of text) from one computer to another. The two endpoints are identified by using identical "wormhole codes": in general, the sending machine generates and displays the code, which must then be typed into the receiving machine.

Installation

GitHub Releases

We publish source code and binaries to GitHub releases. Visit the releases page for the latest release.

Or use cargo binstall:

cargo binstall magic-wormhole-cli

crates.io

You can use cargo to install the CLI from crates.io:

cargo install --locked magic-wormhole-cli

Usage

Get things from one computer to another, safely

Usage: wormhole-rs [OPTIONS] <COMMAND>

Commands:
  send       Send a file or a folder [aliases: tx]
  receive    Receive a file or a folder [aliases: rx]
  send-many  Send a file to many recipients
  forward    Forward ports from one machine to another

Options:
  -v, --verbose  Enable logging to stdout, for debugging purposes
  -h, --help     Print help
  -V, --version  Print version

Run a subcommand with `--help` to know how it's used.
To send files, use `wormhole send <PATH>`.
To receive files, use `wormhole receive <CODE>`.