Home

Awesome

Clipboard

Zsh clipboard plugin that adds cross-platform helper functions to access the system clipboard. Works on macOS, X11 (and Wayland), Cygwin, MSYS2, and WSL (1 and 2).

  1. pbcopy - pipe something to this function, e.g. echo Hello world | pbcopy, and it will be copied to system clipboard.
  2. pbpaste - show the contents of the system clipboard, e.g. pbpaste | grep Hello.
  3. clip - a wrapper around the two previous functions. If you do not pipe something to it, the function will show the clipboard contents; otherwise, it will copy something to the clipboard.

How to install

oh-my-zsh

cd ~/.oh-my-zsh/custom/plugins
git clone https://github.com/zpm-zsh/clipboard.git

plugins=( [plugins...] clipboard [plugins...])

zpm

Add the following to your .zshrc file somewhere after you source zpm.

zpm load zpm-zsh/clipboard

antigen

Add antigen bundle zpm-zsh/clipboard to the part of your .zshrc where you add your other plugins. Antigen will clone clipboard for you and add it to your antigen setup the next time you start a new shell.

prezto

For most people the easiest way to use zpm-zsh/clipboard with prezto is to manually clone the zpm-zsh/clipboard repo to a directory of your choice and symlink the /clipboard folder into your zpretzo/modules folder:

ln -s /path/to/clipboard ~/.zprezto/modules/clipboard

Alternatively, you can add the zpm-zsh/clipboard repository as a submodule to your prezto repo by manually editing the '.gitmodules' file:

[submodule "modules/clipboard"]
        path = modules/clipboard
        url = https://github.com/zpm-zsh/clipboard.git

Then make sure you activate the plugin in your .zpreztorc file:

zstyle ':prezto:load' pmodule \
clipboard \
...

zplug

Add the following to your .zshrc file somewhere after you source zplug.

zplug "zpm-zsh/clipboard"

zcomet

Add the following to your .zshrc file somewhere after you source zcomet.zsh:

zcomet load zpm-zsh/clipboard