megabuff 0.1.0

package/PUBLISHING.md

@@ -0,0 +1,165 @@
+# Publishing Checklist
+
+Quick reference for publishing MegaBuff CLI to npm.
+
+## Pre-publish Checklist
+
+- [ ] Update `package.json`:
+  - [ ] `author` field with your name/email
+  - [ ] `repository.url` with your GitHub URL
+  - [ ] `bugs.url` with your GitHub issues URL
+  - [ ] `homepage` with your GitHub README URL
+  - [ ] `version` is correct (use `npm version patch/minor/major`)
+
+- [ ] Update `README.md`:
+  - [ ] Replace placeholder URLs
+  - [ ] Add screenshots/GIFs if available
+  - [ ] Test all code examples
+
+- [ ] Code quality:
+  - [ ] Run `npm run build` successfully
+  - [ ] Test the CLI locally (`npm link`)
+  - [ ] All features working
+  - [ ] No TypeScript errors
+
+- [ ] Git:
+  - [ ] All changes committed
+  - [ ] Pushed to GitHub
+  - [ ] Tagged with version (auto-created by `npm version`)
+
+## Publishing Commands
+
+## Testing Before Publishing
+
+Always test the build before publishing to avoid publishing broken packages.
+
+### Quick Local Test
+
+```bash
+# 1. Clean build
+rm -rf dist/
+npm run build
+
+# 2. Link locally
+npm link
+
+# 3. Test commands
+megabuff --version
+megabuff config show
+megabuff optimize "test prompt"
+
+# 4. Clean up
+npm unlink -g megabuff
+```
+
+### Recommended: Test Package Tarball
+
+This simulates exactly what will be published:
+
+```bash
+# 1. Create package tarball
+npm pack
+
+# 2. Inspect contents (optional)
+tar -tzf megabuff-0.1.0.tgz
+
+# 3. Install from tarball
+npm install -g ./megabuff-0.1.0.tgz
+
+# 4. Test thoroughly
+megabuff --version
+megabuff optimize "Write a function to validate email"
+megabuff config set sk-test-key
+megabuff config show
+
+# 5. Clean up
+npm uninstall -g megabuff
+rm megabuff-0.1.0.tgz
+```
+
+### Dry Run (See What Would Be Published)
+
+```bash
+# See what files will be included WITHOUT publishing
+npm publish --dry-run
+
+# Check for:
+# ✅ dist/ folder included
+# ❌ src/ folder excluded
+# ❌ node_modules/ excluded
+# ✅ README.md included
+```
+
+### What to Verify
+
+- [ ] `dist/` folder exists with compiled JS
+- [ ] Shebang preserved in `dist/index.js` (`#!/usr/bin/env node`)
+- [ ] All commands work (`optimize`, `config`, etc.)
+- [ ] Clipboard auto-copy works
+- [ ] Config save/load works
+- [ ] No TypeScript errors during build
+- [ ] Package size is reasonable (check with `npm pack`)
+- [ ] Only necessary files included (check with `tar -tzf`)
+
+## Publishing Commands
+
+### First Time
+
+```bash
+# 1. Login to npm
+npm login
+
+# 2. Check if name is available
+npm search megabuff
+
+# 3. Test first (see above)
+npm pack
+npm install -g ./megabuff-0.1.0.tgz
+# ... test thoroughly ...
+
+# 4. Publish
+npm publish
+```
+
+### Updates
+
+```bash
+# 1. Update version (this also creates a git tag)
+npm version patch   # for bug fixes
+npm version minor   # for new features
+npm version major   # for breaking changes
+
+# 2. Publish
+npm publish
+
+# 3. Push to GitHub
+git push && git push --tags
+```
+
+## After Publishing
+
+- [ ] Verify package on npm: https://www.npmjs.com/package/megabuff
+- [ ] Test installation: `npm install -g megabuff`
+- [ ] Test the installed CLI: `megabuff --version`
+- [ ] Update GitHub release notes
+- [ ] Tweet/share the release (optional)
+
+## Troubleshooting
+
+**Error: Package name already exists**
+- Change the `name` field in package.json to something unique
+
+**Error: You must be logged in**
+- Run `npm login` and enter your credentials
+
+**Error: No permission to publish**
+- Make sure you're logged in with the correct account
+- If the package exists, you need to be a maintainer
+
+**Build fails**
+- Check TypeScript errors: `npm run build`
+- Verify all dependencies are installed: `npm install`
+
+**Package too large**
+- Check `.npmignore` is excluding unnecessary files
+- Run `npm pack` to see what's being included

