Setup Guide

Get Copybuffer up and running on your system in just a few steps.

Prerequisites

  • Node.js 18+ and npm
  • Ubuntu/Linux (for clipboard and hotkey support)
  • xclip (install with: sudo apt-get install xclip)

Installation

1

Clone the repository

git clone https://github.com/dev31sanghvi/Copybuffer.git
cd Copybuffer
2

Install dependencies

npm install
3

Build the project

npm run build
4

Install globally (Optional)

sudo npm link

This allows you to run copybuffer from anywhere.

5

Verify installation

copybuffer --help

Troubleshooting

Clipboard monitoring not working

Ensure xclip is installed:

sudo apt-get install xclip

Hotkeys not working

Hotkeys require an X11 display server (graphical environment). If running in headless mode, you can still use all CLI commands. For more help, check our FAQ page.