Clipboard

<br>

<br> <br> <img src="documentation/readme-assets/ProductivityTools.png" alt="The fully-featured yet oh-so-easy-to-use clipboard manager for everyone." /> <br>

The Clipboard Project is a fast and lightweight, feature packed, and user friendly tool that lets you do more on the computer in style. Seriously.

Say hello to one of the most cutting-edge clipboard managers ever. Save time and effort easier and more powerfully than ever before.

Don't just take my word for it!

<br> <img src="documentation/readme-assets/Features.png" alt="Just let the features speak for themselves." height=35px>

• Copy and paste text, files, directories, binary data, your goat, anything
• Infinite numbers of clipboards with unlimited capacity and history each,
• Seriously kickASS performance 🥾🤯 because I'm sick of slow software,
• Seamless integration with your existing clipboard systems,
• Support for your favorite languages like español, português, Türkçe, and Français,
• A superbly scriptable API to automate your workflows in a cinch,
• Gorgeous <img src="documentation/readme-assets/eyecandy.svg" height="16px" alt="eye candy"/> and ear candy for your viewing and listening pleasure,
• Documentation you'll actually want to read _{(all in this readme)}
• And oodles more!

<br>

<i>I believe Clipboard is <b>the best tool for clipboard interaction</b>. As a matter of fact, as of today you have 2713 stars on github, kudos! Keep up the good work.</i>

- pidario on GitHub.com

<br>

<i>Thanks for your work! This is by-far <b>one of my favourite projects</b> on GitHub!</i>

- MaddyGuthridge on GitHub.com

<br>

<i>...I've just discovered CB & <b>it's suiting my needs very well!</b></i>

- all64bits on Discord.com

<br>

<i>I started using this because <b>I just wanted an easy "cb copy && cb paste"</b> VS trying to remember the correct input AND output flags when Im using xclip with different file types. I write a lot of shell scripts that copy certain stuff like images and text and <b>this makes it a lot easier.</b></i>

- SweetBabyAlaska on Reddit.com

<br>

<i>As a sysadmin and hourly terminal user, <b>I found it so useful.</b> Making stuffs some easier.</i>

- Simpleboy_ir on Reddit.com

<br>

<i>Thank you for this app, <b>so simple yet effective!</b> Hats off 🎩 👌</i>

- GlassGruber on GitHub.com

<br>

<i>BTW, really LOVE this project. Its [sic] <b>so unbelievable it isn't already in Linux.</b></i>

- AtomicRobotMan0101 on GitHub.com

<br>

<i>...Thank you again for <b>this great application!</b></i>

- kohane27 on GitHub.com

<br>

<p align="center" id="dummy"> <a href="https://github.com/Slackadays/Clipboard/actions"> <img src="https://img.shields.io/github/actions/workflow/status/Slackadays/Clipboard/build-clipboard.yml?branch=main&label=BUILDS&style=for-the-badge&logo=githubactions&labelColor=rgb(55,55,55)"> <img src="https://img.shields.io/github/actions/workflow/status/slackadays/Clipboard/lint-clipboard.yml?branch=main&label=CHECKS&style=for-the-badge&logo=githubactions&labelColor=rgb(55,55,55)"> </a> <a href="https://app.codecov.io/gh/Slackadays/Clipboard"> <img src="https://img.shields.io/codecov/c/github/slackadays/Clipboard/main?style=for-the-badge&label=COVERAGE&token=RO7KDOZ6Q2&logo=codecov&labelColor=rgb(55,55,55)"> </a> <img src="https://img.shields.io/github/downloads/Slackadays/Clipboard/total?style=for-the-badge&labelColor=rgb(55,55,55)&logo=github"> <br> <a href="https://github.com/Slackadays/Clipboard/releases"> <img src="https://img.shields.io/github/v/release/slackadays/clipboard?label=latest%20release&style=for-the-badge&logo=github&labelColor=rgb(55,55,55)&color=brightgreen"> </a> <a href="https://discord.gg/J6asnc3pEG"><img src="documentation/readme-assets/join-our-discord.svg" alt="Discord Chat"></a> <img src="https://img.shields.io/github/license/slackadays/clipboard?label=FREE%20%26%20OPEN%20SOURCE&logo=gnu&style=for-the-badge&labelColor=rgb(55,55,55)"> <br> <img src="https://img.shields.io/maintenance/yes/2024?style=for-the-badge&labelColor=rgb(55%2C55%2C55)"> </p> <br> <br> <p align="center"> <img src="documentation/readme-assets/GetStartedBelow.png" alt="Ready to turbocharge your productivity? Then let's get started with CB." height="100px" /> </p> <br> <br>

<a href="https://github.com/Slackadays/Clipboard/blob/main/install.sh"><img src="documentation/readme-assets/AllExceptWindows.png" alt="All Except Windows" height=25px /></a>

