Package Exports
- promptboost
- promptboost/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (promptboost) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
AI-Powered Prompt Enhancement Tool - Intelligent and Extensible
A powerful command-line tool that enhances prompts using AI providers to optimize interactions with terminal agents like Claude Code, Gemini CLI, OpenAI Code, and more.
π Table of Contents
- Providers
- Why PromptBoost CLI?
- Features
- Examples
- Installation
- Quick Start
- Configuration
- Development
- Contributing
- License
π Providers
Supported AI Providers
| Name | Description | Models |
|---|---|---|
OpenAI |
GPT models including latest GPT-4 variants | gpt-4o, gpt-4o-mini, gpt-4-turbo, o1, o3-mini |
Anthropic |
Claude models with advanced reasoning | claude-3.5-sonnet, claude-3-haiku, claude-4-opus |
Google |
Gemini models with multimodal capabilities | gemini-1.5-pro, gemini-1.5-flash, gemini-2.0-flash |
xAI Grok |
Grok models with real-time information | grok-3, grok-beta, grok-vision-beta |
Provider Features
| Feature | OpenAI | Anthropic | xAI Grok | |
|---|---|---|---|---|
| Streaming | β | β | β | β |
| Model Validation | β | β | β | β |
| Error Recovery | β | β | β | β |
| Token Counting | β | β | β | β |
π€ Why PromptBoost CLI?
PromptBoost CLI provides intelligent prompt enhancement across multiple AI providers. Whether you're coding, analyzing data, or writing documentation, PromptBoost transforms your simple prompts into comprehensive, context-rich instructions that get better results.
Intelligent Prompt Enhancement

Smart Context Addition
PromptBoost doesn't just pass your prompts throughβit enhances them with:
- Context Awareness: Automatically adds relevant context based on your prompt type
- Best Practices: Incorporates proven prompt engineering techniques
- Template Integration: Uses specialized templates for coding, analysis, and general tasks
- Format Optimization: Structures prompts for maximum AI comprehension
Multi-Provider Intelligence
- Provider Switching: Seamlessly switch between OpenAI, Anthropic, Google, and xAI
- Model Validation: Automatic validation of model names and capabilities
- Streaming Support: Real-time response streaming with compatibility checking
- Fallback System: Robust error handling with provider fallbacks
Developer-Friendly Features

- File Integration: Read prompts from files, save enhanced results
- Template System: Built-in templates for common use cases
- Configuration Management: Secure API key storage and provider management
- Verbose Logging: Detailed logging for debugging and optimization
π¨ Features
- Model Validation: Comprehensive validation of AI models with streaming compatibility checking
- Smart Enhancement: Context-aware prompt improvement using proven techniques
- Multi-Provider Support: Seamless integration with OpenAI, Anthropic, Google, and xAI
- Streaming Responses: Real-time response streaming with progress indicators
- Template System: Built-in templates for coding, analysis, and general use cases
- File Operations: Read from files, save enhanced prompts, batch processing
- Configuration Management: Secure API key storage with environment variable support
- Error Recovery: Robust retry logic with exponential backoff
- Beautiful CLI: Colorized output with progress indicators and clear formatting
- Developer Tools: Verbose logging, testing utilities, and debugging features

