Ddg Search

🚀 Duck🦆 Project README (English Version)

Duck is a powerful collection of tools designed to assist users in conducting web searches, scraping URL content, and extracting metadata efficiently. This project is developed by @OEvortex and released under the Apache License 2.0.

✨ Features

• Web Search Tool: Supports custom query parameters and returns a specified number of search results.
• URL Content Scraping: Extracts the main content of web pages and supports multiple output formats.
• Metadata Extraction: Quickly retrieves basic information such as the title and description of the target URL.

For more detailed features, please refer to the tool descriptions below.

🚀 Quick Start

📦 Installation

npm install duck

💻 Usage Examples

Basic Usage

// Web Search
const { webSearch } = require('duck');

webSearch({
  query: 'Artificial Intelligence',
  numResults: 5,
  page: 2
}).then(results => {
  console.log(results);
});

// URL Content Scraping
const { fetchUrl } = require('duck');

fetchUrl({
  url: 'https://example.com',
  maxLength: 10000
}).then(content => {
  console.log(content);
});

Advanced Usage

// You can customize more parameters according to your needs

📚 Documentation

Web Search Tool (web-search)

• Parameters:
  • query (Required): Search keywords.
  • page (Optional, default is 1): Page number.
  • numResults (Optional, default is 10): Number of results (range 1 - 20).

URL Content Scraping Tool (fetch-url)

• Parameters:
  • url (Required): Target web page address.
  • maxLength (Optional, default is 10000): Maximum return length.
  • extractMainContent (Optional, default is true): Whether to extract the main content.
  • includeLinks (Optional, default is true): Whether to include link text.
  • includeImages (Optional, default is true): Whether to include image descriptions.
  • excludeTags (Optional): Exclude specific tags.

Metadata Extraction Tool (url-metadata)

• Parameters:
  • url (Required): Target web page address.

🔧 Technical Details

Project Structure

bin/              # Command-line interface
src/
  index.js        # Main entry file
  tools/          # Tool definitions and implementations
    searchTool.js
    fetchUrlTool.js
    metadataTool.js
  utils/          # Auxiliary tools and functions
    search.js     # Search and URL-related functions
package.json
README.md

🤝 Contribution Guidelines

Community contributions are welcome! Please participate in the project by submitting issues or Pull Requests.

⚠️ Important Note

Please follow the existing code style and add test cases for new features.

📺 YouTube Channel

@OEvortex

📄 License

This project is licensed under the Apache License 2.0. Please refer to the LICENSE file for specific details.

Developed by @OEvortex ❤️