curl -sSL https://github.com/Slackadays/Clipboard/raw/main/install.sh | sh

<a href="https://github.com/Slackadays/Clipboard/blob/main/install.ps1"><img src="documentation/readme-assets/WindowsRunAsAdmin.png" alt="Windows (run as Administrator)" height=30px /></a>

(Invoke-WebRequest -UseBasicParsing https://github.com/Slackadays/Clipboard/raw/main/install.ps1).Content | powershell

<br> <br>

<img src="documentation/readme-assets/PremadeBuilds.png" alt="Premade Builds" height=25px />

<a href="https://repology.org/project/clipboard/versions"><img src="https://repology.org/badge/vertical-allrepos/clipboard.svg" alt="Packaging status" align="right"></a>

Alpine Linux (you'll need to enable the Community packages first)

apk add clipboard

<br>

AUR (Use your favorite AUR helper such as yay. You can also get clipboard-bin and clipboard-git)

yay -S clipboard

<br>

Flatpak Flathub (You can also get our nightly Flatpak builds under GitHub Downloads)

flatpak install app.getclipboard.Clipboard
# After installing, do "alias cb='flatpak run app.getclipboard.Clipboard'" to use CB easily.
# Then, add that command to your terminal profile (like .bashrc) to make it work every time.

<a href="https://flathub.org/apps/app.getclipboard.Clipboard"><img width='240' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.svg' align="right"/></a>

<br>

Gentoo GURU and LiGurOS (For Gentoo, enable the GURU repo first)

emerge -av app-misc/clipboard

<br>

Homebrew

brew install clipboard

<br>

Nix

nix-env -iA nixpkgs.clipboard-jh

<br>

Pacstall

pacstall -I clipboard-bin

<br>

Scoop

scoop install clipboard

<br>

Snap (You can also get our nightly Snap builds under GitHub Downloads)

sudo snap install clipboard
# After installing, do "alias cb='snap run clipboard'" to use CB easily.
# Then, add that command to your terminal profile (like .bashrc) to make it work every time.

<a href="https://snapcraft.io/clipboard"> <img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" align="right"/> </a> <br>

Void Linux

sudo xbps-install -S Clipboard

<br>

GitHub Downloads

First, get the latest revision of the Clipboard Project from GitHub Actions or the latest release from GitHub Releases.

Then, unpack what you just downloaded to a nice place anywhere on your system.

If you downloaded the Flatpak, now do flatpak install what-you-downloaded.flatpak. Or if you downloaded the Snap, now do sudo snap install --dangerous what_you_downloaded.snap.

Finally, add CB to your PATH (so that you can run it anywhere) by doing one of the following:

# For all platforms except Windows, Flatpak, and Snap
$ export PATH=$PATH:/where/you/unpacked/cb
# Add this to your terminal startup file like .bashrc or the equivalent so that it works every time.
# To get the current path (in case you don't know it), do the "pwd" command.

# For Flatpak
$ alias cb='flatpak run app.getclipboard.Clipboard'
# Add this to your terminal startup file like .bashrc or the equivalent so that it works every time.

# For Snap
$ alias cb='snap run clipboard'
# Add this to your terminal startup file like .bashrc or the equivalent so that it works every time.

# For Windows PowerShell
> $Env:PATH += ";C:\where\you\unpacked\cb"
# Add this to your PowerShell profile (which is located in $profile) so that this works every time.
# To get the current path (in case you don't know it), do the "Get-Location" command.

<br> <br>

<img src="documentation/readme-assets/InstallManually.png" alt="Install Manually" height=25px />

You'll need CMake and C++20 support, and if you want X11 or Wayland support, you'll also need libx11 or libwayland plus Wayland Protocols respectively. If you're on Linux, you'll need ALSA.

Get the latest release instead of the latest commit by adding --branch 0.9.0.1 right after git clone....

Change the system installation prefix by adding -DCMAKE_INSTALL_PREFIX=/custom/prefix to cmake .., or the library install location by adding -DCMAKE_INSTALL_LIBDIR=/custom/dir.

# First, let's download the code and go a nice place to build everything.
$ git clone https://github.com/Slackadays/Clipboard 
$ cd Clipboard/build

# Now let's set up CMake and build CB.
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ cmake --build . -j 12

# Finally, let's install it onto our system.
$ cmake --install .

<img src="documentation/readme-assets/Uninstall.png" alt="Uninstall" height=25px />

Remove everything listed in install_manifest.txt. If you're not using Windows, you can also do xargs rm < install_manifest.txt.

<br> <br> <p align="center"> <img src="documentation/readme-assets/HowToUsePrompt.png" alt="Now let's start saving time and effort." height="40px" /> </p> <br> <br>

<img src="documentation/readme-assets/Examples.png" alt="Examples" height=25px />

# Let's start by copying a file.
$ cb copy NuclearLaunchCodes.pdf

# Now, let's paste this file.
$ cb paste

# Not bad, right?

# Let's make a note for this clipboard.
$ cb note "Keep this a secret"

# What if you wanted to pipe the note in?
$ echo "Keep this a secret OR ELSE" | cb note

# Now let's cut a directory to a different clipboard.
$ cb cut69 MyDirectory

# We put the 69 right after "cut" to tell CB to put MyDirectory in clipboard 69.

# Let's add a file to this same clipboard.
$ cb add69 SomeFile

# To remove a file, enter its name to remove just that file.
$ cb remove69 SomeFile

# Alternatively, you can put in a regex pattern instead to generalize the removal.
$ cb remove69 "So.*le"

# Finally, let's paste what we have in clipboard 69.
$ cb paste69

# You can copy multiple files at the same time. 
# Let's try the "_420" persistent clipboard for this one.
$ cb copy_420 foo.bar NotAVirus.bar.mp3.exe

# Like before, we can remove anything with a regex patttern.
$ cb remove_420 "*.mp3\.exe"

# Notes work exactly the same way for every clipboard.
$ cb note_420 "Some kosher content here"

# Let's look at everything we've stored in clipboard _420.
$ cb show_420

# Now let's see our original note and then clear that clipboard. 
$ cb note
$ cb clear

# This is the same as "cb note" but for clipboard "_420" again.
$ cb note_420

# Let's shake things up. Say you have some kind of content you want to ignore.
# This content could be anything from a password to raw binary data.
# To ignore certain kinds of content, use a regex pattern of your choice.

# Let's try this with a classic example.
$ cb ignore "H.*2"

# This pattern will ignore anything starting with "H" and ending with "2."

# Now, this next command will fail because CB will ignore the content in it through the pattern.
$ cb copy "Hunter2"

# Let's get some more detailed information about our clipboards.
$ cb info
$ cb info69
$ cb info_420

# To wrap things up, let's get a bird's eye view of everything so far.
$ cb
# Doing "cb" is the exact same as "cb status."
$ cb status

# These are just a handful of examples. 
# Check the documentation below for tons more examples of all the commands!

<br>

<img src="documentation/readme-assets/TheBasics.png" alt="The Basics" height=25px />

Add a number to the end of your action to choose which temporary clipboard you want to use (the default is 0). Or, add _ to use a persistent clipboard instead.

<details><summary> &ensp; <b>Copy</b> &emsp; <code>cb [--](copy|cp)[(num)|_(id)] (file) [files]</code> or <code>(something) | cb [[--](copy|cp)][(num)|_(id)]</code></summary> <br>

Copy a file.

$ cb copy FooFile
$ cb --copy FooFile
$ cb cp FooFile 
$ cb --cp FooFile
# These are the same!

Copy a file and a directory.

$ cb copy FooFile BarDir
# These are also the same!

Copy piped in data.

$ echo "Foobar" | cb
$ echo "Foobar" | cb copy 
# The "copy" action is optional here since the only possible action here in the first place is "copy"

Copy text directly.

$ cb copy "Aventura was the best bachata band"

Note: This happens instead of copying a file/directory if there is only one item present and that item doesn't exist as a file/directory.

Copy a file to the clipboard named "4"

$ cb copy4 FooFile

Copy piped in data to the persistent clipboard named "hello"

$ echo "Foobar" | cb copy_hello

Copy text to the clipboard named "hey"

$ cb --clipboard hey copy "Aventura was the best bachata band"
$ cb -c hey copy "Aventura was the best bachata band" 
# These are the same!

Copy a file with spaces and many directories to clipboard "50" using the abbreviated action name.

$ cb cp50 "Aventura/God's Project/04 Un Chi Chi.flac" BarDir BazDir

</details> <br> <details><summary> &ensp; <b>Cut</b> &emsp; <code>cb [--](cut|ct)[(num)|_(id)] (file) [files]</code> or <code>(something) | cb [[--](cut|ct)][(num)|_(id)]</code></summary> <br>

Cut a file.

$ cb cut FooFile
$ cb --cut FooFile
$ cb ct FooFile 
$ cb --ct FooFile
# These are the same!

Cut a file and a directory.

$ cb cut FooFile BarDir
# These are also the same!

Cut piped in data.

$ echo "Foobar" | cb cut

Note: Cutting piped in data is the same as copying, except that CB will delete all content after you paste it somewhere.

Cut text directly.

$ cb cut "Hunter2"

Note: This happens instead of cutting a file/directory if there is only one item present and that item doesn't exist as a file/directory.

Cut a file to the clipboard named "4"

$ cb