https://github.com/bytejoseph/wormhole
A wormhole to transfer files.
https://github.com/bytejoseph/wormhole
Last synced: 11 days ago
JSON representation
A wormhole to transfer files.
- Host: GitHub
- URL: https://github.com/bytejoseph/wormhole
- Owner: ByteJoseph
- Created: 2025-07-20T13:51:25.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-07-20T13:52:50.000Z (8 months ago)
- Last Synced: 2025-07-20T15:23:13.796Z (8 months ago)
- Language: Rust
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
Wormhole
A wormhole to transfer files
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](https://www.rust-lang.org/).
## Build project
```bash
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
```bash
wormhole
```
## Example
```bash
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