Skip to content

ByteJoseph/wormhole

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wormhole

A wormhole to transfer files

Rust Badge MIT License Badge Windows Terminal Badge GNU Bash Badge iTerm2 Badge

Wormhole Preview

Wormhole is a CLI tool that allows users to transfer files to devices on the same local network. It generates a QR code that can be scanned by any phone or browser-enabled device, enabling simple and fast file transfers.


Features

  • Local-Only File Sharing (no internet connection required)
  • QR Code Generation (scan to recieve directly on phones)
  • Automatic LAN IP Detection
  • Supports all file types (served as application/octet-stream)
  • Simple CLI Interface
  • Runs a temporary local HTTP server per transfer

🦀 Installation

Make sure you have Rust installed.

Build project

cargo build --release

Move the binary to your system's path

Move the compiled binary (wormhole) to a directory included in your system’s PATH

Usage

wormhole <filename>

Example

wormhole example.pdf

To Recieve

Scan the displayed QR code using your mobile phone camera or any QR scanning app. The file will automatically begin downloading in the browser

About

A wormhole to transfer files.

Resources

License

Stars

Watchers

Forks