Repository files navigation

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

• Downloads
• Web Site
• Documentation
• Mailing List
• Bug Reports
• Donate
• Scripting API

• CopyQ monitors the system clipboard and saves its content in customized tabs.
• Saved clipboard entries can later be copied and pasted directly into any application.

• Support for Linux, Windows, andOS X 10.15+
• Store text, HTML, images, and any other custom formats
• Quickly browse and filter items in clipboard history
• Sort, create, edit, remove, copy/paste, drag'n'drop items in tabs
• Add notes and tags to items
• System-wide keyboard shortcuts with customizable commands
• Paste items with keyboard shortcuts, from tray, or from main window
• Fully customizable appearance
• Advanced command-line interface and scripting
• Ignore clipboard copied from specified windows or containing specified text
• Support for simple Vim-like editor with keyboard shortcuts
• Many more features

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

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

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

• Installer (setup.exe)
• Portable zip package
• Scoop package from theextras bucket.
• Chocolatey package

Using Scoop:

scoop install copyq

Using Chocolatey:

choco install copyq

On OS X you can useHomebrew to install CopyQ:

brew install --cask copyq

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

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

Installcopyq andcopyq-plugins packages.

Install and keep CopyQ always up to date by running the following commands fromthe terminal (the package from PPA contains all plugins and documentation):

sudo add-apt-repository ppa:hluk/copyqsudo apt updatesudo apt install copyq

Installcopyq package.

Installcopyq package.

InstallFlatpak andcom.github.hluk.copyq fromFlathub.

flatpak install flathub com.github.hluk.copyq

Start CopyQ from the menu or with the following command:

flatpak run com.github.hluk.copyq

To start CopyQ, double-click the program icon or runcopyq.

The list with the clipboard history is accessible by clicking on the system tray iconor by runningcopyq toggle.

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

Selected items can be:

• edited (F2)
• removed (Delete)
• sorted (Ctrl+Shift+S,Ctrl+Shift+R)
• repositioned (with mouse orCtrl+Up/Down)
• copied back to the clipboard (Ctrl+C)
• pasted to the previously active window (Enter)

All items will be restored when CopyQ is next started.

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

Read more:

• Basic Usage
• Keyboard

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

• go to the Command dialog (F6 shortcut)
• click theAdd button, then select a predefined command, or create a new one
• optionally change the command details (shortcut, name)
• clickOK to save the command

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

Read more:

• Writing Commands
• CopyQ Commands Repository

CopyQ has a powerful command line and scripting interface.

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

Print help for some useful command line arguments:

copyq --helpcopyq --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 asthe new line character,\t as tab,\\ as slash,\x asx, 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 2copyq separator "," read 0 1 2

Show the current clipboard content:

copyq clipboardcopyq clipboard text/htmlcopyq clipboard \?    # lists formats in clipboard

Copy text to the clipboard:

copyq copy "Some Text"

Load file content into the clipboard:

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

Create image items:

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

Read more:

• Scripting
• Scripting API

To build CopyQ from source code, first install the required dependencies:

• Git
• CMake
• Qt
• optional on Linux/X11: development files and libraries forXtst andXfixes

sudo apt install \  cmake \  extra-cmake-modules \  git \  libqt5svg5 \  libqt5svg5-dev \  libqt5waylandclient5-dev \  libqt5x11extras5-dev \  libwayland-dev \  libxfixes-dev \  libxtst-dev \  qtbase5-private-dev \  qtdeclarative5-dev \  qttools5-dev \  qttools5-dev-tools \  qtwayland5 \  qtwayland5-dev-tools

sudo yum install \  cmake \  extra-cmake-modules \  gcc-c++ \  git \  libXfixes-devel \  libXtst-devel \  qt5-qtbase-devel \  qt5-qtdeclarative-devel \  qt5-qtsvg-devel \  qt5-qttools-devel \  qt5-qtwayland-devel \  qt5-qtx11extras-devel \  wayland-devel \  kf5-knotifications-devel

Change install prefix if needed:

git clone https://github.com/hluk/CopyQ.gitcd CopyQcmake.make

You can now run the built app.

./copyq

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

Read more:

• Build from Source Code
• Fixing Bugs and Adding Features
• Translations