Skip to content

CrossPaste/crosspaste-desktop

Repository files navigation

poster

CrossPaste: Universal Pasteboard Across Devices

Copy anything and paste it on any device, seamlessly

简体中文 · Official Website · Download

Main CI Test Build Release Dependabot Compose-Multiplatform Realm Kotlin OS Download AGPL-3.0

✨ 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 Signal protocol 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.

🏗 Getting Started with Development

  1. clone the repository

    git clone https://github.com/CrossPaste/crosspaste-desktop.git
  2. Compile and run the application

    cd crosspaste-desktop
    ./gradlew composeApp:run

First start will download JBR / gradle dependencies.

If you encounter the following error:

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, and adjust the parameters to match your proxy configuration:

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 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.

🗺️ Roadmap

CrossPaste is continuously evolving! We plan to add more useful features in future versions. Here's an overview of our near-term development plans:

As seen in the changelog, recent versions have included numerous PRs focused on refactoring and labeled with "multiplatform". Indeed, we are actively working towards launching a mobile version. These efforts are laying the groundwork for mobile support. Therefore, before the mobile version is released, we will only be focusing on bug fixes and a limited number of already-planned new features.

  • v1.0.12: Support for RTF format in pasteboard
  • v1.0.13: Support for color data in pasteboard
  • v1.1.0: Support for mobile devices and shared pasteboard with mobile
  • v1.2.0: Support for native pasteboard, improve pasteboard performance
  • v1.3.0: Introduction of command-line mode

This is just a small part of our plans. Want to learn more details and long-term plans? Check out our full roadmap.

🙋 FAQ

Here are some FAQs that have been collected. If you have other questions, please create an issue 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.
  • 📖 Translate: Help translate and polish CrossPaste into your language.
  • 📝 Contribute: Code, comment on issues, and any contributions that can help the project are welcome.
  • 💖 Sponsor: Support financially via GitHub Sponsors to help with ongoing development and maintenance.

📝 Contributors

💖 Sponsors