Skip to content
zilliz logo

Zilliz Cloud CLI Skill

zilliz

Manage Zilliz Cloud vector databases via zilliz-cli. Use when the user wants to: (1) set up zilliz-cli (install, login, configure), (2) manage clusters (create, list, describe, suspend, resume, delete, modify), (3) manage collections, indexes, partitions, databases, or aliases, (4) perform vector...

zilliztech/zilliz-skill0installs5stars

SKILL.md

Full skill instructions

Zilliz Cloud CLI Skill

Operate Zilliz Cloud through zilliz-cli. All operations are executed via shell commands.

Prerequisite Check (always run first)

Before any operation, verify in order:

# 1. Install or update the CLI
curl -fsSL https://raw.githubusercontent.com/​zilliztech/​zilliz-cli/​master/​install.sh | bash

# 2. Logged in? If not: guide user to login in their terminal
zilliz auth status

# 3. Context set? (only for data-plane ops)
zilliz context current

CRITICAL: zilliz login, zilliz configure, and zilliz auth switch require interactive input — NEVER run them in a non-interactive shell. Instruct the user to run in their own terminal. NEVER ask for API keys in chat.

Command Pattern

zilliz <resource> <action> --flag <value> [--optional-flag <value>]

All commands support --output json|table|text (default: text). Use --output json for programmatic parsing.

Cluster Type Capabilities

FeatureFreeServerlessDedicated
Collection CRUD & Vector opsYesYesYes
Database create/​dropNoNoYes
User/​role managementNoLimitedYes
Backup managementNoYesYes
Cluster modify (CU/​replica)NoNoYes

Check cluster type first when a command fails with permission errors.

Reference Files

Each reference covers one resource domain with full command syntax, options, and guidance. Read the relevant reference when handling that domain:

DomainReferenceWhen to read
Setup & authreferences/​setup.mdInstall, login, context, config, troubleshooting
Clustersreferences/​cluster.mdCreate, list, describe, modify, suspend, resume, delete clusters; create Vector Lake
On-demand clustersreferences/​on-demand-cluster.mdCreate, list, describe, delete on-demand (Vector Lake) clusters with auto-suspend TTL
Collectionsreferences/​collection.mdCreate, list, describe, drop, rename, load, release, aliases, per-collection metrics
External collectionsreferences/​external-collection.mdTrigger, describe, list refresh jobs for Vector Lake-backed collections
Vectorsreferences/​vector.mdSearch, query, insert, upsert, get, delete, hybrid search, filters
Indexesreferences/​index.mdCreate, list, describe, drop indexes
Databasesreferences/​database.mdCreate, list, describe, drop databases
Partitionsreferences/​partition.mdCreate, list, load, release, drop partitions
Users & rolesreferences/​user-role.mdRBAC: users, roles, privileges (Dedicated only)
Backupsreferences/​backup.mdCreate, restore, export backups; manage backup policies
Importreferences/​import.mdBulk data import from cloud storage; manage import stages
Billingreferences/​billing.mdUsage queries, invoices, payment methods
Monitoringreferences/​monitoring.mdCluster status, collection stats, load states, cluster and per-collection time-series metrics
Projects & regionsreferences/​project-region.mdProjects, volumes, cloud providers, regions
PrivateLinkreferences/​privatelink.mdEndpoint services, project endpoints, whitelist management
Jobsreferences/​job.mdTrack async job status, wait for completion
Diagnosereferences/​diagnose.mdRead-only health diagnosis for clusters and collections (slow, stuck, errors, quota)

Quick-Start Workflow

For new users, guide through setup in order:

  1. Install CLI: curl -fsSL https://raw.githubusercontent.com/​zilliztech/​zilliz-cli/​master/​install.sh | bash
  2. Authenticate: user runs zilliz login in their terminal
  3. Verify: zilliz auth status
  4. List clusters: zilliz cluster list
  5. Set context: zilliz context set --cluster-id <id>
  6. Verify: zilliz context current && zilliz collection list

Common Workflows

Create collection and prepare for search:

  1. zilliz collection create --name <name> --dimension <dim> — create
  2. zilliz index create --collection <name> — index (AUTOINDEX recommended)
  3. zilliz collection load --name <name> — load into memory
  4. zilliz vector search --collection <name> --data '[[...]]' — search

Status overview (read references/​monitoring.md):

  1. zilliz context current --output json
  2. zilliz cluster describe --cluster-id <id> --output json
  3. zilliz database list --output json
  4. For each DB: collection list, get-stats, get-load-state, index list
  5. Present as formatted table

Async Operations

These return immediately with a jobId; track with job describe (see references/​job.md):

OperationPoll command
cluster createcluster describe --cluster-id <id> until RUNNING
backup create/​export/​restore-*job describe --job-id <jid> or backup describe
import startjob describe --job-id <jid>
Any async op with jobIdjob describe --job-id <jid> --wait

Safety Rules

  • Confirm before destructive ops: drop collection/​database, delete cluster/​backup, drop user/​role
  • Sensitive commands in user's terminal: zilliz login, zilliz configure, zilliz billing bind-card
  • Never expose credentials in chat or command output

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View