magic-wormhole / magic-wormhole.rs

Rust implementation of Magic Wormhole, with new features and enhancements
European Union Public License 1.2
737 stars 81 forks source link
data-transfer file-transfer magic-wormhole port-forwarding rust wormhole

Rusty Wormhole

Get things from one computer to another, safely.

http://magic-wormhole.io/

This is a Rust port of the Python version at https://github.com/magic-wormhole/magic-wormhole.

Comparison with the Python implementation

Features that are missing:

New features that exceed the other implementations:

Getting started

If you want to toy with the CLI, cargo run -- --help will get you started. The code sits in ./cli/src. For more instructions see cli/README.md.

If you'd like to use Wormhole in your application, cargo doc --open will tell you how to use it. There aren't any hosted docs at the moment.

If you don't fear touching code and want to contribute, ./src/lib.rs, ./src/transfer.rs and ./src/transit.rs are rather easy to get into. The protocol specification will probably be useful to you.

Applications using Wormhole Rust as library

(feel free to add yours)

License

This work is licensed under the EUPL v1.2 or later. Contact the owner(s) for use in proprietary software.


Matrix Irc Build Status Deps Codecov Is-It-Maintained-Resolution-Time Crates.io Docs.rs