volcengine/SearchCLI

SearchCLI – Volcengine AI Search 的命令行界面

是什么 – SearchCLI 是 Volcengine 的 AI Search 服务的 CLI 封装。它让开发者和 AI 代理系统能够从终端管理数据集、应用程序，并执行搜索、推荐和对话式检索操作。

适合谁 –

• 需要将 AI 驱动的搜索或推荐功能集成到业务后端的工程师。
• 需要以可重复、可审查的方式摄取数据、配置搜索应用并验证结果的自主代理团队。
• 希望在将变更推送到生产环境前进行安全“预演”工作流的运维人员。

核心功能

领域	CLI 命令（前缀 vs）	功能
认证与健康检查	vs auth, vs doctor	加载 Volcengine 凭证，检查连接性
LLM 集成	vs llm	注册一个 OpenAI 兼容的 LLM 用于相关性判断或查询生成
数据集处理	vs dataset, vs data	导入文件，推断模式，写入记录
应用管理	vs app	创建搜索应用，附加数据集
搜索 / 推荐 / 对话	vs search run, vs recommend run, vs chat run	执行实时查询，获取排序结果，运行对话式检索
调优	`vs search tune query-generate	plan
可扩展性	Viking skills（通过 npx skills add … 安装）	可重用的命令集合包，外部 AI 代理可程序化调用

典型人类工作流

1. 克隆仓库并运行 bash ./scripts/install.sh（需要 Node 20+ 和 git）。
2. 使用您的 Volcengine Access Key/Secret Key 进行认证（vs auth login 或从环境变量导入）。
3. （可选）注册一个 LLM 用于相关性判断（vs llm login）。
4. 导入一个 JSONL 数据文件，让服务推断模式，写入数据，创建应用，并附加数据集——仅需几个 vs dataset … 和 vs app … 命令即可完成。
5. 运行 vs search run、vs recommend run 或 vs chat run 查看服务运行效果，或使用调优命令提升相关性。

代理导向工作流

• 一次性安装 CLI。
• 添加预打包的 Viking skills（npx skills add …）。这些将相同的命令组暴露为外部 AI 代理可调用的函数。
• 代理进行认证，验证技能包后，即可在自动化流水线中调用 vs search tune … 或 vs chat run …，并内置“预演”和确认步骤以确保安全。

安装与前提条件

• Node.js 20+ 和 git。
• 拥有 AI Search 权限的 Volcengine 账户（AK/SK）。
• （可选）用于相关性判断的 OpenAI 兼容 LLM 端点访问权限。

文档与社区

• 多语言 README 链接（英文、中文、日文等）。
• 详细的代理快速入门指南（docs/agent-quick-start.md）。
• 实时支持的 WeChat 用户群组（仓库中提供二维码）。
• 标准开源贡献文件（CLA、行为准则、安全策略）。

许可证 – Apache-2.0。

---

总结 – SearchCLI 是一个生产级、以 CLI 为先的工具，连接 Volcengine 的 AI Search 平台与人类操作员及自主代理，提供可搜索、可推荐、可对话的检索能力，同时具备安全、可脚本化的流程。