zilliz-cli 0.1.1__tar.gz

zilliz_cli-0.1.1/.gitignore

@@ -0,0 +1,2 @@
+# Documentation (design docs, plans)
+docs/

zilliz_cli-0.1.1/PKG-INFO

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: zilliz-cli
+Version: 0.1.1
+Summary: CLI for Zilliz Cloud resource management and Milvus operations
+Project-URL: Homepage, https://zilliz.com
+Project-URL: Documentation, https://docs.zilliz.com
+Author-email: Zilliz <support@zilliz.com>
+License-Expression: Apache-2.0
+Keywords: cli,milvus,vector-database,zilliz
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Zilliz CLI
+
+Command-line tool for Zilliz Cloud cluster management and Milvus vector database operations.
+
+## Requirements
+
+- Python 3.10+
+
+## Installation
+
+```bash
+pip install zilliz-cli
+```
+
+For development (from source):
+
+```bash
+git clone git@github.com:zilliztech/zilliz-cloud.git
+cd zilliz-cloud/vdc/zilliz-cli
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```bash
+# 1. Configure API Key
+zilliz configure
+# or
+export ZILLIZ_API_KEY=your-api-key
+
+# 2. List clusters
+zilliz cluster list
+
+# 3. Set cluster context (auto-resolves endpoint)
+zilliz context set --cluster-id in01-xxxx
+
+# 4. Work with collections and vectors
+zilliz collection list
+zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --limit 5
+```
+
+## Commands
+
+### Configuration
+
+```bash
+# Interactive setup
+zilliz configure
+
+# Set individual values
+zilliz configure set api_key YOUR_KEY
+zilliz configure set output json
+
+# View values
+zilliz configure get api_key
+zilliz configure list
+```
+
+### Context
+
+```bash
+# Set cluster context (endpoint auto-resolved)
+zilliz context set --cluster-id in01-xxxx
+
+# Set with specific database
+zilliz context set --cluster-id in01-xxxx --database mydb
+
+# Change database only
+zilliz context set --database another_db
+
+# Manual endpoint override
+zilliz context set --cluster-id in01-xxxx --endpoint https://custom.endpoint.com
+
+# View current context
+zilliz context current
+```
+
+### Cluster Management
+
+```bash
+# List all clusters
+zilliz cluster list
+zilliz cluster list --output json
+
+# Describe a cluster
+zilliz cluster describe --cluster-id in01-xxxx
+
+# Create a serverless cluster
+zilliz cluster create --name my-cluster --project-id p1 --region gcp-us-west1
+
+# Delete a cluster
+zilliz cluster delete --cluster-id in01-xxxx
+```
+
+### Collection Operations
+
+Requires a context to be set first (`zilliz context set --cluster-id ...`).
+
+```bash
+# List collections
+zilliz collection list
+
+# Describe a collection
+zilliz collection describe --name my_collection
+
+# Quick Setup: create with dimension and metric type
+zilliz collection create --name my_collection --dimension 768 --metric-type COSINE
+
+# Custom Setup: create with full JSON schema
+zilliz collection create --body '{"collectionName": "my_col", "schema": {...}}'
+zilliz collection create --body file://schema.json
+```
+
+### Vector Operations
+
+Requires a context to be set first (`zilliz context set --cluster-id ...`).
+
+```bash
+# Vector search
+zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --limit 10
+zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --filter "age > 20" --output-fields '["name", "age"]'
+
+# Query by filter
+zilliz vector query --collection my_col --filter "id in [1, 2, 3]" --limit 10
+zilliz vector query --collection my_col --filter "age > 20" --output-fields '["name", "age"]'
+
+# Insert data
+zilliz vector insert --collection my_col --data '[{"id": 1, "vector": [0.1, 0.2], "name": "doc1"}]'
+```
+
+### Version
+
+```bash
+zilliz version
+zilliz version --output json
+```
+
+## Global Options
+
+| Option | Description |
+|--------|-------------|
+| `--output`, `-o` | Output format: `json`, `table`, `text` |
+| `--api-key` | API key (overrides config file and env var) |
+| `--help` | Show help |
+
+## Configuration
+
+### Credential Resolution
+
+API Key is resolved in order (first found wins):
+1. `--api-key` CLI flag
+2. `ZILLIZ_API_KEY` environment variable
+3. `~/.zilliz/credentials` file
+
+### Config Files
+
+```
+~/.zilliz/
+  credentials     # API key
+  config          # CLI settings + cluster context
+```
+
+## Output Formats
+
+```bash
+# Table (default, human-friendly)
+zilliz cluster list
+
+# JSON (machine/agent-friendly)
+zilliz cluster list --output json
+
+# Plain text
+zilliz cluster list --output text
+```
+
+## Testing
+
+```bash
+# Run unit tests
+pytest tests/unit/
+
+# Run all tests (E2E tests skipped without API key)
+pytest
+
+# Run E2E tests (requires real API key)
+ZILLIZ_API_KEY=your-key pytest -m e2e
+
+# Run E2E tests with data plane (requires cluster)
+ZILLIZ_API_KEY=your-key ZILLIZ_CLUSTER_ID=in01-xxxx pytest -m e2e
+```
+
+## License
+
+Apache-2.0

zilliz_cli-0.1.1/README.md

@@ -0,0 +1,194 @@
+# Zilliz CLI
+
+Command-line tool for Zilliz Cloud cluster management and Milvus vector database operations.
+
+## Requirements
+
+- Python 3.10+
+
+## Installation
+
+```bash
+pip install zilliz-cli
+```
+
+For development (from source):
+
+```bash
+git clone git@github.com:zilliztech/zilliz-cloud.git
+cd zilliz-cloud/vdc/zilliz-cli
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```bash
+# 1. Configure API Key
+zilliz configure
+# or
+export ZILLIZ_API_KEY=your-api-key
+
+# 2. List clusters
+zilliz cluster list
+
+# 3. Set cluster context (auto-resolves endpoint)
+zilliz context set --cluster-id in01-xxxx
+
+# 4. Work with collections and vectors
+zilliz collection list
+zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --limit 5
+```
+
+## Commands
+
+### Configuration
+
+```bash
+# Interactive setup
+zilliz configure
+
+# Set individual values
+zilliz configure set api_key YOUR_KEY
+zilliz configure set output json
+
+# View values
+zilliz configure get api_key
+zilliz configure list
+```
+
+### Context
+
+```bash
+# Set cluster context (endpoint auto-resolved)
+zilliz context set --cluster-id in01-xxxx
+
+# Set with specific database
+zilliz context set --cluster-id in01-xxxx --database mydb
+
+# Change database only
+zilliz context set --database another_db
+
+# Manual endpoint override
+zilliz context set --cluster-id in01-xxxx --endpoint https://custom.endpoint.com
+
+# View current context
+zilliz context current
+```
+
+### Cluster Management
+
+```bash
+# List all clusters
+zilliz cluster list
+zilliz cluster list --output json
+
+# Describe a cluster
+zilliz cluster describe --cluster-id in01-xxxx
+
+# Create a serverless cluster
+zilliz cluster create --name my-cluster --project-id p1 --region gcp-us-west1
+
+# Delete a cluster
+zilliz cluster delete --cluster-id in01-xxxx
+```
+
+### Collection Operations
+
+Requires a context to be set first (`zilliz context set --cluster-id ...`).
+
+```bash
+# List collections
+zilliz collection list
+
+# Describe a collection
+zilliz collection describe --name my_collection
+
+# Quick Setup: create with dimension and metric type
+zilliz collection create --name my_collection --dimension 768 --metric-type COSINE
+
+# Custom Setup: create with full JSON schema
+zilliz collection create --body '{"collectionName": "my_col", "schema": {...}}'
+zilliz collection create --body file://schema.json
+```
+
+### Vector Operations
+
+Requires a context to be set first (`zilliz context set --cluster-id ...`).
+
+```bash
+# Vector search
+zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --limit 10
+zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --filter "age > 20" --output-fields '["name", "age"]'
+
+# Query by filter
+zilliz vector query --collection my_col --filter "id in [1, 2, 3]" --limit 10
+zilliz vector query --collection my_col --filter "age > 20" --output-fields '["name", "age"]'
+
+# Insert data
+zilliz vector insert --collection my_col --data '[{"id": 1, "vector": [0.1, 0.2], "name": "doc1"}]'
+```
+
+### Version
+
+```bash
+zilliz version
+zilliz version --output json
+```
+
+## Global Options
+
+| Option | Description |
+|--------|-------------|
+| `--output`, `-o` | Output format: `json`, `table`, `text` |
+| `--api-key` | API key (overrides config file and env var) |
+| `--help` | Show help |
+
+## Configuration
+
+### Credential Resolution
+
+API Key is resolved in order (first found wins):
+1. `--api-key` CLI flag
+2. `ZILLIZ_API_KEY` environment variable
+3. `~/.zilliz/credentials` file
+
+### Config Files
+
+```
+~/.zilliz/
+  credentials     # API key
+  config          # CLI settings + cluster context
+```
+
+## Output Formats
+
+```bash
+# Table (default, human-friendly)
+zilliz cluster list
+
+# JSON (machine/agent-friendly)
+zilliz cluster list --output json
+
+# Plain text
+zilliz cluster list --output text
+```
+
+## Testing
+
+```bash
+# Run unit tests
+pytest tests/unit/
+
+# Run all tests (E2E tests skipped without API key)
+pytest
+
+# Run E2E tests (requires real API key)
+ZILLIZ_API_KEY=your-key pytest -m e2e
+
+# Run E2E tests with data plane (requires cluster)
+ZILLIZ_API_KEY=your-key ZILLIZ_CLUSTER_ID=in01-xxxx pytest -m e2e
+```
+
+## License
+
+Apache-2.0

