Yoop

Cross-Platform Local Network File Sharing

Yoop enables seamless peer-to-peer file transfers over local networks using simple, time-limited codes. Unlike cloud-based solutions, all data stays on your local network, ensuring privacy, speed, and zero bandwidth costs.

Features

Core Features

Cross-platform: Works on Windows, Linux, and macOS
No account required: Zero configuration, no cloud dependency
Simple 4-character codes: Easy discovery without IP addresses
QR code support: Display scannable codes for upcoming mobile app (experimental)
Dual discovery: UDP broadcast + mDNS/DNS-SD for reliable device discovery
Private & secure: TLS 1.3 encryption, data never leaves local network
Fast transfers: Chunked transfers with xxHash64 verification
Resume capability: Interrupted transfers can be resumed automatically
CLI + Web interface: Full-featured command-line tool and browser-based UI
Trusted devices: Ed25519 signature-based authentication for direct transfers
Clipboard sharing: One-shot transfer and live bidirectional sync
Directory sync: Real-time bidirectional directory synchronization
Shell completions: Bash, Zsh, Fish, PowerShell, Elvish support

Quick Start

Share Files

# Share a single file
yoop share document.pdf

# Share multiple files and folders
yoop share photos/ videos/ notes.md

# Share with custom expiration
yoop share project.zip --expire 10m

Receive Files

# Receive using the 4-character code
yoop receive A7K9

# Receive to specific directory
yoop receive A7K9 --output ~/Downloads/

# Batch mode (auto-accept)
yoop receive A7K9 --batch

Clipboard Sharing (Unique Feature!)

# One-shot clipboard sharing
yoop clipboard share               # Share current clipboard
yoop clipboard receive A7K9        # Receive clipboard content

# Live bidirectional sync (sync clipboard changes in real-time)
yoop clipboard sync                # Host sync session
yoop clipboard sync A7K9           # Join sync session

Supports text and images. Changes sync automatically across devices!

VPN & Overlay Network Support

Yoop works seamlessly over VPN overlay networks (Tailscale, WireGuard, ZeroTier, Headscale) where UDP broadcast and mDNS discovery don't work:

# Direct connection using IP address
yoop clipboard sync --host 100.103.164.32 A7K9

# Connect to trusted device (codeless, uses stored IP)
yoop clipboard sync --device "My-Mac"

# First-time pairing over VPN
# Device A:
yoop clipboard sync
# → Code: A7K9

# Device B:
yoop clipboard sync --host 100.103.164.32 A7K9
# After successful connection, Device B is trusted

# Subsequent connections (automatic):
yoop clipboard sync --device "Device-A"

How it works:

First connection: Use --host IP[:PORT] with a share code
Trusted pairing: After connection, devices are added to trust store with stored IP
Future connections: Use --device <name> for codeless connections
Auto-fallback: If discovery fails, automatically tries stored IP addresses

Supported on all commands:

yoop receive --host IP CODE
yoop clipboard receive --device "Device-Name"
yoop clipboard sync --host IP CODE
yoop sync --device "Device-Name" ./folder

Directory Sync

# Host a sync session
yoop sync ~/Projects/shared-folder

# Join a sync session from another device
yoop sync A7K9 ~/Projects/shared-folder

# With exclusion patterns
yoop sync ./folder --exclude "*.log" --exclude "dist/"

# Use a .gitignore-style file
yoop sync ./folder --ignore-file .syncignore

Any file changes (additions, modifications, deletions) sync instantly between devices!

Installation

via npm (Recommended)

# npm
npm install -g yoop

# pnpm
pnpm add -g yoop

# yarn
yarn global add yoop

# bun
bun add -g yoop

From Source

Requires Rust 1.86.0 or later.

git clone https://github.com/sanchxt/yoop
cd yoop
cargo install --path crates/yoop-cli

Pre-built Binaries

Pre-built binaries for Windows, Linux, and macOS are coming soon.

Shell Completions

Install tab completions for your shell:

yoop completions install           # Auto-detect shell and install
yoop completions install --shell zsh
yoop completions generate bash     # Print to stdout

Supported: Bash, Zsh, Fish, PowerShell, Elvish

How It Works

Code-based transfers:

Sender shares files and gets a 4-character code (e.g., A 7 K 9)
Receiver enters the code on their device
Discovery happens via UDP broadcast + mDNS on local network (or direct IP with --host)
Transfer occurs directly over TLS 1.3 encrypted TCP connection
Verification using xxHash64 per chunk, SHA-256 for complete file
Resume automatic resumption of interrupted transfers from last checkpoint

