Files
app__cliphoard/README.md
2026-09-27 21:20:01 +02:00

98 lines
2.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Cliphoard
Local, keyboard-first clipboard history for Linux/X11. History is encrypted
with SQLCipher and unlocked with a passphrase that Cliphoard does not store.
## Install a `.deb`
Install the package on Debian, Ubuntu, or Mint:
```bash
sudo apt install ./cliphoard_1.3.0_amd64.deb
```
The package installs the `cliphoard` command, desktop launcher, tray icon,
autostart entry, and a copy of this README at
`/usr/share/doc/cliphoard/README.md`. Start it from the desktop menu, tray, or
with `cliphoard`.
On first start, create a passphrase and remember it; Cliphoard cannot recover
it. Existing history must already be encrypted. Plaintext databases are not
opened or migrated.
## Build from source
Run this from the repository root:
```bash
sudo apt update
sudo apt install cargo rustc dpkg-dev libgtk-4-dev libdbus-1-dev libx11-dev libxfixes-dev libxtst-dev pkg-config
cargo test --locked --all-features
cargo build --release --locked --features gui
packaging/build-deb.sh
sudo apt install ./target/cliphoard_1.3.0_amd64.deb
```
An isolated Docker build produces the same package:
```bash
docker build -t cliphoard-builder .
docker run --rm -v "$PWD/target:/out" cliphoard-builder
```
## Use
- `Ctrl+Alt+V` opens or hides the popup.
- `Ctrl+Alt+R` pauses or resumes recording.
- Enter copies; `Ctrl+Enter` pastes; Escape hides the popup.
- Double-click an entry to inspect its full contents.
- The tray menu opens the popup or quits Cliphoard completely.
## Remove or disable autostart
Remove the package and its system autostart entry:
```bash
sudo apt remove cliphoard
```
If it was installed with `dpkg` and `apt` cannot find it:
```bash
sudo dpkg -r cliphoard
```
Keep Cliphoard installed but disable autostart for your user:
```bash
mkdir -p ~/.config/autostart
printf '%s\n' '[Desktop Entry]' 'Hidden=true' > ~/.config/autostart/io.cliphoard.Cliphoard.desktop
```
Delete local history, configuration, logs, and migration backups after quitting:
```bash
rm -rf ~/.local/share/cliphoard ~/.config/cliphoard ~/.local/state/cliphoard
```
The last command is permanent. Backups and filesystem snapshots are outside
Cliphoard’s control.
Runtime paths are `~/.local/share/cliphoard/cliphoard.db`,
`~/.config/cliphoard/config.toml`, and `~/.local/state/cliphoard/`.
## Upgrade from a plaintext database
Version 1.1.0 no longer opens or migrates plaintext databases. If Cliphoard
reports that the database is plaintext, stop Cliphoard and remove the old
database before starting the new version. This permanently removes its
history:
```bash
pkill -x cliphoard || true
rm -f ~/.local/share/cliphoard/cliphoard.db \
~/.local/share/cliphoard/cliphoard.db.plaintext-backup*
```
If the old history is needed, keep a copy elsewhere and use the previous
release to export or otherwise preserve it before deleting the local files.