https://github.com/fernvenue/ai-clipboard

Make your clipboard work with AI.
https://github.com/fernvenue/ai-clipboard

Last synced: 19 days ago
JSON representation

Make your clipboard work with AI.

• Host: GitHub
• URL: https://github.com/fernvenue/ai-clipboard
• Owner: fernvenue
• License: agpl-3.0
• Created: 2024-12-13T09:21:14.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-12-13T09:27:05.000Z (about 1 month ago)
• Last Synced: 2024-12-13T09:27:39.273Z (about 1 month ago)
• Language: Go
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AI Clipboard

[![ai-clipboard](https://img.shields.io/badge/LICENSE-AGPL3%20Liscense-blue?style=flat-square)](./LICENSE)

[![ai-clipboard](https://img.shields.io/badge/GitHub-AI%20Clipboard-blueviolet?style=flat-square&logo=github)](https://github.com/fernvenue/ai-clipboard)

[![ai-clipboard](https://img.shields.io/badge/GitLab-AI%20Clipboard-orange?style=flat-square&logo=gitlab)](https://gitlab.com/fernvenue/ai-clipboard)

Make your clipboard work with AI.

## Features

This tool is used to obtain clipboard content, process it with AI, and return it.

- Privacy and Secure: This tool does **NOT** listen to the clipboard in the background and only retrieves the first entry from the clipboard when called;

- Custom Model: Supports specifying the model using `--ai-model`;

- Custom Prompts: Supports specifying the prompt with `--system-prompt` and `--user-prompt`;

Welcome to PR your useful prompts :)

## Usage

Here, using GNOME as an example, first download the tool or compile it yourself and place it in the executable directory, which is recommended to be under `/usr/local/bin`. Then create a prompt directory:

```

mkdir ~/.config/aiClipboard

```

You can also use other directories, and now test if it works:

```

aiClipboard --api-key "******" --system-prompt "/path/to/system/prompt" --user-prompt "/path/to/user/prompt"

```

Here I use Multilingual Translator as a test:

```

aiClipboard --api-key "******" --ai-model "gpt-4o" --system-prompt "/home/******/.config/aiClipboard/multilingual-translator/system.md" --user-prompt "/home/******/.config/aiClipboard/multilingual-translator/user.md"

2024/12/13 14:53:38 [2024-12-13 14:53:38] Detected clipboard text: 你好, 世界.

2024/12/13 14:53:40 [2024-12-13 14:53:40] AI response text: Hello, World.

```

After the test, go to *Settings* - *Keyboard* - *Keyboard Shortcuts* - *View and Customize Shortcuts* - *Custom Shortcuts* to set up shortcut keys to invoke the tools:

![Custom Shortcuts](images/8A9340D4C35570DD.webp)

The command here is exactly the same as during testing, then set the name and shortcut:

![Set Custom Shortcut](images/31B6F4790ACB8052.webp)

Now, you can use the shortcut key you just configured to call the tool.

You can also add more prompts to the prompt directory and configure different shortcut keys for different functions! Let your imagination run wild :)