pplx-zero 1.0.1 → 1.1.1

package/README.md

@@ -29,16 +29,25 @@ A fast TypeScript CLI for Perplexity AI search with multimodal support. Built wi
 
 **📦 Package Manager Installation (Recommended)**
 
+<p align="center">
+  <a href="https://badge.fury.io/js/pplx-zero"><img src="https://badge.fury.io/js/pplx-zero.svg" alt="npm version"></a>
+  <a href="https://aur.archlinux.org/packages/pplx-zero"><img src="https://img.shields.io/aur/version/pplx-zero?style=flat-square" alt="AUR package"></a>
+</p>
+
 ```bash
-# npm (Node.js package manager)
+# npm (Node.js package manager) - Global installation
 npm install -g pplx-zero
 
-# AUR (Arch Linux)
+# AUR (Arch Linux) - Binary package
 yay -S pplx-zero
-# or manual AUR
+
+# AUR (Arch Linux) - Manual build
 git clone https://aur.archlinux.org/pplx-zero.git
 cd pplx-zero
 makepkg -si
+
+# Verify installation
+pplx --version
 ```
 
 **🔨 Manual Installation**
@@ -51,6 +60,9 @@ bun install && bun run build
 
 # Add to PATH
 sudo ln -s "$(pwd)/dist/cli.js" /usr/local/bin/pplx
+
+# Verify installation
+pplx --version
 ```
 
 ### 2️⃣ Setup API Key
@@ -67,46 +79,90 @@ setx PERPLEXITY_API_KEY "your-api-key"
 
 **Get your API key:** https://www.perplexity.ai/account/api/keys
 
-### 3️⃣ Start Searching
+### 3️⃣ Start Searching (Simplified Interface)
 
 ```bash
-# Basic search
+# Simple search
 pplx "latest AI developments"
 
-# Choose model
-pplx --model sonar-pro "Detailed analysis"
+# Choose model for detailed analysis
+pplx --model sonar-pro "Explain quantum computing"
 
-# Document analysis
-pplx --attach report.pdf "Summarize this document"
+# Analyze document (simplified syntax)
+pplx --file report.pdf "Summarize this document"
 
-# Image analysis
-pplx --attach-image screenshot.png "Analyze this interface"
+# Analyze image (simplified syntax)
+pplx --image screenshot.png "What does this interface do?"
 
-# Batch processing
-pplx --input queries.json
+# Document + image analysis
+pplx --file data.csv --image chart.png "Analyze this data"
 
-# Stream processing
-cat queries.jsonl | pplx --stdin
+# Advanced AI models
+pplx --model sonar-reasoning "Solve this math problem"
+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:**
+```bash
+# OLD: pplx --format jsonl --input queries.json "search"
+# NEW: pplx --format jsonl --input queries.json "search"  # format flag unchanged
+
+# OLD: pplx --attach document.pdf "analyze"
+# NEW: pplx --file document.pdf "analyze"              # simplified syntax
 ```
 
 ## Usage Guide
 
 ### Command Line Options
 
+**Simplified Interface (Everyday Usage):**
 ```bash
-# Search with custom settings
-pplx --concurrency 10 --timeout 60000 --format jsonl "machine learning trends"
+# Basic search with model selection
+pplx --model sonar-pro "Detailed analysis"
+
+# File attachments (simplified syntax)
+pplx --file document.pdf "Summarize this report"
+pplx --image chart.png "Analyze this chart"
+
+# Multiple attachments
+pplx --file doc1.pdf --image img1.png "Analyze these files"
 
-# Model selection
+# Output format selection
+pplx --format jsonl "Machine learning trends"
+
+# Choose AI models
 pplx --model sonar-pro "Detailed analysis"
 pplx --model sonar-reasoning "Complex problem solving"
+```
 
-# File attachments
-pplx --attach document.pdf "Summarize this report"
-pplx --attach-image chart.png "Analyze this chart"
+**Advanced Interface (Power Users):**
+```bash
+# Custom concurrency and timeout
+pplx --concurrency 10 --timeout 60000 --format jsonl "machine learning trends"
 
-# Async processing
+# Batch processing
+pplx --input queries.json --concurrency 5
+
+# Stream processing
+cat queries.jsonl | pplx --stdin
+
+# Advanced attachments (multiple files)
+pplx --attach doc1.pdf --attach doc2.txt --attach-image img1.png "Analyze all files"
+
+# Async processing with webhook
 pplx --async --webhook https://api.example.com/callback "Research task"
+
+# Custom workspace
+pplx --workspace /tmp/research "Custom workspace search"
+
+# See all advanced options
+pplx --help-advanced
 ```
 
 ### Batch Processing
