Home

Awesome

<br>

The Clipboard Project

<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> <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>

- MiguelGuthridge 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>

CB Demo Video

<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>

Quick Installation

<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>

How To Use

<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 cut4 FooFile

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

$ echo "Foobar" | cb cut_hello

Cut text to the clipboard named "hey"

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

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

$ cb ct50 "Aventura/God's Project/04 Un Chi Chi.flac" BarDir BazDir
</details> <br> <details><summary> &ensp; <b>Paste</b> &emsp; <code>cb [--](paste|p)[(num)|_(id)] [regex] [regexes]</code> or <code>cb [[--](paste|p][(num)|_(id)] | (something)</code> or <code>cb [[--](paste|p)][(num)|_(id)] > (some file)</code></summary> <br>

Start by copying or cutting something.

$ cb copy FooFile WhyAventuraIsTheBest.pdf

Paste in the current working directory.

$ cb paste
$ cb --paste
$ cb p
$ cb --p
# These are the same!

Note: If you paste after cutting, then CB will delete the original files that you cut.

Paste anything containing "Aventura."

$ cb p ".*Aventura.*"

Now, let's copy some raw data.

$ echo "Bananas!" | cb

Paste the raw data file in the current working directory.

$ cb paste
# Also the same

Pipe everything out to some file.

$ cb paste > SomeFile

Pipe everything from clipboard "42" out to some file.

$ cb paste42 > SomeFile
$ cb p42 > SomeFile
$ cb -c 42 > SomeFile 
# These three versions all work great!

Pipe everything out to some program.

$ cb | cat
# These three versions also all work great.
$ cb | Write-Output 
# The version for PowerShell

Pipe everything from persistent clipboard "2" out to some program.

$ cb paste_2 | cat
$ cb p_2 | cat
$ cb -c _2 | cat 
# These three versions also all work great.
$ cb -c _2 | Write-Output 
# The version for PowerShell

Note: If you paste after cutting, then CB will delete the raw data afterwards, effectively only letting you paste once.

</details> <br> <details><summary> &ensp; <b>Add Contents</b> &emsp; <code>cb [--](add|ad)[(num)|_(id)] (file|text) [files]</code> or <code>(something) | cb [[--](add|ad)][(num)|_(id)]</code></summary> <br>

Start by copying something.

$ cb copy FooFile

Add a file.

$ cb add SomeOtherFile
$ cb --add SomeOtherFile
$ cb ad SomeOtherFile 
$ cb --ad SomeOtherFile
# CB now holds FooFile and SomeOtherFile

Add a directory.

$ cb add "We Broke The Rules"

Now let's copy some raw data.

$ cb copy "'Let me find that'"

Add raw data to the end of what's stored.

$ cb add " is one of Romeo Santos' catchphrases."
# The content is now: 'Let me find that' is one of Romeo Santos' catchphrases.

Add raw data by piping it in.

$ echo " What's yours?" | cb add 
# The content is now: 'Let me find that' is one of Romeo Santos' catchphrases. What's yours?
</details> <br> <details><summary> &ensp; <b>Remove Contents</b> &emsp; <code>cb [--](remove|rm)[(num)|_(id)] (regex) [regexes]</code> or <code>(some regex) | cb [[--](remove|rm)][(num)|_(id)]</code></summary> <br>

Start by copying something.

$ cb copy FooFile BarDir BazDir

Remove everything starting with "B"

$ cb remove "B.*"
$ cb --remove "B.*"
$ cb rm "B.*"
$ cb --rm "B.*"
# CB will match this against "BarDir" and "BazDir" and remove them

Remove everything matching a specific name

$ cb remove "BarDir"
# CB will match this against "BarDir" only and remove it

Now let's copy some raw data.

$ cb copy "A bachatero is someone who makes bachata music."

Remove anything with a space beforehand and that ends with "-ero"

$ cb remove "(?<= ).*ero"
# The content is now: A  is someone who makes bachata music.

Remove anything matching "music" by piping the pattern in.

$ echo "music" | cb remove
# The content is now: A  is someone who makes bachata .
</details> <br> <details><summary> &ensp; <b>Show Contents</b> &emsp; <code>cb [--](show|sh)[(num)|_(id)] [regex] [regexes]</code> or <code>cb [--](show|sh)[(num)|_(id)] [regex] [regexes] | (something)</code></summary> <br>

Start by copying something.

$ cb copy FooFile BarDir BazDir

List all the items in the clipboard.

$ cb show
$ cb --show
$ cb sh 
$ cb --sh
# These all work great!

Now let's copy some raw data.

$ cb copy "Those who are tired of bachata are tired of life"

Show the contents of the clipboard.

$ cb show

Show the raw filepaths of everything in the clipboard.

$ cb sh | cat

Show raw filepaths to a program.

$ cb copy "02 I Believe.flac"
$ eval vlc $(cb sh)
# Use the eval command here to process the raw filepath (which in this case looks like "/tmp/Clipboard/0/02 I Believe.flac") as if it were entered in a shell
# Otherwise, you'll likely get errors complaining about being unable to process quote characters.
</details> <br> <details><summary> &ensp; <b>Clear Clipboard</b> &emsp; <code>cb [--](clear|clr)[(num)|_(id)]</code></summary> <br>

Start by copying something.

$ cb copy FooFile BarDir BazDir

Clear the clipboard of all data.

$ cb clear
$ cb --clear
$ cb clr 
$ cb --clr
# These all work great!
</details> <br> <details><summary> &ensp; <b>Edit Clipboard Content</b> &emsp; <code>cb [--](edit|ed)[(num)|_(id)] [editor]</code></summary> <br>

Start by copying some text.

$ cb copy "Hello Clipboard! This is just some example content."

Edit the clipboard content.

$ cb edit
$ cb --edit
$ cb ed
$ cb --ed
# These all work great!

Use a custom editor to edit with.

cb edit nano
cb ed vim
cb ed code
</details> <br>

<img src="documentation/readme-assets/MoveThingsAround.png" alt="Move Things Around" height=25px />

<details><summary> &ensp; <b>Load Contents</b> &emsp; <code>cb [--](load|ld)[(num)|_(id)] [clipboard] [clipboards]</code></summary> <br>

Start by copying something.

$ cb copy "Yo dawg! I heard you liked bachata music."

Load the contents of the clipboard into other clipboards.

$ cb load 1 2 3 _foo
$ cb --load 1 2 3 _foo
$ cb ld 1 2 3 _foo
$ cb --ld 1 2 3 _foo
# All work great!

Note: If you don't provide a destination clipboard, then the Load action will load the contents into the default clipboard.

Load the contents of some clipboard into the default.

$ cb load_foo

Note: This is useful if you want to load content into GUI clipboard systems, as they only connect to the default clipboard.

</details> <br> <details><summary> &ensp; <b>Swap Contents</b> &emsp; <code>cb [--](swap|sw)[(num)|_(id)] [clipboard]</code></summary> <br>

Start by copying something to two clipboards.

$ cb copy "After breaking up from Aventura, Romeo Santos' music just wasn't up to snuff."
$ cb copy2 "I'd just like to interject for a moment. What you're referring to as Linux, is in fact, GNU/Linux, or as I've recently taken to calling it, GNU plus Linux."

Swap the contents of two clipboards.

$ cb swap 2
$ cb --swap 2
$ cb sw 2
$ cb --sw 2
# All work great!

$ cb swap2
$ cb --swap2
$ cb sw2
$ cb --sw2
# Since swapping is commutative, the target can be freely swapped with the destination.

Note: If you don't provide a destination clipboard, then the Swap action will swap the contents into the default clipboard.

</details> <br> <details><summary> &ensp; <b>Import Clipboards</b> &emsp; <code>cb [--](import|imp) [source folder]</code></summary> <br>

Start by exporting a clipboard.

$ cb copy "The reason Aventura was so popular was because the music was so well-written as well as the luscious guitar chorus effect."
$ cb export

Import all clipboards from a folder.

$ cb import
$ cb --import
$ cb imp
$ cb --imp
# These all work great!

Note: Currently, CB imports from a folder called Exported_Clipboards.

Choose what folder to import from.

$ cb import MySavedClipboards
</details> <br> <details><summary> &ensp; <b>Export Clipboards</b> &emsp; <code>cb [--](export|ex) [clipboard] [clipboards]</code></summary> <br>

Start by copying something.

$ cb copy "Aventura's music is some of the most erotic you'll find anywhere."

Export all clipboards to a folder.

$ cb export
$ cb --export
$ cb ex
$ cb --ex
# These all work great!

Note: Currently, CB exports to a folder called Exported_Clipboards.

Choose what clipboards to export.

$ cb export 1 2 3
</details> <br> <details><summary> &ensp; <b>Queue Clipboard History</b> &emsp; <code>cb [--](history|hs)[(num)|_(id)]</code></summary> <br>

Start by copying several things.

$ cb copy "There are at least two \"Anthony Santos\" who are known for bachata music: the \"regular\" Anthony Santos and Anthony \"Romeo\" Santos."
$ cb copy "blah blah blah"
$ cb copy "Clipboard Project is the best clipboard manager around"

Show the history.

$ cb history
$ cb --history
$ cb hs
$ cb --hs
# These all work great!
</details> <br> <details><summary> &ensp; <b>Get Older Clipboard Entries</b> &emsp; <code>cb [--](history|hs)[(num)|_(id)] (clipboard) [clipboards]</code></summary> <br>

Start by copying several things.

$ cb copy "There are at least two \"Anthony Santos\" who are known for bachata music: the \"regular\" Anthony Santos and Anthony \"Romeo\" Santos."
$ cb copy "blah blah blah"
$ cb copy "Clipboard Project is the best clipboard manager around"

Bring an older entry (or entries) to the front.

$ cb history 1
$ cb --history 2
$ cb hs 1
$ cb --hs 1 2
# These all work great!
</details> <br>

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

<details><summary> &ensp; <b>Set Note</b> &emsp; <code>cb [--](note|nt)[(num)|_(id)] (text)</code> or <code>(something) | cb [[--](note|nt)][(num)|_(id)]</code></summary> <br>

Add a personal note to a clipboard.

$ cb note "For my Aventura music collection"
$ cb --note "For my Aventura music collection"
$ cb nt "For my Aventura music collection"
$ cb --nt "For my Aventura music collection"
# All work great!

Add a personal note to a clipboard by piping it in.

$ echo "For my Aventura music collection" | cb note

Remove a note from a clipboard.

$ cb note ""
</details> <br> <details><summary> &ensp; <b>Show Note</b> &emsp; <code>cb [--](note|nt)[(num)|_(id)]</code></summary> <br>

Start by adding a note to a clipboard.

$ cb note "For my Aventura music collection"

Show the note you added.

$ cb note
$ cb --note
$ cb nt
$ cb --nt
</details> <br> <details><summary> &ensp; <b>Set Ignore Rules</b> &emsp; <code>cb [--](ignore|ig)[(num)|_(id)] (regex) [regexes]</code> or <code>(regex) | cb [[--](ignore|ig)][(num)|_(id)]</code></summary> <br>

Set some kinds of content to always ignore.

$ cb ignore "(?<![A-Za-z0-9/+=])[A-Za-z0-9/+=]{40}(?![A-Za-z0-9/+=])"
$ cb --ignore "(?<![A-Za-z0-9/+=])[A-Za-z0-9/+=]{40}(?![A-Za-z0-9/+=])"
$ cb ig "(?<![A-Za-z0-9/+=])[A-Za-z0-9/+=]{40}(?![A-Za-z0-9/+=])"
$ cb --ig "(?<![A-Za-z0-9/+=])[A-Za-z0-9/+=]{40}(?![A-Za-z0-9/+=])"
# All work great!
# "(?<![A-Za-z0-9/+=])[A-Za-z0-9/+=]{40}(?![A-Za-z0-9/+=])" is the regex for an AWS SK secret.

Set an ignore regex rule by piping it in.

$ echo "[abc]{10}" | cb ignore

Remove all ignore regex rules from a clipboard.

$ cb ignore ""
</details> <br> <details><summary> &ensp; <b>Show Ignore Rules</b> &emsp; <code>cb [--](ignore|ig)[(num)|_(id)]</code></summary> <br>

Start by adding some ignore regex rules to a clipboard.

$ cb ignore "Foo" "Bar" "Baz"

Show the rules you just added.

$ cb ignore
$ cb --ignore
$ cb ig
$ cb --ig
</details> <br> <details><summary> &ensp; <b>Show Detailed Info</b> &emsp; <code>cb [--](info|in)[(num)|_(id)]</code> or <code>cb [--](info|in)[(num)|_(id)] | (something)</code></summary> <br>

Show helpful details for a clipboard.

$ cb info
$ cb --info
$ cb in
$ cb --in
# All are the same!

Output these helpful details in JSON format.

$ cb info | cat
$ cb info | jq
</details> <br> <details><summary> &ensp; <b>Search Clipboard Contents</b> &emsp; <code>cb [--](search|sr)[(num)|_(id)] (query) [queries]</code></summary> <br>

Start by copying several things.

$ cb copy Foo Bar Baz
$ cb copy "Some example content"
$ cb copy2 "Blah bleh bluh bloh"

Search a clipboard's contents.

$ cb search Foo
$ cb --search Blah
$ cb sr Bar
$ cb --sr Baz
# All are the same!
</details> <br> <details><summary> &ensp; <b>Show Help Message</b> &emsp; <code>cb (-h|[--]help)</code></summary> <br>

Show the help message.

$ cb help
$ cb --help
$ cb -h 
# These three versions all work great!
</details> <br> <details><summary> &ensp; <b>Check All Clipboards' Status</b> &emsp; <code>cb [[--]status|st]</code> or <code>cb [--](status|st) | (something)</code></summary> <br>

Check the status of all clipboards that have content.

$ cb status
$ cb --status
$ cb st
$ cb --st
$ cb 
# These all work great!

Get the status of all clipboards in JSON format.

$ cb status | cat
</details> <br> <details><summary> &ensp; <b>Check Your Configuration</b> &emsp; <code>cb [[--]config|cfg]</code></summary> <br>

Check your configuration of CB.

$ cb config
$ cb --config
$ cb cfg
$ cb --cfg
# These all work great!
</details> <br>

<img src="documentation/readme-assets/TipsAndTricks.png" alt="Tips And Tricks" height=25px />

Need to paste a funky symbol somewhere a lot? Copy it to a persistent clipboard.

$ cb cp_theta θ
$ cb -c amog cp ඞ

Paste whatever's in the clipboard straight into your favorite text editor.

# Vim
:r !cb
# Nano
[Ctrl-T] cb
# VSCode
cb | code -

Copy a password securely by deleting it once you've pasted it.

$ cb cut "AVeryStrongPassword!"
$ cb | some-program
# Now gone

On a slow system? Cache certain things so you don't have to do them again.

$ neofetch | cb cp_neo
$ cb | cat

Yank anything sitting in your terminal without ever touching the mouse.

$ env | yank -d = -- cb

Instantly copy to the main clipboard using your favorite dmenu tool.

$ cb cp "$(cb st | jq -r '.[] | if type=="array" then .[].path else if type=="object" then .path else . end end' | dmenu)"
# For copying the latest entry from any of your clipboards
$ cb cp "$(cb hs | jq -r '.[].content | if type=="array" then .[].path else if type=="object" then .path else . end end' | dmenu)"
# For copying any entry from a specific clipboard

Need to share or pore over log files? Copy them in one step!

$ journalctl | cb
# For systemd
$ sudo dmesg | cb
# For Linux; note that you're not running "sudo cb" here
$ cb copy logs/latest.log
# For Minecraft servers

Want CB to look different? Change up the color scheme.

# This one looks like The Matrix
$ export CLIPBOARD_THEME=green
$ cb
# This one is for light backgrounds
$ export CLIPBOARD_THEME=light
$ cb
# Check out the other themes too!

Here's what some of these themes might look like.

<img src="documentation/readme-assets/CBThemes.png" width=600px />

Make your own scripts that can fully automate your workflows.

#!/bin/sh
# This script does nothing except serve as an example of automating CB.
link="https://SomeWebsiteWithLotsOfContent"
wget link
cb copy *.jpg *.png
cb remove "AZ.*\.png"
cb | tar -cf foobar.tar
cb -c footar < foobar.tar
cb note "Latest files from website ABCXYZ"
<br> <br> <p align="center"> <img src="documentation/readme-assets/CustomizeClipboard.png" alt="Let's make CB our own." height="40px" /> </p> <br> <br>

Simple Configuration

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

<details><summary> &ensp; <b><code>--all</code>, <code>-a</code></b> &emsp; Add this when clearing to clear all clipboards at once, or when searching to search all clipboards.</summary> <br>

Start from a blank slate.

$ cb --all clear

WARNING! This will get rid of everything you've stored with CB, so be very careful when clearing with this option.

</details> <br> <details><summary> &ensp; <b><code>--clipboard (clipboard)</code>, <code>-c (clipboard)</code></b> &emsp; Add this to choose which clipboard you want to use. </summary> <br>

Choose a non-default clipboard.

$ cb -c 5 copy Foobar
$ cb --clipboard 10 copy BarBaz

Copy to a temporary clipboard that doesn't start with a number.

$ cb -c SomeCB copy "A really really long sentence, and I mean really realy super DUPER long!"

Note: Although copying to a temporary clipboard that doesn't start with a number is impossible using the conventional method of adding it to the end of the action, this alternative method is completely supported and works great.

Choose a persistent clipboard.

$ cb -c _ copy "Generation Next"/*
</details> <br> <details><summary> &ensp; <b><code>--entry (entry)</code>, <code>-e (entry)</code></b> &emsp; Add this to choose which history entry you want to use. </summary> <br>

Choose a non-default history entry.

$ cb -e 5 copy Foobar
$ cb --entry 10 copy BarBaz

Note: To copy to a non-default entry, that entry must exist already.

</details> <br> <details><summary> &ensp; <b><code>--fast-copy</code>, <code>-fc</code></b> &emsp; Add this to use links when copying, cutting, pasting, or loading. If you modify the items that you used with this flag, then the items you paste will have the same changes.</summary> <br>

Copy a lot of files in much less time than before.

$ cb --fast-copy copy /usr/bin/*
</details> <br> <details><summary> &ensp; <b><code>--mime</code>, <code>-m</code></b> &emsp; Add this to request a specific content MIME type from GUI clipboard systems.</summary> <br>

Save GUI clipboard content of a specific MIME type to the main clipboard.

$ cb --mime text/html | cb
</details> <br> <details><summary> &ensp; <b><code>--no-confirmation</code>, <code>-nc</code></b> &emsp; Add this to disable confirmation messages from CB. </summary> <br>

Reduce distractions after showing some text content.

$ cb -nc sh | cat
</details> <br> <details><summary> &ensp; <b><code>--no-progress</code>, <code>-np</code></b> &emsp; Add this to disable progress messages from CB. </summary> <br>

Reduce distractions while doing a search that takes a while.

$ fzf | cb -np
</details> <br> <details><summary> &ensp; <b><code>--bachata</code></b> &emsp; Add this for something special! </summary> <br>

Make your life less boring.

$ cb --bachata
</details> <br> <br>

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

<details><summary> &ensp; <b><code>CI</code></b> &emsp; Set this to "true" or "1" to make CB overwrite existing items without a user prompt when pasting. This variable is intended for Continuous Integration scripts where a live human is not present to make decisions.</summary> <br>

Use CB in a CI script.

...
cb cp Temp/*
...
cb p
...
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_EDITOR</code></b> &emsp; Set this to the editor you want to use for the Edit action. </summary> <br>

Set a custom editor to use.

$ export CLIPBOARD_EDITOR=nano

Note: The environment variables EDITOR and VISUAL by default take precedence if CLIPBOARD_EDITOR isn't set.

</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_HISTORY</code></b> &emsp; Set this to the maximum history size you want to keep, like <code>10000</code> or <code>50gb</code>. </summary> <br>

CLIPBOARD_HISTORY supports up to 2^32 - 1 as a value. So, go ahead. Crank that b*tch up to a billion.

$ export CLIPBOARD_HISTORY=1000000000
$ cb copy "Oh yeah!"

Only keep a certain amount of data.

$ export CLIPBOARD_HISTORY=100tb
$ cb copy Yo_Mama.tar.gz

Note: You can choose between tb, gb, mb, kb, and b to specify amounts for terabytes, gigabytes, megabytes, kilobytes, and bytes respectively.

Only keep a certain time length.

$ export CLIPBOARD_HISTORY=52w

Note: You can choose between y, m, w, d, and h to specify amounts for years, months, weeks, days, and hours respectively.

</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_LOCALE</code></b> &emsp; Set this to the locale that only CB will use for its commands and output, like <code>en_US.UTF-8</code> or <code>es_DO.UTF-8</code>. </summary> <br>

Change the locale to match what you're more comfortable with.

$ export CLIPBOARD_LOCALE=es_DO.UTF-8
$ cb cp "Amo a Aventura"

> $Env:CLIPBOARD_LOCALE=es_DO.UTF-8
# Powershell version

Override the locale case-by-case.

$ export CLIPBOARD_LOCALE=fr_CA.UTF-8
...
$ CLIPBOARD_LOCALE="" cb cp Foobar
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_TMPDIR</code></b> &emsp; Set this to the directory that only CB will use to hold the items you cut or copy into a temporary directory.</summary> <br>

Choose a special place to put your temporary clipboards this one time.

$ CLIPBOARD_TMPDIR=/home/jackson/SomeDirectory cb copy *

Choose a special place to put your temporary clipboards every time.

$ export CLIPBOARD_TMPDIR=/home/jackson/SomeDirectory
$ cb copy *
> $Env:CLIPBOARD_TMPDIR = /home/jackson/SomeDirectory
# Powershell

Note: By default, CB uses the C++ filesystem library function fs::temp_directory_path() to generate the temporary directory, prioritizing CLIPBOARD_TMPDIR and then XDG_RUNTIME_DIR respectively first if CB can get a value from them.

</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_PERSISTDIR</code></b> &emsp; Set this to the directory that only CB will use to hold the items you cut or copy into a persistent directory.</summary> <br>

Choose a special place to put your persistent clipboards this one time.

$ CLIPBOARD_PERSISTDIR=/home/jackson/SomeDirectory cb copy *

Choose a special place to put your persistent clipboards every time.

$ export CLIPBOARD_PERSISTDIR=/home/jackson/SomeDirectory
$ cb copy *
> $Env:CLIPBOARD_PERSISTDIR = /home/jackson/SomeDirectory
# Powershell

Note: By default, CB uses the user's home directory to generate the persistent directory, prioritizing CLIPBOARD_PERSISTDIR and then XDG_STATE_HOME first respectively if CB can get a value from them.

</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_CUSTOMPERSIST</code></b> &emsp; Set this to the clipboards you want to make persistent, using regex.</summary> <br>

Make everything you copy persistent.

$ export CLIPBOARD_CUSTOMPERSIST=".*"
$ cb copy Foo Bar Baz
# This puts everything in the persistent directory but still with the clipboard name "0"

Make some clipboards persistent.

$ export CLIPBOARD_CUSTOMPERSIST=5
$ cb copy5 Foo Bar Baz
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_NOAUDIO</code></b> &emsp; Set this to "true" or "1" to disable audio coming from CB.</summary> <br>

Turn off those sound effects.

$ export CLIPBOARD_NOAUDIO=1
$ cb ffksdjfdj 
# No more error sounds after doing a nonexistent command
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_NOGUI</code></b> &emsp; Set this to "true" or "1" to disable integration with GUI clipboards.</summary> <br>

Debug a flaky GUI system by disabling its integration with CB.

$ CLIPBOARD_NOGUI=1 cb show
$ export CLIPBOARD_NOGUI=1
$ cb show
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_NOPROGRESS</code></b> &emsp; Set this to "true" or "1" to disable only progress messages from CB.</summary> <br>

Reduce distractions while doing a search that takes a while.

$ fzf | CLIPBOARD_NOPROGRESS=1 cb

Disable progress messages from CB entirely.

$ export CLIPBOARD_NOPROGRESS=1
$ fzf | cb
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_NOREMOTE</code></b> &emsp; Set this to "true" or "1" to disable remote clipboard sharing.</summary> <br>

Disable all clipboard content transfers through the terminal.

$ export CLIPBOARD_NOREMOTE=1
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_SILENT</code></b> &emsp; Set this to "true" or "1" to disable progress and confirmation messages from CB.</summary> <br>

Rest in peace by seeing nothing that isn't an error.

$ export CLIPBOARD_SILENT=1
$ cb cp "I'm running out of Aventura references"
</details> <br> <details><summary> &ensp; <b><code>CLIPBOARD_THEME</code></b> &emsp; Set this to the color theme that CB will use. Choose between <code>light</code>, <code>darkhighcontrast</code>, <code>lighthighcontrast</code>, <code>amber</code>, <code>green</code>, and <code>ansi</code> (the default is <code>dark</code>).</summary> <br>

Remind yourself of the terminals of the past.

$ export CLIPBOARD_THEME=green
$ cb cp "I'm in the Matrix now"
$ export CLIPBOARD_THEME=amber
$ cb cp "Yellow terminals feel just like sitting in front of a nice campfire"

Make CB more accessible.

$ export CLIPBOARD_THEME=darkhighcontrast
$ cb show
</details> <br> <details><summary> &ensp; <b><code>FORCE_COLOR</code></b> &emsp; Set this to "true" or "1" to make CB always show color regardless of what you set <code>NO_COLOR</code> to.</summary> <br>

Override somebody else's choice to disable colors.

$ export NO_COLOR=1
...
$ FORCE_COLOR=1 cb copy "There are almost no bachateros where I live right now"

Note: CB also supports CLICOLOR_FORCE.

Override somebody else's choice to disable colors, but in a different way.

$ export CLICOLOR=0
...
$ CLICOLOR_FORCE=1 cb copy "There are almost no bachateros where I live right now"
</details> <br> <details><summary> &ensp; <b><code>NO_COLOR</code></b> &emsp; Set this to anything to make CB not show any colors.</summary> <br>

Make CB look boring.

$ export NO_COLOR=1
$ cb cp "From the 1960s until the 1990s, bachata was perceived as boring music for poor Dominicans."

Note: CB also supports CLICOLOR.

Make CB look boring, but in a different way.

$ export CLICOLOR=0
$ cb cp "In the 1990s, though, several innovative musicians reinvigorated bachata by using electric guitars with fancy effects."
</details> <br> <br> <br>

Need Help?

We're here for you! Check out the Clipboard Project Wiki for even more information, ask all your burning questions in GitHub Discussions, or join the awesome Discord group!

<p align="center"> <a href="https://github.com/Slackadays/Clipboard/wiki"><img src="https://img.shields.io/badge/Docs-Wiki-green?style=for-the-badge&labelColor=rgb(55,55,55)" alt="CB Wiki"> <a href="https://github.com/Slackadays/Clipboard/discussions"><img src="https://img.shields.io/badge/Questions%3F-Ask%20Away-red?style=for-the-badge&labelColor=rgb(55,55,55)" alt="Questions? Ask Away!"></a> <a href="https://twitter.com/GetClipboard"><img src="https://img.shields.io/badge/FOLLOW-%40GETCLIPBOARD-blue?logo=twitter&style=for-the-badge&labelColor=rgb(55,55,55)" alt="Follow us on Twitter"></a> <br> <a href="https://discord.gg/J6asnc3pEG"><img src="documentation/readme-assets/join-our-discord.svg" alt="Discord Chat"></a> </p> <br> <br>

Thank You!

Say thank you to all our beautiful contributors who have helped make the Clipboard Project incredible. Want to join the club? We're always accepting new contributions too.

Special thanks to MacStadium for sponsoring the Clipboard Project by providing a Mac Mini for macOS development!

And if you're feeling generous, feel free to give us a :star:! We appreciate every single one - including yours.

<br> <p align="center"> <img src="documentation/readme-assets/ClipboardMakesYourLifeEasy.png" alt="CB makes your life easy." /> </p> <br> <p align="right"><sub><code>cb copy haters && cb > /dev/null</code></sub></p>