No Description

Dávid Geréb 490398814d update brew installation 2 days ago
.github bccdf63258 Update clean-up.yml 5 days ago
CutBox 67d9f97a25 CutBox Release: 1.5.3 6 days ago
bin 822838557c [release notes] 1 week ago
cutbox.github.io @ 376b9ce6a9 35098a7485 Update web 1 week ago
cutbox.wiki @ c7223597c7 99cc6d8207 1.4.21 4 months ago
.codeclimate.yml 7adbdc5701 Specs excluded from codeclimate 1 year ago
.gitignore 6bb2a6e371 Ignore tmp folder 1 week ago
.gitmodules 9f0c5c80ab unlink cutbox homebrew 1 week ago
.swiftlint.yml 6e50cbfe87 Fix linting to ignore pods 4 months ago
Brewfile c34cea00cf Add ripgrep 1 week ago
LICENSE be22e9a32f License under GNU GPL3 4 years ago
README.md 490398814d update brew installation 1 day ago
package-lock.json 9b84725399 Fix npm dev dependencies 2 weeks ago
package.json 9b84725399 Fix npm dev dependencies 2 weeks ago
release-notes.md 8991da1427 Update release notes 4 years ago

README.md

  

CutBox

Text Clipboard Manager for MacOS

GitHub release (latest SemVer)

CutBox is a Macos developer focused clipboard history manager. It works only with text (no images, audio, video, blobs) but doesn't interfere with the system clipboard, or other clipboard managers, if you need copy/pasteboard history for things like that. It's main features are: Fuzzy matching, regexp search, favorites and the ability to transform text by pasting multiple clipboard entries at once, and/or using JavaScript to process text, before you paste it.

Inspired by JumpCut & Flycut

Using CutBox

Any text you copy on MacOS is saved to CutBox's history.

CutBox Search is activated using a global hotkey:

Cmd + Shift + V

(This can be customized in preferences.)

Searching and pasting

With the CutBox window open, search for anything you copied.

Press Enter and the selected item will paste into your current app.

To exit press Esc.

Shortcuts / Key commands:

Shortcut Keys Action
Esc exit search
Ctrlg exit search
Enter Paste selected
CmdEnter Paste through JavaScript Functions selected (you'll need ~/.cutbox.js set up)
CmdComma open preferences
CmdDelete Delete selected item(s)
CmdComma open preferences
Cmdt toggle color themes
Cmdp toggle preview
CmdShift= zoom/scale up text
CmdShift- zoom/scale down text
CmdShift0 reset text scale/zoom
Cmds toggle search modes, fuzzy match, regexp/i or regexp
Cmdf toggle search favorites / everything (use the right click menu, to favorite)

Status bar menu

Install via Homebrew Cask

Install the compiled package.

brew tap cutbox/cutbox
brew install --cask cutbox

Install via Homebrew

For advanced users. Builds the package from source, full Xcode installation needed.

brew tap cutbox/cutbox
brew install cutbox

First run

When you first run CutBox Macos will prompt you that the developer cannot be identified.

Please read this post from Apple.

If you prefer to install open source software that isn't notarized (such as CutBox, or Chromium) on your Mac, you can do this in the terminal.

sudo spctl --master-disable

I only recommend this if you feel comfortable using free software that you can code audit. CutBox is code audited by Codacy. However it doesn't participate in Apple's anti opensource gatekeeper / notarisation system or any other parts of Apple's Walled Garden.

CutBox will be free and open forever, and is licensed under GNU/GPL3, so the source is always available.

Dmg/.app builds are produced by Github Workflow actions, so you can also inspect the entire test/deploy/delivery chain. (as of Sept 2022)

Enable automatic paste.

Before CutBox can paste for you (when you select something and hit enter that is.) You have to enable it to control the keyboard.

Go to System Preferences -> Security & Privacy -> Privacy -> Accessibility

Unlock and add CutBox to the list of apps (also switch on the check box next to its icon).

Do the same for input monitoring...:

Go to System Preferences -> Security & Privacy -> Privacy -> Input Monitoring

Make sure CutBox is in the list and its checkbox is on.

These work best before CutBox is run. (Macos will suggest restarting CutBox anyway, wait for the CutBox icon to appear before changing a checkbox in security preferences.)

FYI If you're upgrading, you'll need to remove and re-add the new CutBox.app.

Would you like to know more?

More information is in the wiki

Found something wrong?

If you find a bug, click here to tell me what happened.

Contributing

  • Pull requests must have test cover, existing tests should not break.
  • Open an issue if tests are already failing, so I know I need to fix them.
  • Code must pass the quality checks as used by Codacy.

Clone and setup dependencies

git clone git@github.com:CutBox/CutBox

Compilation setup / tooling

gem install cocoapods
cd CutBox
pod install
cd ..

To build CutBox.app:

bin/build
open CutBox/build/

Run the local CutBox.app with terminal logging...

CutBox/build/CutBox.app/Contents/MacOS/CutBox

Troubleshooting

There's a Gitter channel if you have problems getting up and running (https://gitter.im/CutBox)

Licence

CutBox is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

CutBox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.