Skip to content

README.md

Latest commit

 

History

History
83 lines (58 loc) · 1.56 KB

README.md

File metadata and controls

83 lines (58 loc) · 1.56 KB

Quack Search

DuckDuckGo web search library for JS runtimes, written in Go

Installation

bun add quack-search
# or
npm install quack-search
# or
yarn add quack-search

Usage

import { search, fetchContent } from 'quack-search';
console.log(await search('golang', { maxResults: 5 }));

const page = await fetchContent("https://adistrim.in/now");

if (!page.success) {
  console.log("Blocked:", page.reason);
} else {
  console.log(page.text);
}

Supported Platforms

  • macOS (x64, ARM64)
  • Linux (x64, ARM64)
  • Windows (x64, ARM64)

Advanced: CI / Docker / Offline Environments

For constrained environments where automatic download isn't possible:

Option 1: Environment Variable

Pre-install the binary and point to it:

export QUACK_BINARY_PATH=/usr/local/bin/quack

Option 2: Explicit Download

Download at build time (e.g., in a Dockerfile):

import { downloadBinary } from 'quack-search';

await downloadBinary({ 
  targetDir: '/app/bin',
  version: 'v0.1.0', // or 'latest'
  verbose: true 
});

Option 3: Platform Package

Install the platform-specific package directly:

npm install quack-search-linux-x64

Diagnostics

import { checkBinaryStatus } from 'quack-search';

const status = checkBinaryStatus();
console.log(status);
// { found: true, path: '/path/to/quack', source: 'node_modules', platform: 'darwin', arch: 'arm64' }

Contributing

Open to contributions! See the repository.

License

MIT License. See LICENSE file for details.