pplx-zero 1.1.3 → 1.1.5

package/README.md

@@ -22,6 +22,7 @@ A fast TypeScript CLI for Perplexity AI search with multimodal support. Built wi
 - **🤖 AI Models** - Sonar, Sonar Pro, Sonar Deep Research, Sonar Reasoning
 - **🛡️ Type Safe** - Full Zod validation and TypeScript support
 - **🌍 Cross-Platform** - Native Bun runtime support
+- **🔄 Auto-Update** - Background update checking to stay current
 
 ## Quick Start
 
@@ -79,7 +80,7 @@ setx PERPLEXITY_API_KEY "your-api-key"
 
 **Get your API key:** https://www.perplexity.ai/account/api/keys
 
-### 3️⃣ Start Searching (Simplified Interface)
+### 3️⃣ Start Searching
 
 ```bash
 # Simple search
@@ -88,10 +89,10 @@ pplx "latest AI developments"
 # Choose model for detailed analysis
 pplx --model sonar-pro "Explain quantum computing"
 
-# Analyze document (simplified syntax)
+# Analyze document
 pplx --file report.pdf "Summarize this document"
 
-# Analyze image (simplified syntax)
+# Analyze image
 pplx --image screenshot.png "What does this interface do?"
 
 # Document + image analysis
@@ -103,66 +104,93 @@ pplx --model sonar-deep-research "History of artificial intelligence"
 
 # See basic help
 pplx --help
-
-# See advanced options
-pplx --help-advanced
 ```
 
-**🔄 Migration from v1.0.x:**
+## Auto-Update
+
+PPLX-Zero includes intelligent auto-update functionality that runs in the background to keep your CLI current.
+
+### How It Works
+
+- **Background Checking**: Automatically checks for updates every 24 hours when you run searches
+- **Non-Blocking**: Never slows down your search queries - updates happen in the background
+- **Smart Caching**: Uses intelligent caching to avoid unnecessary network requests
+- **Silent by Default**: Runs quietly without interrupting your workflow
+
+### Update Commands
+
 ```bash
-# OLD: pplx --format jsonl --input queries.json "search"
-# NEW: pplx --format jsonl --input queries.json "search"  # format flag unchanged
+# Check for updates manually
+pplx update --check
+
+# Install available updates automatically
+pplx update --auto
+
+# Show version information
+pplx version
 
-# OLD: pplx --attach document.pdf "analyze"
-# NEW: pplx --file document.pdf "analyze"              # simplified syntax
+# Check updates with version command
+pplx version --check-updates
 ```
 
-## Usage Guide
+### Update Methods
 
-### Command Line Options
+The auto-update system tries multiple package managers in order of preference:
 
-**Simplified Interface (Everyday Usage):**
-```bash
-# Basic search with model selection
-pplx --model sonar-pro "Detailed analysis"
+1. **npm global** (`npm update -g pplx-zero`)
+2. **bun global** (`bun update -g pplx-zero`)
+3. **yarn global** (`yarn global upgrade pplx-zero`)
+4. **pnpm global** (`pnpm update -g pplx-zero`)
 
-# File attachments (simplified syntax)
-pplx --file document.pdf "Summarize this report"
-pplx --image chart.png "Analyze this chart"
+If automatic updates fail, you'll get helpful instructions to update manually.
 
-# Multiple attachments
-pplx --file doc1.pdf --image img1.png "Analyze these files"
+### Configuration
 
-# Output format selection
-pplx --format jsonl "Machine learning trends"
+Auto-update settings are stored in `~/.pplx-zero/update-cache.json`:
 
-# Choose AI models
-pplx --model sonar-pro "Detailed analysis"
-pplx --model sonar-reasoning "Complex problem solving"
-```
+- **Check Interval**: 24 hours by default
+- **Quiet Mode**: Silent operation to not interrupt workflow
+- **Auto Install**: Disabled by default for safety
+
+### Privacy & Performance
+
+- **Minimal Network**: Only checks npm registry for version information
+- **No Data Collection**: Never sends search queries or personal data
+- **Fast Performance**: Cached results prevent repeated network requests
+- **Local Only**: All update logic runs locally on your machine
+
+## Usage Guide
 
-**Advanced Interface (Power Users):**
+### Command Line Options
+
+**Quick Reference:**
 ```bash
-# Custom concurrency and timeout
-pplx --concurrency 10 --timeout 60000 --format jsonl "machine learning trends"
+# Basic search
+pplx "latest AI developments"
+
+# File analysis (simplified)
+pplx -f document.pdf "Summarize this"
 
-# Batch processing
-pplx --input queries.json --concurrency 5
+# Advanced batch processing
+pplx --input queries.json -c 10 -t 60000
 
-# Stream processing
-cat queries.jsonl | pplx --stdin
+# See all options
+pplx --help
+```
 
-# Advanced attachments (multiple files)
-pplx --attach doc1.pdf --attach doc2.txt --attach-image img1.png "Analyze all files"
+**Essential Commands:**
+```bash
+# Model selection
+pplx -m sonar-pro "Detailed analysis"
 
-# Async processing with webhook
-pplx --async --webhook https://api.example.com/callback "Research task"
+# File + image
+pplx -f doc.md -i chart.png "Analyze both"
 
-# Custom workspace
-pplx --workspace /tmp/research "Custom workspace search"
+# Output format
+pplx -o jsonl "Get streaming output"
 
-# See all advanced options
-pplx --help-advanced
+# Async with webhook
+pplx --async --webhook https://api.example.com "Long task"
 ```
 
 ### Batch Processing
@@ -243,6 +271,15 @@ console.log(result);
 | `--version` | `-v` | boolean | - | Show version |
 | `--help` | `-h` | boolean | - | Show basic help |
 
+### Update Commands
+
+| Command | Options | Description |
+|---------|---------|-------------|
+| `pplx update` | `--check` | Check for available updates |
+| `pplx update` | `--auto` | Install available updates automatically |
+| `pplx version` | `--check-updates` | Show version and check for updates |
+| `pplx version` | `--verbose` | Show detailed version information |
+
 ### Advanced Options (Power Users)
 
 | Option | Short | Type | Default | Description |
@@ -256,7 +293,7 @@ console.log(result);
 | `--attach-image` | - | string[] | - | Attach image files (multiple) |
 | `--async` | - | boolean | false | Process requests asynchronously |
 | `--webhook` | - | string | - | Webhook URL for async notifications |
-| `--help-advanced` | - | boolean | - | Show advanced help with all options |
+ |
 
 ### Quick Reference
 
@@ -268,7 +305,7 @@ pplx -f doc.pdf -m sonar-pro "analyze this"
 pplx -I batch.json -c 10 -t 60000 --format jsonl "process all"
 
 # See all available options
-pplx --help-advanced
+pplx --help
 ```
 
 ### AI Models
@@ -304,15 +341,17 @@ Each result printed as a separate JSON line for real-time processing.
 ## Development
 
 ```bash
+# Clone and build
+git clone https://github.com/codewithkenzo/pplx-zero.git
+cd pplx-zero
+bun install && bun run build
+
 # Development mode
 bun run dev
 
 # Type checking
 bun run typecheck
 
-# Run tests
-bun test
-
 # Build for production
 bun run build