| name | quickstart |
| description | Use when the user wants to set up, install, authenticate, or configure the Zilliz Cloud CLI and cluster context for the first time (one-shot onboarding). |
Guide the user through the complete Zilliz Cloud CLI setup. Follow these steps in order:
Step 1: Install zilliz-cli
Check if already installed:
zilliz --version
If not installed or needs upgrading:
curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash
Verify:
zilliz --version
Step 2: Authenticate
Check if already logged in:
zilliz auth status
If not logged in, instruct the user to open their own terminal and run one of:
- Browser login (recommended) —
zilliz login — opens browser for OAuth, full feature access.
- API Key via login —
zilliz login --api-key — prompts for API key, no browser needed.
- API Key via configure (legacy) —
zilliz configure — prompts for API key, simpler setup.
- Environment variable — add
export ZILLIZ_API_KEY=<key> to .zshrc / .bashrc.
IMPORTANT: These commands require interactive input and cannot run inside the agent. Do NOT ask the user to paste API keys into the chat.
Wait for the user to confirm login is complete, then verify:
zilliz auth status
Step 3: Select a Cluster
List available clusters:
zilliz cluster list
If no clusters exist, offer to create one:
zilliz project list
zilliz cluster regions
zilliz cluster create --type serverless --name <name> --project-id <id> --region <region>
Step 4: Set Cluster Context
Set the active cluster for data operations:
zilliz context set --cluster-id <selected-cluster-id>
Step 5: Verify
Confirm everything works:
zilliz context current
zilliz collection list
Report the setup result to the user, showing their cluster ID, endpoint, and database.