zilliz_cli-0.1.1/pyproject.toml

@@ -0,0 +1,83 @@
+# Copyright (c) 2026 Zilliz Inc. All rights reserved.
+#
+# PROPRIETARY AND CONFIDENTIAL
+#
+# This file contains proprietary information of Zilliz Inc.
+#
+# No part of this file may be reproduced, stored, transmitted,
+# or disclosed to any third party without the prior written
+# permission of Zilliz Inc.
+#
+# Unauthorized use is strictly prohibited.
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "zilliz-cli"
+version = "0.1.1"
+description = "CLI for Zilliz Cloud resource management and Milvus operations"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Zilliz", email = "support@zilliz.com" }
+]
+keywords = ["zilliz", "milvus", "vector-database", "cli"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "click>=8.1.0",
+    "httpx>=0.25.0",
+    "rich>=13.0.0",
+    "questionary>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-httpx>=0.30.0",
+    "ruff>=0.4.0",
+    "mypy>=1.10.0",
+]
+
+[project.scripts]
+zilliz = "zilliz_cli.cli:main"
+
+[project.urls]
+Homepage = "https://zilliz.com"
+Documentation = "https://docs.zilliz.com"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/zilliz_cli"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v"
+markers = [
+    "e2e: end-to-end tests that run the CLI as a subprocess",
+    "acceptance: full lifecycle acceptance tests requiring ZILLIZ_API_KEY",
+]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = false
+warn_unused_configs = true
+ignore_missing_imports = true

