README.md

PromptLab

A powerful desktop laboratory for crafting code-based prompts for LLMs.
Allows users to quickly inject their code and craft a prompt with parseable xml format response.
Works best with reasoning models.

⚠️ Note: This is an experimental project and may have compatibility issues on some operating systems. Provided "as is" without any warranties.

Features

• 🧪 Transform your code into perfect LLM prompts
• 📁 Open and analyze any code repository
• 🔍 Select specific files or entire directories
• 🚫 Customizable ignore patterns with regex support
• 📝 Add custom instructions and save templates
• 🌳 Generate textual file tree visualization
• 📋 Copy formatted output to clipboard
• 🔢 Automatic token counting for LLM context limits

Installation

Linux

Download the latest .AppImage or .deb file from the releases page.

AppImage

chmod +x PromptLab-*.AppImage
./PromptLab-*.AppImage

Debian/Ubuntu

sudo dpkg -i promptlab_*.deb

Windows

Download and run the latest .exe installer from the releases page.

macOS

Download and install the latest .dmg file from the releases page.

Development

Prerequisites

• Node.js 16+
• npm or yarn

Setup

1. Clone the repository

git clone https://github.com/0xIbra/promptlab.git
cd promptlab

2. Install dependencies

npm install

3. Start development server

npm run dev

Building

# Build for production
npm run build

# Create distributable
npm run dist

Creating Releases

1. Update version in package.json
2. Create and push a new tag:

git tag v0.1.1
git push origin v0.1.1

This will trigger the GitHub Actions workflow that:

• Builds the app for Linux, Windows, and macOS
• Creates a new GitHub release
• Uploads all build artifacts to the release

License

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

Acknowledgments

• Built with Electron
• UI powered by React and Tailwind CSS
• Token counting by gpt-tokenizer