{"id":35151077,"url":"https://github.com/sanchxt/yoop","last_synced_at":"2026-01-13T22:55:59.849Z","repository":{"id":329609899,"uuid":"1118669709","full_name":"sanchxt/yoop","owner":"sanchxt","description":"A very fast P2P file sharing and clipboard sync for local networks. Works between any device and OS. No cloud or account required. Built with Rust.","archived":false,"fork":false,"pushed_at":"2026-01-13T20:24:36.000Z","size":354,"stargazers_count":21,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-13T22:55:47.132Z","etag":null,"topics":["cli","clipboard-sync","cross-platform","developer","developer-tool","developer-tools","encryption","file-sharing","file-transfer","local-network","mdns","networking","p2p","peer-to-peer","productivity-tools","rust"],"latest_commit_sha":null,"homepage":"https://yoop.sanchxt.com","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sanchxt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-18T05:29:43.000Z","updated_at":"2026-01-12T09:44:14.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sanchxt/yoop","commit_stats":null,"previous_names":["sanchxt/locare","sanchxt/yoop"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/sanchxt/yoop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanchxt%2Fyoop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanchxt%2Fyoop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanchxt%2Fyoop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanchxt%2Fyoop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanchxt","download_url":"https://codeload.github.com/sanchxt/yoop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanchxt%2Fyoop/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28405139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T21:51:37.118Z","status":"ssl_error","status_checked_at":"2026-01-13T21:45:14.585Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","clipboard-sync","cross-platform","developer","developer-tool","developer-tools","encryption","file-sharing","file-transfer","local-network","mdns","networking","p2p","peer-to-peer","productivity-tools","rust"],"created_at":"2025-12-28T15:39:32.661Z","updated_at":"2026-01-13T22:55:59.843Z","avatar_url":"https://github.com/sanchxt.png","language":"Rust","readme":"# Yoop\n\n**Cross-Platform Local Network File Sharing**\n\n[![CI](https://github.com/arceus/yoop/workflows/CI/badge.svg)](https://github.com/arceus/yoop/actions)\n[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](LICENSE-MIT)\n[![Rust Version](https://img.shields.io/badge/rust-1.86.0%2B-blue.svg)](https://www.rust-lang.org)\n\nYoop 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.\n\n## Features\n\n### Core Features\n\n-   **Cross-platform**: Works on Windows, Linux, and macOS\n-   **No account required**: Zero configuration, no cloud dependency\n-   **Simple 4-character codes**: Easy discovery without IP addresses\n-   **QR code support**: Display scannable codes for upcoming mobile app (experimental)\n-   **Dual discovery**: UDP broadcast + mDNS/DNS-SD for reliable device discovery\n-   **Private \u0026 secure**: TLS 1.3 encryption, data never leaves local network\n-   **Fast transfers**: Chunked transfers with xxHash64 verification\n-   **Resume capability**: Interrupted transfers can be resumed automatically\n-   **CLI + Web interface**: Full-featured command-line tool and browser-based UI\n-   **Trusted devices**: Ed25519 signature-based authentication for direct transfers\n-   **Clipboard sharing**: One-shot transfer and live bidirectional sync\n-   **Shell completions**: Bash, Zsh, Fish, PowerShell, Elvish support\n\n## Quick Start\n\n### Share Files\n\n```bash\n# Share a single file\nyoop share document.pdf\n\n# Share multiple files and folders\nyoop share photos/ videos/ notes.md\n\n# Share with custom expiration\nyoop share project.zip --expire 10m\n```\n\n### Receive Files\n\n```bash\n# Receive using the 4-character code\nyoop receive A7K9\n\n# Receive to specific directory\nyoop receive A7K9 --output ~/Downloads/\n\n# Batch mode (auto-accept)\nyoop receive A7K9 --batch\n```\n\n### Clipboard Sharing (Unique Feature!)\n\n```bash\n# One-shot clipboard sharing\nyoop clipboard share               # Share current clipboard\nyoop clipboard receive A7K9        # Receive clipboard content\n\n# Live bidirectional sync (sync clipboard changes in real-time)\nyoop clipboard sync                # Host sync session\nyoop clipboard sync A7K9           # Join sync session\n```\n\nSupports text and images. Changes sync automatically across devices!\n\n## Installation\n\n### via npm (Recommended)\n\n```bash\n# npm\nnpm install -g yoop\n\n# pnpm\npnpm add -g yoop\n\n# yarn\nyarn global add yoop\n\n# bun\nbun add -g yoop\n```\n\n### From Source\n\nRequires **Rust 1.86.0** or later.\n\n```bash\ngit clone https://github.com/arceus/yoop\ncd yoop\ncargo install --path crates/yoop-cli\n```\n\n### Pre-built Binaries\n\nPre-built binaries for Windows, Linux, and macOS are coming soon.\n\n## Shell Completions\n\nInstall tab completions for your shell:\n\n```bash\nyoop completions install           # Auto-detect shell and install\nyoop completions install --shell zsh\nyoop completions generate bash     # Print to stdout\n```\n\nSupported: Bash, Zsh, Fish, PowerShell, Elvish\n\n## How It Works\n\n**Code-based transfers:**\n\n1. **Sender** shares files and gets a 4-character code (e.g., `A 7 K 9`)\n2. **Receiver** enters the code on their device\n3. **Discovery** happens via UDP broadcast + mDNS on local network\n4. **Transfer** occurs directly over TLS 1.3 encrypted TCP connection\n5. **Verification** using xxHash64 per chunk, SHA-256 for complete file\n6. **Resume** automatic resumption of interrupted transfers from last checkpoint\n\n**For trusted devices:** Direct connection using Ed25519 signatures (no code needed)\n\n```\n┌─────────────┐           UDP Broadcast            ┌──────────────┐\n│   Sender    │ ◄────────  Code: A7K9  ──────────► │  Receiver    │\n│             │                                    │              │\n│ Share A7K9  │           TCP + TLS 1.3            │ Receive A7K9 │\n│             │ ────────►  File Data  ───────────► │              │\n└─────────────┘                                    └──────────────┘\n```\n\n## CLI Commands\n\n```bash\n# Sharing \u0026 Receiving\nyoop share \u003cfiles...\u003e              # Share files/folders\nyoop receive \u003ccode\u003e                # Receive with code\nyoop send \u003cdevice\u003e \u003cfiles...\u003e      # Send to trusted device (no code)\n\n# Clipboard Sharing\nyoop clipboard share               # Share clipboard content\nyoop clipboard receive \u003ccode\u003e      # Receive clipboard content\nyoop clipboard sync [code]         # Bidirectional clipboard sync\n\n# Device \u0026 Network Management\nyoop trust list                    # Manage trusted devices\nyoop scan                          # Scan for active shares\nyoop diagnose                      # Network diagnostics\n\n# Configuration \u0026 Utilities\nyoop config                        # Manage configuration\nyoop history                       # View transfer history\nyoop web                           # Start web interface\nyoop completions install           # Install shell completions\n```\n\n## Web Interface\n\nStart a browser-based UI for devices without CLI access:\n\n```bash\nyoop web                    # Start on default port 8080\nyoop web --port 9000        # Custom port\nyoop web --auth             # Require authentication\nyoop web --localhost-only   # Bind to localhost only\n```\n\n**Features:**\n\n-   Drag-and-drop file sharing\n-   QR codes with deep links (for future mobile app integration)\n-   File previews (images, text, archives)\n-   Real-time transfer progress\n-   No installation required (just open in browser)\n\nAccess at `http://[your-ip]:8080` from any device on the network.\n\n## Trusted Devices\n\nSend files directly to trusted devices without share codes:\n\n```bash\n# First transfer: Use share code\nyoop share file.txt\n# After accepting, you'll be prompted to trust the device\n\n# Subsequent transfers: Direct send (no code needed)\nyoop send \"Device-Name\" file.txt\n\n# Manage trusted devices\nyoop trust list                    # List all trusted devices\nyoop trust set \"Name\" --level full # Set trust level\nyoop trust remove \"Name\"           # Remove device\n```\n\n**Security:** Uses Ed25519 signatures for authentication. No MITM attacks possible.\n\n## Configuration\n\nYoop can be configured via TOML files:\n\n-   **Linux**: `~/.config/yoop/config.toml`\n-   **macOS**: `~/Library/Application Support/yoop/config.toml`\n-   **Windows**: `%APPDATA%\\yoop\\config.toml`\n\nExample configuration:\n\n```toml\n[general]\ndevice_name = \"My-Laptop\"\ndefault_expire = \"5m\"\ndefault_output = \"~/Downloads\"\n\n[network]\nport = 52525\nipv6 = true\n\n[transfer]\nchunk_size = 1048576\nparallel_chunks = 4\nverify_checksum = true\n\n[security]\ntls_verify = true\nrate_limit_attempts = 3\n\n[trust]\nenabled = true\nauto_prompt = true\ndefault_level = \"ask_each_time\"\n\n[history]\nenabled = true\nmax_entries = 100\n\n[ui]\nshow_qr = false  # Enable QR codes (for future mobile app)\n\n[web]\nport = 8080\nauth = false\n```\n\nSee all options: `yoop config list`\n\n## Development\n\n### Prerequisites\n\n-   **Rust**: 1.86.0 or later\n-   **Git**: For cloning the repository\n\n### Building\n\n```bash\n# Clone repository\ngit clone https://github.com/arceus/yoop\ncd yoop\n\n# Build all crates\ncargo build --workspace\n\n# Run tests\ncargo test --workspace\n\n# Run with logging\nRUST_LOG=debug cargo run --bin yoop -- share test.txt\n```\n\n### Running Tests\n\n```bash\n# All tests\ncargo test --workspace\n\n# Unit tests only\ncargo test --lib --workspace\n\n# Integration tests only\ncargo test --test integration_transfer\ncargo test --test integration_trust\ncargo test --test integration_clipboard\n\n# With output\ncargo test -- --nocapture\n```\n\n### Code Quality\n\n```bash\n# Format code\ncargo fmt --all\n\n# Lint with clippy\ncargo clippy --workspace -- -D warnings\n\n# Check without building\ncargo check --workspace\n\n# Generate documentation\ncargo doc --workspace --open\n```\n\n## Architecture\n\nYoop uses a custom binary protocol (LDRP) over TLS 1.3:\n\n-   **Discovery**: UDP broadcast + mDNS/DNS-SD on port 52525\n-   **Transfer**: TCP on ports 52530-52540\n-   **Encryption**: TLS 1.3 with self-signed ephemeral certificates\n-   **Integrity**: xxHash64 per chunk, SHA-256 per file\n-   **Resume**: State persistence for interrupted transfer recovery\n-   **Code Format**: 4 characters from `[2-9A-HJ-KMN-Z]` (avoiding ambiguous chars)\n\n## Security\n\nYoop prioritizes security and privacy:\n\n-   **Encryption**: All transfers use TLS 1.3 with perfect forward secrecy\n-   **No persistence**: Ephemeral certificates, no long-term keys (except trusted devices)\n-   **Rate limiting**: 3 failed attempts → 30 second lockout\n-   **Local only**: No internet connectivity required or used\n-   **Code verification**: HMAC-based verification prevents timing attacks\n\n## Contributing\n\nContributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\nBefore submitting a PR:\n\n1. Ensure all tests pass: `cargo test --workspace`\n2. Format code: `cargo fmt --all`\n3. Check lints: `cargo clippy --workspace -- -D warnings`\n4. Update documentation if needed\n\n## License\n\nLicensed under either of:\n\n-   **Apache License, Version 2.0** ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n-   **MIT license** ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.\n\n## Acknowledgments\n\nBuilt with Rust and powered by:\n\n-   [tokio](https://tokio.rs/) - Async runtime\n-   [rustls](https://github.com/rustls/rustls) - TLS implementation\n-   [mdns-sd](https://github.com/keepsimple1/mdns-sd) - mDNS/DNS-SD discovery\n-   [arboard](https://github.com/1Password/arboard) - Cross-platform clipboard access\n-   [clap](https://github.com/clap-rs/clap) - CLI parsing\n-   [serde](https://serde.rs/) - Serialization framework\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanchxt%2Fyoop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanchxt%2Fyoop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanchxt%2Fyoop/lists"}