zilliz

A unified CLI and TUI (Terminal User Interface) for managing Zilliz Cloud clusters and Milvus vector database operations, written in Rust.

Features

• Dual interface -- interactive TUI mode and traditional CLI commands
• Model-driven -- operations defined in JSON, supporting dynamic command generation
• Multi-resource management -- clusters, collections, vectors, indexes, backups, billing, and more
• Rich output -- table, JSON, YAML, CSV, and text formats with JMESPath filtering
• Async job polling -- --wait flag for long-running operations
• Metrics -- query cluster and collection metrics; default output is an inline Braille line chart per metric with min / max / avg / last summary (pass -o table for the pivot-table layout, -o json / --query for raw data)

Quick Start

Install

cargo install zilliz

This installs two binaries: zilliz (primary) and zz (shorthand alias). Both are identical.

Uninstall

zilliz uninstall            # remove the binary and `zz` alias; preserves ~/.zilliz/
zilliz uninstall --purge    # also remove ~/.zilliz/ (credentials, config)
zilliz uninstall --yes      # skip the confirmation prompt

If you installed via cargo install zilliz, also run cargo uninstall zilliz afterwards to clear Cargo's registry record.

Updating

Once installed, update in place by re-running the installer:

zilliz upgrade           # confirms and re-runs the official installer
zilliz upgrade --check   # only report whether a newer version exists
zilliz upgrade --yes     # skip the confirmation prompt

update is an accepted alias (zilliz update).

Guided onboarding

If this is your first time, run:

zilliz quickstart

It walks you through sign-in, picks an organization and cluster, lets you run a few common commands interactively, and prints a copy-pasteable cheatsheet of next-step commands. Use zilliz quickstart --non-interactive (or pipe the output) to print the cheatsheet only — handy in scripts or CI.

Authenticate

# Browser-based OAuth (recommended)
zilliz login

# Login with an API key (prompted if no value is given)
zilliz login --api-key
zilliz login --api-key sk-xxx

# Log in to the CN cloud (api.cloud.zilliz.com.cn) — API key only
zilliz login --cn
zilliz login --cn --api-key sk-xxx

# Or configure credentials interactively
zilliz configure

Set Cluster Context

A cluster context is required for data-plane operations (collections, vectors, etc.).

# Interactive selection
zilliz context set

# Or specify directly
zilliz context set --cluster-id <id>

# Check current context
zilliz context current

Launch TUI

zilliz

Running zilliz without arguments starts the interactive terminal UI.

Use CLI

# List clusters
zilliz cluster list

# Describe a collection (using shorthand alias)
zilliz collection describe

# JSON output with JMESPath filtering
zilliz cluster list -o json --query "clusters[*].{id:clusterId,name:clusterName}"

# Suppress table headers
zilliz cluster list --no-header

# Wait for an async operation to complete
zilliz cluster create --wait

CLI Commands

Built-in Commands

Control-Plane Commands (Cloud Management)

Data-Plane Commands (Milvus Operations)

These commands require a cluster context (zilliz context set).

* Dedicated clusters only.

Local Milvus Standalone

Manage a local Milvus standalone Docker deployment via the official standalone_embed.sh script. Requires bash and a working Docker daemon (macOS / Linux / WSL).

Common flags: --dir <path>, --dry-run, -y / --yes, -h / --help. Install also accepts --script-url <https://...>, --start, and --force.

# Preview without touching the filesystem or Docker
zilliz milvus standalone install --dry-run

# Install and start in one go
zilliz milvus standalone install --start

# Manage the running deployment
zilliz milvus standalone stop
zilliz milvus standalone restart
zilliz milvus standalone upgrade --yes
zilliz milvus standalone delete --yes

Default endpoints after start: Milvus localhost:19530, WebUI http://localhost:9091, embedded etcd localhost:2379. Data is persisted under <install-dir>/volumes/milvus.

Global Flags

TUI Keyboard Shortcuts

Configuration

Config files are stored in ~/.zilliz/ (compatible with zilliz-cli):

Environment Variables

Tech Stack

• ratatui -- terminal UI framework
• clap -- CLI argument parsing
• tokio -- async runtime
• reqwest -- HTTP client