volcengine/SearchCLI

volcengine 프로필

최근 기록된 소스 활동: 2026년 10월 10일 09:56

SkillsMP 카탈로그 업데이트: 2026년 10월 17일 00:09

수집된 skills: 14

GitHub 스타: 1,188
GitHub 포크: 37

저장소 README

README 원본 파일: README.md

README 원본 보기

README 전체 펼치기

<img src="docs/assets/searchcli-logo.svg" alt="SearchCLI logo" width="560" /> # SearchCLI English | [简体中文](README.zh_CN.md) | [日本語](README.ja_JP.md) | [Deutsch](README.de_DE.md) | [한국어](README.ko_KR.md) | [Français](README.fr_FR.md) | [Русский](README.ru_RU.md) | [Italiano](README.it_IT.md) | [Español](README.es_ES.md) | [Português](README.pt_BR.md) | [Türkçe](README.tr_TR.md) | [ไทย](README.th_TH.md) | [Bahasa Indonesia](README.id_ID.md) Connect stable, tunable search, recommendation, and conversational retrieval to your agent system or business system. [Community](#community) · [Quick Start](#quick-start-human-users) · [AI Agent Setup](#quick-start-ai-agents) · [Full Agent Guide](docs/agent-quick-start.md) · [Contributing](CONTRIBUTING.md) · [Security](SECURITY.md) SearchCLI is the open CLI for AI Search on Volcengine. If your agent system or business system needs stable, tunable information distribution services, SearchCLI gives you a practical path to integrate production-grade search, recommendation, and conversational retrieval into real workflows. With SearchCLI and its installable `Viking skills`, external agents can onboard data, build and validate search and recommendation flows, run conversational retrieval, tune strategy configuration, inspect bad cases, and iterate on retrieval quality in a stable, reviewable way. ## Community Follow the SearchCLI WeChat Official Account Scan the QR code below with WeChat to get SearchCLI project updates, usage guides, and announcements. Follow the official account to keep up with SearchCLI updates. <div align="center"> <a href="docs/assets/searchcli-wechat.jpg"> <img src="docs/assets/searchcli-wechat.jpg" alt="SearchCLI WeChat Official Account QR code" width="320" /> </a> </div> ## What SearchCLI Is - The command-line integration surface for AI Search on Volcengine. - A stable path for external systems to access search, recommendation, and conversational retrieval capabilities. - An agent-friendly workflow layer built around installable skills and automation-safe command output. - A reviewable execution model with dry-runs, confirmation gates, and read-after-write verification. ## Who It Is For - Developers integrating AI-powered information distribution into business systems. - Teams building agent systems that need stable, configurable search, recommendation, and retrieval workflows. - Operators and solution teams who need a reviewable way to onboard data, configure applications, and verify runtime behavior before production use. ## What It Enables - Item and catalog search on top of structured business data. - Recommendation flows connected to application scenes and user behavior. - Conversational retrieval experiences grounded in application search. - Agent workflows that can onboard data, configure applications, and validate runtime behavior with explicit review steps. ## Core Capabilities - `vs dataset`, `vs app`, and `vs data` for application and dataset management. - `vs search run`, `vs recommend run`, and `vs chat run` for runtime verification. - `vs search tune query-generate | plan | run | report` for first-version automated text-similarity evaluation and tuning. - Installable `Viking skills` so external agents can use the same workflows. ## Requirements - Node.js 20 or newer - `git` - Volcengine AK/SK with access to AI Search ## Quick Start (Human Users) ### 1. Install ```bash git clone git@github.com:volcengine/SearchCLI.git vs cd vs bash ./scripts/install.sh ``` ### 2. Authenticate If the current shell already has `VIKING_AK` and `VIKING_SK`: ```bash vs auth import-env vs auth status --json vs doctor --json ``` Otherwise, run interactive login in a real terminal: ```bash vs auth login ``` If you will use search tuning query generation or LLM relevance judging, configure an OpenAI-compatible LLM API without placing the API key in plain config: ```bash vs llm login vs llm status --json vs search tune llm-check --live --json ``` If the current shell already has `VIKING_LLM_BASE_URL`, `VIKING_LLM_API_KEY`, and `VIKING_LLM_MODEL`, use `vs llm import-env` instead. The API key is stored in the local secure credential store; base URL and model are stored as non-secret config. ### 3. Run the First Onboarding Flow Onboard a JSONL file into a fresh app using the V2 backend-driven schema inference flow: ```bash vs dataset import-url --file-name items.jsonl curl -X PUT --data-binary "@./items.jsonl" "<FileUrl from previous step>" vs dataset infer-schema --tos-key <FileKey> --type multi_modal --theme e_commerce --language zh --name <dataset-name> vs dataset infer-result --task-id <TaskID> --render-schema vs dataset create --data @dataset-create.json vs data write --dataset-id <DatasetId> --fields @items.jsonl vs app create --name <app-name> --industry e_commerce --language zh vs app attach-dataset --data @attach.json ``` If you only need a dataset (no app), stop after `vs data write`. For user-event datasets, use `--type user_event` and omit `--theme`. ## Quick Start (AI Agents) If an external agent needs to operate AI Search through this repository: ### 1. Install SearchCLI ```bash git clone git@github.com:volcengine/SearchCLI.git vs cd vs bash ./scripts/install.sh ``` ### 2. Install Viking skills ```bash npx skills add "git@github.com:volcengine/SearchCLI.git" -y -g ``` The default public skill bundle is: - `vs-shared` - `vs-item-onboarding` - `vs-search` - `vs-search-tuning` - `vs-chat` - `vs-recommend` ### 3. Authenticate If the current shell already has `VIKING_AK` and `VIKING_SK`, prefer: ```bash vs auth import-env ``` Otherwise: ```bash vs auth login ``` ### 4. Verify ```bash vs --help vs auth status --json vs llm status --json vs doctor --json vs skill list ``` ## Public Command Groups - `vs auth` - `vs llm` - `vs doctor` - `vs skill` - `vs item` - `vs app` - `vs dataset` - `vs data` - `vs search` - `vs chat` - `vs recommend` ## Documentation - [Agent Quick Start](docs/agent-quick-start.md) - [Contributing](CONTRIBUTING.md) - [Security](SECURITY.md) ## Maintainer Workflow If you are maintaining the open-source repository itself, the local skill tooling is: ```bash vs skill list vs skill init viking-demo-skill vs skill validate vs skill install all ``` Build and run repository checks: ```bash npm install npm run validate:skills npm run build npm run test:acceptance:dist ``` ## Contribution Please check [Contributing](CONTRIBUTING.md) for more details. External contributors must complete the Contributor License Agreement (CLA) before a pull request can be accepted. ## Code of Conduct Please check [Code of Conduct](CODE_OF_CONDUCT.md) for more details. ## Security and privacy This project takes security seriously. For vulnerability reporting and supported versions, see [SECURITY.md](SECURITY.md) ## License This project is licensed under the [Apache-2.0 License](LICENSE).

저장소 README를 불러오는 중…

이 저장소의 skills

소프트웨어 개발자 네트워크·컴퓨터 시스템 관리자 소프트웨어 품질 보증 분석가·테스터 프로젝트 관리 전문가

직업 카테고리 4개 · 100% 분류됨

소프트웨어 개발자

Volcengine official documentation lookup helper. Supports both document search and full-content fetch across Volcengine products, developer tools, support content, best practices, pricing, deployment, troubleshooting, API, SDK, and policy pages.

원문 언어: 영어

2026-06-12

수집된 skill 14개 중 14개를 표시합니다.

AI 어시스턴트로 설치

이 프롬프트를 복사해 사용 중인 AI 어시스턴트에 입력하세요.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/volcengine/SearchCLI.