Skip to content

Latest commit

 

History

History
118 lines (97 loc) · 4.7 KB

README.md

File metadata and controls

118 lines (97 loc) · 4.7 KB
Raw

ClipBroad

README | 中文文档

Sync your clipboard across multiple platforms. Download the latest release here.

Introduction

This tools uses Github private repo to store and sync your clipboard items. By default, it listens to your local clipboard change like other clipboard tools do. After login to Github, local clipboard items will be uploaded to Github on a frequent basis, while remote items will be fetched to local.

By login to Github, ClipBroad will ask for your user and repo permission. These permissions are used to get your avatar, username, Github API rate limit, as well as creating a private repository named ClipBroadHistory for you, uploading and deleting clipboard items to this repository.

Currently I'm not going to purchase an Apple developer account to support iOS. Besides, Linux build is not tested. If you find any issue, feel free to fork and build on your own.

Features

  • Free to use
  • Record and reuse clipboard history
  • Sync clipboard history to Github if login with Github
  • Sync through Windows, Mac and Android devices
  • Support common binary file formats

Usage

  • Login at the Settings page
  • Drag to upload & update on the main page
  • On desktop, double click text and image to copy them, or double click other files to save to local
  • On mobile, double tap text to copy, or double tap other files to share
  • Items are automatically uploaded every 30 seconds
  • Click tray icon on desktop to show/hide main panel
  • Keyboard shortcut is Control+Shift+C on Windows and Cmd+Shift+C on Mac (configurable)
  • Files of common type can be shared to this app (ClipBroad) on mobile
  • Click on an item to preview (if possible for some item types)

Screenshots

Main:

Preview:

Dark mode:

Search:

On mobile:

Build

  1. Clone this repository
git clone https://github.com/dale0525/ClipBroad.git
  1. Install Quasar
$ npm install -g @quasar/cli
  1. Install node dependencies
cd ClipBroad
npm install
cd src-electron
npm install
cd ../src-cordova
npm install
  1. Modify Github API plugin
cd ..
rm node_modules/github-api/dist/components/Repository.js
cp Repository_modified.js node_modules/github-api/dist/components/Repository.js
  1. Build
# Desktop verison
quasar build -m electron [-T darwin] [-T win32] [-T linux]
# Mobile version
quasar build -m cordova [-T android] [-T ios]

TODO

  • Settings for max sync item
  • Settings for launch on system boot on desktop
  • Settings for copied notification
  • Settings for network connection on mobile
  • About page
  • Localization (US, zhCN)
  • Delete local item
  • Delete related Github item
  • Support other common binary files
  • Settings for dark mode
  • Settings for desktop shortcut
  • Search function
  • Redirect to app after Github login on mobile
  • Auto update for Windows & MacAuto update for Win & new version notification for Mac
  • Auto update for iOS & Android
  • Upload to App Store(iOS)
  • Upload to Google Play
  • Linux build

Credits

Donation

Paypal