CrossPaste/crosspaste-desktop
<div align="center"> <img src="doc/en/marketing.webp" width="986px" height="641px" alt="poster" /> <h1>CrossPaste: Universal Pasteboard Across Devices</h1> <p> <b>Copy anything and paste it on any device, seamlessly</b> <br /> <br /> <a href="https://github.com/CrossPaste/crosspaste-desktop/blob/main/README.zh-CN.md">简体中文</a> · <a href="https://crosspaste.com/en/" target="_blank">Official Website</a> · <a href="https://deepwiki.com/CrossPaste/crosspaste-desktop" target="_blank">Wiki</a> · <a href="https://crosspaste.com/en/download" target="_blank">Download</a> <br /> </p> [](https://github.com/CrossPaste/crosspaste-desktop/actions/workflows/ci.yml) [](https://github.com/CrossPaste/crosspaste-desktop/actions/workflows/build-release.yml)  [](https://github.com/JetBrains/compose-multiplatform) [](https://www.sqlite.org/)   [](https://crosspaste.com/en/download) [](https://github.com/CrossPaste/crosspaste-desktop/blob/main/LICENSE) [](https://deepwiki.com/CrossPaste/crosspaste-desktop) <a href="https://github.com/sponsors/CrossPaste"><img src="https://img.shields.io/badge/sponsor-30363D?style=social&logo=GitHub-Sponsors&logoColor=#white" height="30px"></a> <img src="https://img.shields.io/github/stars/CrossPaste/crosspaste-desktop?style=social" height="30px"> </div> ## ✨ Features - **🔄 Real-time Sharing**: Instantly share pasteboard content across devices, seamlessly. - **🖥️ Unified Cross-platform**: Consistent interface on Mac, Windows, and Linux. No need to change habits. - **📋 Rich Type Support**: Handle various pasteboard types: Text, Color, URL, HTML, RTF, Image, File. - **🔒 End-to-End Encryption**: Using asymmetric encryption to fully protect your data security. - **🌐 LAN-only Serverless**: Local storage, serverless architecture. Privacy protection, in your control. - **🧹 Smart Space Management**: Auto-cleanup options manage pasteboard storage without manual effort. - **🔍 Built-in OCR**: Extract text from images locally — no network calls, your screenshots never leave the device. - **🤖 MCP Server**: Expose your pasteboard history to AI assistants (Claude, etc.) via the Model Context Protocol. - **🌍 Chrome Extension**: Sync clipboard with the browser — copy from a web page on one device, paste on any other. ## 🏗 Getting Started with Development 1. clone the repository ```bash git clone https://github.com/CrossPaste/crosspaste-desktop.git ``` 2. Compile and run the application ```bash cd crosspaste-desktop ./gradlew app:run ``` First start will download [JBR](https://github.com/JetBrains/JetBrainsRuntime) / gradle dependencies. If you encounter the following error: ```log FAILURE: Build failed with an exception. * What went wrong: java.net.SocketException: Connection reset > java.net.SocketException: Connection reset ``` you might need a VPN to download these dependencies. To configure a proxy for gradle, add the following settings to [gradle.properties](./gradle.properties), and adjust the parameters to match your proxy configuration: ```properties systemProp.https.proxyHost=localhost systemProp.https.proxyPort=8080 systemProp.https.proxyUser=userid systemProp.https.proxyPassword=password systemProp.http.nonProxyHosts=*.nonproxyrepos.com|localhost ``` Additionally, a series of technical [blogs](https://crosspaste.com/en/blog/introduction) about CrossPaste is being published (approximately one article per week). If you're interested in developing cross-platform applications, you're welcome to read them. ### 🌍 Building the Chrome Extension The Chrome extension lives in [`web/`](./web) and is built via Gradle. Node.js (>= 18) is required — the `npmInstall` task will fetch dependencies on first build. 1. Build the extension ```bash ./gradlew :web:build ``` The unpacked extension is emitted to `web/dist/`. 2. Load it into Chrome - Open `chrome://extensions/` - Enable **Developer mode** in the top-right corner - Click **Load unpacked** and select the `web/dist/` directory The extension auto-discovers a CrossPaste desktop app running on the same machine and syncs clipboard content with it. To iterate on extension code, run `npm run dev` inside `web/` for a fast Vite dev loop, then reload the extension in Chrome. The extension imports a Kotlin/JS `core` library produced by `./gradlew :core:jsBrowserProductionLibraryDistribution` (also run as part of `:web:build`) — re-run that task whenever you change `core/` sources. ## 🗺️ Roadmap CrossPaste is continuously evolving! **v2.0** brings the Chrome extension into the sync mesh as a first-class platform. Here's what we're working on next: - [ ] **Command-line mode** — drive CrossPaste from your terminal and shell scripts - [ ] **Plugin system** — let the community extend CrossPaste with custom paste types and integrations This is just a small part of our plans. Want to learn more details and long-term plans? Check out our [full roadmap](doc/en/Roadmap.md). ## 🙋 FAQ Here are some [FAQs](doc/en/FQA.md) that have been collected. If you have other questions, please create an [issue](https://github.com/CrossPaste/crosspaste-desktop/issues/new/choose) to let us know. ## 🤝 Support the project - **🌟 Star this repository**: This is the easiest way to support CrossPaste and costs nothing. - **🪲 Report bugs**: Report any bugs you find on the [issue tracker](https://github.com/CrossPaste/crosspaste-desktop/issues/new/choose). - **📖 Translate**: Help translate and polish CrossPaste into your [language](https://github.com/CrossPaste/crosspaste-desktop/tree/main/app/src/desktopMain/resources/i18n). - **📝 Contribute**: [Code](doc/en/Contributing.md), comment on issues, and any contributions that can help the project are welcome. - **💖 Sponsor**: Support financially via [GitHub Sponsors](https://github.com/sponsors/CrossPaste) to help with ongoing development and maintenance. ## 📝 Contributors <a href="https://github.com/CrossPaste/crosspaste-desktop/graphs/contributors"> <img src="https://contrib.rocks/image?repo=CrossPaste/crosspaste-desktop" /> </a> ## 💖 Sponsors <!-- sponsors --><a href="https://github.com/liaokaime"><img src="https://wsrv.nl/?url=github.com/liaokaime.png&w=120&h=120&fit=cover&mask=circle" width="60" height="60" alt="liaokai" /></a> <a href="https://github.com/jaepil-choi"><img src="https://wsrv.nl/?url=github.com/jaepil-choi.png&w=120&h=120&fit=cover&mask=circle" width="60" height="60" alt="Jaepil.Choi" /></a> <!-- sponsors -->