package/README.md

@@ -0,0 +1,402 @@
+# MegaBuff
+
+AI prompt optimizer CLI - improve your prompts with multiple input/output options
+
+## Installation
+
+Install MegaBuff globally:
+
+```bash
+npm install -g megabuff
+```
+
+Or for development:
+
+```bash
+git clone https://github.com/thesupermegabuff/megabuff-cli.git
+cd megabuff-cli
+npm install
+
+# Originally used nvm use 22
+```
+
+## Setup
+
+### Getting Your OpenAI API Key (BYOK)
+
+MegaBuff uses a **BYOK (Bring Your Own Key)** model, meaning you use your own OpenAI API key. This gives you:
+- ✅ Direct control over your usage and costs
+- ✅ Pay-per-use pricing (typically pennies per optimization)
+- ✅ Full privacy - your prompts go directly to OpenAI
+- ✅ Ability to set your own usage limits
+
+**Steps to get your OpenAI API Key:**
+
+1. **Create an OpenAI Account**
+   - Sign up or log in at [platform.openai.com](https://platform.openai.com/)
+   - Note: This is separate from the standard ChatGPT consumer site
+
+2. **Set up Billing**
+   - The API runs on a pay-per-use model
+   - Add a payment method in the [Billing](https://platform.openai.com/settings/organization/billing/overview) section
+   - You can set usage limits to manage costs
+   - Typical cost: ~$0.001-0.01 per prompt optimization (using gpt-4o-mini)
+
+3. **Generate Your API Key**
+   - Navigate to [API Keys](https://platform.openai.com/api-keys) in the sidebar
+   - Click **"+ Create new secret key"**
+   - Give your key a descriptive name (e.g., "MegaBuff CLI")
+   - Click **"Create secret key"**
+
+4. **Save Your Key Immediately**
+   - **Important**: Copy the key right away - OpenAI only shows it once!
+   - Store it securely - you'll need to generate a new one if you lose it
+   - The key starts with `sk-`
+
+### Configuring Your API Key
+
+Once you have your OpenAI API key, configure it using one of these methods:
+
+#### Option 1: Save to Config (Recommended)
+
+The easiest way to get started:
+
+```bash
+# Save to config file
+megabuff config set sk-your-api-key-here
+
+# Or save to system keychain (more secure)
+megabuff config set sk-your-api-key-here --keychain
+```
+
+This saves your key for future use. You only need to do this once!
+
+#### Option 2: Environment Variable
+
+```bash
+export OPENAI_API_KEY="sk-your-api-key-here"
+```
+
+Add to your shell profile (`.bashrc`, `.zshrc`, etc.) to persist across sessions.
+
+#### Option 3: Pass as Flag
+
+```bash
+megabuff optimize "your prompt" --api-key sk-your-key-here
+```
+
+### API Key Priority
+
+The CLI checks for your API key in this order:
+1. `--api-key` flag (highest priority)
+2. `OPENAI_API_KEY` environment variable
+3. System keychain (if configured)
+4. Config file at `~/.megabuff/config.json`
+
+## Configuration Commands
+
+```bash
+# Save your API key
+megabuff config set sk-your-api-key-here
+
+# Save to keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service)
+megabuff config set sk-your-api-key-here --keychain
+
+# Show current configuration
+megabuff config show
+
+# Remove saved API key
+megabuff config remove
+```
+
+## Development
+
+Test your CLI during development:
+
+```bash
+# Using the dev script (recommended)
+npm run dev optimize "Write a function to sort arrays"
+
+# Or using npx tsx directly
+npx tsx src/index.ts optimize "Your prompt here"
+
+# Or install locally as a global command
+npm link
+megabuff optimize "Your prompt here"
+```
+
+## Build
+
+Compile TypeScript to JavaScript:
+
+```bash
+npm run build
+```
+
+This will create compiled files in the `dist/` folder.
+
+## Install Globally
+
+Install the CLI globally on your machine for testing:
+
+```bash
+npm link
+```
+
+## Usage
+
+The CLI supports multiple input methods:
+
+### 1. Inline Argument (Quick & Simple)
+
+```bash
+megabuff optimize "Write a function that validates email addresses"
+```
+
+### 2. File Input
+
+```bash
+megabuff optimize --file prompt.txt
+```
+
+### 3. Stdin Pipe
+
+```bash
+echo "Explain quantum computing" | megabuff optimize
+cat prompt.txt | megabuff optimize
+```
+
+### 4. Interactive Mode
+
+```bash
+megabuff optimize
+# Then paste/type your prompt and press Ctrl+D when done
+```
+
+## Output Options
+
+### Default: Print to stdout AND copy to clipboard
+
+By default, the optimized prompt is:
+1. Printed to stdout (so you can pipe it)
+2. Automatically copied to your clipboard (works on macOS, Windows, and Linux)
+
+```bash
+megabuff optimize "your prompt"
+# Result is both printed AND copied to clipboard
+```
+
+### Disable clipboard copy
+
+If you don't want automatic clipboard copy:
+
+```bash
+megabuff optimize "your prompt" --no-copy
+```
+
+### Save to file
+
+```bash
+megabuff optimize "your prompt" --output result.txt
+# Still copies to clipboard by default
+```
+
+### Interactive comparison view
+
+```bash
+megabuff optimize "your prompt" --interactive
+# Shows before/after comparison AND copies to clipboard
+```
+
+### Combine options
+
+```bash
+# Save to file without clipboard
+megabuff optimize "your prompt" --output result.txt --no-copy
+
+# Interactive view without clipboard
+megabuff optimize "your prompt" --interactive --no-copy
+
+# Pipe to another command (clipboard still works)
+megabuff optimize "your prompt" | grep "specific"
+```
+
+## Examples
+
+```bash
+# Quick inline optimization (auto-copies to clipboard)
+megabuff optimize "Write code for user auth"
+
+# From file with interactive view (auto-copies)
+megabuff optimize --file my-prompt.txt --interactive
+
+# Pipe and save (auto-copies)
+cat input.txt | megabuff optimize --output optimized.txt
+
+# Disable clipboard copy
+megabuff optimize "Your prompt" --no-copy
+
+# Save to file without clipboard
+megabuff optimize --file prompt.txt --output result.txt --no-copy
+
+# Use specific API key
+megabuff optimize "Your prompt" --api-key sk-your-key-here
+```
+
+## How It Works
+
+The CLI uses OpenAI's GPT-4o-mini model to analyze and optimize your prompts. It:
+
+1. Identifies ambiguities or unclear instructions
+2. Adds relevant context that would improve results
+3. Structures the prompt for clarity
+4. Specifies expected output format if not present
+5. Makes the prompt more specific and actionable
+
+## VS Code Integration
+
+MegaBuff integrates seamlessly with VS Code in multiple ways:
+
+### Option 1: VS Code Extension (Full Experience)
+
+Install and develop the MegaBuff VS Code extension:
+
+```bash
+cd ../megabuff-vscode
+npm install
+npm run compile
+```
+
+Then press `F5` to launch the extension in debug mode.
+
+**Features:**
+- Right-click context menu for selected text
+- Command palette integration
+- Keyboard shortcuts (`Ctrl+Shift+Alt+O`)
+- Diff view for before/after comparison
+- API key management UI
+- Status bar integration
+
+See [megabuff-vscode/README.md](../megabuff-vscode/README.md) for more details.
+
+### Option 2: VS Code Tasks (Quick Setup)
+
+Use the pre-configured tasks in `.vscode/tasks.json`:
+
+1. Select text in VS Code
+2. Press `Ctrl+Shift+P` → "Tasks: Run Task"
+3. Choose "MegaBuff: Optimize Selected Text"
+
+Available tasks:
+- `MegaBuff: Optimize Selected Text`
+- `MegaBuff: Optimize Current File`
+- `MegaBuff: Optimize Selected (Interactive)`
+- `MegaBuff: Configure API Key`
+
+### Option 3: Terminal Integration
+
+Simply use the CLI in VS Code's integrated terminal:
+
+```bash
+# Select text, then in terminal:
+pbpaste | megabuff optimize  # macOS
+xclip -o | megabuff optimize  # Linux
+```
+
+## Publishing to npm
+
+### First-time Setup
+
+1. **Create an npm account** at [npmjs.com/signup](https://www.npmjs.com/signup) if you don't have one
+
+2. **Login to npm** from your terminal:
+   ```bash
+   npm login
+   ```
+
+3. **Update package.json** with your information:
+   - Change `author` to your name and email
+   - Update `repository` URL with your GitHub username
+   - Update `bugs` and `homepage` URLs
+
+4. **Check if the package name is available**:
+   ```bash
+   npm search megabuff
+   ```
+   The name `megabuff` should be available (or use an alternative if taken)
+
+### Publishing Steps
+
+1. **Make sure everything is committed**:
+   ```bash
+   git status
+   git add .
+   git commit -m "Prepare for publish"
+   ```
+
+2. **Build the project**:
+   ```bash
+   npm run build
+   ```
+   This compiles TypeScript to JavaScript in the `dist/` folder
+
+3. **Test the package locally** (optional but recommended):
+   ```bash
+   npm pack
+   # This creates a .tgz file you can inspect
+   ```
+
+4. **Publish to npm**:
+   ```bash
+   npm publish
+   ```
+
+   The `prepublishOnly` script will automatically run `npm run build` before publishing.
+
+### Publishing Updates
+
+When you make changes and want to publish a new version:
+
+1. **Update the version** using semantic versioning:
+   ```bash
+   # For bug fixes (0.1.0 -> 0.1.1)
+   npm version patch
+
+   # For new features (0.1.0 -> 0.2.0)
+   npm version minor
+
+   # For breaking changes (0.1.0 -> 1.0.0)
+   npm version major
+   ```
+
+2. **Publish the update**:
+   ```bash
+   npm publish
+   ```
+
+3. **Push the version tag to GitHub**:
+   ```bash
+   git push && git push --tags
+   ```
+
+### What Gets Published
+
+The npm package includes:
+- ✅ `dist/` - Compiled JavaScript
+- ✅ `README.md` - Documentation
+- ✅ `package.json` - Package metadata
+- ✅ `LICENSE` - License file
+- ❌ `src/` - TypeScript source (excluded)
+- ❌ `node_modules/` - Dependencies (excluded)
+- ❌ Development files (excluded via .npmignore)
+
+### After Publishing
+
+Users can install your CLI globally with:
+```bash
+npm install -g megabuff
+```
+
+Your package will be available at:
+- npm: `https://www.npmjs.com/package/megabuff`
+- Docs: `https://github.com/thesupermegabuff/megabuff-cli`

package/dist/config.d.ts

@@ -0,0 +1,35 @@
+interface Config {
+    apiKey?: string;
+    useKeychain?: boolean;
+    model?: string;
+}
+/**
+ * Get API key with priority:
+ * 1. Command line flag
+ * 2. Environment variable
+ * 3. Keychain (if configured)
+ * 4. Config file
+ */
+export declare function getApiKey(cliKey?: string): Promise<string | undefined>;
+/**
+ * Set API key in config or keychain
+ */
+export declare function setApiKey(apiKey: string, useKeychain?: boolean): Promise<void>;
+/**
+ * Get current configuration
+ */
+export declare function getConfig(): Promise<Config>;
+/**
+ * Update configuration
+ */
+export declare function updateConfig(updates: Partial<Config>): Promise<void>;
+/**
+ * Remove API key from config and keychain
+ */
+export declare function removeApiKey(): Promise<void>;
+/**
+ * Check if API key is configured
+ */
+export declare function hasApiKey(): Promise<boolean>;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AASA,UAAU,MAAM;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAkED;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAuB5E;AAED;;GAEG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAkB3F;AAED;;GAEG;AACH,wBAAsB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAEjD;AAED;;GAEG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAI1E;AAED;;GAEG;AACH,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAMlD;AAED;;GAEG;AACH,wBAAsB,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CASlD"}