Thanks to visit codestin.com
Credit goes to github.com

Skip to content

kojitakakipathos/clipray

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

53 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Clipray πŸ“‹

Test codecov License: MIT

A lightweight, cross-platform clipboard manager built with Tauri and React. Clipray provides a seamless clipboard history experience similar to Windows' "Windows + V" functionality, but available on Windows, macOS, and Linux.

✨ Features

  • πŸ“‹ Clipboard History: Automatically saves text and image clipboard content
  • ⚑ Quick Access: Invoke with customizable global hotkeys (default: Ctrl+Shift+V)
  • πŸ” Smart Search: Filter clipboard history with real-time search
  • πŸ“Œ Pin Items: Mark important items as favorites to prevent auto-deletion
  • πŸ–ΌοΈ Image Support: Store and preview clipboard images
  • 🎨 Theme Support: Multiple built-in themes for personalization
  • βš™οΈ Configurable: Customize history limit, hotkeys, and appearance
  • πŸ”’ Privacy-First: All data stored locally, no external data transmission
  • 🌐 Cross-Platform: Native support for Windows, macOS, and Linux

πŸš€ Installation

Download Pre-built Binaries

Visit the Releases page to download the latest version for your platform:

  • Windows: clipray-setup.exe
  • macOS: clipray.dmg
  • Linux: clipray.AppImage or clipray.deb

Build from Source

Prerequisites

Steps

  1. Clone the repository:
git clone https://github.com/yourusername/clipray.git
cd clipray
  1. Install dependencies:
npm install
  1. Build the application:
npm run tauri --release

The built application will be available in src-tauri/target/release/bundle/.

πŸ“– Usage

Basic Usage

  1. Start Clipray: Launch the application (it will run in the background)
  2. Copy Content: Copy text or images as usual (Ctrl+C / Cmd+C)
  3. Access History: Press Ctrl+Shift+V (or your configured hotkey)
  4. Select Item: Use arrow keys or click to select from history
  5. Paste: Press Enter or click to paste the selected item

Keyboard Shortcuts

Shortcut Action
Ctrl+Shift+V Open clipboard history
↑/↓ Navigate through items
Enter Paste selected item
Delete Delete selected item
Ctrl+P Pin/unpin selected item
Escape Close window
Ctrl+I Open settings

Settings

Access settings by pressing Ctrl+S or clicking the gear icon:

  • History Limit: Set maximum number of items to store (default: 50)
  • Global Hotkey: Customize the activation shortcut
  • Theme: Choose from available themes
  • Auto-start: Enable/disable startup with system

πŸ› οΈ Development

Development Setup

  1. Clone and install dependencies:
git clone https://github.com/yourusername/clipray.git
cd clipray
npm install
  1. Start development server:
npm run tauri dev

Project Structure

clipray/
β”œβ”€β”€ src/                    # React frontend
β”‚   β”œβ”€β”€ components/         # UI components
β”‚   β”œβ”€β”€ hooks/             # Custom React hooks
β”‚   β”œβ”€β”€ types/             # TypeScript type definitions
β”‚   └── utils/             # Utility functions
β”œβ”€β”€ src-tauri/             # Rust backend
β”‚   β”œβ”€β”€ src/libs/          # Core functionality
β”‚   β”‚   β”œβ”€β”€ clipboard.rs   # Clipboard monitoring
β”‚   β”‚   β”œβ”€β”€ database.rs    # SQLite database
β”‚   β”‚   └── commands.rs    # Tauri commands
β”‚   └── tauri.conf.json    # Tauri configuration
└── package.json           # Node.js dependencies

Available Scripts

Development

  • npm run dev - Start Vite development server
  • npm run build - Build frontend for production
  • npm run tauri dev - Start Tauri development mode
  • npm run build:release - Build release version

Testing

  • npm run test - Run all tests

🀝 Contributing

We welcome contributions! Please follow these guidelines:

Getting Started

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Test thoroughly
  5. Commit with clear messages: git commit -m 'Add amazing feature'
  6. Push to your fork: git push origin feature/amazing-feature
  7. Open a Pull Request

Development Guidelines

  • Follow the existing code style
  • Write clear commit messages
  • Add tests for new features
  • Update documentation as needed
  • Ensure cross-platform compatibility

Bug Reports

When reporting bugs, please include:

  • Operating system and version
  • Clipray version
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)

Feature Requests

We love new ideas! Please:

  • Check existing issues first
  • Describe the feature clearly
  • Explain the use case
  • Consider implementation complexity

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

πŸ”— Links


Made with ❀️ by the Clipray team

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •