CopyQ README

The project's README from github.com/hluk/CopyQ. As one markdown file: README.md.

CopyQ

Documentation Status Translation Status Linux Build Status macOS Build Status Windows Build Status Coverage Status

CopyQ is an advanced clipboard manager with powerful editing and scripting features.

Overview

Features

Install

Packaging status

To install CopyQ, use the binary package or the installer provided for your operating system.

For unlisted operating systems, please follow the instructions in Build from Source Code.

Windows

Chocolatey package

On Windows you can use any of the following options to install CopyQ:

Using Scoop:

scoop install copyq

Using Chocolatey:

choco install copyq

macOS

macOS 13 and above are supported (this mainly depends on the Qt version).

Homebrew package

On macOS you can use Homebrew to install CopyQ:

brew install --cask copyq

If you encounter an issue where the app crashes with a dialog saying "CopyQ is damaged" or "CopyQ cannot be opened", you may need to run the following commands (for details, see #2652):

xattr -d com.apple.quarantine /Applications/CopyQ.app
codesign --force --deep --sign - /Applications/CopyQ.app

Debian 11+, Ubuntu 22.04+, and their derivatives

Install copyq and copyq-plugins packages.

Ubuntu PPA

The official PPA (ppa:hluk/copyq) is no longer maintained. Install the packages provided for your distribution.

See the announcement.

Fedora

Install copyq package.

Arch Linux

Install copyq package.

Other Linux Distributions

Download the latest AppImage from GitHub Releases:

chmod +x CopyQ-*.AppImage
./CopyQ-*.AppImage

Alternatively, install Flatpak and com.github.hluk.copyq from Flathub. See Flathub Setup for initial Flatpak/Flathub configuration.

Start CopyQ from the menu or with the following command:

flatpak run com.github.hluk.copyq

Using the App

To start CopyQ, double-click the program icon or run copyq (on Windows, run CopyQ.exe, or launch it from the Start menu; no desktop icon is created by default).

The list with the clipboard history is accessible by clicking on the system tray icon or by running copyq toggle.

Copying text or image to the clipboard will create a new item in the list.

Selected items can be:

All items will be restored when CopyQ is next started.

To exit CopyQ, select Exit from the tray menu or press Ctrl-Q in the CopyQ window.

Read more:

Adding Functionality

To create custom actions that can be executed from the menu, with keyboard shortcuts, or when the clipboard changes:

One of the very useful predefined commands is "Show/hide main window".

Read more:

Command Line

CopyQ has a powerful command line and scripting interface.

Note: The main application must be running to be able to issue commands using the command line.

Print help for some useful command line arguments:

copyq --help
copyq --help add

Insert some text in the history:

copyq add -- 'first item' 'second item' 'third item'

Omitting the double-dash (--) in the command above would mean that slashes (\) in arguments will be treated as special characters. For example, \n will be treated as the new line character, \t as tab, \\ as slash, \x as x, etc.

Create a single item containing two lines:

copyq add 'first line\nsecond line'

Print the content of the first three items:

copyq read 0 1 2
copyq separator "," read 0 1 2

Show the current clipboard content:

copyq clipboard
copyq clipboard text/html
copyq clipboard \?    # lists formats in clipboard

Copy text to the clipboard:

copyq copy "Some Text"

Load file content into the clipboard:

copyq copy - < file.txt
copyq copy text/html < index.html
copyq copy image/jpeg - < image.jpg

Create image items:

copyq write image/gif - < image.gif
copyq write image/svg - < image.svg

Read more:

Build from Source Code

See the documentation section Build from Source Code.

Contributions

You can help translate CopyQ (click the banner below) or help fix issues and implement new features.

Translations

Read more:

CopyQ (hluk/CopyQ)

Searching Database…

12.5K ·GitHub
这是什么?CopyQ 是一款功能强大的剪贴板管理器,它会监控系统剪贴板,并把内容保存到可自定义的标签页中,方便你浏览、搜索和重复使用之前复制过的内容。
这是后台托盘程序吗,还是别的什么?它是一款桌面应用,会驻留在系统托盘中,并保留一个持久的历史记录窗口。它还提供命令行和脚本接口,方便自动化操作。
怎么安装并开始使用?在 Windows 上可以通过安装程序、便携版 zip、Scoop 或 Chocolatey 安装;在 macOS 上通过 Homebrew 安装;在 Linux 上通过发行版的软件包、PPA/Flatpak 或 AppImage 安装。安装后,运行 'copyq'(在 Windows 上则启动 CopyQ.exe),点击托盘图标,或运行 'copyq toggle',即可打开剪贴板历史。
安装前还需要先装别的东西吗,比如 Homebrew?在 macOS 上需要通过 Homebrew 安装;在 Linux 上,除了发行版自带的软件包,也可以使用 Flatpak/Flathub 作为替代方式。应用本身运行不需要其他运行环境。
安装时有哪些需要注意的坑吗?在 macOS 上,安装后 Gatekeeper 可能会弹出 'CopyQ is damaged' 或 'CopyQ cannot be opened' 错误,需要手动在终端中修复。另外,Ubuntu PPA 已不再维护。
它到底支持哪些操作系统?支持 Linux、Windows,以及 macOS 13 及以上版本。
除了纯文本,它还能存哪些内容?它可以保存文本、HTML、图片以及其他自定义的剪贴板格式,还允许你为保存的条目添加备注和标签。
剪贴板内容变化时,我能自动执行操作吗?可以。你可以通过命令对话框(F6)创建自定义命令,让它们通过键盘快捷键或托盘菜单触发,也可以在剪贴板内容每次变化时自动运行。
命令行工具能做什么?'copyq' 命令行工具可以直接在脚本中添加、读取、复制和写入任意格式(文本、HTML、图片)的剪贴板条目,例如 'copyq add first item' 或 'copyq copy image/jpeg - < image.jpg'。
能否排除某些应用或文本,不让它们被记录?可以。CopyQ 可以忽略从指定窗口复制的内容,也可以忽略包含指定文本的内容。
Creator
hluk
Size
44.4 MB
Stars
12.5K
Age
16y
Commits · 90 Days