CrossPaste
Officialby CrossPaste
README.md
<div align="center">
<img src="doc/en/marketing.webp" width="986px" height="518px" 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>
·
<a href="https://crosspaste.com/en/video?from=github" target="_blank">Video</a>
<br />
</p>
<a href="https://trendshift.io/repositories/15491?utm_source=repository-badge&utm_medium=badge&utm_campaign=badge-repository-15491" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/repositories/15491" alt="CrossPaste%2Fcrosspaste-desktop | Trendshift" width="250" height="55"/></a>
<a href="https://trendshift.io/repositories/15491?utm_source=trendshift-badge&utm_medium=badge&utm_campaign=badge-trendshift-15491" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/15491/weekly?language=Kotlin" alt="CrossPaste%2Fcrosspaste-desktop | Trendshift" width="250" height="55"/></a>
[](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://mcpservers.org/servers/crosspaste/crosspaste-desktop)
[](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 on a web page, paste on any device.
- **⌨️ Command-Line**: Copy, paste, and search your history from the terminal and scripts. See the [CLI guide](doc/en/CLI.md).
## 🏗 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.2** brings a full command-line mode — copy, paste, and search your history straight from the terminal. Here's what we're working on next:
- [ ] **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
<!-- contributors --><a href="https://github.com/guiyanakuang"><img src="https://wsrv.nl/?url=github.com/guiyanakuang.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="guiyanakuang" /></a> <a href="https://github.com/amir1376"><img src="https://wsrv.nl/?url=github.com/amir1376.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="amir1376" /></a> <a href="https://github.com/Blushyes"><img src="https://wsrv.nl/?url=github.com/Blushyes.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="Blushyes" /></a> <a href="https://github.com/emmanuel-ferdman"><img src="https://wsrv.nl/?url=github.com/emmanuel-ferdman.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="emmanuel-ferdman" /></a> <a href="https://github.com/Fldicoahkiin"><img src="https://wsrv.nl/?url=github.com/Fldicoahkiin.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="Fldicoahkiin" /></a> <a href="https://github.com/swording-k"><img src="https://wsrv.nl/?url=github.com/swording-k.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="swording-k" /></a> <a href="https://github.com/sunxiang0918"><img src="https://wsrv.nl/?url=github.com/sunxiang0918.png&w=120&h=120&fit=cover&mask=circle&output=png" width="60" height="60" alt="sunxiang0918" /></a> <!-- contributors -->
## 💖 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&output=png" 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&output=png" width="60" height="60" alt="Jaepil.Choi" /></a> <!-- sponsors -->
TDQS
A4.6/5.0
Scored across 5 tools
Disambiguation5/5
Each tool targets a clearly distinct action: full-content retrieval (get_paste_item), summary browsing (search_clipboard), aggregate counts (get_clipboard_stats), tag enumeration (list_tags), and creation (add_to_clipboard). The descriptions explicitly cross-reference each other to steer agents correctly, e.g. 'Use search_clipboard first when the ID is not known' and 'Use get_clipboard_stats for counts only.' No two tools overlap in purpose.
Naming Consistency5/5
All five names follow a strict verb_noun snake_case pattern: get_paste_item, get_clipboard_stats, list_tags, search_clipboard, add_to_clipboard. Verb style is uniform and the object/resource is always explicit, making the surface highly predictable.
Tool Count5/5
Five tools is well-scoped for a clipboard history server, covering the read paths (search, get, stats, tags) and the write path (add) without redundancy. Every tool earns its place and nothing feels padded or missing at the count level.
Completeness3/5
The read surface is thorough, but the write surface is thin: items can only be added, with no delete, update, or clear-history operation. The 'favorite' flag is surfaced in outputs but no tool can set it, and tags can be listed but never created or removed — notable gaps for a clipboard manager.
Maintenance
ActivityActive
ResponsivenessResponsive