SearchCLI

Q: AI Agent 如何接入 SearchCLI？

在克隆安装完成后，执行 npx skills add ＂git@github.com:volcengine/SearchCLI.git＂ -y -g 安装默认技能包，再让 Agent 调用。

终端敲一行命令，AI 搜索能力直接接入项目

开源 🏷️完全免费 🔧 仅开源项目，无在线服务，需自行部署搜索知识 🍴 复刻 39 🐛 待处理 11 👀 关注 13

GitHub ↗

GitHub 星标 ★ 1191

维护状态较活跃

是否开源开源

定价模式 🏷️完全免费开源项目，Apache-2.0 许可证，可自由使用和部署，无付费版本。

项目预览

项目数据

分类搜索知识

开发团队volcengine

GitHubhttps://github.com/volcengine/SearchCLI

定价模式🏷️完全免费

价格说明开源项目，Apache-2.0 许可证，可自由使用和部署，无付费版本。

访问状态🔧 仅开源项目，无在线服务，需自行部署

是否开源是

开源协议Apache-2.0

主要语言TypeScript

技术栈/模型agent-tools,ai-agents,ai-search,ai-search-engine,automation,cli,command-line-tool,conversational-search,information-retrieval,rag,recommendation,recommendation-system,retrieval,search-cli,search-engine,semantic-search,typescript,volcengine

GitHub 星标★ 1191

上线时间2026-05-08 00:00:00

代码更新2026-10-16

仓库体积2.7 MB

本站数据更新2026-11-08

维护状态较活跃

收录时间2026-08-09

浏览次数3

项目介绍

SearchCLI 是火山引擎推出的开源命令行工具，帮助开发者把 AI 搜索、推荐与对话式检索能力集成到智能体系统和业务系统中。通过简洁的 CLI 即可接入强大的检索能力，降低 AI 搜索应用的开发门槛。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

数据来源：GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1191

技术标签

agent-tools ai-agents ai-search ai-search-engine automation

使用教程

ℹ 本教程由 AI 依据该项目 README 整理，个别步骤可能需要按你的环境微调。

难度：入门约 10 分钟部署方式：命令行工具 8 步

环境要求

已安装 Git，可访问 GitHub 仓库（README 使用 SSH 地址）
已安装 Node.js 与 npx（用于安装 Viking skills）
支持 bash 的运行环境（安装脚本为 bash ./scripts/install.sh）
已准备好要导入的 JSONL 数据文件（如 items.jsonl）

安装与启动步骤

1克隆项目仓库

把 SearchCLI 仓库克隆到本地 vs 目录，README 使用 SSH 地址，需提前配置 GitHub SSH Key。
```
git clone git@github.com:volcengine/SearchCLI.git vs
```
2执行安装脚本

进入仓库目录后运行官方安装脚本，完成 vs 命令行工具的安装与初始化。
```
cd vs
bash ./scripts/install.sh
```

3导入并上传数据

先用 import-url 获取上传地址，再用 curl PUT 把本地 JSONL 文件二进制上传到该地址。

vs dataset import-url --file-name items.jsonl
curl -X PUT --data-binary "@./items.jsonl" "https://your-file-url.example.com/items.jsonl"

4推断数据 Schema

用上一步返回的 FileKey 触发 V2 后端驱动的 Schema 推断，指定类型、主题与语言。
```
vs dataset infer-schema --tos-key items.jsonl --type multi_modal --theme e_commerce --language zh --name my_dataset
```
5查看推断结果

用任务 ID 查询推断结果并渲染 Schema，确认字段结构无误后再创建数据集。
```
vs dataset infer-result --task-id task-xxxxxxxx --render-schema
```
6创建数据集

基于渲染出的 Schema 生成 dataset-create.json，再据此创建正式数据集。
```
vs dataset create --data @dataset-create.json
```
7写入数据

把 items.jsonl 中的字段数据写入刚创建的数据集；只用数据集的话到此即可结束。
```
vs data write --dataset-id ds-xxxxxxxx --fields @items.jsonl
```
8创建应用并绑定

创建指定行业与语言的应用，再把上一步的数据集挂载到该应用上完成接入。
```
vs app create --name my-app --industry e_commerce --language zh
vs app attach-dataset --data @attach.json
```

关键配置

配置项	必填	说明	示例
`--type`	是	数据集类型，可选 multi_modal 或 user_event	`multi_modal`
`--theme`	否	数据集主题行业；type 为 user_event 时必须省略	`e_commerce`
`--language`	否	数据集与应用的语言标识	`zh`
`--name`	是	数据集或应用名称，创建时使用	`my_dataset`
`--industry`	否	创建应用时指定的行业	`e_commerce`
`--file-name`	是	本地待导入的 JSONL 文件名	`items.jsonl`

如何确认成功

执行 bash ./scripts/install.sh 无报错后，运行 vs 能正常输出命令信息即表示安装成功。

常见问题

Q：只想建数据集、不建应用可以吗？

A：可以。README 说明如果只需要数据集，执行到 vs data write 这一步就可以停止，后续 app create 与 app attach-dataset 都可省略。

Q：如何导入用户行为（user event）数据集？

A：把 --type 改为 user_event，并省略 --theme 参数，其余导入与推断流程相同。

Q：AI Agent 如何接入 SearchCLI？

A：在克隆安装完成后，执行 npx skills add "git@github.com:volcengine/SearchCLI.git" -y -g 安装默认技能包，再让 Agent 调用。

Q：默认安装的 Viking skills 有哪些？

A：README 列出的默认公开技能包为 vs-shared、vs-item-onboarding、vs-search、vs-search-tuning、vs-chat、vs-recommend。

注意事项

安装脚本必须在克隆后的仓库目录内执行（cd vs 后再运行）。
curl 上传时必须使用 vs dataset import-url 返回的 FileUrl，上传后再用返回的 FileKey 推断 Schema。
命令中的 task-id、dataset-id、FileUrl 等为示例值，实际使用时替换为上一步真实返回值。
README 未提供凭证配置与卸载说明，使用前请自行确认账号与权限环境。

核心亮点

提供统一的CLI接口，整合AI搜索、推荐和对话式检索，方便Agent和业务系统集成
基于TypeScript开发，类型安全，易于扩展和维护
支持多种搜索场景，覆盖信息检索、推荐和对话交互，功能全面

不足之处

项目处于成长阶段，文档和社区生态尚待完善
依赖外部AI服务，可能受限于服务可用性和成本

适用场景

作为Agent系统的搜索工具，增强智能体的信息获取能力
集成到业务系统中，提供统一的搜索和推荐接口
用于命令行环境下的快速信息检索和对话交互

替代项目

LangChain、Haystack、txtai

上一篇：xerj

下一篇：chat-with-your-data-solution-accelerator