@@ -139,7 +195,7 @@ pplx --input queries.json --format jsonl
 Supported file formats for analysis:
 
 **Documents (max 50MB):**
-- PDF, DOC, DOCX, TXT, RTF
+- PDF, DOC, DOCX, TXT, RTF, MD
 
 **Images (max 50MB):**
 - PNG, JPEG, WebP, HEIF, HEIC, GIF
@@ -176,20 +232,44 @@ console.log(result);
 
 ## Configuration
 
+### Simplified Options (Everyday Usage)
+
 | Option | Short | Type | Default | Description |
 |--------|-------|------|---------|-------------|
-| `--input` | `-i` | string | - | Read batch requests from JSON file |
+| `--file` | `-f` | string | - | Attach document (PDF, DOC, DOCX, TXT, RTF, MD) |
+| `--image` | `-i` | string | - | Attach image (PNG, JPEG, WebP, HEIF, HEIC, GIF) |
+| `--format` | `-o` | string | json | Output format: json|jsonl |
+| `--model` | `-m` | string | sonar | AI model: sonar, sonar-pro, sonar-deep-research, sonar-reasoning |
+| `--version` | `-v` | boolean | - | Show version |
+| `--help` | `-h` | boolean | - | Show basic help |
+
+### Advanced Options (Power Users)
+
+| Option | Short | Type | Default | Description |
+|--------|-------|------|---------|-------------|
+| `--input` | `-I` | string | - | Read batch requests from JSON file |
 | `--stdin` | `-s` | boolean | false | Read JSONL requests from stdin |
 | `--concurrency` | `-c` | number | 5 | Max concurrent requests (1-20) |
 | `--timeout` | `-t` | number | 30000 | Request timeout in ms (1000-300000) |
-| `--format` | `-f` | string | json | Output format: json|jsonl |
-| `--model` | `-m` | string | sonar | AI model to use |
-| `--attach` | - | string[] | - | Attach document files |
-| `--attach-image` | - | string[] | - | Attach image files |
+| `--workspace` | `-w` | string | - | Workspace directory for sandboxing |
+| `--attach` | - | string[] | - | Attach document files (multiple) |
+| `--attach-image` | - | string[] | - | Attach image files (multiple) |
 | `--async` | - | boolean | false | Process requests asynchronously |
 | `--webhook` | - | string | - | Webhook URL for async notifications |
-| `--version` | `-v` | boolean | - | Show version |
-| `--help` | `-h` | boolean | - | Show help |
+| `--help-advanced` | - | boolean | - | Show advanced help with all options |
+
+### Quick Reference
+
+```bash
+# Basic usage (simplified)
+pplx -f doc.pdf -m sonar-pro "analyze this"
+
+# Advanced usage (full control)
+pplx -I batch.json -c 10 -t 60000 --format jsonl "process all"
+
+# See all available options
+pplx --help-advanced
+```
 
 ### AI Models
 

package/dist/cli.js