zilliz_cli-0.1.1/scripts/cleanup_test_resources.py

@@ -0,0 +1,89 @@
+#!/usr/bin/env python3
+"""Clean up leftover acceptance test resources (clusters and collections).
+
+Usage:
+    ZILLIZ_API_KEY=xxx python scripts/cleanup_test_resources.py           # actual cleanup
+    ZILLIZ_API_KEY=xxx python scripts/cleanup_test_resources.py --dry-run  # list only
+"""
+import argparse
+import json
+import os
+import subprocess
+import sys
+
+CLUSTER_PREFIX = "zilliz-cli-test-"
+COLLECTION_PREFIX = "zilliz_cli_test_"
+
+
+def run_cli(*args):
+    env = os.environ.copy()
+    result = subprocess.run(
+        ["zilliz", *args],
+        capture_output=True,
+        text=True,
+        env=env,
+        timeout=30,
+    )
+    return result
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Clean up test resources")
+    parser.add_argument("--dry-run", action="store_true", help="List resources without deleting")
+    args = parser.parse_args()
+
+    if not os.environ.get("ZILLIZ_API_KEY"):
+        print("Error: ZILLIZ_API_KEY environment variable is required", file=sys.stderr)
+        sys.exit(1)
+
+    # Find test clusters
+    result = run_cli("cluster", "list", "--all", "-o", "json")
+    if result.returncode != 0:
+        print(f"Error listing clusters: {result.stderr}", file=sys.stderr)
+        sys.exit(1)
+
+    clusters = json.loads(result.stdout)
+    test_clusters = [c for c in clusters if c["clusterName"].startswith(CLUSTER_PREFIX)]
+
+    if not test_clusters:
+        print("No test resources found.")
+        return
+
+    print(f"Found {len(test_clusters)} test cluster(s):")
+    for c in test_clusters:
+        print(f"  {c['clusterId']} ({c['clusterName']}) - {c['status']}")
+
+    if args.dry_run:
+        print("\n[DRY RUN] No resources deleted.")
+        return
+
+    # Clean up each cluster
+    for c in test_clusters:
+        cluster_id = c["clusterId"]
+        print(f"\nCleaning up cluster {cluster_id} ({c['clusterName']})...")
+
+        # Try to set context and clean collections
+        if c["status"] == "RUNNING":
+            ctx_result = run_cli("context", "set", "--cluster-id", cluster_id)
+            if ctx_result.returncode == 0:
+                col_result = run_cli("collection", "list", "-o", "json")
+                if col_result.returncode == 0:
+                    collections = json.loads(col_result.stdout)
+                    for col_name in collections:
+                        if col_name.startswith(COLLECTION_PREFIX):
+                            print(f"  Dropping collection: {col_name}")
+                            run_cli("collection", "drop", "--name", col_name)
+
+        # Delete cluster
+        print(f"  Deleting cluster: {cluster_id}")
+        del_result = run_cli("cluster", "delete", "--cluster-id", cluster_id)
+        if del_result.returncode == 0:
+            print(f"  Deleted: {cluster_id}")
+        else:
+            print(f"  Failed to delete {cluster_id}: {del_result.stderr}")
+
+    print("\nCleanup complete.")
+
+
+if __name__ == "__main__":
+    main()

zilliz_cli-0.1.1/src/zilliz_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

zilliz_cli-0.1.1/src/zilliz_cli/__main__.py

@@ -0,0 +1,3 @@
+from zilliz_cli.cli import main
+
+main()