SearchCLI provides an open command-line interface for integrating Volcengine's AI search, recommendation, and conversational retrieval capabilities into agent and business systems. It offers a stable, tunable, and reviewable path for production-grade information distribution, targeting developers building AI-powered business solutions and agent systems that require configurable and verifiable workflows. The primary benefit is enabling robust AI search integration with explicit review steps and automation-safe command outputs.

How It Works

SearchCLI functions as a CLI integration surface for Volcengine's AI Search services. It employs an architecture built around installable "Viking skills," allowing external agents to onboard data, build and validate search/recommendation flows, and run conversational retrieval. A key design principle is its reviewable execution model, featuring dry-runs, confirmation gates, and read-after-write verification, which ensures stability and auditability before production deployment.

Quick Start & Requirements

• Primary install: Clone the repository, navigate to the directory, and run bash ./scripts/install.sh. For AI agents, use npx skills add "git@github.com:volcengine/SearchCLI.git" -y -g.
• Prerequisites: Node.js 20+, Git, Volcengine AK/SK with AI Search access. An OpenAI-compatible LLM API is required for search tuning features.
• Links: Quick Start (Human Users), AI Agent Setup, Full Agent Guide, Contributing, Security.

Highlighted Details

• Supports item and catalog search on structured business data.
• Enables recommendation flows tied to application scenes and user behavior.
• Facilitates conversational retrieval experiences grounded in application search.
• Includes automated text-similarity evaluation and tuning for search quality (vs search tune).
• Supports data onboarding, application configuration, and runtime verification with explicit review steps.

Maintenance & Community

The project requires external contributors to complete a Contributor License Agreement (CLA). Security issues should be reported directly to Bytedance Security, not via public GitHub issues. No specific community channels (e.g., Discord, Slack) or roadmap links are provided in the README.

Licensing & Compatibility

This project is licensed under the Apache-2.0 License. This license is permissive and generally compatible with commercial use and linking within closed-source projects.

Limitations & Caveats

Operation requires Volcengine-specific credentials (AK/SK). Advanced features like search tuning necessitate configuring an external OpenAI-compatible LLM API endpoint. The provided documentation focuses on setup and usage, with no explicit mention of alpha status, known bugs, or unsupported platforms.