An open API service indexing awesome lists of open source software.

https://github.com/pprp/clipllm

Clipboard-Centric LLM conversation tools
https://github.com/pprp/clipllm

Last synced: 3 months ago
JSON representation

Clipboard-Centric LLM conversation tools

Awesome Lists containing this project

README

          

# ClipLLM

Clipboard as a Bridge to AI Communication

ClipLLM is a project that explores using the clipboard as an interface for AI communication.

## Features

- Read and write data to the clipboard
- Communicate with AI models using clipboard data
- Easy-to-use Python interface

## Installation

1. Clone the repository:

```bash
git clone https://github.com/pprp/ClipLLM.git
cd ClipLLM
```

2. Install dependencies:
```bash
pip install -r requirements.txt
```

## Usage

Run the main script:

```bash
python src/main.py
```

For detailed usage instructions, refer to the [documentation](docs/usage.md).

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.

## License

ClipLLM is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

For questions or feedback, please open an issue on GitHub.

hdiutil detach /Volumes/ClipLLM\ Installer
hdiutil convert ClipLLM.dmg -format UDRW -o ClipLLM_rw.dmg
hdiutil attach ClipLLM_rw.dmg
cp brain.iconset/icon_512x512.png /Volumes/ClipLLM\ Installer/.VolumeIcon.icns
SetFile -a C /Volumes/ClipLLM\ Installer
touch /Volumes/ClipLLM\ Installer

hdiutil detach /Volumes/ClipLLM\ Installer
hdiutil convert ClipLLM_rw.dmg -format UDZO -o ClipLLM_final.dmg
rm ClipLLM_rw.dmg -->

## How to get dmg file

To create a DMG file for ClipLLM, follow these steps:

1. Install required tools:

```bash
pip install pyinstaller py2app
```

2. Create a `setup.py` file in your project directory:

```python
from setuptools import setup

APP = ['interface.py']
DATA_FILES = []
OPTIONS = {
'argv_emulation': True,
'packages': ['PyQt5'],
'plist': {
'CFBundleName': 'ClipLLM',
'CFBundleDisplayName': 'ClipLLM',
'CFBundleGetInfoString': "Making ClipLLM",
'CFBundleIdentifier': "com.yourcompany.ClipLLM",
'CFBundleVersion': "0.1.0",
'CFBundleShortVersionString': "0.1.0",
'NSHumanReadableCopyright': u"Copyright © 2023, Your Company, All Rights Reserved"
}
}

setup(
app=APP,
data_files=DATA_FILES,
options={'py2app': OPTIONS},
setup_requires=['py2app'],
)
```

3. Build the application:

```bash
python setup.py py2app
```

4. Create a folder for the DMG contents:

```bash
mkdir ClipLLM-dmg
cp -R dist/ClipLLM.app ClipLLM-dmg/
ln -s /Applications ClipLLM-dmg/
```

5. Create the initial DMG:

```bash
hdiutil create -volname "ClipLLM Installer" -srcfolder ClipLLM-dmg -ov -format UDZO ClipLLM.dmg
```

6. To add a custom icon to the DMG:

```bash
# Convert icon to iconset if not already done
iconutil -c iconset brain.icns

# Convert DMG to read-write format
hdiutil convert ClipLLM.dmg -format UDRW -o ClipLLM_rw.dmg

# Mount the read-write DMG
hdiutil attach ClipLLM_rw.dmg

# Copy the icon and set attributes
cp brain.iconset/icon_512x512.png /Volumes/ClipLLM\ Installer/.VolumeIcon.icns
SetFile -a C /Volumes/ClipLLM\ Installer
touch /Volumes/ClipLLM\ Installer

# Unmount the DMG
hdiutil detach /Volumes/ClipLLM\ Installer

# Convert back to read-only format
hdiutil convert ClipLLM_rw.dmg -format UDZO -o ClipLLM_final.dmg

# Clean up
rm ClipLLM_rw.dmg
```

Your final DMG file will be `ClipLLM_final.dmg`.

Note: Ensure you have the necessary permissions and sufficient disk space for these operations. If you encounter any issues, you may need to use `sudo` for some commands, but be cautious when doing so.