πΎ Examples
Basic Enhancement
# Simple prompt enhancement
promptboost "Create a React component"
# Use specific provider
promptboost "Fix my code" --provider anthropicAdvanced Usage
# Streaming with verbose output
promptboost "Explain quantum computing" --stream --verbose
# File operations
promptboost --file prompt.txt --output enhanced.txt
# Configuration and testing
promptboost config set --provider openai --key sk-your-key
promptboost test --provider anthropicModel Validation
# Set valid model (auto-validated)
promptboost config set --provider openai --model gpt-4o-mini
β Configuration updated for provider: openai
# Try invalid model (caught by validation)
promptboost config set --provider openai --model invalid-model
β Invalid model configuration:
β’ Model 'invalid-model' is not valid for provider 'openai'
β’ Valid models for openai: gpt-4o, gpt-4o-mini, gpt-4-turbo...π¦ Installation
NPM (Recommended)
npm install -g promptboostFrom Source
# Clone the repository
git clone https://github.com/galfrevn/promptboost.git
cd promptboost
# Install dependencies
bun install
# Build and link
bun run build
npm linkPrerequisites
π Quick Start
1. Install PromptBoost
npm install -g promptboost2. Configure a Provider
# OpenAI (recommended for beginners)
promptboost config set --provider openai --key sk-your-openai-key
# Anthropic (great for coding)
promptboost config set --provider anthropic --key ant-your-anthropic-key
# Google (multimodal capabilities)
promptboost config set --provider google --key AIza-your-google-key
# xAI Grok (real-time information)
promptboost config set --provider grok --key xai-your-grok-key3. Enhance Your First Prompt
promptboost "Create a simple web scraper in Python"4. Explore Advanced Features
# Use streaming for real-time responses
promptboost "Explain machine learning" --stream
# Save results to file
promptboost "Write API documentation" --output docs.mdπ Configuration
Method 1: CLI Configuration (Recommended)
# Configure providers with automatic validation
promptboost config set --provider openai --key sk-your-openai-key
promptboost config set --provider anthropic --key ant-your-anthropic-key
promptboost config set --provider google --key AIza-your-google-key
promptboost config set --provider grok --key xai-your-grok-key
# Set specific models (with validation)
promptboost config set --provider openai --model gpt-4o-mini
promptboost config set --provider anthropic --model claude-3-5-sonnet-20241022
# Set default provider
promptboost config set --default openai
# View configuration
promptboost config showMethod 2: Environment Variables
export PROMPTBOOST_OPENAI_KEY="sk-your-openai-key"
export PROMPTBOOST_ANTHROPIC_KEY="ant-your-anthropic-key"
export PROMPTBOOST_GOOGLE_KEY="AIza-your-google-key"
export PROMPTBOOST_GROK_KEY="xai-your-grok-key"
export PROMPTBOOST_DEFAULT_PROVIDER="openai"Method 3: Configuration File
Configuration is stored in ~/.promptboost/config.json:
{
"version": "1.0.0",
"defaultProvider": "openai",
"providers": {
"openai": {
"name": "openai",
"apiKey": "sk-your-key-here",
"model": "gpt-4o-mini",
"baseUrl": "https://api.openai.com/v1",
"enabled": true
},
"anthropic": {
"name": "anthropic",
"apiKey": "ant-your-key-here",
"model": "claude-3-5-sonnet-20241022",
"baseUrl": "https://api.anthropic.com",
"enabled": true
}
}
}Model Validation
PromptBoost automatically validates model names and streaming compatibility:
# β
Valid model names are accepted
promptboost config set --provider openai --model gpt-4o-mini
β Configuration updated for provider: openai
# β Invalid models are rejected with helpful suggestions
promptboost config set --provider openai --model gpt-5
β Invalid model configuration:
β’ Model 'gpt-5' is not valid for provider 'openai'
β’ Valid models for openai: gpt-4o, gpt-4o-mini, gpt-4-turbo...
# β οΈ Special models show warnings
promptboost config set --provider openai --model o1-mini
β οΈ Note: o1-mini is a reasoning model with longer response times.
β Configuration updated for provider: openaiπ§ Development
Project Structure
promptboost/
βββ src/
β βββ commands/ # CLI command implementations
β β βββ enhance.ts # Main enhancement command
β β βββ config.ts # Configuration management
β β βββ test.ts # Provider testing
β βββ providers/ # AI provider implementations
β β βββ base.ts # Abstract base provider
β β βββ openai.ts # OpenAI integration
β β βββ anthropic.ts # Anthropic Claude integration
β β βββ grok.ts # xAI Grok integration
β β βββ google.ts # Google Gemini integration
β βββ utils/ # Utility modules
β β βββ config.ts # Configuration management
β β βββ logger.ts # Logging utility
β β βββ validation.ts # Input validation
β β βββ model-validation.ts # AI model validation
β βββ types/ # TypeScript type definitions
β β βββ index.ts # All interface definitions
β βββ index.ts # Main CLI entry point
βββ examples/ # Usage examples
βββ tests/ # Test filesSetup
Fork main branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check if there are any errors.
$ git clone https://github.com/{your-personal-repo}/promptboost.git
$ cd promptboost
$ bun install
$ bun run build
$ bun run testDevelopment Commands
# Start development mode
bun run dev
# Type checking
bun run typecheck
# Linting and formatting
bun run lint
# Build for production
bun run build
# Run tests
bun run testCode Style
This project uses Biome for linting and formatting:
- Indentation: 2 spaces
- Quotes: Single quotes for JavaScript, double for JSON
- Semicolons: Always required
- Line width: 100 characters
Adding New Providers
To add a new AI provider:
Create Provider Class:
// src/providers/newprovider.ts export class NewProvider extends BaseProvider { async enhance(request: EnhanceRequest): Promise<EnhanceResponse> { // Implementation } }
Update Provider Factory:
// src/providers/index.ts case 'newprovider': return new NewProvider(provider);
Add Model Validation:
// src/utils/model-validation.ts newprovider: { 'model-name': { streaming: true }, // ... other models }
Testing
# Test all providers
bun run test
# Test specific functionality
promptboost test --provider openai --verbose
# Manual testing workflow
promptboost config set --provider openai --key test-key
promptboost "test prompt" --verboseπ€ Contributing
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Make your changes
- Run tests:
bun run test - Run linting:
bun run lint - Commit changes:
git commit -m 'Add amazing feature' - Push to branch:
git push origin feature/amazing-feature - Open a Pull Request
π License
MIT License - see LICENSE file for details.
π Acknowledgments
- Bun - Fast JavaScript runtime
- Commander.js - CLI framework
- Biome - Linting and formatting
- Picocolors - Terminal colors
Built with β€οΈ using TypeScript and Bun