@@ -31,7 +31,7 @@ var __export = (target, all) => {
 var require_package = __commonJS((exports, module) => {
   module.exports = {
     name: "pplx-zero",
-    version: "1.0.1",
+    version: "1.1.0",
     description: "Fast Perplexity AI search CLI with multimodal support - minimal setup, maximal results",
     type: "module",
     main: "dist/index.js",
@@ -94,7 +94,7 @@ var require_package = __commonJS((exports, module) => {
     license: "MIT",
     repository: {
       type: "git",
-      url: "https://github.com/codewithkenzo/pplx-zero.git"
+      url: "git+https://github.com/codewithkenzo/pplx-zero.git"
     },
     files: [
       "dist",
@@ -6496,7 +6496,9 @@ var DOCUMENT_MIME_TYPES = {
   ".doc": "application/msword",
   ".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
   ".txt": "text/plain",
-  ".rtf": "application/rtf"
+  ".rtf": "application/rtf",
+  ".md": "text/markdown",
+  ".markdown": "text/markdown"
 };
 var MAX_FILE_SIZE = 50 * 1024 * 1024;
 var MAX_ATTACHMENTS = 10;
@@ -6671,9 +6673,6 @@ class PerplexitySearchTool {
       } else if (validatedInput.args.attachments) {
         attachments = validatedInput.args.attachments;
       }
-      if (validatedInput.args.attachments) {
-        attachments = [...attachments, ...validatedInput.args.attachments];
-      }
       const timeoutMs = validatedInput.options?.timeoutMs || 30000;
       const controller = new AbortController;
       if (signal) {
@@ -6984,15 +6983,18 @@ var __dirname2 = dirname(__filename2);
 var { values: cliOptions, positionals: commandLineQueries } = parseArgs({
   args: process.argv.slice(2),
   options: {
-    input: { type: "string", short: "i" },
+    model: { type: "string", short: "m" },
+    file: { type: "string", short: "f" },
+    image: { type: "string", short: "i" },
+    format: { type: "string", short: "o", default: "json" },
+    version: { type: "boolean", short: "v" },
+    help: { type: "boolean", short: "h" },
+    "help-advanced": { type: "boolean" },
+    input: { type: "string", short: "I" },
     stdin: { type: "boolean", short: "s" },
     concurrency: { type: "string", short: "c" },
     timeout: { type: "string", short: "t" },
     workspace: { type: "string", short: "w" },
-    format: { type: "string", short: "f", default: "json" },
-    version: { type: "boolean", short: "v" },
-    help: { type: "boolean", short: "h" },
-    model: { type: "string", short: "m" },
     attach: { type: "string", multiple: true },
     "attach-image": { type: "string", multiple: true },
     async: { type: "boolean" },
@@ -7002,62 +7004,100 @@ var { values: cliOptions, positionals: commandLineQueries } = parseArgs({
 });
 if (cliOptions.help) {
   console.error(`
-PPLX-Zero - Minimal, fast Perplexity AI search CLI with multimodal support
+PPLX-Zero - Fast Perplexity AI search CLI with multimodal support
 
 USAGE:
   pplx [OPTIONS] [QUERY...]
 
-OPTIONS:
-  -i, --input <file>              Read batch requests from JSON file
-  -s, --stdin                     Read JSONL requests from stdin
-  -c, --concurrency <n>          Max concurrent requests (default: 5)
-  -t, --timeout <ms>              Request timeout in milliseconds (default: 30000)
-  -w, --workspace <path>          Workspace directory for sandboxing
-  -f, --format <format>           Output format: json|jsonl (default: json)
-  -m, --model <model>             AI model: sonar, sonar-pro, sonar-deep-research, sonar-reasoning (default: sonar)
-  --attach <file>                 Attach document files (PDF, DOC, DOCX, TXT, RTF) - can be used multiple times
-  --attach-image <file>           Attach image files (PNG, JPEG, WebP, HEIF, HEIC, GIF) - can be used multiple times
-  --async                         Process requests asynchronously
-  --webhook <url>                 Webhook URL for async notifications
-  -v, --version                   Show version
-  -h, --help                      Show this help
+BASIC OPTIONS:
+  -m, --model <model>       Choose AI model (sonar, sonar-pro, sonar-deep-research, sonar-reasoning)
+  -f, --file <file>         Attach document (PDF, DOC, DOCX, TXT, RTF)
+  -i, --image <file>        Attach image (PNG, JPEG, WebP, HEIF, HEIC, GIF)
+  -o, --format <format>     Output format (json, jsonl)
+
+  -v, --version             Show version
+  -h, --help                Show this help
 
 EXAMPLES:
-  # Basic query
+  # Simple search
   pplx "latest AI developments"
 
-  # Model selection
-  pplx --model sonar-pro "Detailed analysis"
-  pplx --model sonar-deep-research "Comprehensive research"
-  pplx --model sonar-reasoning "Complex problem solving"
+  # Choose model for detailed analysis
+  pplx --model sonar-pro "Explain quantum computing"
 
-  # Image analysis
-  pplx --attach-image screenshot.png --model sonar-pro "Analyze this interface"
+  # Analyze document
+  pplx --file report.pdf "Summarize this document"
 
-  # Document analysis
-  pplx --attach report.pdf --model sonar-deep-research "Summarize this document"
+  # Analyze image
+  pplx --image screenshot.png "What does this interface do?"
 
-  # Multimodal analysis
-  pplx --attach document.txt --attach-image chart.png --model sonar-reasoning "Analyze this data"
+  # Document + image analysis
+  pplx --file data.csv --image chart.png "Analyze this data"
 
-  # Async processing with webhook
-  pplx --async --webhook https://api.example.com/callback "Long research task"
+  # Different AI models
+  pplx --model sonar-reasoning "Solve this math problem"
+  pplx --model sonar-deep-research "History of artificial intelligence"
+
+# Advanced Usage (see --help-advanced):
+  pplx --help-advanced
+
+SUPPORTED FORMATS:
+  Documents: PDF, DOC, DOCX, TXT, RTF (max 50MB)
+  Images: PNG, JPEG, WebP, HEIF, HEIC, GIF (max 50MB)
 
-  # Batch from file
+Get your API key: https://www.perplexity.ai/account/api/keys
+Set environment variable: export PERPLEXITY_API_KEY="your-key"
+`);
+  process.exit(0);
+}
+if (cliOptions["help-advanced"]) {
+  console.error(`
+PPLX-Zero - Advanced Usage Options
+
+USAGE:
+  pplx [ADVANCED-OPTIONS] [QUERY...]
+
+ADVANCED OPTIONS:
+  -I, --input <file>         Read batch requests from JSON file
+  -s, --stdin                Read JSONL requests from stdin
+  -c, --concurrency <n>      Max concurrent requests (default: 5, max: 20)
+  -t, --timeout <ms>          Request timeout in milliseconds (default: 30000)
+  -w, --workspace <path>     Workspace directory for sandboxing
+  -o, --format <format>      Output format: json|jsonl (default: json)
+  -m, --model <model>         AI model (default: sonar)
+
+  --attach <file>             Attach document files (can be used multiple times)
+  --attach-image <file>       Attach image files (can be used multiple times)
+  --async                     Process requests asynchronously
+  --webhook <url>             Webhook URL for async notifications
+
+  -v, --version               Show version
+  -h, --help                  Show basic help
+
+ADVANCED EXAMPLES:
+  # Batch processing
   pplx --input queries.json
 
-  # Streaming from stdin
+  # Stream processing
   cat queries.jsonl | pplx --stdin
 
-  # JSONL output for streaming
-  pplx --format jsonl --input queries.json
+  # Custom concurrency and timeout
+  pplx --concurrency 10 --timeout 60000 "Multiple searches"
 
-  # High concurrency batch with attachments
-  pplx --concurrency 10 --timeout 60000 --input queries.json --attach appendix.pdf
+  # High performance batch
+  pplx --input queries.json --concurrency 15 --format jsonl
 
-SUPPORTED FORMATS:
-  Images: PNG, JPEG, WebP, HEIF, HEIC, GIF (max 50MB, 10 files)
-  Documents: PDF, DOC, DOCX, TXT, RTF (max 50MB, 10 files)
+  # Multiple attachments (advanced syntax)
+  pplx --attach doc1.pdf --attach doc2.txt --attach-image img1.png "Analyze all files"
+
+  # Async processing with webhook
+  pplx --async --webhook https://api.example.com/webhook "Long research task"
+
+  # Custom workspace
+  pplx --workspace /tmp/research "Custom workspace search"
+
+# Basic Usage (see --help):
+  pplx --help
 `);
   process.exit(0);
 }
@@ -7164,7 +7204,7 @@ async function main() {
         model: selectedModel,
         async: cliOptions.async,
         webhook: cliOptions.webhook,
-        hasAttachments: (cliOptions.attach?.length || 0) + (cliOptions["attach-image"]?.length || 0) > 0
+        hasAttachments: (cliOptions.file || cliOptions.image || (cliOptions.attach?.length || 0) + (cliOptions["attach-image"]?.length || 0)) > 0
       }
     });
     let batchSearchInput;
@@ -7178,6 +7218,18 @@ async function main() {
     } else if (commandLineQueries.length > 0) {
       const combinedQuery = commandLineQueries.join(" ");
       const attachmentInputs = [];
+      if (cliOptions.file) {
+        attachmentInputs.push({
+          path: cliOptions.file,
+          type: "document"
+        });
+      }
+      if (cliOptions.image) {
+        attachmentInputs.push({
+          path: cliOptions.image,
+          type: "image"
+        });
+      }
       if (cliOptions.attach && cliOptions.attach.length > 0) {
         for (const filePath of cliOptions.attach) {
           attachmentInputs.push({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pplx-zero",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Fast Perplexity AI search CLI with multimodal support - minimal setup, maximal results",
   "type": "module",
   "main": "dist/index.js",
@@ -63,7 +63,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/codewithkenzo/pplx-zero.git"
+    "url": "git+https://github.com/codewithkenzo/pplx-zero.git"
   },
   "files": [
     "dist",
@@ -71,4 +71,4 @@
     "LICENSE",
     "package.json"
   ]
-}
+}