For trusted devices: Direct connection using Ed25519 signatures (no code needed)

Connection methods:

Discovery: UDP broadcast + mDNS for local networks
Direct IP: --host IP[:PORT] for VPN/overlay networks
Trusted devices: --device <name> for codeless connections with stored addresses
Auto-fallback: Tries stored IP addresses when discovery fails

┌─────────────┐           UDP Broadcast            ┌──────────────┐
│   Sender    │ ◄────────  Code: A7K9  ──────────► │  Receiver    │
│             │                                    │              │
│ Share A7K9  │           TCP + TLS 1.3            │ Receive A7K9 │
│             │ ────────►  File Data  ───────────► │              │
└─────────────┘                                    └──────────────┘

CLI Commands

# Sharing & Receiving
yoop share <files...>              # Share files/folders
yoop receive <code>                # Receive with code
yoop send <device> <files...>      # Send to trusted device (no code)

# Clipboard Sharing
yoop clipboard share               # Share clipboard content
yoop clipboard receive <code>      # Receive clipboard content
yoop clipboard sync [code]         # Bidirectional clipboard sync

# Directory Sync
yoop sync <directory>              # Host a sync session
yoop sync <code> <directory>       # Join a sync session

# Device & Network Management
yoop trust list                    # Manage trusted devices
yoop scan                          # Scan for active shares
yoop diagnose                      # Network diagnostics

# Configuration & Utilities
yoop config                        # Manage configuration
yoop history                       # View transfer history
yoop tui                           # Launch interactive TUI dashboard
yoop web                           # Start web interface
yoop completions install           # Install shell completions

TUI Mode

Launch a full-featured terminal dashboard for managing all Yoop features:

# Launch TUI dashboard
yoop tui

# Launch directly to a specific view
yoop tui --view share
yoop tui --view receive
yoop tui --view clipboard
yoop tui --view devices

Features:

Dashboard view: All features accessible from a single interface
Vim-style navigation: j/k to move, h/l to navigate, Space to select
Multiple views: Share, Receive, Clipboard, Sync, Devices, History, Config
Responsive layout: Adapts to terminal size (split panels, tabs, or minimal)
Real-time monitoring: See active transfers and clipboard sync status
File browser: Built-in file browser with multi-select support
Help overlay: Press ? for keybinding reference

Key navigation:

| Key | Action | |-----|--------| | S/R/C/Y/D/H/G | Switch views (Share/Receive/Clipboard/sYnc/Devices/History/confiG) | | j/k or arrows | Navigate up/down | | Tab | Cycle focus | | Enter | Confirm/Start | | Space | Toggle selection | | ? | Show help | | Q | Quit |

The TUI provides the same functionality as the CLI commands but with an interactive interface - perfect for users who prefer visual navigation over memorizing commands.

Web Interface

Start a browser-based UI for devices without CLI access:

yoop web                    # Start on default port 8080
yoop web --port 9000        # Custom port
yoop web --auth             # Require authentication
yoop web --localhost-only   # Bind to localhost only

Features:

Drag-and-drop file sharing
QR codes with deep links (for future mobile app integration)
File previews (images, text, archives)
Real-time transfer progress
No installation required (just open in browser)

Access at http://[your-ip]:8080 from any device on the network.

Trusted Devices

Send files directly to trusted devices without share codes:

# First transfer: Use share code
yoop share file.txt
# After accepting, you'll be prompted to trust the device

# Subsequent transfers: Direct send (no code needed)
yoop send "Device-Name" file.txt

# Connect to trusted device for clipboard/sync (codeless)
yoop clipboard sync --device "Device-Name"
yoop clipboard receive --device "Device-Name"

# Direct IP connection (saves address for future use)
yoop clipboard sync --host 192.168.1.100 A7K9

# Manage trusted devices
yoop trust list                    # List all trusted devices
yoop trust set "Name" --level full # Set trust level
yoop trust remove "Name"           # Remove device

Security: Uses Ed25519 signatures for authentication. No MITM attacks possible.

VPN Support: Stored IP addresses enable seamless connections over Tailscale, WireGuard, and other overlay networks where discovery doesn't work.

Directory Sync

Keep directories

Yoop

Install / Use

README

Yoop

Features

Core Features

Quick Start

Share Files

Receive Files

Clipboard Sharing (Unique Feature!)

VPN & Overlay Network Support

Directory Sync

Installation

via npm (Recommended)

From Source

Pre-built Binaries

Shell Completions

How It Works

CLI Commands

TUI Mode

Web Interface

Trusted Devices

Directory Sync