https://github.com/ricardoliveira5ro/clipvault
Clipboard manager for the terminal built with Node.js. Easily store, search, pin, remove, and interact with clipboard history
https://github.com/ricardoliveira5ro/clipvault
cli-tool coverage jest nodejs
Last synced: 10 months ago
JSON representation
Clipboard manager for the terminal built with Node.js. Easily store, search, pin, remove, and interact with clipboard history
- Host: GitHub
- URL: https://github.com/ricardoliveira5ro/clipvault
- Owner: ricardoliveira5ro
- Created: 2025-07-07T11:11:18.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-18T09:02:59.000Z (11 months ago)
- Last Synced: 2025-08-12T02:26:25.877Z (10 months ago)
- Topics: cli-tool, coverage, jest, nodejs
- Language: JavaScript
- Homepage:
- Size: 107 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ClipVault
A powerful and flexible clipboard manager for the terminal, built with Node.js.
Easily store, search, pin, remove, and interact with clipboard history — all from your command line.
### ⚡ Features
- 📥 Automatically watch and save clipboard contents
- 🔍 Multiple query search
- 📌 Pin and unpin entries
- 🧹 Clear old or unwanted clipboard entries
- 🧾 Easily copy previous entries back to clipboard
- 💾 Persistent history saved locally in JSON format
### 📦 Installation
```
git clone https://github.com/ricardoliveira5ro/ClipVault.git
cd clipvault
npm install
```
Globally CLI usage
```
npm link
```
### 🚀 Usage
##### 🟢 Start Watching Clipboard
```bash
clipvault watch
```
Continuously monitors clipboard changes and saves them
##### 📄 List All Entries
```bash
clipvault list
```
##### 🔍 Search Clipboard History
```bash
clipvault search --query "password"
clipvault search --date "2025-07-01"
clipvault search --pinned
clipvault search --min-size 10 --max-size 1000
```
##### 📌 Pin/Unpin an Entry
```bash
clipvault pin
clipvault unpin
```
##### ❌ Remove an Entry
```bash
clipvault remove
clipvault remove --force # Remove pinned
```
##### 🧹 Clear Entries
```bash
clipvault clear
clipvault clear --days 7 # Clears entries older than 7 days
clipvault clear --days 7 --force
```
##### 📋 Copy an Entry
```bash
clipvault copy
```
Copies the clipboard entry with given ID back into the system clipboard.
### 👨🏼💻 Developer Guide
🧪 Running Tests
```
npm run test
```
Mocks are created using `jest.unstable_mockModule` for ESM compatibility
✅ Coverage
```
npm run coverage
```
Current code coverage: 97.93%
### 📁 File Structure
```python
├── 📂 bin/
│ ├── 📄 index.js/ # CLI entry point
├── 📂 commands/ # CLI commands
├── 📂 lib/ # Shared utility modules
├── 📂 __tests__/ # Unit tests
├── 📄 jest.config.cjs
├── 📄 package.json
└── 📄 README.md
```