plock

Introduction to the Plock Project

Plock is an innovative tool designed to make utilizing Large Language Models (LLMs) or other command-line outputs directly from anywhere you can type. It's designed to provide real-time streaming of results, enabling users to seamlessly replace their input prompts with dynamic output from models like GPT-3.5 or GPT-4.

How Plock Works

Plock is intuitive and user-friendly. To begin, you can write a prompt and select it. By default, hitting Cmd+Shift+. will transform your prompt into the live streaming output of the chosen model. For users preferring context-based queries, Plock allows you to use clipboard data (text you copy before writing your prompt). In this setup, pressing Cmd+Shift+/ will let the model use this clipboard data as context for responding to your prompt.

Linux users can operate Plock using Ctrl instead of Cmd.

An appealing aspect of Plock is its default local operation, meaning it can function fully offline without needing external APIs. However, if you choose to integrate online resources, you can do so through shell scripts as outlined in the configurable settings.json file.

Demonstrations and Capabilities

Plock showcases its flexibility and capabilities through several demonstrations:

• Concept of Triggers: A demo illustrating the newly implemented trigger system that enhances how processes and outputs are managed.
• Integration with GPT Models: Videos demonstrate Plock's dynamic interactions when used with cutting-edge models like GPT-3.5 and GPT-4.
• Original Demo using Ollama: Exhibits how Plock interfaces with the Ollama tool, showing real-world applications and usage scenarios.

Getting Started with Plock

To begin using Plock:

1. Install Prerequisites: Ensure you have the necessary tools like Node.js and Rust installed on your machine.
2. Setup: Install the required scripts like ollama, or update your setup with personal preferences or alternate scripts via settings.json.
3. Launch Plock: Use the shortcut keys to interact with the models.

Default shortcuts include:

• Ctrl / Cmd + Shift + .: Replaces selected text with model output.
• Ctrl / Cmd + Shift + /: Uses clipboard content as context before replacing the selected text with output.

Customizing Your Experience

Plock offers robust customization, allowing users to modify settings related to shortcuts, models, and prompts. You can use JSON configuration to fine-tune these aspects to better fit your workflow.

To modify settings, simply open your settings.json file. Plock's system tray icon provides easy access to this file's location, making updates straightforward.

Contributing to Plock

Plock is open-source, and contributions are highly encouraged. Whether you have feature ideas, encounter issues, or wish to help improve the project, your participation is valued. Plock's flexibility and community-driven design make it a continuously evolving tool, inviting enthusiasts and developers to contribute their expertise.

Building Plock from Source

For those who prefer to build Plock themselves:

• Prerequisites: Install Node.js, Rust, and NPM.
• Project Setup: Clone the repository, navigate to the project directory, and run installation commands to set up the development environment.
• Build Command: Execute the build process using provided scripts to create an executable version of Plock.

Closing Thoughts

Plock extends a user-friendly gateway to seamless integration with LLMs. Its design philosophy emphasizes local operation, modular customization, and open-source development. Plock not only simplifies complex interactions with language models but also opens up avenues for further innovation through its flexible, community-oriented approach.