Skip to content GitHub
Guide contents
English View source

Installation and Setup

Installation & Setup

This guide covers installing CyberPaste, building from source, and keeping it up to date.


System Requirements

Requirement Minimum
OS Windows 10 (64-bit) or later
Architecture x64
WebView2 Required — the installer bootstraps it automatically; the portable build requires it already present
Runtime None (Tauri bundles all other dependencies)
Disk space ~50 MB
RAM 2 GB

Installation Methods

WinGet (Coming soon)

WinGet support is planned, but CyberGems.CyberPaste has not yet been published in the official WinGet community source. The following command is therefore not available yet:

winget install CyberGems.CyberPaste

Until the package is published, use the NSIS installer or portable ZIP below. This section will be updated when the official package identifier is available.

Installer (NSIS)

  1. Download the latest *-setup.exe installer from Releases
  2. Run the installer; the setup lets you choose a per-user or per-machine (Program Files) install
  3. Follow the setup wizard
  4. Launch CyberPaste

Portable

  1. Download the latest CyberPaste_<version>_x64-portable.zip from Releases
  2. Extract to a writable folder
  3. Run CyberPaste.exe

Portable vs installed:

  • Shares the same user data and settings as the installed build; deleting the portable folder does not delete your clipboard history
  • Does not register Windows autostart and does not auto-update (to update: close CyberPaste, download the next ZIP, replace the executable)
  • Do not run the portable and installed builds at the same time; they share the same clipboard monitor, global shortcut, tray integration, and profile
  • WebView2 must already be available on the system (it is not bundled)

Release notes include SHA256 checksums so you can verify the downloaded installer or portable ZIP.

Windows SmartScreen

Windows may show a SmartScreen warning the first time you run the CyberPaste installer; this is expected until Windows builds enough reputation for the file. The same can appear when launching the portable build. (Checksums verify file integrity; SmartScreen is a separate reputation-based warning.)

To continue:

  1. Click More info.
  2. Click Run anyway.

Building from Source

Prerequisites

Tool Version
Node.js 18+ (CI uses Node 20)
Rust 1.77+
npm Ships with Node.js

Setup

# Clone the repository
git clone https://github.com/CyberGems/CyberPaste.git
cd CyberPaste

# Install dependencies
npm install

# Run in development mode
npm run tauri dev

Build for Production

npm run tauri build

The built installer will be in:

src-tauri/target/release/bundle/nsis/CyberPaste_<version>_x64-setup.exe

Auto-Start

CyberPaste can launch automatically when you sign in:

Enable/Disable

  • Settings → General → Start with Windows
  • Or: Windows Settings → Apps → Startup → Toggle CyberPaste

How It Works

CyberPaste registers itself in the Windows startup via the Tauri autostart plugin, writing an entry under HKCU\Software\Microsoft\Windows\CurrentVersion\Run.

Since v1.19.1, the Run entry is written with a quoted executable path, fixing autostart when CyberPaste is installed under C:\Program Files\... (previously the unquoted path with spaces never launched, even with the toggle ON).


Auto-Update

CyberPaste ships signed updates through the Tauri updater plugin.

How It Works

  1. When Auto-check updates is enabled, CyberPaste checks the update feed (latest.json on GitHub Releases) at startup
  2. When an update is available you are notified in three places:
    • A toast notification
    • A collapsible update pill in the window title bar (since v1.19.0)
    • The About window, with a Check Now control
  3. Open the update modal and click Download
  4. The update is downloaded and its signature is verified before install
  5. CyberPaste relaunches with the new version

Update Settings

Setting Description
Auto-check updates Check for new versions on startup (About window toggle)

Manual Update

  1. Open About (title-bar menu or window branding) → Check Now
  2. Or: download the latest NSIS setup from Releases and run it

ℹ️ Portable builds do not check for or install updates automatically; download the next portable ZIP, close CyberPaste, and replace the executable.


Data Location

Default Locations

Data Location
Database %APPDATA%\CyberPaste\cyber_paste.db
Images %APPDATA%\CyberPaste\images\
Settings %APPDATA%\me.cybergems.cyberpaste\settings.json
Logs (release builds) %LOCALAPPDATA%\me.cybergems.cyberpaste\logs\

ℹ️ The database and images live under CyberPaste; the settings file and logs use the app identifier me.cybergems.cyberpaste (Tauri's app data/log directories). In debug builds, logs go to stdout/webview instead of files.


Uninstallation

Standard Uninstall

  1. Windows Settings → Apps → Installed Apps
  2. Find CyberPaste → Click Uninstall

What Gets Removed

  • Program files
  • Start Menu shortcuts

What Is Kept

  • Database and images (%APPDATA%\CyberPaste)
  • Settings (%APPDATA%\me.cybergems.cyberpaste)

Auto-Start Entry

  • If you disable Start with Windows in Settings before uninstalling, the Run entry is removed cleanly
  • If the toggle was ON, the entry under HKCU\Software\Microsoft\Windows\CurrentVersion\Run may remain; remove it manually (or re-run the old app, toggle OFF, uninstall)

⚠️ To remove all data, manually delete %APPDATA%\CyberPaste and %APPDATA%\me.cybergems.cyberpaste after uninstalling.

← All documentation