Skip to content

radres/clipboardgpt-electron

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ClipboardGPT

An AI-powered clipboard assistant that provides contextual responses to your selected text. Simply copy text to your clipboard and ask questions about it using global shortcuts.

Features

  • 🚀 Global Shortcuts: Access AI assistance from anywhere with customizable keyboard shortcuts
  • 🎯 Context-Aware: Analyzes your clipboard content and provides relevant answers
  • 💬 Floating Bubble UI: Non-intrusive chat interface that appears when needed
  • Custom Prompts: Create and save custom AI prompts for repeated tasks
  • 🔐 Secure Authentication: Login system to protect your API usage
  • 🖥️ Cross-Platform: Works on Windows, macOS, and Linux

Installation

From Release (Recommended)

  1. Download the latest release for your platform from the Releases page
  2. Install the application:
    • macOS: Open the .dmg file and drag ClipboardGPT to Applications
    • Windows: Run the .exe installer
    • Linux: Use the .AppImage or .deb package

From Source

# Clone the repository
git clone https://github.com/clipboardgpt/clipboardgpt-electron.git
cd clipboardgpt-electron

# Install dependencies
npm install

# Run in development mode
npm start

# Build for your platform
npm run build:mac     # macOS
npm run build:win     # Windows
npm run build:linux   # Linux

Usage

Default Keyboard Shortcuts

  • Alt+C - Open AI bubble to ask about clipboard content
  • Alt+Space - Open dashboard
  • Alt+L - Open login window
  • Alt+[custom key] - Use custom prompts

Getting Started

  1. Login: Press Alt+L to open the login window and authenticate
  2. Copy Text: Select and copy any text to your clipboard
  3. Ask AI: Press Alt+C to open the bubble and type your question
  4. Get Answer: The AI will analyze your clipboard content and provide a response

Custom Prompts

Create custom prompts for repetitive tasks:

  1. Open the dashboard with Alt+Space
  2. Navigate to "Custom Prompts"
  3. Add a new prompt with a name, shortcut key, and prompt text
  4. Use Alt+[your key] to instantly apply that prompt to clipboard content

Configuration

Server URL

By default, the app connects to https://clipboardgpt.com. To use a different server:

  1. Set the CLIPBOARDGPT_SERVER_URL environment variable
  2. Or modify server-client.js before building

Auto-Paste (macOS only)

The app can automatically paste AI responses. This feature requires accessibility permissions on macOS.

Development

Project Structure

clipboardgpt-electron/
├── main.js              # Main Electron process
├── server-client.js     # API client for backend communication
├── prompt-store.js      # Custom prompts storage
├── login.html          # Login window UI
├── dashboard.html      # Dashboard UI
├── bubble.html         # Floating bubble UI
└── package.json        # Project configuration

Building

# All platforms
npm run build:all

# Platform-specific
npm run build:mac
npm run build:win
npm run build:linux

# Create distribution packages
node create-distribution.js

Troubleshooting

macOS Security Warning

If you see "ClipboardGPT can't be opened because it is from an unidentified developer":

  1. Right-click the app and select "Open"
  2. Click "Open" in the dialog
  3. Or go to System Preferences > Security & Privacy and click "Open Anyway"

Shortcuts Not Working

  • Windows/Linux: Make sure no other application is using the same shortcuts
  • macOS: Grant accessibility permissions in System Preferences > Security & Privacy > Privacy > Accessibility

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Support

About

ClipboardGPT Electron application - AI-powered clipboard management tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published