跳到主要内容

快速开始：安装 CLI 与 Agent 集成

本指南将帮助你在本地设置 Zilliz CLI 和 Agent 集成。设置完成后，你可以通过自然语言让 Agent 操作 Zilliz Cloud，也可以直接在终端、脚本和 CI 工作流中使用 CLI。

安装​

开始之前，请确保你已准备好：

安装 Claude Code 插件​

如果您想直接在 OpenAI Codex 中操作 Zilliz Cloud，请使用 Zilliz Plugin。

1

添加 Marketplace。

plaintext
codex plugin marketplace add zilliztech/zilliz-plugin
2

在 Codex 中打开 /plugins 并从 Marketplace 中安装 zilliz 插件。

或者您也可以根据以下方式直接通过codex-marketplace 安装。

plaintext
npx codex-marketplace add zilliztech/zilliz-plugin --plugins

安装 Claude Code 插件​

如果您想直接在 Claude Code 中操作 Zilliz Cloud，请使用Claude Code Plugin 。

1

运行 Claude Code

bash
> claude
2

打开 Plugin Marketplace

bash
/plugin
3

搜索并安装 Zilliz Plugin

前往 Discover 页签并搜索 zilliz。选择 zilliz plugin 并安装。

HiRrbywpvo7mN7xFIjecc4A1nzf

4

运行 quickstart wizard。并根据指导安装 CLI 、进行身份验证、连接集群。

plaintext
/zilliz:quickstart

为常用 Agent 框架安装 Zilliz Skill​

如果您的 Agent（例如 Codex、Gemini CLI、Cursor 或其他 Agent）支持 Agent Skills，可以按如下方式安装 Zilliz Skill：

bash
npx skills add zilliztech/zilliz-skill

该命令会提示你选择目标 Agent 框架和安装范围。

安装 Zilliz CLI​

Zilliz CLI 是 Plugin 和 Skill 使用的基础命令行工具。

1

安装 Zilliz CLI.

bash
curl -fsSL https://zilliz.com/cli/install.sh | bash

验证是否安装成功：

bash
zilliz --version
2

身份认证。

使用您的 Zilliz Cloud 账号进行身份认证：

bash
zilliz login

该命令会打开浏览器完成认证。登录后，您的身份认证凭据会存储在本地。

何时使用 CLI、Plugin 或 Skill​

在以下场景中使用这些工具：

  • 从本地环境进行手动开发和测试。

  • 编写自动化运维脚本，以支持可重复执行的工作流。

  • 让您的 Agent 自动调用 Vector Database 或 Vector Lakebase 服务。

工具对比​

Claude Code Plugin、Zilliz Skill 和 Zilliz CLI 的能力一致。请根据您工作流选择合适的工具，而不是基于支持的能力范围选择。

Claude Code PluginZilliz SkillZilliz CLI
适合场景Claude Code 自然语言工作流兼容 Skill 的 Agent终端、脚本和 CI
设置方式/zilliz:quickstartnpx skills add zilliztech/zilliz-skillInstall script + zilliz login
自然语言支持支持不支持
自动化Agent 辅助Agent 辅助脚本优先
结构化输出Agent 可读响应Agent 可读响应使用 --output json 供脚本解析

支持的能力​

下表说明 CLI、Plugin 和 Skill 支持的能力。

能力领域可执行操作
集群创建、删除、挂起、恢复运行、修改
Collection使用自定义 schema 创建、加载、释放、重命名、删除
向量Search、Query、Insert,、Upsert、Delete、Hybrid Search
Index创建 AUTOINDEX、列出、查看详情、删除
Database创建、列出、查看详情、删除
用户和角色RBAC 设置、权限管理
备份创建、恢复、导出、策略管理
导入从阿里云 OSS、Amazon S3 批量导入数据
Partition创建、加载、释放、管理
监控集群状态、Collection 统计信息、加载状态
项目项目和云地域管理
账单用量查询、发票查询

可以让 Agent 做什么​

安装完成后，直接描述您的任务。Agent 应将您的请求转换为对应的 Zilliz CLI 命令。以下示例展示了自然语言请求如何映射到 Agent 预期执行的 CLI 命令。

  • 列出我的集群，并显示当前正在使用哪个集群。

    预期 CLI 命令：

    bash
    zilliz cluster list
    zilliz context current

  • 为商品向量创建一个 Collection，向量字段维度为 768。

    预期 CLI 命令：

    bash
    zilliz collection create --name product_embeddings --dimension 768

  • 将 S3 中的数据导入到我的 Collection，并检查导入任务状态。

    预期 CLI 命令：

    bash
    zilliz import start --cluster-id <cluster-id> --collection product_embeddings --body '{"files": [["s3://bucket/path/data.json"]]}'

  • 为生产环境中的集群创建备份。

    预期 CLI 命令：

    bash
    zilliz backup create --cluster-id <cluster-id>

  • 使用元数据 Filter 搜索我的 Collection，并返回 top 10 结果。

    预期 CLI 命令：

    bash
    zilliz vector search --collection product_embeddings --data '[[0.1, 0.2, 0.3]]' --filter 'age > 20' --limit 10 --output-fields '["name", "age"]'

  • 创建一个对 analytics collection 具有只读权限的角色。

    预期 CLI 命令：

    bash
    zilliz role create --role analytics_readonly
    zilliz role grant-privilege --role analytics_readonly --object-type Collection --object-name analytics --privilege Search
    zilliz role grant-privilege --role analytics_readonly --object-type Collection --object-name analytics --privilege Query
Ctrl I