heyduck 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,161 @@
+# heyduck
+
+A fast and minimal CLI tool to search DuckDuckGo directly from your terminal and get clean, actionable results with links.
+
+---
+
+## 🚀 Features
+
+* Instant DuckDuckGo search from terminal
+* Clean formatted output using ANSI + chalk styling
+* Quick link-first results for fast navigation
+* JSON output mode for scripting
+* Raw text mode for minimal output
+* Control number of results
+
+---
+
+## 📦 Installation
+
+```bash
+npm install -g heyduck
+```
+
+---
+
+## ⚡ Usage
+
+```bash
+heyduck <keywords>
+```
+
+Example:
+
+```bash
+heyduck nodejs event loop
+```
+
+---
+
+## 🎛️ Options
+
+### Limit results
+
+```bash
+heyduck <keywords> -r <number>
+```
+
+Example:
+
+```bash
+heyduck javascript promises -r 5
+```
+
+---
+
+### JSON output
+
+```bash
+heyduck <keywords> -j
+```
+
+Example:
+
+```bash
+heyduck react hooks -j
+```
+
+---
+
+### Raw text output
+
+```bash
+heyduck <keywords> -t
+```
+
+Example:
+
+```bash
+heyduck docker basics -t
+```
+
+---
+
+## 🧠 How it works
+
+heyduck sends a request to DuckDuckGo, parses the results, and extracts titles, links, and snippets. It then formats them for terminal display or returns structured data depending on flags.
+
+---
+
+## 🧩 Flags
+
+| Flag | Description                     |
+| ---- | ------------------------------- |
+| `-r` | Number of results to display    |
+| `-j` | Output results as JSON          |
+| `-t` | Output raw text without styling |
+
+---
+
+## 💡 Examples
+
+### Basic search
+
+```bash
+heyduck linux file permissions
+```
+
+### Limited results
+
+```bash
+heyduck npm publish package -r 3
+```
+
+### JSON output
+
+```bash
+heyduck async await -j
+```
+
+### Raw output
+
+```bash
+heyduck git rebase -t
+```
+
+---
+
+## 🛠️ Tech Stack
+
+* Node.js
+* Axios (HTTP requests)
+* Cheerio (HTML parsing)
+* Chalk (terminal styling)
+* ANSI formatting
+
+---
+
+## 📌 Use Cases
+
+* Quick developer searches without opening browser
+* Copying links directly from terminal
+* Scripting search workflows
+* Lightweight research tool
+
+---
+
+## 📄 License
+
+MIT
+
+---
+
+## 🤝 Contributing
+
+Pull requests and suggestions are welcome.
+
+---
+
+## 🔥 Author
+
+Built for fast terminal-based searching with focus on speed, simplicity, and usability.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "heyduck",
-    "version": "1.0.0",
-    "description": "",
+    "version": "1.0.1",
+    "description": "A fast CLI tool to search DuckDuckGo and instantly get keyword-based results with links, formatted output, JSON support, and customizable result limits.",
     "main": "index.js",
     "type": "module",
     "scripts": {
@@ -10,8 +10,24 @@
     "bin": {
         "heyduck": "./script.js"
     },
-    "keywords": [],
-    "author": "",
+    "keywords": [
+        "cli",
+        "search",
+        "duckduckgo",
+        "terminal",
+        "command-line",
+        "scraper",
+        "search-engine",
+        "productivity",
+        "developer-tools",
+        "nodejs",
+        "automation",
+        "cli-tool",
+        "json-output",
+        "web-search",
+        "fast-search"
+    ],
+    "author": "aliashraf34",
     "license": "ISC",
     "packageManager": "pnpm@10.30.3",
     "dependencies": {
@@ -20,4 +36,4 @@
         "cheerio": "^1.2.0",
         "wrap-ansi": "^10.0.0"
     }
-}
+}

package/script.js

@@ -10,6 +10,11 @@ const AXIOS_CFG = { headers: { "User-Agent": "Mozilla/5.0" }, timeout: 8000 };
 async function searchMetaTUI(keyword, max = 10, mode = "chalk") {
     const { data } = await axios.get(`https://duckduckgo.com/html/?q=${encodeURIComponent(keyword)}`, AXIOS_CFG);
 
+    if (!data) {
+        console.log("Error: Could not get results from duck duck go.");
+        process.exit(1);
+    }
+
     const $ = cheerio.load(data);
     const results = [];
 
@@ -65,7 +70,19 @@ async function searchMetaTUI(keyword, max = 10, mode = "chalk") {
 const args = process.argv.slice(2);
 
 // Determine mode
-const mode = args.includes("-j") ? "json" : args.includes("-t") ? "text" : "chalk";
+const mode = args.includes("-j") && args.includes("-t") ? null : args.includes("-j") ? "json" : args.includes("-t") ? "text" : "chalk";
+
+if (mode === null) {
+    console.log("Error: -j and -t cannot be used together.");
+    process.exit(1);
+}
+
+if (rIndex !== -1 && (maxResults < 1 || maxResults > 10)) {
+    console.log("Error: -r must be between 1 and 10.");
+    process.exit(1);
+}
+
+
 
 // Determine number of results with -r flag
 let maxResults = 10;
@@ -75,7 +92,7 @@ if (rIndex !== -1 && args[rIndex + 1] && !isNaN(args[rIndex + 1])) {
 }
 
 // Combine all other args as keyword
-const keyword = args.filter(arg => !arg.startsWith("-") && arg !== args[rIndex + 1]).join(" ");
+const keyword = args.filter((arg, i) => !arg.startsWith("-") && (rIndex === -1 || i !== rIndex + 1)).join(" ");
 
 if (!keyword) {
     console.log("Usage: node script.js <search keyword> [-j|-t] [-r number]");