Skip to main content

A resilient, token-efficient CLI wrapper around the DuckDuckGo Search (ddgs) Python library.

Project description

ddgo-search

Tests PyPI version Python versions

A highly resilient, token-efficient, and feature-rich Command Line Interface (CLI) wrapper around the DuckDuckGo Search (ddgs) Python library. It features built-in proxy rotation, rate-limiting, custom token-saving ASCII rendering, webpage extraction, and direct content fetching.


✨ Features

  • 🌐 Comprehensive Query Support: Subcommands for text, images, videos, news, books, and web page extraction/fetching.
  • 🔄 Resilient Proxy Rotation: Accepts single proxy URLs, comma-separated lists, or files containing lists of proxies. Automatically rotates proxy servers sequentially on failure.
  • ⏱️ Process-Safe Rate Limiting: Randomised delays (between 1.5s to 3.0s) are tracked globally using a system-level temporary file to ensure safe execution even when multiple commands are run concurrently.
  • ⚡ Direct Web Fetching (fetch): Inspired by Charmbracelet's crush tool. Directly fetches and converts webpages using httpx, BeautifulSoup, and markdownify into beautiful plain text, markdown, or HTML, with auto-truncation limits (e.g., 100KB) to preserve context windows.
  • 📊 Token-Efficient ASCII Layouts: Formats console lists using space-padded ASCII dividers rather than heavy Unicode grids to save context window tokens when using LLM agents.

🚀 Installation

It is recommended to install and manage ddgo-search using uv.

1. Global Installation (As a CLI Tool)

To install it globally so that the ddgo-search command is available from anywhere:

# Install directly from PyPI
uv tool install ddgo-search

# Or install from GitHub
uv tool install git+https://github.com/twn39/ddgo-search.git

2. Local Development Installation

If you want to clone the repository and run it locally:

# Clone the repository
git clone https://github.com/twn39/ddgo-search.git
cd ddgo-search

# Install dependencies and sync virtual environment
uv sync

📖 CLI Usage

Invoke ddgo-search directly using uv:

uv run ddgo-search [GLOBAL-OPTIONS] COMMAND [ARGS]...

Global Options

These options must be passed before any subcommand:

  • -p, --proxy TEXT: Proxy URL, comma-separated list of proxy URLs, or file path containing proxies (one per line). Falls back to the DDGS_PROXY environment variable.
  • -t, --timeout INTEGER: Request timeout in seconds (default: 10).
  • --verify / --no-verify: Enable/disable SSL certification verification (default: --verify).
  • -r, --max-retries INTEGER: Maximum retries upon server failures or timeouts (default: 3).

Commands

1. Text Search (text)

Search the web for text results with custom formatting.

uv run ddgo-search text "artificial intelligence" --format plain
uv run ddgo-search text "python programming" --format table --max-results 5

2. Image Search (images)

Query and filter DuckDuckGo images.

uv run ddgo-search images "cute kittens" --size Large --color Monochrome
uv run ddgo-search images "space nebula" --layout Wide --format json

3. Video Search (videos)

Search for videos with specific duration, resolution, or license filters.

uv run ddgo-search videos "golang tutorial" --resolution high --duration short

Note: The third-party library standard resolution uses the spelling "standart". The CLI enum automatically handles this mapping.

4. News Search (news)

Query recent news.

uv run ddgo-search news "climate change" --timelimit w --format csv

5. Book Search (books)

Search DuckDuckGo books.

uv run ddgo-search books "machine learning" --max-results 10

6. Web Page Extract (extract)

Fetch and extract webpage content using DuckDuckGo's internal extraction backend.

uv run ddgo-search extract "https://example.com" --format text_markdown

7. Direct Web Page Fetch (fetch)

Directly fetch a URL via httpx and convert its HTML content locally to Markdown, clean text (excluding scripts, styles, headers, footers), or HTML. Includes auto-truncation.

# Direct fetch and convert to Markdown
uv run ddgo-search fetch "https://example.com" --format markdown

# Direct fetch and extract readable plain text
uv run ddgo-search fetch "https://example.com" --format text

# Direct fetch and write to file
uv run ddgo-search fetch "https://example.com" --format markdown --output doc.md

# Set custom truncation limit (e.g. 5KB)
uv run ddgo-search fetch "https://example.com" --max-size 5120

🤖 Codex Subagent & Skill Integration

You can integrate ddgo-search as a custom subagent in Codex to handle all web search and page fetching tasks.

1. Global Installation (Recommended)

To allow Codex to automatically call the ddgo-search subagent across all your projects:

  1. Install the CLI globally so it is available from any workspace directory:
    # Install globally using uv
    uv tool install .
    
  2. Install the Skill globally by copying the skill directory to your user-level Codex skills folder:
    mkdir -p ~/.codex/skills/
    cp -r skills/ddgo-search-skill ~/.codex/skills/
    
  3. Install the Subagent Configuration globally:
    mkdir -p ~/.codex/agents/
    cp .codex/agents/ddgo-search.toml ~/.codex/agents/
    

2. Project-level Installation

If you only want this subagent available inside this project directory:

  1. Ensure the project is trusted in your ~/.codex/config.toml:
    [projects."/absolute/path/to/ddgo-search"]
    trust_level = "trusted"
    
  2. The local configurations are already set up under:

3. Usage

Once the skill and subagent are installed globally, Codex can delegate searches automatically when prompted. You can trigger it explicitly by prompting:

"使用网络查找关于..."


🧪 Development & Testing

Run the comprehensive unit test suite:

uv run pytest

Our tests mock the ddgs.DDGS library as well as network activities to ensure the test suite runs instantly, robustly, and offline.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ddgo_search-1.0.3.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ddgo_search-1.0.3-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file ddgo_search-1.0.3.tar.gz.

File metadata

  • Download URL: ddgo_search-1.0.3.tar.gz
  • Upload date:
  • Size: 55.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ddgo_search-1.0.3.tar.gz
Algorithm Hash digest
SHA256 7548cd77711f27eb5db2a40bf91ea42cec056f6ec49760ab939356372435e03a
MD5 4ca0836569213a20df587e39d582e79b
BLAKE2b-256 01b41ad7deea8a996678ba3948b280f5c8092ee22bf220752b1a37f84f9b65b4

See more details on using hashes here.

File details

Details for the file ddgo_search-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: ddgo_search-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ddgo_search-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 51d3dc894763452b888aff81194b718f9185a92aa2236ec80ebdb6ff5784b368
MD5 b1b687b7f0e9a59bdbc505a9a17da30d
BLAKE2b-256 d1ac1c6749cbaf3b97b04484c4f64627e730b6d6f6ac458738316fac531a16b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page