omnisearch-cli 1.0.1 → 1.0.2

package/README.md

@@ -33,6 +33,85 @@ omnisearch "quantum computing" -n 5
 
 ---
 
+## 🔑 Providing API Keys
+
+The CLI supports 3 ways to provide API keys:
+
+### 1. Automatic `.env` File (Recommended)
+Place a `.env` file in your current working directory. The CLI will automatically detect and load it on startup without requiring any flags or external dependencies:
+
+```env
+# .env template — Fill only the providers you want to use:
+
+# Brave Search
+BRAVE_API_KEY=
+
+# Tavily AI Search
+TAVILY_API_KEY=
+
+# Google Custom Search (Requires both)
+GOOGLE_API_KEY=
+GOOGLE_CX=
+
+# Azure Bing Web Search
+BING_API_KEY=
+
+# You.com Search
+YOU_API_KEY=
+
+# Exa Neural Search
+EXA_API_KEY=
+
+# Perplexity AI
+PERPLEXITY_API_KEY=
+
+# Parallel Search
+PARALLEL_API_KEY=
+
+# SerpAPI
+SERPAPI_KEY=
+
+# Self-Hosted SearXNG Instance
+SEARXNG_URL=
+
+# GitHub (Optional, increases rate limit)
+GITHUB_TOKEN=
+
+# Semantic Scholar (Optional, increases rate limit)
+SEMANTIC_SCHOLAR_API_KEY=
+
+# PubMed / NCBI (Optional, increases rate limit)
+PUBMED_API_KEY=
+```
+
+Then simply run:
+```bash
+npx omnisearch-cli "latest AI research"
+```
+
+### 2. Inline Environment Variable (One-off / CI)
+Pass keys directly on the command line:
+
+* **macOS / Linux / WSL / Git Bash:**
+  ```bash
+  BRAVE_API_KEY="your_key" npx omnisearch-cli "deep learning" -p brave
+  ```
+* **Windows PowerShell:**
+  ```powershell
+  $env:BRAVE_API_KEY="your_key"; npx omnisearch-cli "deep learning" -p brave
+  ```
+
+### 3. Persistent Shell Profile
+Export your keys in your `~/.bashrc`, `~/.zshrc`, or Windows Environment Variables:
+```bash
+export BRAVE_API_KEY="your_key"
+export TAVILY_API_KEY="your_key"
+```
+
+> **Zero-Key Mode:** If no API keys are configured, `omnisearch-cli` automatically runs using free public providers (**DuckDuckGo**, **PubMed**, **Arxiv**, and **Semantic Scholar**) with no signup required.
+
+---
+
 ## 🛠 Command-Line Options
 
 ```text

package/dist/index.js

@@ -20,6 +20,10 @@ import {
   createYouProvider,
   webSearch
 } from "omnisearch-sdk";
+try {
+  process.loadEnvFile();
+} catch {
+}
 function showHelp() {
   console.log(`
 OmniSearch CLI - High-performance multi-provider search
@@ -48,7 +52,7 @@ function resolveProviders(providerName) {
   const registry = {
     duckduckgo: () => createDuckDuckGoProvider(),
     arxiv: () => createArxivProvider(),
-    pubmed: () => createPubMedProvider(),
+    pubmed: () => createPubMedProvider({ apiKey: env.PUBMED_API_KEY }),
     github: () => createGitHubProvider({ apiKey: env.GITHUB_TOKEN || env.GITHUB_API_KEY }),
     brave: () => env.BRAVE_API_KEY || env.BRAVE_SEARCH_API_KEY ? createBraveProvider({ apiKey: env.BRAVE_API_KEY || env.BRAVE_SEARCH_API_KEY }) : null,
     google: () => env.GOOGLE_API_KEY && env.GOOGLE_CX ? createGoogleProvider({ apiKey: env.GOOGLE_API_KEY, cx: env.GOOGLE_CX }) : null,
@@ -58,9 +62,9 @@ function resolveProviders(providerName) {
     bing: () => env.BING_API_KEY ? createBingProvider({ apiKey: env.BING_API_KEY }) : null,
     you: () => env.YOU_API_KEY ? createYouProvider({ apiKey: env.YOU_API_KEY }) : null,
     parallel: () => env.PARALLEL_API_KEY ? createParallelProvider({ apiKey: env.PARALLEL_API_KEY }) : null,
-    serpapi: () => env.SERPAPI_API_KEY ? createSerpApiProvider({ apiKey: env.SERPAPI_API_KEY }) : null,
-    searxng: () => env.SEARXNG_BASE_URL ? createSearXNGProvider({ baseUrl: env.SEARXNG_BASE_URL }) : null,
-    semanticscholar: () => createSemanticScholarProvider()
+    serpapi: () => env.SERPAPI_KEY || env.SERPAPI_API_KEY ? createSerpApiProvider({ apiKey: env.SERPAPI_KEY || env.SERPAPI_API_KEY }) : null,
+    searxng: () => env.SEARXNG_URL || env.SEARXNG_BASE_URL ? createSearXNGProvider({ baseUrl: env.SEARXNG_URL || env.SEARXNG_BASE_URL }) : null,
+    semanticscholar: () => createSemanticScholarProvider({ apiKey: env.SEMANTIC_SCHOLAR_API_KEY })
   };
   if (name) {
     const factory = registry[name];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "omnisearch-cli",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Command-line interface for OmniSearch SDK",
   "type": "module",
   "license": "MIT",
@@ -15,7 +15,7 @@
     "node": ">=24.0.0"
   },
   "dependencies": {
-    "omnisearch-sdk": "5.0.1"
+    "omnisearch-sdk": "5.1.0"
   },
   "devDependencies": {
     "tsup": "^8.5.1",