Sync

Seamless keyboard, mouse, and clipboard sharing between Windows and macOS over LAN/Wi-Fi.

Why This Project

Sync is a desktop app for sharing one keyboard and mouse across multiple nearby computers, as if they were one setup:

• one keyboard and mouse across machines
• text clipboard synchronization
• edge-based screen handoff
• secure pairing and trusted peer persistence

Designed for dual-computer workflows (for example: Windows desktop + MacBook side-by-side).

Current Capabilities

• Tauri-based cross-platform desktop application
• Host/client roles with pairing code flow
• Local identity and trusted peer store
• TLS-backed network session commands
• Clipboard text sync with loop prevention
• Configurable edge handoff logic and emergency release
• Runtime heartbeat and network status reporting

Project Status

This repository is a strong reference implementation and active foundation.
For production-grade behavior, continue hardening low-level global input capture/injection and run full multi-device validation matrix.

Quick Start

Prerequisites

• Node.js 20+
• Rust stable toolchain (rustup, cargo, rustc)
• Tauri OS prerequisites

Install & Build (web assets only)

npm install
npm run build

Backend Check

cd apps/desktop/src-tauri
cargo check

Installable app for end users (Windows .msi / NSIS, macOS .dmg)

Build installers from the repo root:

npm install
npm run tauri:build

Artifacts are written under apps/desktop/src-tauri/target/release/bundle/.
See docs/distribution.md for platform notes, icons, and signing.

Run Locally (developers)

npm run dev -w apps/desktop

For full desktop runtime with hot reload:

cd apps/desktop
npm run tauri:dev

Repository Structure

• apps/desktop - React frontend + Tauri app
• apps/desktop/src-tauri - Rust core runtime, networking, platform adapters
• shared/proto - shared message schema
• docs - architecture, threat model, setup, validation, troubleshooting

Documentation

• docs/architecture.md
• docs/threat-model.md
• docs/setup.md
• docs/validation-matrix.md
• docs/troubleshooting.md
• docs/distribution.md

GitHub

Repository: github.com/robintrepte/sync

• CI on main: .github/workflows/ci.yml
• Releases: Windows MSI + NSIS installers are built in .github/workflows/release.yml when you push a tag like v0.1.0 (see docs/distribution.md). They are not stored in git on purpose.

Enable Actions in the repo settings if workflows are disabled.

License

MIT - see LICENSE.