searchxng 1.0.0

package/README.md

@@ -0,0 +1,54 @@
+# SearchXNG CLI
+
+A command-line interface for querying a [SearchXNG](https://docs.searxng.org/) instance.
+
+## Installation
+
+```bash
+npm install -g searchxng
+```
+
+## Usage
+
+```bash
+searchxng "your search query here" [options]
+```
+
+### Options:
+- `-e, --endpoint <url>`: The SearchXNG instance URL (defaults to `http://localhost:8080/` or `SEARCHXNG_URL` env var)
+- `-l, --language <lang>`: Language to search in (defaults to `en`)
+- `-c, --categories <categories>`: Comma-separated list of categories (e.g. `news,science`)
+- `-m, --max-results <number>`: Maximum number of results to return (defaults to `5`)
+- `-j, --json`: Output raw JSON instead of formatted text
+
+### Examples:
+```bash
+# Basic search with a specific endpoint
+searchxng "cool new restaurants in orange county" --endpoint "http://192.168.4.4:8081/"
+
+# Search in specific language
+searchxng "best restaurants" -e "http://192.168.4.4:8081/" -l "es"
+
+# Search with specific categories
+searchxng "latest AI news" -e "http://192.168.4.4:8081/" -c "news,science"
+```
+
+## Configuration
+
+You can also omit the `--endpoint` parameter if you export the `SEARCHXNG_URL` environment variable in your session:
+
+```bash
+export SEARCHXNG_URL="http://192.168.4.4:8081/"
+searchxng "cool new restaurants in orange county"
+```
+
+### Troubleshooting: 403 Forbidden Error
+If you encounter a `403 Forbidden` error when running a search, it is likely because SearchXNG disables JSON API requests by default for security/privacy. To fix this, enable the `json` format in your SearchXNG's `settings.yml` file:
+
+```yaml
+search:
+  formats:
+    - html
+    - json
+```
+Restart your SearchXNG container or service after updating the settings.

package/bin/searchxng.js

@@ -0,0 +1,78 @@
+#!/usr/bin/env node
+
+const { Command } = require("commander");
+
+const program = new Command();
+
+program
+  .name("searchxng")
+  .description("CLI to query a local or remote SearchXNG instance")
+  .version("1.0.0");
+
+program
+  .argument("<query>", "The search query")
+  .option("-e, --endpoint <url>", "The SearchXNG instance URL", process.env.SEARCHXNG_URL || "http://localhost:8080/")
+  .option("-l, --language <lang>", "Language to search in", "en")
+  .option("-c, --categories <categories>", "Comma-separated list of categories (e.g. news,science)")
+  .option("-m, --max-results <number>", "Maximum number of results to return", "5")
+  .option("-j, --json", "Output raw JSON instead of formatted text")
+  .action(async (query, options) => {
+    try {
+      let endpoint = options.endpoint;
+      if (!endpoint.startsWith("http://") && !endpoint.startsWith("https://")) {
+        endpoint = "http://" + endpoint;
+      }
+      
+      const baseUrl = endpoint.endsWith("/") ? endpoint : `${endpoint}/`;
+      const url = new URL("search", baseUrl);
+      
+      url.searchParams.set("q", query);
+      url.searchParams.set("format", "json");
+      url.searchParams.set("language", options.language);
+      
+      if (options.categories) {
+        url.searchParams.set("categories", options.categories);
+      }
+
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), 15000); // 15 second timeout
+
+      const response = await fetch(url.toString(), { signal: controller.signal });
+      clearTimeout(timeoutId);
+      
+      if (!response.ok) {
+        console.error(`SearchXNG API returned status ${response.status}`);
+        process.exit(1);
+      }
+
+      const data = await response.json();
+      
+      const results = data.results || [];
+      
+      let limit = parseInt(options.maxResults, 10);
+      if (isNaN(limit) || limit <= 0) limit = 5;
+
+      const topResults = results.slice(0, limit);
+      
+      if (options.json) {
+        console.log(JSON.stringify(topResults, null, 2));
+        return;
+      }
+
+      if (topResults.length === 0) {
+        console.log("No results found.");
+        return;
+      }
+
+      const formatted = topResults.map((r, i) => {
+        return `${i + 1}. ${r.title}\n   URL: ${r.url}\n   Snippet: ${r.content || r.snippet || ""}`;
+      }).join("\n\n");
+
+      console.log(formatted);
+    } catch (error) {
+      console.error(`Failed to search: ${error.message}`);
+      process.exit(1);
+    }
+  });
+
+program.parse();

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "searchxng",
+  "version": "1.0.0",
+  "description": "A command-line interface for querying a SearchXNG instance.",
+  "bin": {
+    "searchxng": "./bin/searchxng.js"
+  },
+  "files": [
+    "bin",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "searchxng",
+    "search",
+    "cli"
+  ],
+  "author": "chrisb",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/chrisb/searchxng-cli.git",
+    "directory": "packages/cli"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "commander": "^14.0.3"
+  }
+}