volcengine/SearchCLI

SearchCLI – a command‑line interface for Volcengine AI Search

What it is – SearchCLI is a CLI wrapper around Volcengine’s AI Search service. It lets developers and AI‑agent systems manage datasets, applications, and run search, recommendation, and chat‑style retrieval operations from the terminal.

Who it’s for –

• Engineers who need to plug AI‑powered search or recommendation into a business backend.
• Teams building autonomous agents that must ingest data, configure search apps, and verify results in a repeatable, reviewable way.
• Operators who want a safe, “dry‑run” workflow before pushing changes to production.

Core capabilities

Area	CLI commands (prefix vs)	What it does
Auth & health	vs auth, vs doctor	Load Volcengine credentials, check connectivity
LLM integration	vs llm	Register an OpenAI‑compatible LLM for relevance judging or query generation
Dataset handling	vs dataset, vs data	Import files, infer schema, write records
Application management	vs app	Create a search app, attach datasets
Search / recommendation / chat	vs search run, vs recommend run, vs chat run	Execute live queries, get ranked results, run conversational retrieval
Tuning	`vs search tune query-generate	plan
Extensibility	Viking skills (installed via npx skills add …)	Bundle reusable command sets that agents can call programmatically

Typical human workflow

1. Clone the repo and run bash ./scripts/install.sh (requires Node 20+ and git).
2. Authenticate with your Volcengine Access Key/Secret Key (vs auth login or import from env).
3. (Optional) Register an LLM for relevance judging (vs llm login).
4. Import a JSONL data file, let the service infer a schema, write the data, create an app, and attach the dataset – all with a handful of vs dataset … and vs app … commands.
5. Run vs search run, vs recommend run or vs chat run to see the service in action, or use the tuning commands to improve relevance.

Agent‑oriented workflow

• Install the CLI once.
• Add the pre‑packaged Viking skills (npx skills add …). These expose the same command groups as functions that an external AI agent can invoke.
• The agent authenticates, validates the skill bundle, and then can call vs search tune … or vs chat run … as part of an automated pipeline, with built‑in dry‑run and confirmation steps for safety.

Installation & prerequisites

• Node.js 20+ and git.
• A Volcengine account with an AK/SK that has AI Search permissions.
• (Optional) Access to an OpenAI‑compatible LLM endpoint for relevance judging.

Documentation & community

• Multilingual README links (English, Chinese, Japanese, etc.).
• Detailed agent quick‑start guide (docs/agent-quick-start.md).
• WeChat user group for real‑time support (QR code provided in the repo).
• Standard open‑source contribution files (CLA, Code of Conduct, Security policy).

License – Apache‑2.0.

---

Bottom line – SearchCLI is a production‑grade, CLI‑first tool that bridges Volcengine’s AI Search platform with both human operators and autonomous agents, offering searchable, recommendable, and conversational retrieval capabilities together with a safe, scriptable workflow.