pplx-zero 1.1.3 → 1.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +26 -50
  2. package/dist/cli.js +5489 -6537
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -79,7 +79,7 @@ setx PERPLEXITY_API_KEY "your-api-key"
79
79
 
80
80
  **Get your API key:** https://www.perplexity.ai/account/api/keys
81
81
 
82
- ### 3️⃣ Start Searching (Simplified Interface)
82
+ ### 3️⃣ Start Searching
83
83
 
84
84
  ```bash
85
85
  # Simple search
@@ -88,10 +88,10 @@ pplx "latest AI developments"
88
88
  # Choose model for detailed analysis
89
89
  pplx --model sonar-pro "Explain quantum computing"
90
90
 
91
- # Analyze document (simplified syntax)
91
+ # Analyze document
92
92
  pplx --file report.pdf "Summarize this document"
93
93
 
94
- # Analyze image (simplified syntax)
94
+ # Analyze image
95
95
  pplx --image screenshot.png "What does this interface do?"
96
96
 
97
97
  # Document + image analysis
@@ -103,66 +103,40 @@ pplx --model sonar-deep-research "History of artificial intelligence"
103
103
 
104
104
  # See basic help
105
105
  pplx --help
106
-
107
- # See advanced options
108
- pplx --help-advanced
109
- ```
110
-
111
- **🔄 Migration from v1.0.x:**
112
- ```bash
113
- # OLD: pplx --format jsonl --input queries.json "search"
114
- # NEW: pplx --format jsonl --input queries.json "search" # format flag unchanged
115
-
116
- # OLD: pplx --attach document.pdf "analyze"
117
- # NEW: pplx --file document.pdf "analyze" # simplified syntax
118
106
  ```
119
107
 
120
108
  ## Usage Guide
121
109
 
122
110
  ### Command Line Options
123
111
 
124
- **Simplified Interface (Everyday Usage):**
112
+ **Quick Reference:**
125
113
  ```bash
126
- # Basic search with model selection
127
- pplx --model sonar-pro "Detailed analysis"
128
-
129
- # File attachments (simplified syntax)
130
- pplx --file document.pdf "Summarize this report"
131
- pplx --image chart.png "Analyze this chart"
114
+ # Basic search
115
+ pplx "latest AI developments"
132
116
 
133
- # Multiple attachments
134
- pplx --file doc1.pdf --image img1.png "Analyze these files"
117
+ # File analysis (simplified)
118
+ pplx -f document.pdf "Summarize this"
135
119
 
136
- # Output format selection
137
- pplx --format jsonl "Machine learning trends"
120
+ # Advanced batch processing
121
+ pplx --input queries.json -c 10 -t 60000
138
122
 
139
- # Choose AI models
140
- pplx --model sonar-pro "Detailed analysis"
141
- pplx --model sonar-reasoning "Complex problem solving"
123
+ # See all options
124
+ pplx --help-advanced
142
125
  ```
143
126
 
144
- **Advanced Interface (Power Users):**
127
+ **Essential Commands:**
145
128
  ```bash
146
- # Custom concurrency and timeout
147
- pplx --concurrency 10 --timeout 60000 --format jsonl "machine learning trends"
129
+ # Model selection
130
+ pplx -m sonar-pro "Detailed analysis"
148
131
 
149
- # Batch processing
150
- pplx --input queries.json --concurrency 5
132
+ # File + image
133
+ pplx -f doc.md -i chart.png "Analyze both"
151
134
 
152
- # Stream processing
153
- cat queries.jsonl | pplx --stdin
135
+ # Output format
136
+ pplx -o jsonl "Get streaming output"
154
137
 
155
- # Advanced attachments (multiple files)
156
- pplx --attach doc1.pdf --attach doc2.txt --attach-image img1.png "Analyze all files"
157
-
158
- # Async processing with webhook
159
- pplx --async --webhook https://api.example.com/callback "Research task"
160
-
161
- # Custom workspace
162
- pplx --workspace /tmp/research "Custom workspace search"
163
-
164
- # See all advanced options
165
- pplx --help-advanced
138
+ # Async with webhook
139
+ pplx --async --webhook https://api.example.com "Long task"
166
140
  ```
167
141
 
168
142
  ### Batch Processing
@@ -304,15 +278,17 @@ Each result printed as a separate JSON line for real-time processing.
304
278
  ## Development
305
279
 
306
280
  ```bash
281
+ # Clone and build
282
+ git clone https://github.com/codewithkenzo/pplx-zero.git
283
+ cd pplx-zero
284
+ bun install && bun run build
285
+
307
286
  # Development mode
308
287
  bun run dev
309
288
 
310
289
  # Type checking
311
290
  bun run typecheck
312
291
 
313
- # Run tests
314
- bun test
315
-
316
292
  # Build for production
317
293
  bun run build
318
294